VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkPicker Class Reference

superclass for 3D geometric pickers (uses ray cast) More...

#include <vtkPicker.h>

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

Public Types

typedef vtkAbstractPropPicker Superclass
 
- Public Types inherited from vtkAbstractPropPicker
typedef vtkAbstractPicker Superclass
 
- Public Types inherited from vtkAbstractPicker
typedef vtkObject Superclass
 

Public Member Functions

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

Static Public Member Functions

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. 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

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
 vtkAbstractPropPicker ()
 
 ~vtkAbstractPropPicker () override
 
- Protected Member Functions inherited from vtkAbstractPicker
 vtkAbstractPicker ()
 
 ~vtkAbstractPicker () 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 CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static bool CalculateRay (const double p1[3], const double p2[3], double ray[3], double &rayFactor)
 

Protected Attributes

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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

superclass for 3D geometric pickers (uses ray cast)

vtkPicker is used to select instances of vtkProp3D by shooting a ray into a graphics window and intersecting with the actor's bounding box. The ray is defined from a point defined in window (or pixel) coordinates, and a point located from the camera's position.

vtkPicker may return more than one vtkProp3D, since more than one bounding box may be intersected. vtkPicker returns an unsorted list of props that were hit, and a list of the corresponding world points of the hits. For the vtkProp3D that is closest to the camera, vtkPicker returns the pick coordinates in world and untransformed mapper space, the prop itself, the data set, and the mapper. For vtkPicker the closest prop is the one whose center point (i.e., center of bounding box) projected on the view ray is closest to the camera. Subclasses of vtkPicker use other methods for computing the pick point.

See also
vtkPicker is used for quick geometric picking. If you desire more precise picking of points or cells based on the geometry of any vtkProp3D, use the subclasses vtkPointPicker or vtkCellPicker. For hardware-accelerated picking of any type of vtkProp, use vtkPropPicker or vtkWorldPointPicker.
Tests:
vtkPicker (Tests)

Definition at line 58 of file vtkPicker.h.

Member Typedef Documentation

Definition at line 62 of file vtkPicker.h.

Constructor & Destructor Documentation

vtkPicker::vtkPicker ( )
protected
vtkPicker::~vtkPicker ( )
overrideprotected

Member Function Documentation

static vtkPicker* vtkPicker::New ( )
static
static vtkTypeBool vtkPicker::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkPicker::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractPropPicker.

Reimplemented in vtkCellPicker, vtkVolumePicker, vtkPointPicker, and vtkResliceCursorPicker.

static vtkPicker* vtkPicker::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkPicker::NewInstanceInternal ( ) const
protectedvirtual
vtkPicker* vtkPicker::NewInstance ( ) const
void vtkPicker::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractPropPicker.

Reimplemented in vtkVolumePicker, and vtkPointPicker.

virtual void vtkPicker::SetTolerance ( double  )
virtual

Specify tolerance for performing pick operation.

Tolerance is specified as fraction of rendering window size. (Rendering window size is measured across diagonal.)

virtual double vtkPicker::GetTolerance ( )
virtual

Specify tolerance for performing pick operation.

Tolerance is specified as fraction of rendering window size. (Rendering window size is measured across diagonal.)

virtual double* vtkPicker::GetMapperPosition ( )
virtual

Return position in mapper (i.e., non-transformed) coordinates of pick point.

virtual void vtkPicker::GetMapperPosition ( double  data[3])
virtual

Return position in mapper (i.e., non-transformed) coordinates of pick point.

virtual vtkAbstractMapper3D* vtkPicker::GetMapper ( )
virtual

Return mapper that was picked (if any).

virtual vtkDataSet* vtkPicker::GetDataSet ( )
virtual

Get a pointer to the dataset that was picked (if any).

If nothing was picked then NULL is returned.

virtual vtkCompositeDataSet* vtkPicker::GetCompositeDataSet ( )
virtual

Get a pointer to the composite dataset that was picked (if any).

If nothing was picked or a non-composite data object was picked then NULL is returned.

virtual vtkIdType vtkPicker::GetFlatBlockIndex ( )
virtual

Get the flat block index of the vtkDataSet in the composite dataset that was picked (if any).

If nothing was picked or a non-composite data object was picked then -1 is returned.

vtkProp3DCollection* vtkPicker::GetProp3Ds ( )
inline

Return a collection of all the prop 3D's that were intersected by the pick ray.

