VTK  9.1.0
Protected Member Functions | Protected Attributes | List of all members
vtkPointPicker Class Reference

select a point by shooting a ray into a graphics window More...

#include <vtkPointPicker.h>

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

Public Member Functions

virtual vtkIdType GetPointId ()
 Get the id of the picked point.
 
virtual void SetUseCells (vtkTypeBool)
 Specify whether the point search should be based on cell points or directly on the point list.
 
virtual vtkTypeBool GetUseCells ()
 Specify whether the point search should be based on cell points or directly on the point list.
 
virtual void UseCellsOn ()
 Specify whether the point search should be based on cell points or directly on the point list.
 
virtual void UseCellsOff ()
 Specify whether the point search should be based on cell points or directly on the point list.
 
- Public Member Functions inherited from vtkPicker
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPickerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkProp3DCollectionGetProp3Ds ()
 Return a collection of all the prop 3D's that were intersected by the pick ray.
 
vtkActorCollectionGetActors ()
 Return a collection of all the actors that were intersected.
 
vtkPointsGetPickedPositions ()
 Return a list of the points the actors returned by GetProp3Ds were intersected at.
 
int Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer) override
 Perform pick operation with selection point provided.
 
int Pick (double selectionPt[3], vtkRenderer *ren)
 Perform pick operation with selection point provided.
 
int Pick3DPoint (double selectionPt[3], vtkRenderer *ren) override
 Perform pick operation with selection point provided.
 
virtual int Pick3DPoint (double p1World[3], double p2World[3], vtkRenderer *ren)
 
int Pick3DRay (double selectionPt[3], double orient[4], vtkRenderer *ren) override
 Perform pick operation with selection point and orientation provided.
 
virtual void SetTolerance (double)
 Specify tolerance for performing pick operation.
 
virtual double GetTolerance ()
 Specify tolerance for performing pick operation.
 
virtual double * GetMapperPosition ()
 Return position in mapper (i.e., non-transformed) coordinates of pick point.
 
virtual void GetMapperPosition (double data[3])
 Return position in mapper (i.e., non-transformed) coordinates of pick point.
 
virtual vtkAbstractMapper3DGetMapper ()
 Return mapper that was picked (if any).
 
virtual vtkDataSetGetDataSet ()
 Get a pointer to the dataset that was picked (if any).
 
virtual vtkCompositeDataSetGetCompositeDataSet ()
 Get a pointer to the composite dataset that was picked (if any).
 
virtual vtkIdType GetFlatBlockIndex ()
 Get the flat block index of the vtkDataSet in the composite dataset that was picked (if any).
 
- Public Member Functions inherited from vtkAbstractPropPicker
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAbstractPropPickerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual vtkPropGetViewProp ()
 Return the vtkProp that has been picked.
 
virtual vtkProp3DGetProp3D ()
 Return the vtkProp that has been picked.
 
virtual vtkActorGetActor ()
 Return the vtkActor that has been picked.
 
virtual vtkActor2DGetActor2D ()
 Return the vtkActor2D that has been picked.
 
virtual vtkVolumeGetVolume ()
 Return the vtkVolume that has been picked.
 
virtual vtkAssemblyGetAssembly ()
 Return the vtkAssembly that has been picked.
 
virtual vtkPropAssemblyGetPropAssembly ()
 Return the vtkPropAssembly that has been picked.
 
virtual void SetPath (vtkAssemblyPath *)
 Return the vtkAssemblyPath that has been picked.
 
virtual vtkAssemblyPathGetPath ()
 Return the vtkAssemblyPath that has been picked.
 
- Public Member Functions inherited from vtkAbstractPicker
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAbstractPickerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual int Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)=0
 Perform pick operation with selection point provided.
 
int Pick (double selectionPt[3], vtkRenderer *ren)
 provided.
 
virtual int Pick3DPoint (double[3], vtkRenderer *)
 Perform pick operation with selection point provided.
 
virtual int Pick3DRay (double[3], double[4], vtkRenderer *)
 Perform pick operation with selection point and orientation provided.
 
void InitializePickList ()
 Initialize list of actors in pick list.
 
void AddPickList (vtkProp *)
 Add an actor to the pick list.
 
void DeletePickList (vtkProp *)
 Delete an actor from the pick list.
 
vtkPropCollectionGetPickList ()
 Return the list of actors in the PickList.
 
virtual vtkRendererGetRenderer ()
 Get the renderer in which pick event occurred.
 
virtual double * GetSelectionPoint ()
 Get the selection point in screen (pixel) coordinates.
 
virtual void GetSelectionPoint (double data[3])
 Get the selection point in screen (pixel) coordinates.
 
virtual double * GetPickPosition ()
 Return position in global coordinates of pick point.
 
virtual void GetPickPosition (double data[3])
 Return position in global coordinates of pick point.
 
virtual void SetPickFromList (vtkTypeBool)
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors).
 
virtual vtkTypeBool GetPickFromList ()
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors).
 
virtual void PickFromListOn ()
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors).
 
virtual void PickFromListOff ()
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors).
 
- 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.
 
vtkCommandGetCommand (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.
 

Protected Member Functions

 vtkPointPicker ()
 
 ~vtkPointPicker () override=default
 
double IntersectWithLine (const double p1[3], const double p2[3], double tol, vtkAssemblyPath *path, vtkProp3D *p, vtkAbstractMapper3D *m) override
 
void Initialize () override
 
vtkIdType IntersectDataSetWithLine (const double p1[3], double ray[3], double rayFactor, double tol, vtkDataSet *dataSet, double &tMin, double minXYZ[3])
 
- Protected Member Functions inherited from vtkPicker
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPicker ()
 
 ~vtkPicker () override
 
virtual int Pick3DInternal (vtkRenderer *ren, double p1World[4], double p2World[4])
 
void MarkPicked (vtkAssemblyPath *path, vtkProp3D *p, vtkAbstractMapper3D *m, double tMin, double mapperPos[3])
 
void MarkPickedData (vtkAssemblyPath *path, double tMin, double mapperPos[3], vtkAbstractMapper3D *mapper, vtkDataSet *input, vtkIdType flatBlockIndex=-1)
 
virtual double IntersectWithLine (const double p1[3], const double p2[3], double tol, vtkAssemblyPath *path, vtkProp3D *p, vtkAbstractMapper3D *m)
 
void Initialize () override
 
- Protected Member Functions inherited from vtkAbstractPropPicker
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractPropPicker ()
 
 ~vtkAbstractPropPicker () override
 
void Initialize () override
 
- Protected Member Functions inherited from vtkAbstractPicker
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractPicker ()
 
 ~vtkAbstractPicker () override
 
virtual void Initialize ()
 
- 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

vtkIdType PointId
 
vtkTypeBool UseCells
 
- Protected Attributes inherited from vtkPicker
double Tolerance
 
double MapperPosition [3]
 
vtkAbstractMapper3DMapper
 
vtkDataSetDataSet
 
vtkCompositeDataSetCompositeDataSet
 
vtkIdType FlatBlockIndex
 
double GlobalTMin
 
vtkTransformTransform
 
vtkActorCollectionActors
 
vtkProp3DCollectionProp3Ds
 
vtkPointsPickedPositions
 
- Protected Attributes inherited from vtkAbstractPropPicker
vtkAssemblyPathPath
 
- Protected Attributes inherited from vtkAbstractPicker
vtkRendererRenderer
 
double SelectionPoint [3]
 
double PickPosition [3]
 
vtkTypeBool PickFromList
 
vtkPropCollectionPickList
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkPicker Superclass
 Standard methods for instantiation, type information, and printing.
 
static vtkPointPickerNew ()
 Standard methods for instantiation, type information, and printing.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiation, type information, and printing.
 
static vtkPointPickerSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiation, type information, and printing.
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiation, type information, and printing.
 
vtkPointPickerNewInstance () const
 Standard methods for instantiation, type information, and printing.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiation, type information, and printing.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiation, type information, and printing.
 

Additional Inherited Members

- Public Types inherited from vtkPicker
typedef vtkAbstractPropPicker Superclass
 
- Public Types inherited from vtkAbstractPropPicker
typedef vtkAbstractPicker Superclass
 
- Public Types inherited from vtkAbstractPicker
typedef vtkObject Superclass
 
- Static Public Member Functions inherited from vtkPicker
static vtkPickerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPickerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractPropPicker
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractPropPickerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractPicker
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractPickerSafeDownCast (vtkObjectBase *o)
 
- 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.
 
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 vtkObjectBaseNew ()
 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.
 
- Static Protected Member Functions inherited from vtkPicker
static bool CalculateRay (const double p1[3], const double p2[3], double ray[3], double &rayFactor)
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

select a point by shooting a ray into a graphics window

vtkPointPicker is used to select a point by shooting a ray into a graphics window and intersecting with actor's defining geometry - specifically its points. Beside returning coordinates, actor, and mapper, vtkPointPicker returns the id of the point projecting closest onto the ray (within the specified tolerance). Ties are broken (i.e., multiple points all projecting within the tolerance along the pick ray) by choosing the point closest to the ray origin (i.e., closest to the eye).

See also
vtkPicker vtkCellPicker
Online Examples:

Definition at line 110 of file vtkPointPicker.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instantiation, type information, and printing.

Definition at line 118 of file vtkPointPicker.h.

Constructor & Destructor Documentation

◆ vtkPointPicker()

vtkPointPicker::vtkPointPicker ( )
protected

◆ ~vtkPointPicker()

vtkPointPicker::~vtkPointPicker ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkPointPicker * vtkPointPicker::New ( )
static

Standard methods for instantiation, type information, and printing.

◆ IsTypeOf()

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

Standard methods for instantiation, type information, and printing.

◆ IsA()

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

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPicker.

◆ SafeDownCast()

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

Standard methods for instantiation, type information, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPointPicker::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPicker.

◆ NewInstance()

vtkPointPicker * vtkPointPicker::NewInstance ( ) const

Standard methods for instantiation, type information, and printing.

◆ PrintSelf()

void vtkPointPicker::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkPicker.

◆ GetPointId()

virtual vtkIdType vtkPointPicker::GetPointId ( )
virtual

Get the id of the picked point.

If PointId = -1, nothing was picked.

◆ SetUseCells()

virtual void vtkPointPicker::SetUseCells ( vtkTypeBool  )
virtual

Specify whether the point search should be based on cell points or directly on the point list.

◆ GetUseCells()

virtual vtkTypeBool vtkPointPicker::GetUseCells ( )
virtual

Specify whether the point search should be based on cell points or directly on the point list.

◆ UseCellsOn()

virtual void vtkPointPicker::UseCellsOn ( )
virtual

Specify whether the point search should be based on cell points or directly on the point list.

◆ UseCellsOff()

virtual void vtkPointPicker::UseCellsOff ( )
virtual

Specify whether the point search should be based on cell points or directly on the point list.

◆ IntersectWithLine()

double vtkPointPicker::IntersectWithLine ( const double  p1[3],
const double  p2[3],
double  tol,
vtkAssemblyPath path,
vtkProp3D p,
vtkAbstractMapper3D m 
)
overrideprotectedvirtual

Reimplemented from vtkPicker.

◆ Initialize()

void vtkPointPicker::Initialize ( )
overrideprotectedvirtual

Reimplemented from vtkPicker.

◆ IntersectDataSetWithLine()

vtkIdType vtkPointPicker::IntersectDataSetWithLine ( const double  p1[3],
double  ray[3],
double  rayFactor,
double  tol,
vtkDataSet dataSet,
double &  tMin,
double  minXYZ[3] 
)
protected

Member Data Documentation

◆ PointId

vtkIdType vtkPointPicker::PointId
protected

Definition at line 143 of file vtkPointPicker.h.

◆ UseCells

vtkTypeBool vtkPointPicker::UseCells
protected

Definition at line 144 of file vtkPointPicker.h.


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