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

vtkPointPlacer - Abstract interface to translate 2D display positions to world coordinates More...

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

List of all members.

Public Member Functions

 vtkPointPlacer (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPointPlacer ()
 Instantiate this class.
virtual int ComputeWorldPosition (vtkRenderer ren, IntPtr displayPos, IntPtr worldPos, IntPtr worldOrient)
 Given a renderer and a display position in pixel coordinates, compute the world position and orientation where this point will be placed. This method is typically used by the representation to place the point initially. A return value of 1 indicates that constraints of the placer are met.
virtual int ComputeWorldPosition (vtkRenderer ren, IntPtr displayPos, IntPtr refWorldPos, IntPtr worldPos, IntPtr worldOrient)
 Given a renderer, a display position, and a reference world position, compute the new world position and orientation of this point. This method is typically used by the representation to move the point. A return value of 1 indicates that constraints of the placer are met.
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.
override int IsA (string type)
 Standard methods for instances of this class.
new vtkPointPlacer NewInstance ()
 Standard methods for instances of this class.
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.
virtual int ValidateWorldPosition (IntPtr worldPos)
 Given a world position check the validity of this position according to the constraints of the placer.
virtual int ValidateWorldPosition (IntPtr worldPos, IntPtr worldOrient)
 Given a world position and a world orientation, validate it according to the constraints of the placer.

Static Public Member Functions

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

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkPointPlacer"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkPointPlacer"
 Automatically generated type registration mechanics.

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.

Private Member Functions

static internal IntPtr vtkPointPlacer_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkPointPlacer_ComputeWorldPosition_01 (HandleRef pThis, HandleRef ren, IntPtr displayPos, IntPtr worldPos, IntPtr worldOrient)
static internal int vtkPointPlacer_ComputeWorldPosition_02 (HandleRef pThis, HandleRef ren, IntPtr displayPos, IntPtr refWorldPos, IntPtr worldPos, IntPtr worldOrient)
static internal int vtkPointPlacer_GetPixelTolerance_03 (HandleRef pThis)
static internal int vtkPointPlacer_GetPixelToleranceMaxValue_04 (HandleRef pThis)
static internal int vtkPointPlacer_GetPixelToleranceMinValue_05 (HandleRef pThis)
static internal double vtkPointPlacer_GetWorldTolerance_06 (HandleRef pThis)
static internal double vtkPointPlacer_GetWorldToleranceMaxValue_07 (HandleRef pThis)
static internal double vtkPointPlacer_GetWorldToleranceMinValue_08 (HandleRef pThis)
static internal int vtkPointPlacer_IsA_09 (HandleRef pThis, string type)
static internal int vtkPointPlacer_IsTypeOf_10 (string type)
static internal IntPtr vtkPointPlacer_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPointPlacer_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPointPlacer_SetPixelTolerance_14 (HandleRef pThis, int _arg)
static internal void vtkPointPlacer_SetWorldTolerance_15 (HandleRef pThis, double _arg)
static internal int vtkPointPlacer_UpdateInternalState_16 (HandleRef pThis)
static internal int vtkPointPlacer_UpdateWorldPosition_17 (HandleRef pThis, HandleRef ren, IntPtr worldPos, IntPtr worldOrient)
static internal int vtkPointPlacer_ValidateDisplayPosition_18 (HandleRef pThis, HandleRef arg0, IntPtr displayPos)
static internal int vtkPointPlacer_ValidateWorldPosition_19 (HandleRef pThis, IntPtr worldPos)
static internal int vtkPointPlacer_ValidateWorldPosition_20 (HandleRef pThis, IntPtr worldPos, IntPtr worldOrient)

Static Private Member Functions

static vtkPointPlacer ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPointPlacer - Abstract interface to translate 2D display positions to world coordinates

Description Most widgets in VTK have a need to translate of 2D display coordinates (as reported by the RenderWindowInteractor) to 3D world coordinates. This class is an abstraction of this functionality. A few subclasses are listed below: <p>1) vtkFocalPlanePointPlacer: This class converts 2D display positions to world positions such that they lie on the focal plane. <p>2) vtkPolygonalSurfacePointPlacer: Converts 2D display positions to world positions such that they lie on the surface of one or more specified polydatas. <p>3) vtkImageActorPointPlacer: Converts 2D display positions to world positions such that they lie on an ImageActor <p>4) vtkBoundedPlanePointPlacer: Converts 2D display positions to world positions such that they lie within a set of specified bounding planes. <p>5) vtkTerrainDataPointPlacer: Converts 2D display positions to world positions such that they lie on a height field. <p> Point placers provide an extensible framework to specify constraints on points. The methods ComputeWorldPosition, ValidateDisplayPosition and ValidateWorldPosition may be overridden to dictate whether a world or display position is allowed. These classes are currently used by the HandleWidget and the ContourWidget to allow various constraints to be enforced on the placement of their handles.


