class used to assign Id to any VTK object and be able to retreive it base on its id. More...

#include <vtkObjectIdMap.h>

Inheritance diagram for vtkObjectIdMap:

Collaboration diagram for vtkObjectIdMap:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkObjectIdMap *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

vtkTypeUInt32	GetGlobalId (vtkObject *obj)

vtkObject *	GetVTKObject (vtkTypeUInt32 globalId)

vtkTypeUInt32	SetActiveObject (const char objectType, vtkObject obj)

vtkObject *	GetActiveObject (const char *objectType)

void	FreeObject (vtkObject *obj)

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 vtkObjectIdMap *	New ()

static int	IsTypeOf (const char *type)

static vtkObjectIdMap *	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

	vtkObjectIdMap ()

	~vtkObjectIdMap ()

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

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

class used to assign Id to any VTK object and be able to retreive it base on its id.

Definition at line 26 of file vtkObjectIdMap.h.

Member Typedef Documentation

typedef vtkObject vtkObjectIdMap::Superclass

Definition at line 30 of file vtkObjectIdMap.h.

Constructor & Destructor Documentation

vtkObjectIdMap::vtkObjectIdMap ( )

protected

vtkObjectIdMap::~vtkObjectIdMap ( )

protected

Member Function Documentation

static vtkObjectIdMap* vtkObjectIdMap::New ( )

static

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

static

virtual int vtkObjectIdMap::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.

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

static

virtual vtkObjectBase* vtkObjectIdMap::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkObjectIdMap* vtkObjectIdMap::NewInstance ( ) const

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

vtkTypeUInt32 vtkObjectIdMap::GetGlobalId ( vtkObject * obj )

Retreive a unique identifier for the given object or generate a new one if its global id was never requested.

vtkObject* vtkObjectIdMap::GetVTKObject ( vtkTypeUInt32 globalId )

Retreive a vtkObject based on its global id. If not found return NULL

vtkTypeUInt32 vtkObjectIdMap::SetActiveObject	(	const char *	objectType,
		vtkObject *	obj
	)

Assign an active key (string) to an existing object. This is usually used to provide another type of access to specific vtkObject that we want to retreive easily using a string. Return the global Id of the given registered object

vtkObject* vtkObjectIdMap::GetActiveObject ( const char * objectType )

Retreive a previously stored object based on a name

void vtkObjectIdMap::FreeObject ( vtkObject * obj )

Remove any internal reference count due to internal Id/Object mapping

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation