abstract API for pickers that can pick an instance of vtkProp More...

#include <vtkAbstractPropPicker.h>

Inheritance diagram for vtkAbstractPropPicker:

Collaboration diagram for vtkAbstractPropPicker:

Public Types
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...

vtkAbstractPropPicker *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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

virtual int	Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)=0
	Perform pick operation with selection point provided. More...

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 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

	vtkAbstractPropPicker ()

	~vtkAbstractPropPicker ()

void	Initialize ()

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
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

abstract API for pickers that can pick an instance of vtkProp

vtkAbstractPropPicker is an abstract superclass for pickers that can pick an instance of vtkProp. Some pickers, like vtkWorldPointPicker (not a subclass of this class), cannot identify the prop that is picked. Subclasses of vtkAbstractPropPicker return a prop in the form of a vtkAssemblyPath when a pick is invoked. Note that an vtkAssemblyPath contain a list of vtkAssemblyNodes, each of which in turn contains a reference to a vtkProp and a 4x4 transformation matrix. The path fully describes the entire pick path, so you can pick assemblies or portions of assemblies, or just grab the tail end of the vtkAssemblyPath (which is the picked prop).

Warning: Because a vtkProp can be placed into different assemblies, or even in different leaf positions of the same assembly, the vtkAssemblyPath is used to fully qualify exactly which use of the vtkProp was picked, including its position (since vtkAssemblyPath includes a transformation matrix per node).; The class returns information about picked actors, props, etc. Note that what is returned by these methods is the top level of the assembly path. This can cause a lot of confusion! For example, if you pick a vtkAssembly, and the returned vtkAssemblyPath has as a leaf a vtkActor, then if you invoke GetActor(), you will get NULL, even though an actor was indeed picked. (GetAssembly() will return something.) Note that the safest thing to do is to do a GetViewProp(), which will always return something if something was picked. A better way to manage picking is to work with vtkAssemblyPath, since this completely defines the pick path from top to bottom in a assembly hierarchy, and avoids confusion when the same prop is used in different assemblies.; The returned assembly paths refer to assembly nodes that in turn refer to vtkProp and vtkMatrix. This association to vtkProp is not a reference counted association, meaning that dangling references are possible if you do a pick, get an assembly path, and then delete a vtkProp. (Reason: assembly paths create many self-referencing loops that destroy reference counting.)

See also: vtkPropPicker vtkPicker vtkWorldPointPicker vtkCellPicker vtkPointPicker vtkAssemblyPath vtkAssemblyNode vtkAssemblyPaths vtkAbstractPicker vtkRenderer

Definition at line 79 of file vtkAbstractPropPicker.h.

Member Typedef Documentation

typedef vtkAbstractPicker vtkAbstractPropPicker::Superclass

Definition at line 82 of file vtkAbstractPropPicker.h.

Constructor & Destructor Documentation

vtkAbstractPropPicker::vtkAbstractPropPicker ( )

protected

vtkAbstractPropPicker::~vtkAbstractPropPicker ( )

protected

Member Function Documentation

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

static

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

Reimplemented in vtkCellPicker, vtkAreaPicker, vtkPicker, vtkVolumePicker, vtkPropPicker, vtkRenderedAreaPicker, vtkResliceCursorPicker, vtkPointPicker, and vtkPropPicker3D.

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

static

virtual vtkObjectBase* vtkAbstractPropPicker::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractPicker.

Reimplemented in vtkCellPicker, vtkAreaPicker, vtkPicker, vtkVolumePicker, vtkPropPicker, vtkRenderedAreaPicker, vtkResliceCursorPicker, vtkPointPicker, and vtkPropPicker3D.

vtkAbstractPropPicker* vtkAbstractPropPicker::NewInstance ( ) const

void vtkAbstractPropPicker::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 vtkAbstractPicker.

Reimplemented in vtkCellPicker, vtkAreaPicker, vtkPicker, vtkVolumePicker, vtkPropPicker, vtkRenderedAreaPicker, vtkPointPicker, and vtkPropPicker3D.

virtual void vtkAbstractPropPicker::SetPath ( vtkAssemblyPath * )

virtual

Return the vtkAssemblyPath that has been picked.

The assembly path lists all the vtkProps that form an assembly. If no assembly is present, then the assembly path will have one node (which is the picked prop). The set method is used internally to set the path. (Note: the structure of an assembly path is a collection of vtkAssemblyNode, each node pointing to a vtkProp and (possibly) a transformation matrix.)

virtual vtkAssemblyPath* vtkAbstractPropPicker::GetPath ( )

virtual

Return the vtkAssemblyPath that has been picked.

The assembly path lists all the vtkProps that form an assembly. If no assembly is present, then the assembly path will have one node (which is the picked prop). The set method is used internally to set the path. (Note: the structure of an assembly path is a collection of vtkAssemblyNode, each node pointing to a vtkProp and (possibly) a transformation matrix.)

virtual vtkProp* vtkAbstractPropPicker::GetViewProp ( )

virtual

Return the vtkProp that has been picked.

If NULL, nothing was picked. If anything at all was picked, this method will return something.

virtual vtkProp3D* vtkAbstractPropPicker::GetProp3D ( )

virtual

Return the vtkProp that has been picked.

If NULL, no vtkProp3D was picked.

virtual vtkActor* vtkAbstractPropPicker::GetActor ( )

virtual

Return the vtkActor that has been picked.

If NULL, no actor was picked.

virtual vtkActor2D* vtkAbstractPropPicker::GetActor2D ( )

virtual

Return the vtkActor2D that has been picked.

If NULL, no actor2D was picked.

virtual vtkVolume* vtkAbstractPropPicker::GetVolume ( )

virtual

Return the vtkVolume that has been picked.

If NULL, no volume was picked.

virtual vtkAssembly* vtkAbstractPropPicker::GetAssembly ( )

virtual

Return the vtkAssembly that has been picked.

If NULL, no assembly was picked. (Note: the returned assembly is the first node in the assembly path. If the path is one node long, then the assembly and the prop are the same, assuming that the first node is a vtkAssembly.)

virtual vtkPropAssembly* vtkAbstractPropPicker::GetPropAssembly ( )

virtual

Return the vtkPropAssembly that has been picked.

If NULL, no prop assembly was picked. (Note: the returned prop assembly is the first node in the assembly path. If the path is one node long, then the prop assembly and the prop are the same, assuming that the first node is a vtkPropAssembly.)

void vtkAbstractPropPicker::Initialize ( )

protectedvirtual

Reimplemented from vtkAbstractPicker.

Reimplemented in vtkCellPicker, vtkPicker, vtkAreaPicker, vtkPropPicker, vtkPropPicker3D, and vtkPointPicker.

Member Data Documentation

vtkAssemblyPath* vtkAbstractPropPicker::Path

protected

Definition at line 153 of file vtkAbstractPropPicker.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation