Converts 2D display positions to world positions such that they lie on an ImageActor. More...

#include <vtkImageActorPointPlacer.h>

Inheritance diagram for vtkImageActorPointPlacer:

Collaboration diagram for vtkImageActorPointPlacer:

Public Member Functions
int	ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9]) override
	Given and renderer and a display position in pixels, find a world position and orientation.

int	ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[2], double worldPos[3], double worldOrient[9]) override
	This method is identical to the one above since the reference position is ignored by the bounded plane point placer.

int	ValidateWorldPosition (double worldPos[3]) override
	This method validates a world position by checking to see if the world position is valid according to the constraints of the internal placer (essentially - is this world position on the image?)

int	ValidateWorldPosition (double worldPos[3], double worldOrient[9]) override
	This method is identical to the one above since the bounded plane point placer ignores orientation.

int	UpdateWorldPosition (vtkRenderer *ren, double worldPos[3], double worldOrient[9]) override
	Update the world position and orientation according the the current constraints of the placer.

int	UpdateInternalState () override
	A method for configuring the internal placer according to the constraints of the image actor.

void	SetWorldTolerance (double tol) override
	Set the world tolerance.


void	SetImageActor (vtkImageActor *)
	Set / get the reference vtkImageActor used to place the points.

virtual vtkImageActor *	GetImageActor ()
	Set / get the reference vtkImageActor used to place the points.


virtual void	SetBounds (double, double, double, double, double, double)
	Optionally, you may set bounds to restrict the placement of the points.

virtual void	SetBounds (double[6])
	Optionally, you may set bounds to restrict the placement of the points.

virtual double *	GetBounds ()
	Optionally, you may set bounds to restrict the placement of the points.

virtual void	GetBounds (double &, double &, double &, double &, double &, double &)
	Optionally, you may set bounds to restrict the placement of the points.

virtual void	GetBounds (double[6])
	Optionally, you may set bounds to restrict the placement of the points.

Public Member Functions inherited from vtkPointPlacer
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 double	GetWorldTolerance ()
	Set/get the tolerance used when performing computations in world coordinates.

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

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

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)

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.

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.

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

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

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

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.

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

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

Static Public Member Functions inherited from vtkPointPlacer
static vtkPointPlacer *	New ()
	Instantiate 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.

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

	~vtkImageActorPointPlacer () override

Protected Member Functions inherited from vtkPointPlacer
	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 *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkImageActor *	ImageActor

vtkBoundedPlanePointPlacer *	Placer

double	SavedBounds [6]

double	Bounds [6]

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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkPointPlacer	Superclass
	Standard methods for instances of this class.

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

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

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

vtkImageActorPointPlacer *	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
Public Types inherited from vtkPointPlacer
typedef vtkObject	Superclass
	Standard methods for instances of this class.

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Converts 2D display positions to world positions such that they lie on an ImageActor.

This PointPlacer is used to constrain the placement of points on the supplied image actor. Additionally, you may set bounds to restrict the placement of the points. The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

Definition at line 36 of file vtkImageActorPointPlacer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPointPlacer vtkImageActorPointPlacer::Superclass

Standard methods for instances of this class.

Definition at line 48 of file vtkImageActorPointPlacer.h.

Constructor & Destructor Documentation

◆ vtkImageActorPointPlacer()

vtkImageActorPointPlacer::vtkImageActorPointPlacer ( )

protected

◆ ~vtkImageActorPointPlacer()

vtkImageActorPointPlacer::~vtkImageActorPointPlacer ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkImageActorPointPlacer * vtkImageActorPointPlacer::New ( )

static

Instantiate this class.

◆ IsTypeOf()

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

static

Standard methods for instances of this class.

◆ IsA()

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

virtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

◆ SafeDownCast()

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

static

Standard methods for instances of this class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkImageActorPointPlacer::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

◆ NewInstance()

vtkImageActorPointPlacer * vtkImageActorPointPlacer::NewInstance ( ) const

Standard methods for instances of this class.

◆ PrintSelf()

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

overridevirtual

Standard methods for instances of this class.

Reimplemented from vtkObject.

◆ ComputeWorldPosition() [1/2]

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

overridevirtual

Given and renderer and a display position in pixels, find a world position and orientation.

In this class an internal vtkBoundedPlanePointPlacer is used to compute the world position and orientation. The internal placer is set to use the plane of the image actor and the bounds of the image actor as the constraints for placing points.

Reimplemented from vtkPointPlacer.

◆ ComputeWorldPosition() [2/2]

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

override

This method is identical to the one above since the reference position is ignored by the bounded plane point placer.