This collection is not sorted.

Definition at line 119 of file vtkPicker.h.

vtkActorCollection* vtkPicker::GetActors ( )

Return a collection of all the actors that were intersected.

This collection is not sorted. (This is a convenience method to maintain backward compatibility.)

vtkPoints* vtkPicker::GetPickedPositions ( )
inline

Return a list of the points the actors returned by GetProp3Ds were intersected at.

The order of this list will match the order of GetProp3Ds.

Definition at line 134 of file vtkPicker.h.

int vtkPicker::Pick ( double  selectionX,
double  selectionY,
double  selectionZ,
vtkRenderer renderer 
)
overridevirtual

Perform pick operation with selection point provided.

Normally the first two values for the selection point are x-y pixel coordinate, and the third value is =0. Return non-zero if something was successfully picked.

Implements vtkAbstractPicker.

int vtkPicker::Pick ( double  selectionPt[3],
vtkRenderer ren 
)
inline

Perform pick operation with selection point provided.

Normally the first two values for the selection point are x-y pixel coordinate, and the third value is =0. Return non-zero if something was successfully picked.

Definition at line 151 of file vtkPicker.h.

int vtkPicker::Pick3DPoint ( double  selectionPt[3],
vtkRenderer ren 
)
overridevirtual

Perform pick operation with selection point provided.

The selectionPt is in world coordinates. Return non-zero if something was successfully picked.

Reimplemented from vtkAbstractPicker.

virtual int vtkPicker::Pick3DPoint ( double  p1World[3],
double  p2World[3],
vtkRenderer ren 
)
virtual
int vtkPicker::Pick3DRay ( double  selectionPt[3],
double  orient[4],
vtkRenderer ren 
)
overridevirtual

Perform pick operation with selection point and orientation provided.

The selectionPt is in world coordinates. Return non-zero if something was successfully picked.

Reimplemented from vtkAbstractPicker.

virtual int vtkPicker::Pick3DInternal ( vtkRenderer ren,
double  p1World[4],
double  p2World[4] 
)
protectedvirtual
void vtkPicker::MarkPicked ( vtkAssemblyPath path,
vtkProp3D p,
vtkAbstractMapper3D m,
double  tMin,
double  mapperPos[3] 
)
protected
void vtkPicker::MarkPickedData ( vtkAssemblyPath path,
double  tMin,
double  mapperPos[3],
vtkAbstractMapper3D mapper,
vtkDataSet input,
vtkIdType  flatBlockIndex = -1 
)
protected
virtual double vtkPicker::IntersectWithLine ( const double  p1[3],
const double  p2[3],
double  tol,
vtkAssemblyPath path,
vtkProp3D p,
vtkAbstractMapper3D m 
)
protectedvirtual

Reimplemented in vtkCellPicker, and vtkPointPicker.

void vtkPicker::Initialize ( )
overrideprotectedvirtual

Reimplemented from vtkAbstractPropPicker.

Reimplemented in vtkPointPicker.

static bool vtkPicker::CalculateRay ( const double  p1[3],
const double  p2[3],
double  ray[3],
double rayFactor 
)
staticprotected

Member Data Documentation

double vtkPicker::Tolerance
protected

Definition at line 196 of file vtkPicker.h.

double vtkPicker::MapperPosition[3]
protected

Definition at line 197 of file vtkPicker.h.

vtkAbstractMapper3D* vtkPicker::Mapper
protected

Definition at line 199 of file vtkPicker.h.

vtkDataSet* vtkPicker::DataSet
protected

Definition at line 200 of file vtkPicker.h.

vtkCompositeDataSet* vtkPicker::CompositeDataSet
protected

Definition at line 201 of file vtkPicker.h.

vtkIdType vtkPicker::FlatBlockIndex
protected

Definition at line 202 of file vtkPicker.h.

double vtkPicker::GlobalTMin
protected

Definition at line 204 of file vtkPicker.h.

vtkTransform* vtkPicker::Transform
protected

Definition at line 205 of file vtkPicker.h.

vtkActorCollection* vtkPicker::Actors
protected

Definition at line 206 of file vtkPicker.h.

vtkProp3DCollection* vtkPicker::Prop3Ds
protected

Definition at line 207 of file vtkPicker.h.

vtkPoints* vtkPicker::PickedPositions
protected

Definition at line 208 of file vtkPicker.h.


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