VTK
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPointPlacer Class Reference

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

#include <vtkPointPlacer.h>

Inheritance diagram for vtkPointPlacer:
Inheritance graph
[legend]
Collaboration diagram for vtkPointPlacer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual int ValidateWorldPosition (double worldPos[3])
virtual int ValidateDisplayPosition (vtkRenderer *, double displayPos[2])
virtual int UpdateInternalState ()
virtual int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9])
virtual int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[3], double worldPos[3], double worldOrient[9])
virtual int ValidateWorldPosition (double worldPos[3], double worldOrient[9])
virtual int UpdateWorldPosition (vtkRenderer *ren, double worldPos[3], double worldOrient[9])
virtual int UpdateNodeWorldPosition (double worldPos[3], vtkIdType nodePointId)
virtual void SetPixelTolerance (int)
virtual int GetPixelTolerance ()
virtual void SetWorldTolerance (double)
virtual double GetWorldTolerance ()

Static Public Member Functions

static vtkPointPlacerNew ()

Protected Member Functions

 vtkPointPlacer ()
 ~vtkPointPlacer ()

Protected Attributes

int PixelTolerance
double WorldTolerance
typedef vtkObject Superclass
static int IsTypeOf (const char *type)
static vtkPointPlacerSafeDownCast (vtkObjectBase *o)
virtual int IsA (const char *type)
vtkPointPlacerNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBaseNewInstanceInternal () const

Detailed Description

Abstract interface to translate 2D display positions to world coordinates.

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:

1) vtkFocalPlanePointPlacer: This class converts 2D display positions to world positions such that they lie on the focal plane.

2) vtkPolygonalSurfacePointPlacer: Converts 2D display positions to world positions such that they lie on the surface of one or more specified polydatas.

3) vtkImageActorPointPlacer: Converts 2D display positions to world positions such that they lie on an ImageActor

4) vtkBoundedPlanePointPlacer: Converts 2D display positions to world positions such that they lie within a set of specified bounding planes.

5) vtkTerrainDataPointPlacer: Converts 2D display positions to world positions such that they lie on a height field.

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.

Definition at line 48 of file vtkPointPlacer.h.


Member Typedef Documentation


Constructor & Destructor Documentation


Member Function Documentation

static vtkPointPlacer* vtkPointPlacer::New ( ) [static]
static int vtkPointPlacer::IsTypeOf ( const char *  type) [static]
virtual int vtkPointPlacer::IsA ( const char *  type) [virtual]
virtual vtkObjectBase* vtkPointPlacer::NewInstanceInternal ( ) const [protected, virtual]
void vtkPointPlacer::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]
virtual int vtkPointPlacer::ComputeWorldPosition ( vtkRenderer ren,
double  displayPos[2],
double  worldPos[3],
double  worldOrient[9] 
) [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 vtkBoundedPlanePointPlacer, vtkPolygonalSurfacePointPlacer, vtkTerrainDataPointPlacer, vtkCellCentersPointPlacer, vtkClosedSurfacePointPlacer, vtkPolyDataPointPlacer, vtkImageActorPointPlacer, and vtkFocalPlanePointPlacer.

virtual int vtkPointPlacer::ComputeWorldPosition ( vtkRenderer ren,
double  displayPos[2],
double  refWorldPos[3],
double  worldPos[3],
double  worldOrient[9] 
) [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 vtkBoundedPlanePointPlacer, vtkPolygonalSurfacePointPlacer, vtkTerrainDataPointPlacer, vtkCellCentersPointPlacer, vtkPolyDataPointPlacer, and vtkFocalPlanePointPlacer.

virtual int vtkPointPlacer::ValidateWorldPosition ( double  worldPos[3]) [virtual]

Given a world position check the validity of this position according to the constraints of the placer.

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

virtual int vtkPointPlacer::ValidateDisplayPosition ( vtkRenderer ,
double  displayPos[2] 
) [virtual]

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

Reimplemented in vtkPolygonalSurfacePointPlacer, vtkTerrainDataPointPlacer, vtkCellCentersPointPlacer, and vtkPolyDataPointPlacer.

virtual int vtkPointPlacer::ValidateWorldPosition ( double  worldPos[3],
double  worldOrient[9] 
) [virtual]

Given a world position and a world orientation, validate it according to the constraints of the placer.

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

virtual int vtkPointPlacer::UpdateWorldPosition ( vtkRenderer ren,
double  worldPos[3],
double  worldOrient[9] 
) [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 vtkBoundedPlanePointPlacer, and vtkImageActorPointPlacer.

virtual int vtkPointPlacer::UpdateNodeWorldPosition ( double  worldPos[3],
vtkIdType  nodePointId 
) [virtual]

Give the placer a chance to update the node information, if any. Most placers do not maintain any cached node information. vtkPolygonalSurfacePointPlacer is one that does. It stores the point id (id on the surface mesh) on which its drawn. The second argument may be used to pass that in. Update world position

Reimplemented in vtkPolygonalSurfacePointPlacer.

virtual int vtkPointPlacer::UpdateInternalState ( ) [inline, virtual]

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

Reimplemented in vtkImageActorPointPlacer.

Definition at line 123 of file vtkPointPlacer.h.

virtual void vtkPointPlacer::SetPixelTolerance ( int  ) [virtual]

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

virtual int vtkPointPlacer::GetPixelTolerance ( ) [virtual]

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

virtual void vtkPointPlacer::SetWorldTolerance ( double  ) [virtual]

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

Reimplemented in vtkImageActorPointPlacer.

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


Member Data Documentation

Definition at line 143 of file vtkPointPlacer.h.

Definition at line 144 of file vtkPointPlacer.h.


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