vtkPointPicker Class Reference

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

#include <vtkPointPicker.h>

Inheritance diagram for vtkPointPicker:

Collaboration diagram for vtkPointPicker:

Public Types
typedef vtkPicker	Superclass
Public Types inherited from vtkPicker
typedef vtkAbstractPropPicker	Superclass
Public Types inherited from vtkAbstractPropPicker
typedef vtkAbstractPicker	Superclass
Public Types inherited from vtkAbstractPicker
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkPointPicker *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkIdType	GetPointId ()
virtual void	SetUseCells (int)
virtual int	GetUseCells ()
virtual void	UseCellsOn ()
virtual void	UseCellsOff ()
Public Member Functions inherited from vtkPicker
vtkPicker *	NewInstance () const
vtkActorCollection *	GetActors ()
virtual void	SetTolerance (double)
virtual double	GetTolerance ()
virtual double *	GetMapperPosition ()
virtual void	GetMapperPosition (double data[3])
virtual vtkAbstractMapper3D *	GetMapper ()
virtual vtkDataSet *	GetDataSet ()
vtkProp3DCollection *	GetProp3Ds ()
vtkPoints *	GetPickedPositions ()
virtual int	Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)
int	Pick (double selectionPt[3], vtkRenderer *ren)
Public Member Functions inherited from vtkAbstractPropPicker
vtkAbstractPropPicker *	NewInstance () const
virtual vtkProp *	GetViewProp ()
virtual vtkProp3D *	GetProp3D ()
virtual vtkActor *	GetActor ()
virtual vtkActor2D *	GetActor2D ()
virtual vtkVolume *	GetVolume ()
virtual vtkAssembly *	GetAssembly ()
virtual vtkPropAssembly *	GetPropAssembly ()
virtual void	SetPath (vtkAssemblyPath *)
virtual vtkAssemblyPath *	GetPath ()
Public Member Functions inherited from vtkAbstractPicker
vtkAbstractPicker *	NewInstance () const
void	InitializePickList ()
void	AddPickList (vtkProp *)
void	DeletePickList (vtkProp *)
vtkPropCollection *	GetPickList ()
virtual vtkRenderer *	GetRenderer ()
virtual double *	GetSelectionPoint ()
virtual void	GetSelectionPoint (double data[3])
virtual double *	GetPickPosition ()
virtual void	GetPickPosition (double data[3])
int	Pick (double selectionPt[3], vtkRenderer *ren)
virtual void	SetPickFromList (int)
virtual int	GetPickFromList ()
virtual void	PickFromListOn ()
virtual void	PickFromListOff ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool 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)
vtkCommand *	GetCommand (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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkPointPicker *	New ()
static int	IsTypeOf (const char *type)
static vtkPointPicker *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPicker
static vtkPicker *	New ()
static int	IsTypeOf (const char *type)
static vtkPicker *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractPropPicker
static int	IsTypeOf (const char *type)
static vtkAbstractPropPicker *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractPicker
static int	IsTypeOf (const char *type)
static vtkAbstractPicker *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPointPicker ()
	~vtkPointPicker ()
double	IntersectWithLine (double p1[3], double p2[3], double tol, vtkAssemblyPath *path, vtkProp3D *p, vtkAbstractMapper3D *m)
void	Initialize ()
Protected Member Functions inherited from vtkPicker
	vtkPicker ()
	~vtkPicker ()
void	MarkPicked (vtkAssemblyPath *path, vtkProp3D *p, vtkAbstractMapper3D *m, double tMin, double mapperPos[3])
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 &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkIdType	PointId
int	UseCells
Protected Attributes inherited from vtkPicker
double	Tolerance
double	MapperPosition [3]
vtkAbstractMapper3D *	Mapper
vtkDataSet *	DataSet
double	GlobalTMin
vtkTransform *	Transform
vtkActorCollection *	Actors
vtkProp3DCollection *	Prop3Ds
vtkPoints *	PickedPositions
Protected Attributes inherited from vtkAbstractPropPicker
vtkAssemblyPath *	Path
Protected Attributes inherited from vtkAbstractPicker
vtkRenderer *	Renderer
double	SelectionPoint [3]
double	PickPosition [3]
int	PickFromList
vtkPropCollection *	PickList
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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.

See also

vtkPicker vtkCellPicker.

Tests:

vtkPointPicker (Tests)

Definition at line 41 of file vtkPointPicker.h.

Member Typedef Documentation

typedef vtkPicker vtkPointPicker::Superclass

Definition at line 45 of file vtkPointPicker.h.

Constructor & Destructor Documentation

vtkPointPicker::vtkPointPicker ( )

protected

vtkPointPicker::~vtkPointPicker ( )

inlineprotected

Definition at line 63 of file vtkPointPicker.h.

Member Function Documentation

static vtkPointPicker* vtkPointPicker::New ( )

static

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

static

virtual int vtkPointPicker::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 vtkPicker.

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

static

virtual vtkObjectBase* vtkPointPicker::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPicker.

vtkPointPicker* vtkPointPicker::NewInstance

(

)

const

void vtkPointPicker::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 vtkPicker.

virtual vtkIdType vtkPointPicker::GetPointId ( )

virtual

Get the id of the picked point. If PointId = -1, nothing was picked.

virtual void vtkPointPicker::SetUseCells ( int  )

virtual

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

virtual int vtkPointPicker::GetUseCells ( )

virtual

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

virtual void vtkPointPicker::UseCellsOn ( )

virtual

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

virtual void vtkPointPicker::UseCellsOff ( )

virtual

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

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

protectedvirtual

Reimplemented from vtkPicker.

void vtkPointPicker::Initialize ( )

protectedvirtual

Reimplemented from vtkPicker.

Member Data Documentation

vtkIdType vtkPointPicker::PointId

protected

Definition at line 65 of file vtkPointPicker.h.

int vtkPointPicker::UseCells

protected

Definition at line 66 of file vtkPointPicker.h.

---

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

• dox/Rendering/Core/vtkPointPicker.h