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

#include <vtkBoundedPlanePointPlacer.h>

Inheritance diagram for vtkBoundedPlanePointPlacer:

Collaboration diagram for vtkBoundedPlanePointPlacer:

Public Types
enum	{ XAxis =0, YAxis, ZAxis, Oblique }

Public Types inherited from vtkPointPlacer
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
int	ValidateWorldPosition (double worldPos[3])

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


virtual void	SetProjectionNormal (int)

virtual int	GetProjectionNormal ()

void	SetProjectionNormalToXAxis ()

void	SetProjectionNormalToYAxis ()

void	SetProjectionNormalToZAxis ()

void	SetProjectionNormalToOblique ()


void	SetObliquePlane (vtkPlane *)

virtual vtkPlane *	GetObliquePlane ()


void	SetProjectionPosition (double position)

virtual double	GetProjectionPosition ()


void	AddBoundingPlane (vtkPlane *plane)

void	RemoveBoundingPlane (vtkPlane *plane)

void	RemoveAllBoundingPlanes ()

virtual void	SetBoundingPlanes (vtkPlaneCollection *)

virtual vtkPlaneCollection *	GetBoundingPlanes ()

void	SetBoundingPlanes (vtkPlanes *planes)


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	UpdateWorldPosition (vtkRenderer *ren, double worldPos[3], double worldOrient[9])

Public Member Functions inherited from vtkPointPlacer
virtual int	ValidateDisplayPosition (vtkRenderer *, double displayPos[2])

virtual int	UpdateInternalState ()

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

virtual void	SetPixelTolerance (int)

virtual int	GetPixelTolerance ()

virtual void	SetWorldTolerance (double)

virtual double	GetWorldTolerance ()

vtkPointPlacer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkBoundedPlanePointPlacer *	New ()

Static Public Member Functions inherited from vtkPointPlacer
static vtkPointPlacer *	New ()

static int	IsTypeOf (const char *type)

static vtkPointPlacer *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
	vtkBoundedPlanePointPlacer ()

	~vtkBoundedPlanePointPlacer ()

void	GetProjectionNormal (double normal[3])

void	GetProjectionOrigin (double origin[3])

void	GetCurrentOrientation (double worldOrient[9])

Protected Member Functions inherited from vtkPointPlacer
	vtkPointPlacer ()

	~vtkPointPlacer ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static double	GetDistanceFromObject (double pos[3], vtkPlaneCollection *pc, double closestPt[3])

Protected Attributes
int	ProjectionNormal

double	ProjectionPosition

vtkPlane *	ObliquePlane

vtkPlaneCollection *	BoundingPlanes

Protected Attributes inherited from vtkPointPlacer
int	PixelTolerance

double	WorldTolerance

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkPointPlacer	Superclass

static int	IsTypeOf (const char *type)

static vtkBoundedPlanePointPlacer *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkBoundedPlanePointPlacer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

a placer that constrains a handle to a finite plane

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

See also: vtkPointPlacer vtkHandleWidget vtkHandleRepresentation

Tests:: vtkBoundedPlanePointPlacer (Tests)

Definition at line 40 of file vtkBoundedPlanePointPlacer.h.

Member Typedef Documentation

typedef vtkPointPlacer vtkBoundedPlanePointPlacer::Superclass

Standard methods for instances of this class.

Definition at line 48 of file vtkBoundedPlanePointPlacer.h.

Member Enumeration Documentation

anonymous enum

Enumerator
XAxis
YAxis
ZAxis
Oblique

Definition at line 102 of file vtkBoundedPlanePointPlacer.h.

Constructor & Destructor Documentation

vtkBoundedPlanePointPlacer::vtkBoundedPlanePointPlacer ( )

protected

vtkBoundedPlanePointPlacer::~vtkBoundedPlanePointPlacer ( )

protected

Member Function Documentation

static vtkBoundedPlanePointPlacer* vtkBoundedPlanePointPlacer::New ( )

static

Instantiate this class.

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

static

Standard methods for instances of this class.

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

virtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

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

static

Standard methods for instances of this class.

virtual vtkObjectBase* vtkBoundedPlanePointPlacer::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

vtkBoundedPlanePointPlacer* vtkBoundedPlanePointPlacer::NewInstance ( ) const

Standard methods for instances of this class.

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

virtual

Standard methods for instances of this class.

Reimplemented from vtkObject.

virtual void vtkBoundedPlanePointPlacer::SetProjectionNormal ( int )

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.

virtual int vtkBoundedPlanePointPlacer::GetProjectionNormal ( )

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.

void vtkBoundedPlanePointPlacer::SetProjectionNormalToXAxis ( )

inline

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.

Definition at line 60 of file vtkBoundedPlanePointPlacer.h.

void vtkBoundedPlanePointPlacer::SetProjectionNormalToYAxis ( )

inline

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.

Definition at line 62 of file vtkBoundedPlanePointPlacer.h.

void vtkBoundedPlanePointPlacer::SetProjectionNormalToZAxis ( )

inline

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.

Definition at line 64 of file vtkBoundedPlanePointPlacer.h.

void vtkBoundedPlanePointPlacer::SetProjectionNormalToOblique ( )

inline

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.

Definition at line 66 of file vtkBoundedPlanePointPlacer.h.

void vtkBoundedPlanePointPlacer::SetObliquePlane ( vtkPlane * )

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

virtual vtkPlane* vtkBoundedPlanePointPlacer::GetObliquePlane ( )

virtual

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

void vtkBoundedPlanePointPlacer::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).

virtual double vtkBoundedPlanePointPlacer::GetProjectionPosition ( )

virtual

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

void vtkBoundedPlanePointPlacer::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 vtkBoundedPlanePointPlacer::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 vtkBoundedPlanePointPlacer::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 vtkBoundedPlanePointPlacer::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* vtkBoundedPlanePointPlacer::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 vtkBoundedPlanePointPlacer::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 vtkBoundedPlanePointPlacer::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.

virtual int vtkBoundedPlanePointPlacer::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.

Reimplemented from vtkPointPlacer.

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

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

void vtkBoundedPlanePointPlacer::GetProjectionNormal ( double normal[3] )

protected

void vtkBoundedPlanePointPlacer::GetProjectionOrigin ( double origin[3] )

protected

void vtkBoundedPlanePointPlacer::GetCurrentOrientation ( double worldOrient[9] )

protected

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

staticprotected

Member Data Documentation

int vtkBoundedPlanePointPlacer::ProjectionNormal

protected

Definition at line 167 of file vtkBoundedPlanePointPlacer.h.

double vtkBoundedPlanePointPlacer::ProjectionPosition

protected

Definition at line 171 of file vtkBoundedPlanePointPlacer.h.

vtkPlane* vtkBoundedPlanePointPlacer::ObliquePlane

protected

Definition at line 175 of file vtkBoundedPlanePointPlacer.h.

vtkPlaneCollection* vtkBoundedPlanePointPlacer::BoundingPlanes

protected

Definition at line 179 of file vtkBoundedPlanePointPlacer.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkBoundedPlanePointPlacer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation