VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPickingManager Class Reference

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

#include <vtkPickingManager.h>

Inheritance diagram for vtkPickingManager:
[legend]
Collaboration diagram for vtkPickingManager:
[legend]

Public Types

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...
 
vtkPickingManagerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void AddPicker (vtkAbstractPicker *picker, vtkObject *object=nullptr)
 Register a picker into the picking manager. More...
 
void RemovePicker (vtkAbstractPicker *picker, vtkObject *object=nullptr)
 Unregister the picker from the picking manager. More...
 
void RemoveObject (vtkObject *object)
 Remove all occurrence of the object from the registered list. More...
 
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. More...
 
bool Pick (vtkObject *object)
 Run the picking selection process and return true if the object is associated with the best picker. More...
 
bool Pick (vtkAbstractPicker *picker)
 Run the picking selection process and return if picker is the one selected. More...
 
vtkAssemblyPathGetAssemblyPath (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. More...
 
int GetNumberOfPickers ()
 Return the number of pickers registered. More...
 
int GetNumberOfObjectsLinked (vtkAbstractPicker *picker)
 Return the number of objects linked with a given picker. More...
 
virtual void EnabledOn ()
 Enable/Disable management. More...
 
virtual void EnabledOff ()
 Enable/Disable management. More...
 
virtual void SetEnabled (bool)
 Enable/Disable management. More...
 
virtual bool GetEnabled ()
 Enable/Disable management. More...
 
void SetOptimizeOnInteractorEvents (bool optimize)
 Enable/Disable optimization depending on the renderWindowInteractor events. More...
 
virtual bool GetOptimizeOnInteractorEvents ()
 Enable/Disable optimization depending on the renderWindowInteractor events. More...
 
void SetInteractor (vtkRenderWindowInteractor *iren)
 Set the window interactor associated with the manager. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 Set the window interactor associated with the manager. 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...
 
vtkCommandGetCommand (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 vtkPickingManagerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPickingManagerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. 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

vtkRenderWindowInteractorInteractor
 
bool Enabled
 
bool OptimizeOnInteractorEvents
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 supression of all pickers
Tests:
vtkPickingManager (Tests)

Definition at line 85 of file vtkPickingManager.h.

Member Typedef Documentation

Definition at line 89 of file vtkPickingManager.h.

Constructor & Destructor Documentation

vtkPickingManager::vtkPickingManager ( )
protected
vtkPickingManager::~vtkPickingManager ( )
overrideprotected

Member Function Documentation

static vtkPickingManager* vtkPickingManager::New ( )
static
static int vtkPickingManager::IsTypeOf ( const char *  type)
static
virtual int 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.

static vtkPickingManager* vtkPickingManager::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkPickingManager::NewInstanceInternal ( ) const
protectedvirtual
vtkPickingManager* vtkPickingManager::NewInstance ( ) const
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.

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.

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.

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.

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.

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.

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.

void vtkPickingManager::SetInteractor ( vtkRenderWindowInteractor iren)

Set the window interactor associated with the manager.

virtual vtkRenderWindowInteractor* vtkPickingManager::GetInteractor ( )
virtual

Set the window interactor associated with the manager.

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

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.

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.

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.

bool vtkPickingManager::Pick ( vtkAbstractPicker picker)

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

This is an overloaded function.

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.

int vtkPickingManager::GetNumberOfPickers ( )

Return the number of pickers registered.

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

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

vtkRenderWindowInteractor* vtkPickingManager::Interactor
protected

Definition at line 199 of file vtkPickingManager.h.

bool vtkPickingManager::Enabled
protected

Definition at line 200 of file vtkPickingManager.h.

bool vtkPickingManager::OptimizeOnInteractorEvents
protected

Definition at line 201 of file vtkPickingManager.h.


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