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

#include <vtkPointPlacer.h>

Inheritance diagram for vtkPointPlacer:

Collaboration diagram for vtkPointPlacer:

Public Member Functions
virtual int	ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9])
	Given a renderer and a display position in pixel coordinates, compute the world position and orientation where this point will be placed.

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.

virtual int	ValidateWorldPosition (double worldPos[3])
	Given a world position check the validity of this position according to the constraints of the placer.

virtual int	ValidateDisplayPosition (vtkRenderer *, double displayPos[2])
	Given a display position, check the validity of this position.

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

virtual int	UpdateWorldPosition (vtkRenderer *ren, double worldPos[3], double worldOrient[9])
	Given a current renderer, world position and orientation, update them according to the constraints of the placer.

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

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


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

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


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

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

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

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

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

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

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

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

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

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

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

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.

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.

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.

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

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

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

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

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.

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

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

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

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

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

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkPointPlacer ()

	~vtkPointPlacer () override

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=nullptr)
	These methods allow a command to exclusively grab all events.

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	PixelTolerance

double	WorldTolerance

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkObject	Superclass
	Standard methods for instances of this class.

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

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

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

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

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

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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 38 of file vtkPointPlacer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPointPlacer::Superclass

Standard methods for instances of this class.

Definition at line 50 of file vtkPointPlacer.h.

Constructor & Destructor Documentation

◆ vtkPointPlacer()

vtkPointPlacer::vtkPointPlacer ( )

protected

◆ ~vtkPointPlacer()

vtkPointPlacer::~vtkPointPlacer ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPointPlacer * vtkPointPlacer::New ( )

static

Instantiate this class.

◆ IsTypeOf()

static vtkTypeBool vtkPointPlacer::IsTypeOf ( const char * type )

static

Standard methods for instances of this class.

◆ IsA()

virtual vtkTypeBool vtkPointPlacer::IsA ( const char * type )

virtual

Standard methods for instances of this class.

Reimplemented from vtkObjectBase.

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

◆ SafeDownCast()

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

static

Standard methods for instances of this class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPointPlacer::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of this class.

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

◆ NewInstance()

vtkPointPlacer * vtkPointPlacer::NewInstance ( ) const

Standard methods for instances of this class.

◆ PrintSelf()

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

overridevirtual

Standard methods for instances of this class.

Reimplemented from vtkObject.

Reimplemented in vtkPolyDataPointPlacer, vtkPolygonalSurfacePointPlacer, and vtkTerrainDataPointPlacer.

◆ ComputeWorldPosition() [1/2]

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, vtkCellCentersPointPlacer, vtkClosedSurfacePointPlacer, vtkFocalPlanePointPlacer, vtkImageActorPointPlacer, vtkPolyDataPointPlacer, vtkPolygonalSurfacePointPlacer, and vtkTerrainDataPointPlacer.

◆ ComputeWorldPosition() [2/2]

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, vtkCellCentersPointPlacer, vtkClosedSurfacePointPlacer, vtkFocalPlanePointPlacer, vtkPolyDataPointPlacer, vtkPolygonalSurfacePointPlacer, and vtkTerrainDataPointPlacer.

◆ ValidateWorldPosition() [1/2]

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, vtkCellCentersPointPlacer, vtkClosedSurfacePointPlacer, vtkFocalPlanePointPlacer, vtkImageActorPointPlacer, vtkPolyDataPointPlacer, vtkPolygonalSurfacePointPlacer, and vtkTerrainDataPointPlacer.

◆ ValidateDisplayPosition()

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

virtual

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

Reimplemented in vtkCellCentersPointPlacer, vtkPolyDataPointPlacer, vtkPolygonalSurfacePointPlacer, and vtkTerrainDataPointPlacer.

◆ ValidateWorldPosition() [2/2]

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, vtkCellCentersPointPlacer, vtkClosedSurfacePointPlacer, vtkFocalPlanePointPlacer, vtkImageActorPointPlacer, vtkPolyDataPointPlacer, vtkPolygonalSurfacePointPlacer, and vtkTerrainDataPointPlacer.

◆ UpdateWorldPosition()

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.

◆ UpdateNodeWorldPosition()

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.

◆ UpdateInternalState()

virtual int vtkPointPlacer::UpdateInternalState ( )

inlinevirtual

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

Reimplemented in vtkImageActorPointPlacer.

Definition at line 118 of file vtkPointPlacer.h.

◆ SetPixelTolerance()

virtual void vtkPointPlacer::SetPixelTolerance ( int )

virtual

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

◆ GetPixelTolerance()

virtual int vtkPointPlacer::GetPixelTolerance ( )

virtual

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

◆ SetWorldTolerance()

virtual void vtkPointPlacer::SetWorldTolerance ( double )

virtual

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

Reimplemented in vtkImageActorPointPlacer.

◆ GetWorldTolerance()

virtual double vtkPointPlacer::GetWorldTolerance ( )

virtual

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

Member Data Documentation

◆ PixelTolerance

int vtkPointPlacer::PixelTolerance

protected

Definition at line 142 of file vtkPointPlacer.h.

◆ WorldTolerance

double vtkPointPlacer::WorldTolerance

protected

Definition at line 143 of file vtkPointPlacer.h.

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

Interaction/Widgets/vtkPointPlacer.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPointPlacer()

◆ ~vtkPointPlacer()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ ComputeWorldPosition() [1/2]

◆ ComputeWorldPosition() [2/2]

◆ ValidateWorldPosition() [1/2]

◆ ValidateDisplayPosition()

◆ ValidateWorldPosition() [2/2]

◆ UpdateWorldPosition()

◆ UpdateNodeWorldPosition()

◆ UpdateInternalState()

◆ SetPixelTolerance()

◆ GetPixelTolerance()

◆ SetWorldTolerance()

◆ GetWorldTolerance()

Member Data Documentation

◆ PixelTolerance

◆ WorldTolerance