manage contention for cursors and other resources More...
#include <vtkObserverMediator.h>
Inheritance diagram for vtkObserverMediator:
Collaboration diagram for vtkObserverMediator:
Public Member Functions | |
| int | RequestCursorShape (vtkInteractorObserver *, int cursorShape) |
| Method used to request a cursor shape. More... | |
| void | RemoveAllCursorShapeRequests (vtkInteractorObserver *) |
| Remove all requests for cursor shape from a given interactor. More... | |
| void | SetInteractor (vtkRenderWindowInteractor *iren) |
| Specify the instance of vtkRenderWindow whose cursor shape is to be managed. More... | |
| virtual vtkRenderWindowInteractor * | GetInteractor () |
| Specify the instance of vtkRenderWindow whose cursor shape is to be managed. 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... | |
| 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... | |
| 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 vtkObserverMediator * | New () |
| Instantiate the class. More... | |
| 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 vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| vtkObserverMediator () | |
| ~vtkObserverMediator () | |
| 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=NULL) |
| 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 | |
| vtkRenderWindowInteractor * | Interactor |
| vtkObserverMap * | ObserverMap |
| vtkInteractorObserver * | CurrentObserver |
| int | CurrentCursorShape |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
| typedef vtkObject | Superclass |
| Standard macros. More... | |
| static int | IsTypeOf (const char *type) |
| Standard macros. More... | |
| static vtkObserverMediator * | SafeDownCast (vtkObjectBase *o) |
| Standard macros. More... | |
| virtual int | IsA (const char *type) |
| Standard macros. More... | |
| vtkObserverMediator * | NewInstance () const |
| Standard macros. More... | |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| Standard macros. More... | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| Standard macros. More... | |
Detailed Description
manage contention for cursors and other resources
The vtkObserverMediator is a helper class that manages requests for cursor changes from multiple interactor observers (e.g. widgets). It keeps a list of widgets (and their priorities) and their current requests for cursor shape. It then satisfies requests based on widget priority and the relative importance of the request (e.g., a lower priority widget requesting a particular cursor shape will overrule a higher priority widget requesting a default shape).
Definition at line 42 of file vtkObserverMediator.h.
Member Typedef Documentation
Standard macros.
Definition at line 54 of file vtkObserverMediator.h.
Constructor & Destructor Documentation
|
protected |
|
protected |
Member Function Documentation
|
static |
Instantiate the class.
|
static |
Standard macros.
|
virtual |
Standard macros.
Reimplemented from vtkObjectBase.
|
static |
Standard macros.
|
protectedvirtual |
Standard macros.
| vtkObserverMediator* vtkObserverMediator::NewInstance | ( | ) | const |
Standard macros.
|
virtual |
Standard macros.
Reimplemented from vtkObject.
| void vtkObserverMediator::SetInteractor | ( | vtkRenderWindowInteractor * | iren | ) |
Specify the instance of vtkRenderWindow whose cursor shape is to be managed.
|
virtual |
Specify the instance of vtkRenderWindow whose cursor shape is to be managed.
| int vtkObserverMediator::RequestCursorShape | ( | vtkInteractorObserver * | , |
| int | cursorShape | ||
| ) |
Method used to request a cursor shape.
Note that the shape is specified using one of the integral values determined in vtkRenderWindow.h. The method returns a non-zero value if the shape was successfully changed.
| void vtkObserverMediator::RemoveAllCursorShapeRequests | ( | vtkInteractorObserver * | ) |
Remove all requests for cursor shape from a given interactor.
Member Data Documentation
|
protected |
Definition at line 84 of file vtkObserverMediator.h.
|
protected |
Definition at line 89 of file vtkObserverMediator.h.
|
protected |
Definition at line 92 of file vtkObserverMediator.h.
|
protected |
Definition at line 93 of file vtkObserverMediator.h.
The documentation for this class was generated from the following file:
- /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/Core/vtkObserverMediator.h
