define API for picking subclasses More...

#include <vtkAbstractPicker.h>

Inheritance diagram for vtkAbstractPicker:

Collaboration diagram for vtkAbstractPicker:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkAbstractPicker *	NewInstance () const

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

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

virtual int	Pick3DPoint (double[3], vtkRenderer *)
	Perform pick operation with selection point provided. More...

virtual int	Pick3DRay (double[3], double[4], vtkRenderer *)
	Perform pick operation with selection point and orientation 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 (vtkTypeBool)
	Use these methods to control whether to limit the picking to this list (rather than renderer's actors). More...

virtual vtkTypeBool	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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

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

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkTypeBool	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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractPicker ()

	~vtkAbstractPicker () override

virtual void	Initialize ()

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=nullptr)
	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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkRenderer *	Renderer

double	SelectionPoint [3]

double	PickPosition [3]

vtkTypeBool	PickFromList

vtkPropCollection *	PickList

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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.

Online Examples:

MarkKeypoints

CaptionActor2D

Definition at line 97 of file vtkAbstractPicker.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkAbstractPicker::Superclass

Definition at line 100 of file vtkAbstractPicker.h.

Constructor & Destructor Documentation

◆ vtkAbstractPicker()

vtkAbstractPicker::vtkAbstractPicker ( )

protected

◆ ~vtkAbstractPicker()

vtkAbstractPicker::~vtkAbstractPicker ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAbstractPicker::NewInstanceInternal ( ) const

protectedvirtual

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

◆ NewInstance()

vtkAbstractPicker * vtkAbstractPicker::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractPicker::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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, vtkAreaPicker, vtkCellPicker, vtkPicker, vtkPointPicker, vtkPropPicker, vtkRenderedAreaPicker, vtkWorldPointPicker, vtkVolumePicker, and vtkVRHardwarePicker.

◆ GetRenderer()

virtual vtkRenderer * vtkAbstractPicker::GetRenderer ( )

virtual

Get the renderer in which pick event occurred.

◆ GetSelectionPoint() [1/2]

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

◆ GetSelectionPoint() [2/2]

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

◆ GetPickPosition() [1/2]

virtual double * vtkAbstractPicker::GetPickPosition ( )

virtual

Return position in global coordinates of pick point.

◆ GetPickPosition() [2/2]

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

virtual

Return position in global coordinates of pick point.

◆ Pick() [1/2]

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 vtkResliceCursorPicker, vtkCellPicker, vtkPicker, vtkPropPicker, and vtkWorldPointPicker.

◆ Pick() [2/2]

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 139 of file vtkAbstractPicker.h.

◆ Pick3DPoint()

virtual int vtkAbstractPicker::Pick3DPoint	(	double	[3],
		vtkRenderer *
	)

inlinevirtual

Perform pick operation with selection point provided.

The selectionPt is in world coordinates. Return non-zero if something was successfully picked.

Reimplemented in vtkPicker, and vtkPropPicker.

Definition at line 149 of file vtkAbstractPicker.h.

◆ Pick3DRay()

virtual int vtkAbstractPicker::Pick3DRay	(	double	[3],
		double	[4],
		vtkRenderer *
	)

inlinevirtual

Perform pick operation with selection point and orientation provided.

The selectionPt is in world coordinates. Return non-zero if something was successfully picked.

Reimplemented in vtkCellPicker, vtkPicker, and vtkPropPicker.

Definition at line 160 of file vtkAbstractPicker.h.

◆ SetPickFromList()

virtual void vtkAbstractPicker::SetPickFromList ( vtkTypeBool )

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.

◆ GetPickFromList()

virtual vtkTypeBool 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.

◆ PickFromListOn()

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.

◆ PickFromListOff()

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.

◆ InitializePickList()

void vtkAbstractPicker::InitializePickList ( )

Initialize list of actors in pick list.

◆ AddPickList()

void vtkAbstractPicker::AddPickList ( vtkProp * )

Add an actor to the pick list.

◆ DeletePickList()

void vtkAbstractPicker::DeletePickList ( vtkProp * )

Delete an actor from the pick list.

◆ GetPickList()

vtkPropCollection * vtkAbstractPicker::GetPickList ( )

inline

Return the list of actors in the PickList.

Definition at line 195 of file vtkAbstractPicker.h.

◆ Initialize()

virtual void vtkAbstractPicker::Initialize ( )

protectedvirtual

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

Member Data Documentation

◆ Renderer

vtkRenderer* vtkAbstractPicker::Renderer

protected

Definition at line 203 of file vtkAbstractPicker.h.

◆ SelectionPoint

double vtkAbstractPicker::SelectionPoint[3]

protected

Definition at line 204 of file vtkAbstractPicker.h.

◆ PickPosition

double vtkAbstractPicker::PickPosition[3]

protected

Definition at line 205 of file vtkAbstractPicker.h.

◆ PickFromList

vtkTypeBool vtkAbstractPicker::PickFromList

protected

Definition at line 208 of file vtkAbstractPicker.h.

◆ PickList

vtkPropCollection* vtkAbstractPicker::PickList

protected

Definition at line 209 of file vtkAbstractPicker.h.

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

Rendering/Core/vtkAbstractPicker.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAbstractPicker()

◆ ~vtkAbstractPicker()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetRenderer()

◆ GetSelectionPoint() [1/2]

◆ GetSelectionPoint() [2/2]

◆ GetPickPosition() [1/2]

◆ GetPickPosition() [2/2]

◆ Pick() [1/2]

◆ Pick() [2/2]

◆ Pick3DPoint()

◆ Pick3DRay()

◆ SetPickFromList()

◆ GetPickFromList()

◆ PickFromListOn()

◆ PickFromListOff()

◆ InitializePickList()

◆ AddPickList()

◆ DeletePickList()

◆ GetPickList()

◆ Initialize()

Member Data Documentation

◆ Renderer

◆ SelectionPoint

◆ PickPosition

◆ PickFromList

◆ PickList