Constructor & Destructor Documentation

static Kitware.VTK.vtkPointPlacer.vtkPointPlacer ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Instantiate this class.


Member Function Documentation

virtual int Kitware.VTK.vtkPointPlacer.ComputeWorldPosition ( vtkRenderer  ren,
IntPtr  displayPos,
IntPtr  worldPos,
IntPtr  worldOrient 
) [virtual]

Given a renderer and a display position in pixel coordinates, compute the world position and orientation where this point will be placed. This method is typically used by the representation to place the point initially. A return value of 1 indicates that constraints of the placer are met.

Reimplemented in Kitware.VTK.vtkBoundedPlanePointPlacer, Kitware.VTK.vtkClosedSurfacePointPlacer, Kitware.VTK.vtkTerrainDataPointPlacer, Kitware.VTK.vtkPolyDataPointPlacer, Kitware.VTK.vtkPolygonalSurfacePointPlacer, Kitware.VTK.vtkImageActorPointPlacer, and Kitware.VTK.vtkFocalPlanePointPlacer.

virtual int Kitware.VTK.vtkPointPlacer.ComputeWorldPosition ( vtkRenderer  ren,
IntPtr  displayPos,
IntPtr  refWorldPos,
IntPtr  worldPos,
IntPtr  worldOrient 
) [virtual]

Given a renderer, a display position, and a reference world position, compute the new world position and orientation of this point. This method is typically used by the representation to move the point. A return value of 1 indicates that constraints of the placer are met.

Reimplemented in Kitware.VTK.vtkBoundedPlanePointPlacer, Kitware.VTK.vtkClosedSurfacePointPlacer, Kitware.VTK.vtkTerrainDataPointPlacer, Kitware.VTK.vtkPolyDataPointPlacer, Kitware.VTK.vtkPolygonalSurfacePointPlacer, Kitware.VTK.vtkFocalPlanePointPlacer, and Kitware.VTK.vtkImageActorPointPlacer.

override void Kitware.VTK.vtkPointPlacer.Dispose ( bool  disposing) [protected]

Set/get the tolerance used when performing computations in display coordinates.

Set/get the tolerance used when performing computations in display coordinates.

Set/get the tolerance used when performing computations in display coordinates.

virtual double Kitware.VTK.vtkPointPlacer.GetWorldTolerance ( ) [virtual]

Set/get the tolerance used when performing computations in world coordinates.

Set/get the tolerance used when performing computations in world coordinates.

Set/get the tolerance used when performing computations in world coordinates.

override int Kitware.VTK.vtkPointPlacer.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkPointPlacer.IsTypeOf ( string  type) [static]

Standard methods for instances of this class.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkBoundedPlanePointPlacer, Kitware.VTK.vtkClosedSurfacePointPlacer, Kitware.VTK.vtkPolygonalSurfacePointPlacer, Kitware.VTK.vtkPolyDataPointPlacer, Kitware.VTK.vtkImageActorPointPlacer, Kitware.VTK.vtkTerrainDataPointPlacer, and Kitware.VTK.vtkFocalPlanePointPlacer.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkPointPlacer.SetPixelTolerance ( int  _arg) [virtual]

Set/get the tolerance used when performing computations in display coordinates.

virtual void Kitware.VTK.vtkPointPlacer.SetWorldTolerance ( double  _arg) [virtual]

Set/get the tolerance used when performing computations in world coordinates.

Reimplemented in Kitware.VTK.vtkImageActorPointPlacer.

Called by the representation to give the placer a chance to update itself.

Reimplemented in Kitware.VTK.vtkImageActorPointPlacer.

virtual int Kitware.VTK.vtkPointPlacer.UpdateWorldPosition ( vtkRenderer  ren,
IntPtr  worldPos,
IntPtr  worldOrient 
) [virtual]

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.

Reimplemented in Kitware.VTK.vtkBoundedPlanePointPlacer, and Kitware.VTK.vtkImageActorPointPlacer.

virtual int Kitware.VTK.vtkPointPlacer.ValidateDisplayPosition ( vtkRenderer  arg0,
IntPtr  displayPos 
) [virtual]

Given a display position, check the validity of this position.

Reimplemented in Kitware.VTK.vtkPolygonalSurfacePointPlacer, Kitware.VTK.vtkPolyDataPointPlacer, and Kitware.VTK.vtkTerrainDataPointPlacer.

virtual int Kitware.VTK.vtkPointPlacer.ValidateWorldPosition ( IntPtr  worldPos) [virtual]
virtual int Kitware.VTK.vtkPointPlacer.ValidateWorldPosition ( IntPtr  worldPos,
IntPtr  worldOrient 
) [virtual]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_ComputeWorldPosition_01 ( HandleRef  pThis,
HandleRef  ren,
IntPtr  displayPos,
IntPtr  worldPos,
IntPtr  worldOrient 
) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_ComputeWorldPosition_02 ( HandleRef  pThis,
HandleRef  ren,
IntPtr  displayPos,
IntPtr  refWorldPos,
IntPtr  worldPos,
IntPtr  worldOrient 
) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_GetPixelTolerance_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_GetPixelToleranceMaxValue_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_GetPixelToleranceMinValue_05 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkPointPlacer.vtkPointPlacer_GetWorldTolerance_06 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkPointPlacer.vtkPointPlacer_GetWorldToleranceMaxValue_07 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkPointPlacer.vtkPointPlacer_GetWorldToleranceMinValue_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_IsTypeOf_10 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkPointPlacer.vtkPointPlacer_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPointPlacer.vtkPointPlacer_NewInstance_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPointPlacer.vtkPointPlacer_SafeDownCast_13 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPointPlacer.vtkPointPlacer_SetPixelTolerance_14 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkPointPlacer.vtkPointPlacer_SetWorldTolerance_15 ( HandleRef  pThis,
double  _arg 
) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_UpdateInternalState_16 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_UpdateWorldPosition_17 ( HandleRef  pThis,
HandleRef  ren,
IntPtr  worldPos,
IntPtr  worldOrient 
) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_ValidateDisplayPosition_18 ( HandleRef  pThis,
HandleRef  arg0,
IntPtr  displayPos 
) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_ValidateWorldPosition_19 ( HandleRef  pThis,
IntPtr  worldPos 
) [private]
static internal int Kitware.VTK.vtkPointPlacer.vtkPointPlacer_ValidateWorldPosition_20 ( HandleRef  pThis,
IntPtr  worldPos,
IntPtr  worldOrient 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkPointPlacer.MRClassNameKey = "14vtkPointPlacer" [static]
new const string Kitware.VTK.vtkPointPlacer.MRFullTypeName = "Kitware.VTK.vtkPointPlacer"

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