|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkObjectFactory * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Print ObjectFactory to stream.
|
|
virtual const char * | GetVTKSourceVersion ()=0 |
| All sub-classes of vtkObjectFactory should must return the version of VTK they were built with.
|
|
virtual const char * | GetDescription ()=0 |
| Return a descriptive string describing the factory.
|
|
virtual int | GetNumberOfOverrides () |
| Return number of overrides this factory can create.
|
|
virtual const char * | GetClassOverrideName (int index) |
| Return the name of a class override at the given index.
|
|
virtual const char * | GetClassOverrideWithName (int index) |
| Return the name of the class that will override the class at the given index.
|
|
virtual vtkTypeBool | GetEnableFlag (int index) |
| Return the enable flag for the class at the given index.
|
|
virtual const char * | GetOverrideDescription (int index) |
| Return the description for a the class override at the given index.
|
|
virtual int | HasOverride (const char *className) |
| Return 1 if this factory overrides the given class name, 0 otherwise.
|
|
virtual int | HasOverride (const char *className, const char *subclassName) |
| Return 1 if this factory overrides the given class name, 0 otherwise.
|
|
virtual void | Disable (const char *className) |
| Set all enable flags for the given class to 0.
|
|
|
virtual void | SetEnableFlag (vtkTypeBool flag, const char *className, const char *subclassName) |
| Set and Get the Enable flag for the specific override of className.
|
|
virtual vtkTypeBool | GetEnableFlag (const char *className, const char *subclassName) |
| Set and Get the Enable flag for the specific override of className.
|
|
|
| vtkGetFilePathMacro (LibraryPath) |
| This returns the path to a dynamically loaded factory.
|
|
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
|
virtual void | DebugOn () |
| Turn debugging output on.
|
|
virtual void | DebugOff () |
| Turn debugging output off.
|
|
bool | GetDebug () |
| Get the value of the debug flag.
|
|
void | SetDebug (bool debugFlag) |
| Set the value of the debug flag.
|
|
virtual void | Modified () |
| Update the modification time for this object.
|
|
virtual vtkMTimeType | GetMTime () |
| Return this object's modified time.
|
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
void | RemoveObserver (unsigned long tag) |
|
void | RemoveObservers (unsigned long event) |
|
void | RemoveObservers (const char *event) |
|
void | RemoveAllObservers () |
|
vtkTypeBool | HasObserver (unsigned long event) |
|
vtkTypeBool | HasObserver (const char *event) |
|
int | InvokeEvent (unsigned long event) |
|
int | InvokeEvent (const char *event) |
|
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method.
|
|
int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not.
|
|
int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not.
|
|
const char * | GetClassName () const |
| Return the class name as a string.
|
|
virtual vtkTypeBool | IsA (const char *name) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
| Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
|
virtual void | Delete () |
| Delete a VTK object.
|
|
virtual void | FastDelete () |
| Delete a reference to this object.
|
|
void | InitializeObjectBase () |
|
void | Print (ostream &os) |
| Print an object to an ostream.
|
|
virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object).
|
|
virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object).
|
|
int | GetReferenceCount () |
| Return the current reference count of this object.
|
|
void | SetReferenceCount (int) |
| Sets the reference count.
|
|
bool | GetIsInMemkind () const |
| A local state flag that remembers whether this object lives in the normal or extended memory space.
|
|
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses.
|
|
|
static vtkObject * | CreateInstance (const char *vtkclassname, bool isAbstract=false) |
| Create and return an instance of the named vtk object.
|
|
static void | CreateAllInstance (const char *vtkclassname, vtkCollection *retList) |
| Create all possible instances of the named vtk object.
|
|
static void | ReHash () |
| Re-check the VTK_AUTOLOAD_PATH for new factory libraries.
|
|
static void | RegisterFactory (vtkObjectFactory *) |
| Register a factory so it can be used to create vtk objects.
|
|
static void | UnRegisterFactory (vtkObjectFactory *) |
| Remove a factory from the list of registered factories.
|
|
static void | UnRegisterAllFactories () |
| Unregister all factories.
|
|
static vtkObjectFactoryCollection * | GetRegisteredFactories () |
| Return the list of all registered factories.
|
|
static int | HasOverrideAny (const char *className) |
| return 1 if one of the registered factories overrides the given class name
|
|
static void | GetOverrideInformation (const char *name, vtkOverrideInformationCollection *) |
| Fill the given collection with all the overrides for the class with the given name.
|
|
static void | SetAllEnableFlags (vtkTypeBool flag, const char *className) |
| Set the enable flag for a given named class for all registered factories.
|
|
static void | SetAllEnableFlags (vtkTypeBool flag, const char *className, const char *subclassName) |
| Set the enable flag for a given named class subclass pair for all registered factories.
|
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkObjectFactory * | SafeDownCast (vtkObjectBase *o) |
|
static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
|
static void | BreakOnError () |
| This method is called when vtkErrorMacro executes.
|
|
static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class.
|
|
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
| Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
|
static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
|
static void | SetMemkindDirectory (const char *directoryname) |
| The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
|
|
static bool | GetUsingMemkind () |
| A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
|
|
abstract base class for vtkObjectFactories
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, 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.
- Online Examples:
Definition at line 161 of file vtkObjectFactory.h.