vtkPropPicker3D Class Reference

pick an actor/prop given XYZ coordinates More...

#include <vtkPropPicker3D.h>

Inheritance diagram for vtkPropPicker3D:

Collaboration diagram for vtkPropPicker3D:

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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkPropPicker3D *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
int	PickProp (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)
	Perform the pick and set the PickedProp ivar. More...
int	PickProp (double selectionX, double selectionY, double selectionZ, 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. More...
int	Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)
	Overide superclasses' Pick() method. More...
int	Pick (double selectionPt[3], vtkRenderer *renderer)
Public Member Functions inherited from vtkAbstractPropPicker
vtkAbstractPropPicker *	NewInstance () const
virtual vtkProp *	GetViewProp ()
	Return the vtkProp that has been picked. More...
virtual vtkProp3D *	GetProp3D ()
	Return the vtkProp that has been picked. More...
virtual vtkActor *	GetActor ()
	Return the vtkActor that has been picked. More...
virtual vtkActor2D *	GetActor2D ()
	Return the vtkActor2D that has been picked. More...
virtual vtkVolume *	GetVolume ()
	Return the vtkVolume that has been picked. More...
virtual vtkAssembly *	GetAssembly ()
	Return the vtkAssembly that has been picked. More...
virtual vtkPropAssembly *	GetPropAssembly ()
	Return the vtkPropAssembly that has been picked. More...
virtual void	SetPath (vtkAssemblyPath *)
	Return the vtkAssemblyPath that has been picked. More...
virtual vtkAssemblyPath *	GetPath ()
	Return the vtkAssemblyPath that has been picked. More...
Public Member Functions inherited from vtkAbstractPicker
vtkAbstractPicker *	NewInstance () 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...
vtkPropCollection *	GetPickList ()
	Return the list of actors in the PickList. More...
virtual vtkRenderer *	GetRenderer ()
	Get the renderer in which pick event occurred. More...
virtual double *	GetSelectionPoint ()
	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 double *	GetPickPosition ()
	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 (int)
	Use these methods to control whether to limit the picking to this list (rather than renderer's actors). More...
virtual int	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 ()
int	HasObserver (unsigned long event)
int	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...
vtkCommand *	GetCommand (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...
int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
int	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 vtkPropPicker3D *	New ()
static int	IsTypeOf (const char *type)
static vtkPropPicker3D *	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 vtkObject *	New ()
	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPropPicker3D ()
	~vtkPropPicker3D ()
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 ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
	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 &)

Protected Attributes
vtkPropCollection *	PickFromProps
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 given XYZ coordinates

vtkPropPicker3D is used to pick an actor/prop given a selection point in world coordinates. This class determines the actor/prop and pick position in world coordinates; point and cell ids are not determined. This is useful for VRE devices that provide 3D positions directly via the vtkRenderWindowInteractor3D. It is the default picker for the vtkInteractorStyle3D

See also

vtkPicker vtkRenderWindowInteractor3D vtkInteractorStyle3D

Definition at line 39 of file vtkPropPicker3D.h.

Member Typedef Documentation

typedef vtkAbstractPropPicker vtkPropPicker3D::Superclass

Definition at line 44 of file vtkPropPicker3D.h.

Constructor & Destructor Documentation

vtkPropPicker3D::vtkPropPicker3D ( )

protected

vtkPropPicker3D::~vtkPropPicker3D ( )

protected

Member Function Documentation

static vtkPropPicker3D* vtkPropPicker3D::New ( )

static

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

static

virtual int vtkPropPicker3D::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 vtkPropPicker3D* vtkPropPicker3D::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkPropPicker3D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractPropPicker.

vtkPropPicker3D* vtkPropPicker3D::NewInstance

(

)

const

void vtkPropPicker3D::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 vtkPropPicker3D::PickProp	(	double	selectionX,
		double	selectionY,
		double	selectionZ,
		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 vtkPropPicker3D::PickProp	(	double	selectionX,
		double	selectionY,
		double	selectionZ,
		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 vtkPropPicker3D::Pick ( double  selectionX, double  selectionY, double  selectionZ, vtkRenderer *  renderer  )

virtual

Overide superclasses' Pick() method.

Implements vtkAbstractPicker.

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

inline

Definition at line 69 of file vtkPropPicker3D.h.

void vtkPropPicker3D::Initialize ( )

protectedvirtual

Reimplemented from vtkAbstractPropPicker.

Member Data Documentation

vtkPropCollection* vtkPropPicker3D::PickFromProps

protected

Definition at line 79 of file vtkPropPicker3D.h.

---

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

• /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/Core/vtkPropPicker3D.h