#include <vtkObjectFactory.h>
Inheritance diagram for vtkObjectFactory:
vtkObjectFactory is used to create vtk objects. The base class vtkObjectFactory contains a static method CreateInstance which is used to create vtk objects from the list of registered vtkObjectFactory sub-classes. The first time CreateInstance is called, all dll's or shared libraries in the environment variable VTK_AUTOLOAD_PATH are loaded into the current process. The C functions vtkLoad, vtkGetFactoryCompilerUsed, and vtkGetFactoryVersion are called on each dll. To implement these functions in a shared library or dll, use the macro: VTK_FACTORY_INTERFACE_IMPLEMENT. VTK_AUTOLOAD_PATH is an environment variable containing a colon separated (semi-colon on win32) list of paths.
The vtkObjectFactory can be use to override the creation of any object in VTK with a sub-class of that object. The factories can be registered either at run time with the VTK_AUTOLOAD_PATH, or at compile time with the vtkObjectFactory::RegisterFactory method.
Definition at line 55 of file vtkObjectFactory.h.
| typedef vtkObject *(* | CreateFunction )() |
| void | RegisterOverride (const char *classOverride, const char *overrideClassName, const char *description, int enableFlag, CreateFunction createFunction) |
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual const char * | GetVTKSourceVersion ()=0 |
| virtual const char * | GetDescription ()=0 |
| virtual int | GetNumberOfOverrides () |
| virtual const char * | GetClassOverrideName (int index) |
| virtual const char * | GetClassOverrideWithName (int index) |
| virtual int | GetEnableFlag (int index) |
| virtual const char * | GetOverrideDescription (int index) |
| virtual void | SetEnableFlag (int flag, const char *className, const char *subclassName) |
| virtual int | GetEnableFlag (const char *className, const char *subclassName) |
| virtual int | HasOverride (const char *className) |
| virtual int | HasOverride (const char *className, const char *subclassName) |
| virtual void | Disable (const char *className) |
| virtual char * | GetLibraryPath () |
Static Public Member Functions | |
| static vtkObjectFactoryCollection * | GetRegisteredFactories () |
| static int | IsTypeOf (const char *type) |
| static vtkObjectFactory * | SafeDownCast (vtkObject *o) |
| static vtkObject * | CreateInstance (const char *vtkclassname) |
| static void | CreateAllInstance (const char *vtkclassname, vtkCollection *retList) |
| static void | ReHash () |
| static void | RegisterFactory (vtkObjectFactory *) |
| static void | UnRegisterFactory (vtkObjectFactory *) |
| static void | UnRegisterAllFactories () |
| static int | HasOverrideAny (const char *className) |
| static void | GetOverrideInformation (const char *name, vtkOverrideInformationCollection *) |
| static void | SetAllEnableFlags (int flag, const char *className) |
| static void | SetAllEnableFlags (int flag, const char *className, const char *subclassName) |
Protected Member Functions | |
| virtual vtkObject * | CreateObject (const char *vtkclassname) |
| vtkObjectFactory () | |
| ~vtkObjectFactory () | |
Protected Attributes | |
| OverrideInformation * | OverrideArray |
| char ** | OverrideClassNames |
| int | SizeOverrideArray |
| int | OverrideArrayLength |
Classes | |
| struct | OverrideInformation |
|
|
Reimplemented from vtkObject. Reimplemented in vtkParallelFactory. Definition at line 118 of file vtkObjectFactory.h. |
|
|
Definition at line 177 of file vtkObjectFactory.h. |
|
|
|
|
|
|
|
|
Create and return an instance of the named vtk object. Each loaded vtkObjectFactory will be asked in the order the factory was in the VTK_AUTOLOAD_PATH. After the first factory returns the object no other factories are asked. |
|
||||||||||||
|
Create all possible instances of the named vtk object. Each registered vtkObjectFactory will be asked, and the result will be stored in the user allocated vtkCollection passed in to the function. |
|
|
Create and return an instance of the named vtk object. Each loaded vtkObjectFactory will be asked in the order the factory was in the VTK_AUTOLOAD_PATH. After the first factory returns the object no other factories are asked. |
|
|
Create and return an instance of the named vtk object. Each loaded vtkObjectFactory will be asked in the order the factory was in the VTK_AUTOLOAD_PATH. After the first factory returns the object no other factories are asked. |
|
|
Create and return an instance of the named vtk object. Each loaded vtkObjectFactory will be asked in the order the factory was in the VTK_AUTOLOAD_PATH. After the first factory returns the object no other factories are asked. |
|
|
Create and return an instance of the named vtk object. Each loaded vtkObjectFactory will be asked in the order the factory was in the VTK_AUTOLOAD_PATH. After the first factory returns the object no other factories are asked. |
|
|
Return the list of all registered factories. This is NOT a copy, do not remove items from this list! |
|
|
return 1 if one of the registered factories overrides the given class name |
|
||||||||||||
|
Fill the given collection with all the overrides for the class with the given name. |
|
||||||||||||
|
Set the enable flag for a given named class for all registered factories. |
|
||||||||||||||||
|
Set the enable flag for a given named class for all registered factories. |
|
|
Reimplemented from vtkObject. Reimplemented in vtkParallelFactory. |
|
|
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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkParallelFactory. |
|
|
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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkParallelFactory. |
|
|
Reimplemented from vtkObject. Reimplemented in vtkParallelFactory. |
|
||||||||||||
|
Print ObjectFactory to stream. Reimplemented from vtkObject. Reimplemented in vtkParallelFactory. |
|
|
All sub-classes of vtkObjectFactory should must return the version of VTK they were built with. This should be implemented with the macro VTK_SOURCE_VERSION and NOT a call to vtkVersion::GetVTKSourceVersion. As the version needs to be compiled into the file as a string constant. This is critical to determine possible incompatible dynamic factory loads. Implemented in vtkParallelFactory. |
|
|
Return a descriptive string describing the factory. Implemented in vtkParallelFactory. |
|
|
Return number of overrides this factory can create. |
|
|
Return the name of a class override at the given index. |
|
|
Return the name of the class that will override the class at the given index |
|
|
Return the enable flag for the class at the given index. |
|
|
Return the description for a the class override at the given index. |
|
||||||||||||||||
|
Set and Get the Enable flag for the specific override of className. if subclassName is null, then it is ignored. |
|
||||||||||||
|
Return the description for a the class override at the given index. |
|
|
Return 1 if this factory overrides the given class name, 0 otherwise. |
|
||||||||||||
|
Return 1 if this factory overrides the given class name, 0 otherwise. |
|
|
Set all enable flags for the given class to 0. This will mean that the factory will stop producing class with the given name. |
|
|
This returns the path to a dynamically loaded factory. |
|
||||||||||||||||||||||||
|
Register object creation information with the factory. |
|
|
This method is provided by sub-classes of vtkObjectFactory. It should create the named vtk object or return 0 if that object is not supported by the factory implementation. |
|
|
Definition at line 210 of file vtkObjectFactory.h. |
|
|
Definition at line 211 of file vtkObjectFactory.h. |
|
|
Definition at line 212 of file vtkObjectFactory.h. |
|
|
Definition at line 213 of file vtkObjectFactory.h. |
1.4.3-20050530