◆ ValidateWorldPosition() [1/2]

int vtkImageActorPointPlacer::ValidateWorldPosition ( double worldPos[3] )

overridevirtual

This method validates a world position by checking to see if the world position is valid according to the constraints of the internal placer (essentially - is this world position on the image?)

Reimplemented from vtkPointPlacer.

◆ ValidateWorldPosition() [2/2]

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

overridevirtual

This method is identical to the one above since the bounded plane point placer ignores orientation.

Reimplemented from vtkPointPlacer.

◆ UpdateWorldPosition()

int vtkImageActorPointPlacer::UpdateWorldPosition	(	vtkRenderer *	ren,
		double	worldPos[3],
		double	worldOrient[9]
	)

overridevirtual

Update the world position and orientation according the the current constraints of the placer.

Will be called by the representation when it notices that this placer has been modified.

Reimplemented from vtkPointPlacer.

◆ UpdateInternalState()

int vtkImageActorPointPlacer::UpdateInternalState ( )

overridevirtual

A method for configuring the internal placer according to the constraints of the image actor.

Called by the representation to give the placer a chance to update itself, which may cause the MTime to change, which would then cause the representation to update all of its points

Reimplemented from vtkPointPlacer.

◆ SetImageActor()

void vtkImageActorPointPlacer::SetImageActor ( vtkImageActor * )

Set / get the reference vtkImageActor used to place the points.

An image actor must be set for this placer to work. An internal bounded plane point placer is created and set to match the bounds of the displayed image.

◆ GetImageActor()

virtual vtkImageActor * vtkImageActorPointPlacer::GetImageActor ( )

virtual

Set / get the reference vtkImageActor used to place the points.

An image actor must be set for this placer to work. An internal bounded plane point placer is created and set to match the bounds of the displayed image.

◆ SetBounds() [1/2]

virtual void vtkImageActorPointPlacer::SetBounds	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)

virtual

Optionally, you may set bounds to restrict the placement of the points.

The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

◆ SetBounds() [2/2]

virtual void vtkImageActorPointPlacer::SetBounds ( double [6] )

virtual

Optionally, you may set bounds to restrict the placement of the points.

The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

◆ GetBounds() [1/3]

virtual double * vtkImageActorPointPlacer::GetBounds ( )

virtual

Optionally, you may set bounds to restrict the placement of the points.

The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

◆ GetBounds() [2/3]

virtual void vtkImageActorPointPlacer::GetBounds	(	double &	,
		double &	,
		double &	,
		double &	,
		double &	,
		double &
	)

virtual

Optionally, you may set bounds to restrict the placement of the points.

The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

◆ GetBounds() [3/3]

virtual void vtkImageActorPointPlacer::GetBounds ( double [6] )

virtual

Optionally, you may set bounds to restrict the placement of the points.

The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

◆ SetWorldTolerance()

void vtkImageActorPointPlacer::SetWorldTolerance ( double tol )

overridevirtual

Set the world tolerance.

This propagates it to the internal BoundedPlanePointPlacer.

Reimplemented from vtkPointPlacer.

Member Data Documentation

◆ ImageActor

vtkImageActor* vtkImageActorPointPlacer::ImageActor

protected

Definition at line 137 of file vtkImageActorPointPlacer.h.

◆ Placer

vtkBoundedPlanePointPlacer* vtkImageActorPointPlacer::Placer

protected

Definition at line 140 of file vtkImageActorPointPlacer.h.

◆ SavedBounds

double vtkImageActorPointPlacer::SavedBounds[6]

protected

Definition at line 144 of file vtkImageActorPointPlacer.h.

◆ Bounds

double vtkImageActorPointPlacer::Bounds[6]

protected

Definition at line 147 of file vtkImageActorPointPlacer.h.

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

Interaction/Widgets/vtkImageActorPointPlacer.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

◆ vtkImageActorPointPlacer()

◆ ~vtkImageActorPointPlacer()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ ComputeWorldPosition() [1/2]

◆ ComputeWorldPosition() [2/2]

◆ ValidateWorldPosition() [1/2]

◆ ValidateWorldPosition() [2/2]

◆ UpdateWorldPosition()

◆ UpdateInternalState()

◆ SetImageActor()

◆ GetImageActor()

◆ SetBounds() [1/2]

◆ SetBounds() [2/2]

◆ GetBounds() [1/3]

◆ GetBounds() [2/3]

◆ GetBounds() [3/3]

◆ SetWorldTolerance()

Member Data Documentation

◆ ImageActor

◆ Placer

◆ SavedBounds

◆ Bounds