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)

void	RemoveAllCursorShapeRequests (vtkInteractorObserver *)


void	SetInteractor (vtkRenderWindowInteractor *iren)

virtual vtkRenderWindowInteractor *	GetInteractor ()

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	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkObserverMediator *	New ()

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

typedef vtkObject	Superclass

static int	IsTypeOf (const char *type)

static vtkObserverMediator *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkObserverMediator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

typedef vtkObject vtkObserverMediator::Superclass

Standard macros.

Definition at line 49 of file vtkObserverMediator.h.

Constructor & Destructor Documentation

vtkObserverMediator::vtkObserverMediator ( )

protected

vtkObserverMediator::~vtkObserverMediator ( )

protected

Member Function Documentation

static vtkObserverMediator* vtkObserverMediator::New ( )

static

Instantiate the class.

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

static

Standard macros.

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

virtual

Standard macros.

Reimplemented from vtkObject.

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

static

Standard macros.

virtual vtkObjectBase* vtkObserverMediator::NewInstanceInternal ( ) const

protectedvirtual

Standard macros.

Reimplemented from vtkObject.

vtkObserverMediator* vtkObserverMediator::NewInstance ( ) const

Standard macros.

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

virtual

Standard macros.

Reimplemented from vtkObject.

void vtkObserverMediator::SetInteractor ( vtkRenderWindowInteractor * iren )

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

virtual vtkRenderWindowInteractor* vtkObserverMediator::GetInteractor ( )

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

vtkRenderWindowInteractor* vtkObserverMediator::Interactor

protected

Definition at line 74 of file vtkObserverMediator.h.

vtkObserverMap* vtkObserverMediator::ObserverMap

protected

Definition at line 79 of file vtkObserverMediator.h.

vtkInteractorObserver* vtkObserverMediator::CurrentObserver

protected

Definition at line 82 of file vtkObserverMediator.h.

int vtkObserverMediator::CurrentCursorShape

protected

Definition at line 83 of file vtkObserverMediator.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Core/vtkObserverMediator.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation