VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
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]

List of all members.

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkProp3DCollectionGetProp3Ds ()
vtkActorCollectionGetActors ()
vtkPointsGetPickedPositions ()
virtual void SetTolerance (double)
virtual double GetTolerance ()
virtual double * GetMapperPosition ()
virtual void GetMapperPosition (double data[3])
virtual vtkAbstractMapper3DGetMapper ()
virtual vtkDataSetGetDataSet ()
virtual int Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)
int Pick (double selectionPt[3], vtkRenderer *ren)
- Public Member Functions inherited from vtkAbstractPropPicker
virtual vtkPropGetViewProp ()
virtual vtkProp3DGetProp3D ()
virtual vtkActorGetActor ()
virtual vtkActor2DGetActor2D ()
virtual vtkVolumeGetVolume ()
virtual vtkAssemblyGetAssembly ()
virtual vtkPropAssemblyGetPropAssembly ()
virtual vtkPropGetProp ()
virtual void SetPath (vtkAssemblyPath *)
virtual vtkAssemblyPathGetPath ()
- Public Member Functions inherited from vtkAbstractPicker
void InitializePickList ()
void AddPickList (vtkProp *)
void DeletePickList (vtkProp *)
vtkPropCollectionGetPickList ()
virtual vtkRendererGetRenderer ()
virtual double * GetSelectionPoint ()
virtual void GetSelectionPoint (double data[3])
virtual double * GetPickPosition ()
virtual void GetPickPosition (double data[3])
virtual void SetPickFromList (int)
virtual int GetPickFromList ()
virtual void PickFromListOn ()
virtual void PickFromListOff ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkPickerNew ()
static int IsTypeOf (const char *type)
static vtkPickerSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPicker ()
 ~vtkPicker ()
void MarkPicked (vtkAssemblyPath *path, vtkProp3D *p, vtkAbstractMapper3D *m, double tMin, double mapperPos[3])
virtual double IntersectWithLine (double p1[3], double p2[3], double tol, vtkAssemblyPath *path, vtkProp3D *p, vtkAbstractMapper3D *m)
virtual void Initialize ()
- Protected Member Functions inherited from vtkAbstractPropPicker
 vtkAbstractPropPicker ()
 ~vtkAbstractPropPicker ()
- Protected Member Functions inherited from vtkAbstractPicker
 vtkAbstractPicker ()
 ~vtkAbstractPicker ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

double Tolerance
double MapperPosition [3]
vtkAbstractMapper3DMapper
vtkDataSetDataSet
double GlobalTMin
vtkTransformTransform
vtkActorCollectionActors
vtkProp3DCollectionProp3Ds
vtkPointsPickedPositions
- Protected Attributes inherited from vtkAbstractPropPicker
vtkAssemblyPathPath
- Protected Attributes inherited from vtkAbstractPicker
vtkRendererRenderer
double SelectionPoint [3]
double PickPosition [3]
int PickFromList
vtkPropCollectionPickList
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int 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.
Events:
vtkCommand::PickEvent vtkCommand::EndPickEvent vtkCommand::StartPickEvent

Definition at line 55 of file vtkPicker.h.


Member Typedef Documentation

Reimplemented from vtkAbstractPropPicker.

Reimplemented in vtkCellPicker, vtkVolumePicker, and vtkPointPicker.

Definition at line 59 of file vtkPicker.h.


Constructor & Destructor Documentation

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

Member Function Documentation

static vtkPicker* vtkPicker::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

Reimplemented in vtkCellPicker, vtkVolumePicker, and vtkPointPicker.

virtual const char* vtkPicker::GetClassName ( )
virtual

Reimplemented from vtkAbstractPropPicker.

Reimplemented in vtkCellPicker, vtkVolumePicker, and vtkPointPicker.

static int vtkPicker::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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, and vtkPointPicker.

virtual int 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, and vtkPointPicker.

static vtkPicker* vtkPicker::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkAbstractPropPicker.

Reimplemented in vtkCellPicker, vtkVolumePicker, and vtkPointPicker.

void vtkPicker::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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

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 89 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 the actors returned by GetProp3Ds were intersected at. The order of this list will match the order of GetProp3Ds.

Definition at line 99 of file vtkPicker.h.

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

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.

Reimplemented in vtkCellPicker.

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.

Reimplemented from vtkAbstractPicker.

Definition at line 115 of file vtkPicker.h.

void vtkPicker::MarkPicked ( vtkAssemblyPath path,
vtkProp3D p,
vtkAbstractMapper3D m,
double  tMin,
double  mapperPos[3] 
)
protected
virtual double vtkPicker::IntersectWithLine ( double  p1[3],
double  p2[3],
double  tol,
vtkAssemblyPath path,
vtkProp3D p,
vtkAbstractMapper3D m 
)
protectedvirtual

Reimplemented in vtkCellPicker, and vtkPointPicker.

virtual void vtkPicker::Initialize ( )
protectedvirtual

Reimplemented from vtkAbstractPropPicker.

Reimplemented in vtkCellPicker, and vtkPointPicker.


Member Data Documentation

double vtkPicker::Tolerance
protected

Definition at line 130 of file vtkPicker.h.

double vtkPicker::MapperPosition[3]
protected

Definition at line 131 of file vtkPicker.h.

vtkAbstractMapper3D* vtkPicker::Mapper
protected

Definition at line 133 of file vtkPicker.h.

vtkDataSet* vtkPicker::DataSet
protected

Definition at line 134 of file vtkPicker.h.

double vtkPicker::GlobalTMin
protected

Definition at line 136 of file vtkPicker.h.

vtkTransform* vtkPicker::Transform
protected

Definition at line 137 of file vtkPicker.h.

vtkActorCollection* vtkPicker::Actors
protected

Definition at line 138 of file vtkPicker.h.

vtkProp3DCollection* vtkPicker::Prop3Ds
protected

Definition at line 139 of file vtkPicker.h.

vtkPoints* vtkPicker::PickedPositions
protected

Definition at line 140 of file vtkPicker.h.


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