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

#include <vtkClosedSurfacePointPlacer.h>

Inheritance diagram for vtkClosedSurfacePointPlacer:

Collaboration diagram for vtkClosedSurfacePointPlacer:

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

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

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

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

virtual void	SetMinimumDistance (double)

virtual double	GetMinimumDistance ()


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

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

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

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

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

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

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

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)

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

	~vtkClosedSurfacePointPlacer () override

void	BuildPlanes ()

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

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkPlaneCollection *	BoundingPlanes

double	MinimumDistance

vtkPlaneCollection *	InnerBoundingPlanes

Protected Attributes inherited from vtkPointPlacer
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 vtkPointPlacer	Superclass
	Standard methods for instances of this class.

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

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

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

vtkClosedSurfacePointPlacer *	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.

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 28 of file vtkClosedSurfacePointPlacer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPointPlacer vtkClosedSurfacePointPlacer::Superclass

Standard methods for instances of this class.

Definition at line 40 of file vtkClosedSurfacePointPlacer.h.

Constructor & Destructor Documentation

◆ vtkClosedSurfacePointPlacer()

vtkClosedSurfacePointPlacer::vtkClosedSurfacePointPlacer ( )

protected

◆ ~vtkClosedSurfacePointPlacer()

vtkClosedSurfacePointPlacer::~vtkClosedSurfacePointPlacer ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkClosedSurfacePointPlacer * vtkClosedSurfacePointPlacer::New ( )

static

Instantiate this class.

◆ IsTypeOf()

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

static

Standard methods for instances of this class.

◆ IsA()

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

virtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

◆ SafeDownCast()

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

static

Standard methods for instances of this class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkClosedSurfacePointPlacer::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

◆ NewInstance()

vtkClosedSurfacePointPlacer * vtkClosedSurfacePointPlacer::NewInstance ( ) const

Standard methods for instances of this class.

◆ PrintSelf()

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

overridevirtual

Standard methods for instances of this class.

Reimplemented from vtkObjectBase.

◆ AddBoundingPlane()

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.

◆ RemoveBoundingPlane()

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.

◆ RemoveAllBoundingPlanes()

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.

◆ SetBoundingPlanes() [1/2]

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.

◆ GetBoundingPlanes()

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.

◆ SetBoundingPlanes() [2/2]

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.

◆ ComputeWorldPosition() [1/2]

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

overridevirtual

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.

◆ ComputeWorldPosition() [2/2]

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

overridevirtual

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.

Reimplemented from vtkPointPlacer.

◆ ValidateWorldPosition() [1/2]

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

overridevirtual

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.

◆ ValidateWorldPosition() [2/2]

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

overridevirtual

Given a world position and a world orientation, validate it according to the constraints of the placer.

Reimplemented from vtkPointPlacer.

◆ SetMinimumDistance()

virtual void vtkClosedSurfacePointPlacer::SetMinimumDistance ( double )

virtual

◆ GetMinimumDistance()

virtual double vtkClosedSurfacePointPlacer::GetMinimumDistance ( )

virtual

◆ GetDistanceFromObject()

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

staticprotected

◆ BuildPlanes()

void vtkClosedSurfacePointPlacer::BuildPlanes ( )

protected

Member Data Documentation

◆ BoundingPlanes

vtkPlaneCollection* vtkClosedSurfacePointPlacer::BoundingPlanes

protected

Definition at line 116 of file vtkClosedSurfacePointPlacer.h.

◆ MinimumDistance

double vtkClosedSurfacePointPlacer::MinimumDistance

protected

Definition at line 125 of file vtkClosedSurfacePointPlacer.h.

◆ InnerBoundingPlanes

vtkPlaneCollection* vtkClosedSurfacePointPlacer::InnerBoundingPlanes

protected

Definition at line 126 of file vtkClosedSurfacePointPlacer.h.

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

Interaction/Widgets/vtkClosedSurfacePointPlacer.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkClosedSurfacePointPlacer()

◆ ~vtkClosedSurfacePointPlacer()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ AddBoundingPlane()

◆ RemoveBoundingPlane()

◆ RemoveAllBoundingPlanes()

◆ SetBoundingPlanes() [1/2]

◆ GetBoundingPlanes()

◆ SetBoundingPlanes() [2/2]

◆ ComputeWorldPosition() [1/2]

◆ ComputeWorldPosition() [2/2]

◆ ValidateWorldPosition() [1/2]

◆ ValidateWorldPosition() [2/2]

◆ SetMinimumDistance()

◆ GetMinimumDistance()

◆ GetDistanceFromObject()

◆ BuildPlanes()

Member Data Documentation

◆ BoundingPlanes

◆ MinimumDistance

◆ InnerBoundingPlanes