VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkClosedSurfacePointPlacer Class Reference

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

#include <vtkClosedSurfacePointPlacer.h>

Inheritance diagram for vtkClosedSurfacePointPlacer:
[legend]
Collaboration diagram for vtkClosedSurfacePointPlacer:
[legend]

Public Member Functions

int ValidateWorldPosition (double worldPos[3])
 
int ValidateWorldPosition (double worldPos[3], double worldOrient[9])
 
virtual void SetMinimumDistance (double)
 
virtual double GetMinimumDistance ()
 
void AddBoundingPlane (vtkPlane *plane)
 
void RemoveBoundingPlane (vtkPlane *plane)
 
void RemoveAllBoundingPlanes ()
 
virtual void SetBoundingPlanes (vtkPlaneCollection *)
 
virtual vtkPlaneCollectionGetBoundingPlanes ()
 
void SetBoundingPlanes (vtkPlanes *planes)
 
int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9])
 
int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[2], double worldPos[3], double worldOrient[9])
 
- Public Member Functions inherited from vtkPointPlacer
virtual int ValidateDisplayPosition (vtkRenderer *, double displayPos[2])
 
virtual int UpdateInternalState ()
 
virtual int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[3], 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 ()
 
vtkPointPlacerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static
vtkClosedSurfacePointPlacer
New ()
 
- Static Public Member Functions inherited from vtkPointPlacer
static vtkPointPlacerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPointPlacerSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

 vtkClosedSurfacePointPlacer ()
 
 ~vtkClosedSurfacePointPlacer ()
 
void BuildPlanes ()
 
- Protected Member Functions inherited from vtkPointPlacer
 vtkPointPlacer ()
 
 ~vtkPointPlacer ()
 

Static Protected Member Functions

static double GetDistanceFromObject (double pos[3], vtkPlaneCollection *pc, double closestPt[3])
 

Protected Attributes

vtkPlaneCollectionBoundingPlanes
 
double MinimumDistance
 
vtkPlaneCollectionInnerBoundingPlanes
 
- Protected Attributes inherited from vtkPointPlacer
int PixelTolerance
 
double WorldTolerance
 
typedef vtkPointPlacer Superclass
 
static int IsTypeOf (const char *type)
 
static
vtkClosedSurfacePointPlacer
SafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkClosedSurfacePointPlacerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

Detailed Description

PointPlacer to constrain validity within a set of convex planes.

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.

See Also
vtkParallelopipedRepresentation

Definition at line 38 of file vtkClosedSurfacePointPlacer.h.

Member Typedef Documentation

Standard methods for instances of this class.

Definition at line 46 of file vtkClosedSurfacePointPlacer.h.

Constructor & Destructor Documentation

vtkClosedSurfacePointPlacer::vtkClosedSurfacePointPlacer ( )
protected
vtkClosedSurfacePointPlacer::~vtkClosedSurfacePointPlacer ( )
protected

Member Function Documentation

static vtkClosedSurfacePointPlacer* vtkClosedSurfacePointPlacer::New ( )
static

Instantiate this class.

static int vtkClosedSurfacePointPlacer::IsTypeOf ( const char *  type)
static

Standard methods for instances of this class.

virtual int vtkClosedSurfacePointPlacer::IsA ( const char *  type)
virtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

static vtkClosedSurfacePointPlacer* vtkClosedSurfacePointPlacer::SafeDownCast ( vtkObjectBase *  o)
static

Standard methods for instances of this class.

virtual vtkObjectBase* vtkClosedSurfacePointPlacer::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

vtkClosedSurfacePointPlacer* vtkClosedSurfacePointPlacer::NewInstance ( ) const

Standard methods for instances of this class.

void vtkClosedSurfacePointPlacer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

Standard methods for instances of this class.

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

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

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

virtual void vtkClosedSurfacePointPlacer::SetBoundingPlanes ( vtkPlaneCollection )
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.

virtual vtkPlaneCollection* 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.

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

int vtkClosedSurfacePointPlacer::ComputeWorldPosition ( vtkRenderer *  ren,
double  displayPos[2],
double  worldPos[3],
double  worldOrient[9] 
)
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 vtkPointPlacer.

int vtkClosedSurfacePointPlacer::ComputeWorldPosition ( vtkRenderer *  ren,
double  displayPos[2],
double  refWorldPos[2],
double  worldPos[3],
double  worldOrient[9] 
)

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.

int vtkClosedSurfacePointPlacer::ValidateWorldPosition ( double  worldPos[3])
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 vtkPointPlacer.

int vtkClosedSurfacePointPlacer::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 from vtkPointPlacer.

virtual void vtkClosedSurfacePointPlacer::SetMinimumDistance ( double  )
virtual
virtual double vtkClosedSurfacePointPlacer::GetMinimumDistance ( )
virtual
static double vtkClosedSurfacePointPlacer::GetDistanceFromObject ( double  pos[3],
vtkPlaneCollection pc,
double  closestPt[3] 
)
staticprotected
void vtkClosedSurfacePointPlacer::BuildPlanes ( )
protected

Member Data Documentation

vtkPlaneCollection* vtkClosedSurfacePointPlacer::BoundingPlanes
protected

Definition at line 119 of file vtkClosedSurfacePointPlacer.h.

double vtkClosedSurfacePointPlacer::MinimumDistance
protected

Definition at line 130 of file vtkClosedSurfacePointPlacer.h.

vtkPlaneCollection* vtkClosedSurfacePointPlacer::InnerBoundingPlanes
protected

Definition at line 131 of file vtkClosedSurfacePointPlacer.h.


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