vtkPickingManager Class Reference

Class defines API to manage the picking process. More...

#include <vtkPickingManager.h>

Inheritance diagram for vtkPickingManager:

Collaboration diagram for vtkPickingManager:

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.
vtkPickingManager *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	AddPicker (vtkAbstractPicker *picker, vtkObject *object=nullptr)
	Register a picker into the picking manager.
void	RemovePicker (vtkAbstractPicker *picker, vtkObject *object=nullptr)
	Unregister the picker from the picking manager.
void	RemoveObject (vtkObject *object)
	Remove all occurrence of the object from the registered list.
bool	Pick (vtkAbstractPicker *picker, vtkObject *object)
	Run the picking selection process and return true if the object is associated with the given picker if it is the best one, false otherwise.
bool	Pick (vtkObject *object)
	Run the picking selection process and return true if the object is associated with the best picker.
bool	Pick (vtkAbstractPicker *picker)
	Run the picking selection process and return if picker is the one selected.
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker, vtkRenderer *renderer, vtkObject *obj)
	If the picking manager is enabled, it runs the picking selection process and return the assembly path associated to the picker passed as argument if it is the one mediated.
int	GetNumberOfPickers ()
	Return the number of pickers registered.
int	GetNumberOfObjectsLinked (vtkAbstractPicker *picker)
	Return the number of objects linked with a given picker.
virtual void	EnabledOn ()
	Enable/Disable management.
virtual void	EnabledOff ()
	Enable/Disable management.
virtual void	SetEnabled (bool)
	Enable/Disable management.
virtual bool	GetEnabled ()
	Enable/Disable management.
void	SetOptimizeOnInteractorEvents (bool optimize)
	Enable/Disable optimization depending on the renderWindowInteractor events.
virtual bool	GetOptimizeOnInteractorEvents ()
	Enable/Disable optimization depending on the renderWindowInteractor events.
void	SetInteractor (vtkRenderWindowInteractor *iren)
	Set the window interactor associated with the manager.
virtual vtkRenderWindowInteractor *	GetInteractor ()
	Set the window interactor associated with the manager.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
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).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkPickingManager *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPickingManager *	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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
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).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPickingManager ()
	~vtkPickingManager () override
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
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
vtkRenderWindowInteractor *	Interactor
bool	Enabled
bool	OptimizeOnInteractorEvents
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

Class defines API to manage the picking process.

The Picking Manager (PM) coordinates picking across widgets simultaneously. It maintains a collection of registered pickers; when the manager is picked (e.g. vtkPickingManager::Pick()), a pick is run on each picker but only the best picker (e.g. closest to camera point) is selected. It finally returns the widget/representation or picker that was selected.

Warning

Every time a vtkWidget and/or a vtkWidgetRepresentation is instantiated, it automatically registers its picker(s) and start being managed by delegating all its pick calls to the picking manager. It is possible to customize with the management in two ways:

• at the widget level, the "ManagesPicking" variable can be changed from the widget/representation class to tell whether to use the manager or not.
• Directly disable the picking manager itself with the boolean variable

See also

Enabled using vtkPickingManager::EnabledOn(), EnabledOff(), SetEnabled(bool).

Important:

The picking manager is not active by default as it slightly reduces the performances when interacting with the scene.

Important:

When registering pickers, a null object is considered valid because we can managed picker without any associated object. It is really important to note that a null object is different from one to an other !! This has been done to allow adding multiple times the same picker to the manager by not passing the referenced object to not force the suppression of all pickers

Definition at line 82 of file vtkPickingManager.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPickingManager::Superclass

Definition at line 86 of file vtkPickingManager.h.

Constructor & Destructor Documentation

vtkPickingManager()

vtkPickingManager::vtkPickingManager ( )

protected

~vtkPickingManager()

vtkPickingManager::~vtkPickingManager ( )

overrideprotected

Member Function Documentation

New()

static vtkPickingManager * vtkPickingManager::New ( )

static

IsTypeOf()

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

static

IsA()

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

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkPickingManager::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkPickingManager * vtkPickingManager::NewInstance

(

)

const

PrintSelf()

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

EnabledOn()

virtual void vtkPickingManager::EnabledOn ( )

virtual

Enable/Disable management.

When disabled, it redirects every pick on the picker. By default the picking manager is disabled when initialized.

EnabledOff()

virtual void vtkPickingManager::EnabledOff ( )

virtual

Enable/Disable management.

When disabled, it redirects every pick on the picker. By default the picking manager is disabled when initialized.

SetEnabled()

