VTK  9.2.20230603
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPointPlacer Class Reference

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

#include <vtkPointPlacer.h>

Inheritance diagram for vtkPointPlacer:
[legend]
Collaboration diagram for vtkPointPlacer:
[legend]

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. 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...
 
virtual int ValidateWorldPosition (double worldPos[3])
 Given a world position check the validity of this position according to the constraints of the placer. More...
 
virtual int ValidateDisplayPosition (vtkRenderer *, double displayPos[2])
 Given a display position, check the validity of this position. More...
 
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. More...
 
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. 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...
 
- 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 ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
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...
 
vtkCommandGetCommand (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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkPointPlacerNew ()
 Instantiate this class. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

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. 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 ReportReferences (vtkGarbageCollector *)
 
 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. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkPointPlacerSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instances of this class. More...
 
vtkPointPlacerNewInstance () const
 Standard methods for instances of this class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instances of this class. More...
 

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

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 62 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

◆ SafeDownCast()

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

Standard methods for instances of this class.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPointPlacer::NewInstanceInternal ( ) const
protectedvirtual

◆ 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 vtkTerrainDataPointPlacer, vtkPolygonalSurfacePointPlacer, and vtkPolyDataPointPlacer.

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

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

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

◆ ValidateDisplayPosition()

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

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

Reimplemented in vtkTerrainDataPointPlacer, vtkPolygonalSurfacePointPlacer, vtkPolyDataPointPlacer, and vtkCellCentersPointPlacer.

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

◆ 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 vtkImageActorPointPlacer, and vtkBoundedPlanePointPlacer.

◆ 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 130 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 154 of file vtkPointPlacer.h.

◆ WorldTolerance

double vtkPointPlacer::WorldTolerance
protected

Definition at line 155 of file vtkPointPlacer.h.


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