create an instance of any VTK class from its name. More...
#include <vtkInstantiator.h>
Public Types | |
| typedef vtkObject | Superclass |
| typedef vtkObject *(* | CreateFunction )() |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkInstantiator * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
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) |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkInstantiator () | |
| ~vtkInstantiator () | |
Static Protected Member Functions | |
| static void | ClassInitialize () |
| static void | ClassFinalize () |
Static Protected Attributes | |
| static vtkInstantiatorHashTable * | CreatorTable |
Friends | |
| class | vtkInstantiatorInitialize |
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 |
Reimplemented from vtkObject.
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] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
| static int vtkInstantiator::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 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] |
Reimplemented from vtkObject.
| virtual vtkObjectBase* vtkInstantiator::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkObject.
| vtkInstantiator* vtkInstantiator::NewInstance | ( | ) | const |
Reimplemented from vtkObject.
| void vtkInstantiator::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
| 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 | ( | ) | [static, protected] |
| static void vtkInstantiator::ClassFinalize | ( | ) | [static, protected] |
Friends And Related Function Documentation
friend class vtkInstantiatorInitialize [friend] |
Definition at line 114 of file vtkInstantiator.h.
Member Data Documentation
vtkInstantiatorHashTable* vtkInstantiator::CreatorTable [static, protected] |
Definition at line 108 of file vtkInstantiator.h.
The documentation for this class was generated from the following file:
- dox/Common/Core/vtkInstantiator.h
