vtkObserverMediator Class Reference

manage contention for cursors and other resources More...

#include <vtkObserverMediator.h>

Inheritance diagram for vtkObserverMediator:

Collaboration diagram for vtkObserverMediator:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkObserverMediator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetInteractor (vtkRenderWindowInteractor *iren)
virtual vtkRenderWindowInteractor *	GetInteractor ()
int	RequestCursorShape (vtkInteractorObserver *, int cursorShape)
void	RemoveAllCursorShapeRequests (vtkInteractorObserver *)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
int	GetReferenceCount ()
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkObserverMediator *	New ()
static int	IsTypeOf (const char *type)
static vtkObserverMediator *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkObserverMediator ()
	~vtkObserverMediator ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
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
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

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 49 of file vtkObserverMediator.h.

Constructor & Destructor Documentation

vtkObserverMediator()

vtkObserverMediator::vtkObserverMediator ( )

protected

~vtkObserverMediator()

vtkObserverMediator::~vtkObserverMediator ( )

protected

Member Function Documentation

New()

static vtkObserverMediator* vtkObserverMediator::New ( )

static

Instantiate the class.

IsTypeOf()

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

static

IsA()

virtual int 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 vtkObject.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase* vtkObserverMediator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

NewInstance()

vtkObserverMediator* vtkObserverMediator::NewInstance

(

)

const

PrintSelf()

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

virtual

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 74 of file vtkObserverMediator.h.

ObserverMap

vtkObserverMap* vtkObserverMediator::ObserverMap

protected

Definition at line 79 of file vtkObserverMediator.h.

CurrentObserver

vtkInteractorObserver* vtkObserverMediator::CurrentObserver

protected

Definition at line 82 of file vtkObserverMediator.h.

CurrentCursorShape

int vtkObserverMediator::CurrentCursorShape

protected

Definition at line 83 of file vtkObserverMediator.h.

---

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

• dox/opt/build/vtk6-6.3.0+dfsg2/Rendering/Core/vtkObserverMediator.h