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

manage contention for cursors and other resources More...

#include <vtkObserverMediator.h>

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

Public Types

typedef vtkObject Superclass
 Standard macros. More...
 

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...
 
vtkObserverMediatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetInteractor (vtkRenderWindowInteractor *iren)
 Specify the instance of vtkRenderWindow whose cursor shape is to be managed. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 
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...
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkObserverMediatorNew ()
 Instantiate the class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkObserverMediatorSafeDownCast (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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkObserverMediator ()
 
 ~vtkObserverMediator () 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 ()
 
- 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
 
vtkObserverMap * ObserverMap
 
vtkInteractorObserverCurrentObserver
 
int CurrentCursorShape
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

See also
vtkAbstractWidget vtkWidgetRepresentation

Definition at line 41 of file vtkObserverMediator.h.

Member Typedef Documentation

◆ Superclass

Standard macros.

Definition at line 53 of file vtkObserverMediator.h.

Constructor & Destructor Documentation

◆ vtkObserverMediator()

vtkObserverMediator::vtkObserverMediator ( )
protected

◆ ~vtkObserverMediator()

vtkObserverMediator::~vtkObserverMediator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkObserverMediator* vtkObserverMediator::New ( )
static

Instantiate the class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkObserverMediator::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 vtkObserverMediator* vtkObserverMediator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkObserverMediator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkObserverMediator* vtkObserverMediator::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetInteractor()

void vtkObserverMediator::SetInteractor ( vtkRenderWindowInteractor iren)

Specify the instance of vtkRenderWindow whose cursor shape is to be managed.

◆ GetInteractor()

virtual vtkRenderWindowInteractor* vtkObserverMediator::GetInteractor ( )
virtual

◆ RequestCursorShape()

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.

◆ RemoveAllCursorShapeRequests()

void vtkObserverMediator::RemoveAllCursorShapeRequests ( vtkInteractorObserver )

Remove all requests for cursor shape from a given interactor.

Member Data Documentation

◆ Interactor

vtkRenderWindowInteractor* vtkObserverMediator::Interactor
protected

Definition at line 83 of file vtkObserverMediator.h.

◆ ObserverMap

vtkObserverMap* vtkObserverMediator::ObserverMap
protected

Definition at line 88 of file vtkObserverMediator.h.

◆ CurrentObserver

vtkInteractorObserver* vtkObserverMediator::CurrentObserver
protected

Definition at line 91 of file vtkObserverMediator.h.

◆ CurrentCursorShape

int vtkObserverMediator::CurrentCursorShape
protected

Definition at line 92 of file vtkObserverMediator.h.


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