vtkInstantiator Class Reference

create an instance of any VTK class from its name. More...

#include <vtkInstantiator.h>

Inheritance diagram for vtkInstantiator:

Collaboration diagram for vtkInstantiator:

Public Types
typedef vtkObject	Superclass
typedef vtkObject *(*	CreateFunction) ()
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkInstantiator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
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 vtkInstantiator *	New ()
static int	IsTypeOf (const char *type)
static vtkInstantiator *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	CreateInstance (const char *className)
static void	RegisterInstantiator (const char *className, CreateFunction createFunction)
static void	UnRegisterInstantiator (const char *className, CreateFunction createFunction)
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
	vtkInstantiator ()
	~vtkInstantiator ()
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 &)

Static Protected Member Functions
static void	ClassInitialize ()
static void	ClassFinalize ()

Static Protected Attributes
static vtkInstantiatorHashTable *	CreatorTable

Friends
class	vtkInstantiatorInitialize

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

create an instance of any VTK class from its name.

vtkInstantiator provides an interface to create an instance of any VTK class from its name. Instances are created through registered pointers to functions returning the objects. New classes can also be registered with the creator. VTK libraries automatically register their classes with the creator when they are loaded. Instances are created using the static New() method, so the normal vtkObjectFactory mechanism is still invoked.

When using this class from language wrappers (Tcl, Python, or Java), the vtkInstantiator should be able to create any class from any kit that has been loaded.

In C++ code, one should include the header for each kit from which one wishes to create instances through vtkInstantiator. This is necessary to ensure proper linking when building static libraries. Be careful, though, because including each kit's header means every class from that kit will be linked into your executable whether or not the class is used. The headers are:

vtkCommon - vtkCommonInstantiator.h vtkFiltering - vtkFilteringInstantiator.h vtkIO - vtkIOInstantiator.h vtkImaging - vtkImagingInstantiator.h vtkGraphics - vtkGraphicsInstantiator.h vtkRendering - vtkRenderingInstantiator.h vtkVolumeRendering - vtkVolumeRenderingInstantiator.h vtkHybrid - vtkHybridInstantiator.h vtkParallel - vtkParallelInstantiator.h

The VTK_MAKE_INSTANTIATOR() command in CMake is used to automatically generate the creator registration for each VTK library. It can also be used to create registration code for VTK-style user libraries that are linked to vtkCommon. After using this command to register classes from a new library, the generated header must be included.

Tests:

vtkInstantiator (Tests)

Definition at line 71 of file vtkInstantiator.h.

Member Typedef Documentation

typedef vtkObject vtkInstantiator::Superclass

Definition at line 75 of file vtkInstantiator.h.

typedef vtkObject*(* vtkInstantiator::CreateFunction) ()

Definition at line 83 of file vtkInstantiator.h.

Constructor & Destructor Documentation

vtkInstantiator::vtkInstantiator ( )

protected

vtkInstantiator::~vtkInstantiator ( )

protected

Member Function Documentation

static vtkInstantiator* vtkInstantiator::New ( )

static

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

static

virtual int vtkInstantiator::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 vtkInstantiator* vtkInstantiator::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkInstantiator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkInstantiator* vtkInstantiator::NewInstance

(

)

const

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

static vtkObject* vtkInstantiator::CreateInstance ( const char *  className )

static

Create an instance of the class whose name is given. If creation fails, a NULL pointer is returned.

static void vtkInstantiator::RegisterInstantiator ( const char *  className, CreateFunction  createFunction  )

static

Register a function to create instances of the class whose name is given. This allows more than one create function to be registered for the same class. The first one registered is used until it is unregistered.

static void vtkInstantiator::UnRegisterInstantiator ( const char *  className, CreateFunction  createFunction  )

static

Unregister the instance creation of the class whose name is given. This will unregister the function given, but any other function registered for the same class will be left untouched.

static void vtkInstantiator::ClassInitialize ( )

staticprotected

static void vtkInstantiator::ClassFinalize ( )

staticprotected

Friends And Related Function Documentation

friend class vtkInstantiatorInitialize

friend

Definition at line 114 of file vtkInstantiator.h.

Member Data Documentation

vtkInstantiatorHashTable* vtkInstantiator::CreatorTable

staticprotected

Definition at line 108 of file vtkInstantiator.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkInstantiator.h