ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkClosedSurfacePointPlacer Class Reference

vtkClosedSurfacePointPlacer - PointPlacer to constrain validity within a set of convex planes More...

Inheritance diagram for Kitware.VTK.vtkClosedSurfacePointPlacer:
[legend]
Collaboration diagram for Kitware.VTK.vtkClosedSurfacePointPlacer:
[legend]

List of all members.

Public Member Functions

 vtkClosedSurfacePointPlacer (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkClosedSurfacePointPlacer ()
 Instantiate this class.
void AddBoundingPlane (vtkPlane plane)
 A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.
override int ComputeWorldPosition (vtkRenderer ren, IntPtr displayPos, IntPtr worldPos, IntPtr worldOrient)
 Given a renderer and a display position, compute the world position and world orientation for this point. A plane is defined by a combination of the ProjectionNormal, ProjectionOrigin, and ObliquePlane ivars. The display position is projected onto this plane to determine a world position, and the orientation is set to the normal of the plane. If the point cannot project onto the plane or if it falls outside the bounds imposed by the BoundingPlanes, then 0 is returned, otherwise 1 is returned to indicate a valid return position and orientation.
override int ComputeWorldPosition (vtkRenderer ren, IntPtr displayPos, IntPtr refWorldPos, IntPtr worldPos, IntPtr worldOrient)
 Given a renderer, a display position and a reference position, "worldPos" is calculated as : Consider the line "L" that passes through the supplied "displayPos" and is parallel to the direction of projection of the camera. Clip this line segment with the parallelopiped, let's call it "L_segment". The computed world position, "worldPos" will be the point on "L_segment" that is closest to refWorldPos. NOTE: Note that a set of bounding planes must be supplied. The Oblique plane, if supplied is ignored.
virtual vtkPlaneCollection GetBoundingPlanes ()
 A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.
virtual double GetMinimumDistance ()
 Descrption: The minimum distance the object should be from the faces of the object. Must be greater than 0. Default is 0.
virtual double GetMinimumDistanceMaxValue ()
 Descrption: The minimum distance the object should be from the faces of the object. Must be greater than 0. Default is 0.
virtual double GetMinimumDistanceMinValue ()
 Descrption: The minimum distance the object should be from the faces of the object. Must be greater than 0. Default is 0.
override int IsA (string type)
 Standard methods for instances of this class.
new vtkClosedSurfacePointPlacer NewInstance ()
 Standard methods for instances of this class.
void RemoveAllBoundingPlanes ()
 A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.
void RemoveBoundingPlane (vtkPlane plane)
 A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.
virtual void SetBoundingPlanes (vtkPlaneCollection arg0)
 A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.
void SetBoundingPlanes (vtkPlanes planes)
 A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.
virtual void SetMinimumDistance (double _arg)
 Descrption: The minimum distance the object should be from the faces of the object. Must be greater than 0. Default is 0.
override int ValidateWorldPosition (IntPtr worldPos)
 Give a world position check if it is valid - does it lie on the plane and within the bounds? Returns 1 if it is valid, 0 otherwise.
override int ValidateWorldPosition (IntPtr worldPos, IntPtr worldOrient)
 Descrption: Orientationation is ignored, and the above method is called instead.
- Public Member Functions inherited from Kitware.VTK.vtkPointPlacer
 vtkPointPlacer (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPointPlacer ()
 Instantiate this class.
virtual int GetPixelTolerance ()
 Set/get the tolerance used when performing computations in display coordinates.
virtual int GetPixelToleranceMaxValue ()
 Set/get the tolerance used when performing computations in display coordinates.
virtual int GetPixelToleranceMinValue ()
 Set/get the tolerance used when performing computations in display coordinates.
virtual double GetWorldTolerance ()
 Set/get the tolerance used when performing computations in world coordinates.
virtual double GetWorldToleranceMaxValue ()
 Set/get the tolerance used when performing computations in world coordinates.
virtual double GetWorldToleranceMinValue ()
 Set/get the tolerance used when performing computations in world coordinates.
virtual void SetPixelTolerance (int _arg)
 Set/get the tolerance used when performing computations in display coordinates.
virtual void SetWorldTolerance (double _arg)
 Set/get the tolerance used when performing computations in world coordinates.
virtual int UpdateInternalState ()
 Called by the representation to give the placer a chance to update itself.
virtual int UpdateWorldPosition (vtkRenderer ren, IntPtr worldPos, IntPtr worldOrient)
 Given a current renderer, world position and orientation, update them according to the constraints of the placer. This method is typically used when UpdateContour is called on the representation, which must be called after changes are made to the constraints in the placer. A return value of 1 indicates that the point has been updated. A return value of 0 indicates that the point could not be updated and was left alone. By default this is a no-op - leaving the point as is.
virtual int ValidateDisplayPosition (vtkRenderer arg0, IntPtr displayPos)
 Given a display position, check the validity of this position.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new
vtkClosedSurfacePointPlacer 
New ()
 Instantiate this class.
static new int IsTypeOf (string type)
 Standard methods for instances of this class.
static new
vtkClosedSurfacePointPlacer 
SafeDownCast (vtkObjectBase o)
 Standard methods for instances of this class.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkClosedSurfacePointPlacer"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkPointPlacer
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "27vtkClosedSurfacePointPlacer"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkPointPlacer
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions

static vtkClosedSurfacePointPlacer ()
 Automatically generated type registration mechanics.

Detailed Description

vtkClosedSurfacePointPlacer - PointPlacer to constrain validity within a set of convex planes

Description This placer takes a set of boudning planes and constraints the validity within the supplied convex planes. It is used by the ParallelopPipedRepresentation to place constraints on the motion the handles within the parallelopiped.

vtkParallelopipedRepresentation


Constructor & Destructor Documentation

static Kitware.VTK.vtkClosedSurfacePointPlacer.vtkClosedSurfacePointPlacer ( )
staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkClosedSurfacePointPlacer.vtkClosedSurfacePointPlacer ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkClosedSurfacePointPlacer.vtkClosedSurfacePointPlacer ( )

Instantiate this class.


Member Function Documentation

void Kitware.VTK.vtkClosedSurfacePointPlacer.AddBoundingPlane ( vtkPlane  plane)

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

override int Kitware.VTK.vtkClosedSurfacePointPlacer.ComputeWorldPosition ( vtkRenderer  ren,
IntPtr  displayPos,
IntPtr  worldPos,
IntPtr  worldOrient 
)
virtual

Given a renderer and a display position, compute the world position and world orientation for this point. A plane is defined by a combination of the ProjectionNormal, ProjectionOrigin, and ObliquePlane ivars. The display position is projected onto this plane to determine a world position, and the orientation is set to the normal of the plane. If the point cannot project onto the plane or if it falls outside the bounds imposed by the BoundingPlanes, then 0 is returned, otherwise 1 is returned to indicate a valid return position and orientation.

Reimplemented from Kitware.VTK.vtkPointPlacer.

override int Kitware.VTK.vtkClosedSurfacePointPlacer.ComputeWorldPosition ( vtkRenderer  ren,
IntPtr  displayPos,
IntPtr  refWorldPos,
IntPtr  worldPos,
IntPtr  worldOrient 
)
virtual

Given a renderer, a display position and a reference position, "worldPos" is calculated as : Consider the line "L" that passes through the supplied "displayPos" and is parallel to the direction of projection of the camera. Clip this line segment with the parallelopiped, let's call it "L_segment". The computed world position, "worldPos" will be the point on "L_segment" that is closest to refWorldPos. NOTE: Note that a set of bounding planes must be supplied. The Oblique plane, if supplied is ignored.

Reimplemented from Kitware.VTK.vtkPointPlacer.

override void Kitware.VTK.vtkClosedSurfacePointPlacer.Dispose ( bool  disposing)
protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkPointPlacer.

virtual vtkPlaneCollection Kitware.VTK.vtkClosedSurfacePointPlacer.GetBoundingPlanes ( )
virtual

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

Here is the call graph for this function:

virtual double Kitware.VTK.vtkClosedSurfacePointPlacer.GetMinimumDistance ( )
virtual

Descrption: The minimum distance the object should be from the faces of the object. Must be greater than 0. Default is 0.

virtual double Kitware.VTK.vtkClosedSurfacePointPlacer.GetMinimumDistanceMaxValue ( )
virtual

Descrption: The minimum distance the object should be from the faces of the object. Must be greater than 0. Default is 0.

virtual double Kitware.VTK.vtkClosedSurfacePointPlacer.GetMinimumDistanceMinValue ( )
virtual

Descrption: The minimum distance the object should be from the faces of the object. Must be greater than 0. Default is 0.

override int Kitware.VTK.vtkClosedSurfacePointPlacer.IsA ( string  type)
virtual

Standard methods for instances of this class.

Reimplemented from Kitware.VTK.vtkPointPlacer.

static new int Kitware.VTK.vtkClosedSurfacePointPlacer.IsTypeOf ( string  type)
static

Standard methods for instances of this class.

Reimplemented from Kitware.VTK.vtkPointPlacer.

static new vtkClosedSurfacePointPlacer Kitware.VTK.vtkClosedSurfacePointPlacer.New ( )
static

Instantiate this class.

Reimplemented from Kitware.VTK.vtkPointPlacer.

new vtkClosedSurfacePointPlacer Kitware.VTK.vtkClosedSurfacePointPlacer.NewInstance ( )

Standard methods for instances of this class.

Reimplemented from Kitware.VTK.vtkPointPlacer.

void Kitware.VTK.vtkClosedSurfacePointPlacer.RemoveAllBoundingPlanes ( )

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

void Kitware.VTK.vtkClosedSurfacePointPlacer.RemoveBoundingPlane ( vtkPlane  plane)

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

static new vtkClosedSurfacePointPlacer Kitware.VTK.vtkClosedSurfacePointPlacer.SafeDownCast ( vtkObjectBase  o)
static

Standard methods for instances of this class.

Reimplemented from Kitware.VTK.vtkPointPlacer.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkClosedSurfacePointPlacer.SetBoundingPlanes ( vtkPlaneCollection  arg0)
virtual

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

void Kitware.VTK.vtkClosedSurfacePointPlacer.SetBoundingPlanes ( vtkPlanes  planes)

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

virtual void Kitware.VTK.vtkClosedSurfacePointPlacer.SetMinimumDistance ( double  _arg)
virtual

Descrption: The minimum distance the object should be from the faces of the object. Must be greater than 0. Default is 0.

override int Kitware.VTK.vtkClosedSurfacePointPlacer.ValidateWorldPosition ( IntPtr  worldPos)
virtual

Give a world position check if it is valid - does it lie on the plane and within the bounds? Returns 1 if it is valid, 0 otherwise.

Reimplemented from Kitware.VTK.vtkPointPlacer.

override int Kitware.VTK.vtkClosedSurfacePointPlacer.ValidateWorldPosition ( IntPtr  worldPos,
IntPtr  worldOrient 
)
virtual

Descrption: Orientationation is ignored, and the above method is called instead.

Reimplemented from Kitware.VTK.vtkPointPlacer.


Member Data Documentation

new readonly string Kitware.VTK.vtkClosedSurfacePointPlacer.MRClassNameKey = "27vtkClosedSurfacePointPlacer"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPointPlacer.

new const string Kitware.VTK.vtkClosedSurfacePointPlacer.MRFullTypeName = "Kitware.VTK.vtkClosedSurfacePointPlacer"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPointPlacer.


The documentation for this class was generated from the following file: