VTK
9.1.0
|
Class defines API to manage the picking process. More...
#include <vtkPickingManager.h>
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... | |
vtkPickingManager * | NewInstance () 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... | |
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. 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 vtkRenderWindowInteractor * | GetInteractor () |
Set the window interactor associated with the manager. More... | |
![]() | |
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... | |
![]() | |
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 vtkPickingManager * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkPickingManager * | SafeDownCast (vtkObjectBase *o) |
![]() | |
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 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 |
vtkPickingManager () | |
~vtkPickingManager () override | |
![]() | |
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... | |
![]() | |
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 |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 82 of file vtkPickingManager.h.
Definition at line 86 of file vtkPickingManager.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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 |
|
protectedvirtual |
vtkPickingManager * vtkPickingManager::NewInstance | ( | ) | const |
|
overridevirtual |
|
virtual |
Enable/Disable management.
When disabled, it redirects every pick on the picker. By default the picking manager is disabled when initialized.
|
virtual |
Enable/Disable management.
When disabled, it redirects every pick on the picker. By default the picking manager is disabled when initialized.
|
virtual |
Enable/Disable management.
When disabled, it redirects every pick on the picker. By default the picking manager is disabled when initialized.
|
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 |
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 |
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.
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.
|
protected |
Definition at line 194 of file vtkPickingManager.h.
|
protected |
Definition at line 195 of file vtkPickingManager.h.
|
protected |
Definition at line 196 of file vtkPickingManager.h.