define API for picking subclasses More...

#include <vtkAbstractPicker.h>

Inheritance diagram for vtkAbstractPicker:

Collaboration diagram for vtkAbstractPicker:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAbstractPicker *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

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


virtual int	Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)=0


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

	vtkAbstractPicker ()

	~vtkAbstractPicker ()

virtual void	Initialize ()

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

define API for picking subclasses

vtkAbstractPicker is an abstract superclass that defines a minimal API for its concrete subclasses. The minimum functionality of a picker is to return the x-y-z global coordinate position of a pick (the pick itself is defined in display coordinates).

The API to this class is to invoke the Pick() method with a selection point (in display coordinates - pixels) and a renderer. Then get the resulting pick position in global coordinates with the GetPickPosition() method.

vtkPicker fires events during the picking process. These events are StartPickEvent, PickEvent, and EndPickEvent which are invoked prior to picking, when something is picked, and after all picking candidates have been tested. Note that during the pick process the PickEvent of vtkProp (and its subclasses such as vtkActor) is fired prior to the PickEvent of vtkPicker.

Warning: vtkAbstractPicker and its subclasses will not pick props that are "unpickable" (see vtkProp) or are fully transparent (if transparency is a property of the vtkProp).; There are two classes of pickers: those that pick using geometric methods (typically a ray cast); and those that use rendering hardware. Geometric methods return more information but are slower. Hardware methods are much faster and return minimal information. Examples of geometric pickers include vtkPicker, vtkCellPicker, and vtkPointPicker. Examples of hardware pickers include vtkWorldPointPicker and vtkPropPicker.

See also: vtkPropPicker uses hardware acceleration to pick an instance of vtkProp. (This means that 2D and 3D props can be picked, and it's relatively fast.) If you need to pick cells or points, you might wish to use vtkCellPicker or vtkPointPicker. vtkWorldPointPicker is the fastest picker, returning an x-y-z coordinate value using the hardware z-buffer. vtkPicker can be used to pick the bounding box of 3D props.

Definition at line 67 of file vtkAbstractPicker.h.

Member Typedef Documentation

typedef vtkObject vtkAbstractPicker::Superclass

Definition at line 70 of file vtkAbstractPicker.h.

Constructor & Destructor Documentation

vtkAbstractPicker::vtkAbstractPicker ( )

protected

vtkAbstractPicker::~vtkAbstractPicker ( )

protected

Member Function Documentation

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

static

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

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

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

static

virtual vtkObjectBase* vtkAbstractPicker::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

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

vtkAbstractPicker* vtkAbstractPicker::NewInstance ( ) const

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

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

virtual vtkRenderer* vtkAbstractPicker::GetRenderer ( )

virtual

Get the renderer in which pick event occurred.

virtual double* vtkAbstractPicker::GetSelectionPoint ( )

virtual

Get the selection point in screen (pixel) coordinates. The third value is related to z-buffer depth. (Normally should be =0.)

virtual void vtkAbstractPicker::GetSelectionPoint ( double data[3] )

virtual

Get the selection point in screen (pixel) coordinates. The third value is related to z-buffer depth. (Normally should be =0.)

virtual double* vtkAbstractPicker::GetPickPosition ( )

virtual

Return position in global coordinates of pick point.

virtual void vtkAbstractPicker::GetPickPosition ( double data[3] )

virtual

Return position in global coordinates of pick point.

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

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

Implemented in vtkPicker, vtkCellPicker, vtkPropPicker, vtkResliceCursorPicker, and vtkWorldPointPicker.

int vtkAbstractPicker::Pick	(	double	selectionPt[3],
		vtkRenderer *	ren
	)

inline

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.

Definition at line 102 of file vtkAbstractPicker.h.

virtual void vtkAbstractPicker::SetPickFromList ( int )

virtual

Use these methods to control whether to limit the picking to this list (rather than renderer's actors). Make sure that the pick list contains actors that referred to by the picker's renderer.

virtual int vtkAbstractPicker::GetPickFromList ( )

virtual

Use these methods to control whether to limit the picking to this list (rather than renderer's actors). Make sure that the pick list contains actors that referred to by the picker's renderer.

virtual void vtkAbstractPicker::PickFromListOn ( )

virtual

Use these methods to control whether to limit the picking to this list (rather than renderer's actors). Make sure that the pick list contains actors that referred to by the picker's renderer.

virtual void vtkAbstractPicker::PickFromListOff ( )

virtual

Use these methods to control whether to limit the picking to this list (rather than renderer's actors). Make sure that the pick list contains actors that referred to by the picker's renderer.

void vtkAbstractPicker::InitializePickList ( )

Initialize list of actors in pick list.

void vtkAbstractPicker::AddPickList ( vtkProp * )

Add an actor to the pick list.

void vtkAbstractPicker::DeletePickList ( vtkProp * )

Delete an actor from the pick list.

vtkPropCollection* vtkAbstractPicker::GetPickList ( )

inline

Return the list of actors in the PickList.

Definition at line 125 of file vtkAbstractPicker.h.

virtual void vtkAbstractPicker::Initialize ( )

protectedvirtual

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

Member Data Documentation

vtkRenderer* vtkAbstractPicker::Renderer

protected

Definition at line 133 of file vtkAbstractPicker.h.

double vtkAbstractPicker::SelectionPoint[3]

protected

Definition at line 134 of file vtkAbstractPicker.h.

double vtkAbstractPicker::PickPosition[3]

protected

Definition at line 135 of file vtkAbstractPicker.h.

int vtkAbstractPicker::PickFromList

protected

Definition at line 138 of file vtkAbstractPicker.h.

vtkPropCollection* vtkAbstractPicker::PickList

protected

Definition at line 139 of file vtkAbstractPicker.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/vtkAbstractPicker.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