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

Public Member Functions inherited from vtkObjectBase
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 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 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
	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 ()
	These methods allow a command to exclusively grab all events. More...

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

vtkObserverMap *	ObserverMap

vtkInteractorObserver *	CurrentObserver

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

typedef vtkObject	Superclass
	Standard macros. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard macros. More...

static vtkObserverMediator *	SafeDownCast (vtkObjectBase *o)
	Standard macros. More...

virtual vtkTypeBool	IsA (const char *type)
	Standard macros. More...

vtkObserverMediator *	NewInstance () const
	Standard macros. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard macros. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard macros. More...

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

typedef vtkObject vtkObserverMediator::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

Standard macros.

◆ IsA()

virtual vtkTypeBool vtkObserverMediator::IsA ( const char * type )

virtual

Standard macros.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

Standard macros.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkObserverMediator::NewInstanceInternal ( ) const

protectedvirtual

Standard macros.

◆ NewInstance()

vtkObserverMediator * vtkObserverMediator::NewInstance ( ) const

Standard macros.

◆ PrintSelf()

void vtkObserverMediator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard macros.

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

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

◆ RequestCursorShape()

int vtkObserverMediator::RequestCursorShape	(	vtkInteractorObserver *	,
		int	requestedShape
	)

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:

Rendering/Core/vtkObserverMediator.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkObserverMediator()

◆ ~vtkObserverMediator()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetInteractor()

◆ GetInteractor()

◆ RequestCursorShape()

◆ RemoveAllCursorShapeRequests()

Member Data Documentation

◆ Interactor

◆ ObserverMap

◆ CurrentObserver

◆ CurrentCursorShape