VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkObjectIdMap Class Reference

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:
Inheritance graph
[legend]
Collaboration diagram for vtkObjectIdMap:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkObjectIdMapNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
vtkTypeUInt32 GetGlobalId (vtkObject *obj)
vtkObjectGetVTKObject (vtkTypeUInt32 globalId)
vtkTypeUInt32 SetActiveObject (const char *objectType, vtkObject *obj)
vtkObjectGetActiveObject (const char *objectType)
void FreeObject (vtkObject *obj)

Static Public Member Functions

static vtkObjectIdMapNew ()
static int IsTypeOf (const char *type)
static vtkObjectIdMapSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkObjectIdMap ()
 ~vtkObjectIdMap ()

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

Reimplemented from vtkObject.

Definition at line 30 of file vtkObjectIdMap.h.


Constructor & Destructor Documentation


Member Function Documentation

static vtkObjectIdMap* vtkObjectIdMap::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkObjectIdMap::IsTypeOf ( const char *  name) [static]

Return 1 if this class type 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.

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.

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkObjectIdMap::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

Reimplemented from vtkObject.

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

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


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