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

vtkBoundedPlanePointPlacer - a placer that constrains a handle to a finite plane More...

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

List of all members.

Public Types

enum  Oblique_WrapperEnum { Oblique = 3, XAxis = 0, YAxis = 1, ZAxis = 2 }
 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. More...

Public Member Functions

 vtkBoundedPlanePointPlacer (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkBoundedPlanePointPlacer ()
 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 world position, compute the new world position and orientation of this point. This method is typically used by the representation to move the point.
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 int GetProjectionNormal ()
 Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.
virtual int GetProjectionNormalMaxValue ()
 Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.
virtual int GetProjectionNormalMinValue ()
 Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.
virtual double GetProjectionPosition ()
 The position of the bounding plane from the origin along the normal. The origin and normal are defined in the oblique plane when the ProjectionNormal is oblique. For the X, Y, and Z axes projection normals, the normal is the axis direction, and the origin is (0,0,0).
override int IsA (string type)
 Standard methods for instances of this class.
new vtkBoundedPlanePointPlacer 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.
void SetObliquePlane (vtkPlane arg0)
 If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position.
virtual void SetProjectionNormal (int _arg)
 Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.
void SetProjectionNormalToOblique ()
 Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.
void SetProjectionNormalToXAxis ()
 Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.
void SetProjectionNormalToYAxis ()
 Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.
void SetProjectionNormalToZAxis ()
 Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.
void SetProjectionPosition (double position)
 The position of the bounding plane from the origin along the normal. The origin and normal are defined in the oblique plane when the ProjectionNormal is oblique. For the X, Y, and Z axes projection normals, the normal is the axis direction, and the origin is (0,0,0).
override int UpdateWorldPosition (vtkRenderer ren, IntPtr worldPos, IntPtr worldOrient)
 If the constraints on this placer are changed, then this method will be called by the representation on each of its points. For this placer, the world position will be converted to a display position, then ComputeWorldPosition will be used to update the point.
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.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "26vtkBoundedPlanePointPlacer"
 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 vtkBoundedPlanePointPlacer_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBoundedPlanePointPlacer_AddBoundingPlane_01 (HandleRef pThis, HandleRef plane)
static internal int vtkBoundedPlanePointPlacer_ComputeWorldPosition_02 (HandleRef pThis, HandleRef ren, IntPtr displayPos, IntPtr worldPos, IntPtr worldOrient)
static internal int vtkBoundedPlanePointPlacer_ComputeWorldPosition_03 (HandleRef pThis, HandleRef ren, IntPtr displayPos, IntPtr refWorldPos, IntPtr worldPos, IntPtr worldOrient)
static internal IntPtr vtkBoundedPlanePointPlacer_GetBoundingPlanes_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkBoundedPlanePointPlacer_GetProjectionNormal_05 (HandleRef pThis)
static internal int vtkBoundedPlanePointPlacer_GetProjectionNormalMaxValue_06 (HandleRef pThis)
static internal int vtkBoundedPlanePointPlacer_GetProjectionNormalMinValue_07 (HandleRef pThis)
static internal double vtkBoundedPlanePointPlacer_GetProjectionPosition_08 (HandleRef pThis)
static internal int vtkBoundedPlanePointPlacer_IsA_09 (HandleRef pThis, string type)
static internal int vtkBoundedPlanePointPlacer_IsTypeOf_10 (string type)
static internal IntPtr vtkBoundedPlanePointPlacer_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBoundedPlanePointPlacer_RemoveAllBoundingPlanes_13 (HandleRef pThis)
static internal void vtkBoundedPlanePointPlacer_RemoveBoundingPlane_14 (HandleRef pThis, HandleRef plane)
static internal IntPtr vtkBoundedPlanePointPlacer_SafeDownCast_15 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBoundedPlanePointPlacer_SetBoundingPlanes_16 (HandleRef pThis, HandleRef arg0)
static internal void vtkBoundedPlanePointPlacer_SetBoundingPlanes_17 (HandleRef pThis, HandleRef planes)
static internal void vtkBoundedPlanePointPlacer_SetObliquePlane_18 (HandleRef pThis, HandleRef arg0)
static internal void vtkBoundedPlanePointPlacer_SetProjectionNormal_19 (HandleRef pThis, int _arg)
static internal void vtkBoundedPlanePointPlacer_SetProjectionNormalToOblique_20 (HandleRef pThis)
static internal void vtkBoundedPlanePointPlacer_SetProjectionNormalToXAxis_21 (HandleRef pThis)
static internal void vtkBoundedPlanePointPlacer_SetProjectionNormalToYAxis_22 (HandleRef pThis)
static internal void vtkBoundedPlanePointPlacer_SetProjectionNormalToZAxis_23 (HandleRef pThis)
static internal void vtkBoundedPlanePointPlacer_SetProjectionPosition_24 (HandleRef pThis, double position)
static internal int vtkBoundedPlanePointPlacer_UpdateWorldPosition_25 (HandleRef pThis, HandleRef ren, IntPtr worldPos, IntPtr worldOrient)
static internal int vtkBoundedPlanePointPlacer_ValidateWorldPosition_26 (HandleRef pThis, IntPtr worldPos)
static internal int vtkBoundedPlanePointPlacer_ValidateWorldPosition_27 (HandleRef pThis, IntPtr worldPos, IntPtr worldOrient)

Static Private Member Functions

static vtkBoundedPlanePointPlacer ()
 Automatically generated type registration mechanics.

Detailed Description

vtkBoundedPlanePointPlacer - a placer that constrains a handle to a finite plane

Description vtkBoundedPlanePointPlacer is a type of point placer that constrains its points to a finite (i.e., bounded) plance.

vtkPointPlacer vtkHandleWidget vtkHandleRepresentation


Member Enumeration Documentation

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.

Enumerator:
Oblique 

enum member

XAxis 

enum member

YAxis 

enum member

ZAxis 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Instantiate this class.


Member Function Documentation

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.vtkBoundedPlanePointPlacer.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.vtkBoundedPlanePointPlacer.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.

Reimplemented from Kitware.VTK.vtkPointPlacer.

override void Kitware.VTK.vtkBoundedPlanePointPlacer.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.

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:

Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.

Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.

Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.

The position of the bounding plane from the origin along the normal. The origin and normal are defined in the oblique plane when the ProjectionNormal is oblique. For the X, Y, and Z axes projection normals, the normal is the axis direction, and the origin is (0,0,0).

override int Kitware.VTK.vtkBoundedPlanePointPlacer.IsA ( string  type) [virtual]

Standard methods for instances of this class.

Reimplemented from Kitware.VTK.vtkPointPlacer.

static new int Kitware.VTK.vtkBoundedPlanePointPlacer.IsTypeOf ( string  type) [static]

Standard methods for instances of this class.

Reimplemented from Kitware.VTK.vtkPointPlacer.

Instantiate this class.

Reimplemented from Kitware.VTK.vtkPointPlacer.

Standard methods for instances of this class.

Reimplemented from Kitware.VTK.vtkPointPlacer.

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.

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.

Standard methods for instances of this class.

Reimplemented from Kitware.VTK.vtkPointPlacer.

Here is the call graph for this function:

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.

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.

If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position.

virtual void Kitware.VTK.vtkBoundedPlanePointPlacer.SetProjectionNormal ( int  _arg) [virtual]

Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.

Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.

Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.

Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.

Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.

The position of the bounding plane from the origin along the normal. The origin and normal are defined in the oblique plane when the ProjectionNormal is oblique. For the X, Y, and Z axes projection normals, the normal is the axis direction, and the origin is (0,0,0).

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

If the constraints on this placer are changed, then this method will be called by the representation on each of its points. For this placer, the world position will be converted to a display position, then ComputeWorldPosition will be used to update the point.

Reimplemented from Kitware.VTK.vtkPointPlacer.

override int Kitware.VTK.vtkBoundedPlanePointPlacer.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.vtkBoundedPlanePointPlacer.ValidateWorldPosition ( IntPtr  worldPos,
IntPtr  worldOrient 
) [virtual]

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

Reimplemented from Kitware.VTK.vtkPointPlacer.

static internal void Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_AddBoundingPlane_01 ( HandleRef  pThis,
HandleRef  plane 
) [private]
static internal int Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_ComputeWorldPosition_02 ( HandleRef  pThis,
HandleRef  ren,
IntPtr  displayPos,
IntPtr  worldPos,
IntPtr  worldOrient 
) [private]
static internal int Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_ComputeWorldPosition_03 ( HandleRef  pThis,
HandleRef  ren,
IntPtr  displayPos,
IntPtr  refWorldPos,
IntPtr  worldPos,
IntPtr  worldOrient 
) [private]
static internal IntPtr Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_GetBoundingPlanes_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_NewInstance_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_RemoveBoundingPlane_14 ( HandleRef  pThis,
HandleRef  plane 
) [private]
static internal IntPtr Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_SafeDownCast_15 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_SetBoundingPlanes_16 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_SetBoundingPlanes_17 ( HandleRef  pThis,
HandleRef  planes 
) [private]
static internal void Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_SetObliquePlane_18 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_SetProjectionNormal_19 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_SetProjectionPosition_24 ( HandleRef  pThis,
double  position 
) [private]
static internal int Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_UpdateWorldPosition_25 ( HandleRef  pThis,
HandleRef  ren,
IntPtr  worldPos,
IntPtr  worldOrient 
) [private]
static internal int Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_ValidateWorldPosition_26 ( HandleRef  pThis,
IntPtr  worldPos 
) [private]
static internal int Kitware.VTK.vtkBoundedPlanePointPlacer.vtkBoundedPlanePointPlacer_ValidateWorldPosition_27 ( HandleRef  pThis,
IntPtr  worldPos,
IntPtr  worldOrient 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkBoundedPlanePointPlacer.MRClassNameKey = "26vtkBoundedPlanePointPlacer" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPointPlacer.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPointPlacer.


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