vtkPropPicker Class Reference

pick an actor/prop using graphics hardware More...

#include <vtkPropPicker.h>

Inheritance diagram for vtkPropPicker:

Collaboration diagram for vtkPropPicker:

Public Types
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)
vtkPropPicker *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
int	PickProp (double selectionX, double selectionY, vtkRenderer *renderer)
int	PickProp (double selectionX, double selectionY, vtkRenderer *renderer, vtkPropCollection *pickfrom)
int	Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)
int	Pick (double selectionPt[3], vtkRenderer *renderer)
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 vtkPropPicker *	New ()
static int	IsTypeOf (const char *type)
static vtkPropPicker *	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
	vtkPropPicker ()
	~vtkPropPicker ()
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 &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPropCollection *	PickFromProps
vtkWorldPointPicker *	WorldPointPicker
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

pick an actor/prop using graphics hardware

vtkPropPicker is used to pick an actor/prop given a selection point (in display coordinates) and a renderer. This class uses graphics hardware/rendering system to pick rapidly (as compared to using ray casting as does vtkCellPicker and vtkPointPicker). This class determines the actor/prop and pick position in world coordinates; point and cell ids are not determined.

See also

vtkPicker vtkWorldPointPicker vtkCellPicker vtkPointPicker

Events:

vtkCommand::PickEvent vtkCommand::EndPickEvent vtkCommand::StartPickEvent

Tests:

vtkPropPicker (Tests)

Definition at line 44 of file vtkPropPicker.h.

Member Typedef Documentation

typedef vtkAbstractPropPicker vtkPropPicker::Superclass

Definition at line 49 of file vtkPropPicker.h.

Constructor & Destructor Documentation

vtkPropPicker::vtkPropPicker ( )

protected

vtkPropPicker::~vtkPropPicker ( )

protected

Member Function Documentation

static vtkPropPicker* vtkPropPicker::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkPropPicker::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractPropPicker.

vtkPropPicker* vtkPropPicker::NewInstance

(

)

const

void vtkPropPicker::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.

int vtkPropPicker::PickProp	(	double	selectionX,
		double	selectionY,
		vtkRenderer *	renderer
	)

Perform the pick and set the PickedProp ivar. If something is picked, a 1 is returned, otherwise 0 is returned. Use the GetViewProp() method to get the instance of vtkProp that was picked. Props are picked from the renderers list of pickable Props.

int vtkPropPicker::PickProp	(	double	selectionX,
		double	selectionY,
		vtkRenderer *	renderer,
		vtkPropCollection *	pickfrom
	)

Perform a pick from the user-provided list of vtkProps and not from the list of vtkProps that the render maintains.

int vtkPropPicker::Pick ( double  selectionX, double  selectionY, double  selectionZ, vtkRenderer *  renderer  )

virtual

Overide superclasses' Pick() method.

Implements vtkAbstractPicker.

int vtkPropPicker::Pick ( double  selectionPt[3], vtkRenderer *  renderer  )

inline

Overide superclasses' Pick() method.

Definition at line 69 of file vtkPropPicker.h.

void vtkPropPicker::Initialize ( )

protectedvirtual

Reimplemented from vtkAbstractPropPicker.

Member Data Documentation

vtkPropCollection* vtkPropPicker::PickFromProps

protected

Definition at line 80 of file vtkPropPicker.h.

vtkWorldPointPicker* vtkPropPicker::WorldPointPicker

protected

Definition at line 83 of file vtkPropPicker.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Core/vtkPropPicker.h