virtual void vtkPickingManager::SetEnabled ( bool  )

virtual

Enable/Disable management.

When disabled, it redirects every pick on the picker. By default the picking manager is disabled when initialized.

GetEnabled()

virtual bool vtkPickingManager::GetEnabled ( )

virtual

Enable/Disable management.

When disabled, it redirects every pick on the picker. By default the picking manager is disabled when initialized.

SetOptimizeOnInteractorEvents()

void vtkPickingManager::SetOptimizeOnInteractorEvents

(

bool

optimize

)

Enable/Disable optimization depending on the renderWindowInteractor events.

The mechanism keeps in cache the last selected picker as well as the last render time to recompute the selection only if a new render event occurred after the last selection; otherwise, it simply returns the last picker selected. By default pickingManagers does use the optimization. Warning: Turning off the caching significantly decreases performance.

GetOptimizeOnInteractorEvents()

virtual bool vtkPickingManager::GetOptimizeOnInteractorEvents ( )

virtual

Enable/Disable optimization depending on the renderWindowInteractor events.

The mechanism keeps in cache the last selected picker as well as the last render time to recompute the selection only if a new render event occurred after the last selection; otherwise, it simply returns the last picker selected. By default pickingManagers does use the optimization. Warning: Turning off the caching significantly decreases performance.

SetInteractor()

void vtkPickingManager::SetInteractor

(

vtkRenderWindowInteractor *

iren

)

Set the window interactor associated with the manager.

GetInteractor()

virtual vtkRenderWindowInteractor * vtkPickingManager::GetInteractor ( )

virtual

Set the window interactor associated with the manager.

AddPicker()

void vtkPickingManager::AddPicker	(	vtkAbstractPicker *	picker,
		vtkObject *	object = nullptr
	)

Register a picker into the picking manager.

It can be internally associated (optional) with an object. This allows the removal of all the pickers of the given object. Note that a picker can be registered multiple times with different objects.

See also

RemovePicker(), RemoveObject().

RemovePicker()

void vtkPickingManager::RemovePicker	(	vtkAbstractPicker *	picker,
		vtkObject *	object = nullptr
	)

Unregister the picker from the picking manager.

If object is non null, only the pair (picker, object) is removed.

RemoveObject()

void vtkPickingManager::RemoveObject

(

vtkObject *

object

)

Remove all occurrence of the object from the registered list.

If a picker associated with the object is not also associated with any other object, it is removed from the list as well.

Pick() [1/3]

bool vtkPickingManager::Pick	(	vtkAbstractPicker *	picker,
		vtkObject *	object
	)

Run the picking selection process and return true if the object is associated with the given picker if it is the best one, false otherwise.

If OptimizeOnInteractorEvents is true, the pick can reuse cached information.

Pick() [2/3]

bool vtkPickingManager::Pick

(

vtkObject *

object

)

Run the picking selection process and return true if the object is associated with the best picker.

This is an overloaded function.

Pick() [3/3]

bool vtkPickingManager::Pick

(

vtkAbstractPicker *

picker

)

Run the picking selection process and return if picker is the one selected.

This is an overloaded function.

GetAssemblyPath()

vtkAssemblyPath * vtkPickingManager::GetAssemblyPath	(	double	X,
		double	Y,
		double	Z,
		vtkAbstractPropPicker *	picker,
		vtkRenderer *	renderer,
		vtkObject *	obj
	)

If the picking manager is enabled, it runs the picking selection process and return the assembly path associated to the picker passed as argument if it is the one mediated.

Otherwise it simply proceeds to a pick using the given renderer and returns the corresponding assembly path.

GetNumberOfPickers()

int vtkPickingManager::GetNumberOfPickers

(

)

Return the number of pickers registered.

If the same picker is added multiple times with different objects, it is counted once.

GetNumberOfObjectsLinked()

int vtkPickingManager::GetNumberOfObjectsLinked

(

vtkAbstractPicker *

picker

)

Return the number of objects linked with a given picker.

Note: a null object is counted as an associated object.

Member Data Documentation

Interactor

vtkRenderWindowInteractor* vtkPickingManager::Interactor

protected

Definition at line 194 of file vtkPickingManager.h.

Enabled

bool vtkPickingManager::Enabled

protected

Definition at line 195 of file vtkPickingManager.h.

OptimizeOnInteractorEvents

bool vtkPickingManager::OptimizeOnInteractorEvents

protected

Definition at line 196 of file vtkPickingManager.h.

---

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

• Rendering/Core/vtkPickingManager.h