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
	Standard methods for instances of this class. More...

Public Member Functions
int	ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9])
	Given a renderer and a display position, compute the world position and world orientation for this point. More...

virtual int	ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[3], double worldPos[3], double worldOrient[9])
	Given a renderer, a display position, and a reference world position, compute the new world position and orientation of this point. More...

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

int	ValidateWorldPosition (double worldPos[3], double worldOrient[9])
	Given a world position and a world orientation, validate it according to the constraints of the placer. More...

virtual int	UpdateWorldPosition (vtkRenderer *ren, double worldPos[3], double worldOrient[9])
	If the constraints on this placer are changed, then this method will be called by the representation on each of its points. More...


virtual void	SetProjectionNormal (int)
	Set the projection normal to lie along the x, y, or z axis, or to be oblique. More...

virtual int	GetProjectionNormal ()
	Set the projection normal to lie along the x, y, or z axis, or to be oblique. More...

void	SetProjectionNormalToXAxis ()
	Set the projection normal to lie along the x, y, or z axis, or to be oblique. More...

void	SetProjectionNormalToYAxis ()
	Set the projection normal to lie along the x, y, or z axis, or to be oblique. More...

void	SetProjectionNormalToZAxis ()
	Set the projection normal to lie along the x, y, or z axis, or to be oblique. More...

void	SetProjectionNormalToOblique ()
	Set the projection normal to lie along the x, y, or z axis, or to be oblique. More...


void	SetObliquePlane (vtkPlane *)
	If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position. More...

virtual vtkPlane *	GetObliquePlane ()
	If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position. More...


void	SetProjectionPosition (double position)
	The position of the bounding plane from the origin along the normal. More...

virtual double	GetProjectionPosition ()
	The position of the bounding plane from the origin along the normal. More...


void	AddBoundingPlane (vtkPlane *plane)
	A collection of plane equations used to bound the position of the point. More...

void	RemoveBoundingPlane (vtkPlane *plane)
	A collection of plane equations used to bound the position of the point. More...

void	RemoveAllBoundingPlanes ()
	A collection of plane equations used to bound the position of the point. More...

virtual void	SetBoundingPlanes (vtkPlaneCollection *)
	A collection of plane equations used to bound the position of the point. More...

virtual vtkPlaneCollection *	GetBoundingPlanes ()
	A collection of plane equations used to bound the position of the point. More...

void	SetBoundingPlanes (vtkPlanes *planes)
	A collection of plane equations used to bound the position of the point. More...

Public Member Functions inherited from vtkPointPlacer
virtual int	ValidateDisplayPosition (vtkRenderer *, double displayPos[2])
	Given a display position, check the validity of this position. More...

virtual int	UpdateNodeWorldPosition (double worldPos[3], vtkIdType nodePointId)
	Give the placer a chance to update the node information, if any. More...

virtual int	UpdateInternalState ()
	Called by the representation to give the placer a chance to update itself. More...

virtual void	SetPixelTolerance (int)
	Set/get the tolerance used when performing computations in display coordinates. More...

virtual int	GetPixelTolerance ()
	Set/get the tolerance used when performing computations in display coordinates. More...

virtual void	SetWorldTolerance (double)
	Set/get the tolerance used when performing computations in world coordinates. More...

virtual double	GetWorldTolerance ()
	Set/get the tolerance used when performing computations in world coordinates. More...

vtkPointPlacer *	NewInstance () const
	Standard methods for instances of this class. More...

void	PrintSelf (ostream &os, vtkIndent indent)
	Standard methods for instances of this class. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkBoundedPlanePointPlacer *	New ()
	Instantiate this class. More...

Static Public Member Functions inherited from vtkPointPlacer
static vtkPointPlacer *	New ()
	Instantiate this class. More...

static int	IsTypeOf (const char *type)
	Standard methods for instances of this class. More...

static vtkPointPlacer *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

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

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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
	Standard methods for instances of this class. More...

static int	IsTypeOf (const char *type)
	Standard methods for instances of this class. More...

static vtkBoundedPlanePointPlacer *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class. More...

virtual int	IsA (const char *type)
	Standard methods for instances of this class. More...

vtkBoundedPlanePointPlacer *	NewInstance () const
	Standard methods for instances of this class. More...

void	PrintSelf (ostream &os, vtkIndent indent)
	Standard methods for instances of this class. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instances of this class. More...

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 41 of file vtkBoundedPlanePointPlacer.h.

Member Typedef Documentation

typedef vtkPointPlacer vtkBoundedPlanePointPlacer::Superclass

Standard methods for instances of this class.

Definition at line 53 of file vtkBoundedPlanePointPlacer.h.

Member Enumeration Documentation

anonymous enum

Enumerator
XAxis
YAxis
ZAxis
Oblique

Definition at line 115 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 67 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 69 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 71 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 73 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 188 of file vtkBoundedPlanePointPlacer.h.

double vtkBoundedPlanePointPlacer::ProjectionPosition

protected

Definition at line 192 of file vtkBoundedPlanePointPlacer.h.

vtkPlane* vtkBoundedPlanePointPlacer::ObliquePlane

protected

Definition at line 196 of file vtkBoundedPlanePointPlacer.h.

vtkPlaneCollection* vtkBoundedPlanePointPlacer::BoundingPlanes

protected

Definition at line 200 of file vtkBoundedPlanePointPlacer.h.

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

/home/demarle/Builds/VTK/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