147#ifndef vtkObjectFactory_h
148#define vtkObjectFactory_h
150#include "vtkCommonCoreModule.h"
152#include "vtkFeatures.h"
298 virtual int HasOverride(
const char* className,
const char* subclassName);
321 const char* description,
int enableFlag, CreateFunction createFunction);
347 void GrowOverrideArray();
357 static void RegisterDefaults();
361 static void LoadDynamicFactories();
365 static void LoadLibrariesInPath(
const std::string&);
373 char* LibraryVTKVersion;
397#define VTK_CREATE_CREATE_FUNCTION(classname) \
398 static vtkObject* vtkObjectFactoryCreate##classname() { return classname::New(); }
402#define VTK_FACTORY_INTERFACE_EXPORT VTKCOMMONCORE_EXPORT
409#define VTK_FACTORY_INTERFACE_IMPLEMENT(factoryName) \
410 extern "C" VTK_FACTORY_INTERFACE_EXPORT const char* vtkGetFactoryVersion() \
412 return VTK_SOURCE_VERSION; \
414 extern "C" VTK_FACTORY_INTERFACE_EXPORT vtkObjectFactory* vtkLoad() \
416 return factoryName ::New(); \
420#define VTK_OBJECT_FACTORY_NEW_BODY(thisClass) \
421 vtkObject* ret = vtkObjectFactory::CreateInstance(#thisClass, false); \
424 return static_cast<thisClass*>(ret); \
426 auto result = new thisClass; \
427 result->InitializeObjectBase(); \
433#define VTK_ABSTRACT_OBJECT_FACTORY_NEW_BODY(thisClass) \
434 vtkObject* ret = vtkObjectFactory::CreateInstance(#thisClass, true); \
437 return static_cast<thisClass*>(ret); \
439 vtkGenericWarningMacro("Error: no override found for '" #thisClass "'."); \
443#if defined(VTK_ALL_NEW_OBJECT_FACTORY)
444#define VTK_STANDARD_NEW_BODY(thisClass) VTK_OBJECT_FACTORY_NEW_BODY(thisClass)
446#define VTK_STANDARD_NEW_BODY(thisClass) \
447 auto result = new thisClass; \
448 result->InitializeObjectBase(); \
453#define vtkStandardNewMacro(thisClass) \
454 thisClass* thisClass::New() { VTK_STANDARD_NEW_BODY(thisClass); }
458#define vtkStandardExtendedNewMacro(thisClass) \
459 thisClass* thisClass::ExtendedNew() \
461 auto mkhold = vtkMemkindRAII(true); \
463 return thisClass::New(); \
467#define vtkObjectFactoryNewMacro(thisClass) \
468 thisClass* thisClass::New() { VTK_OBJECT_FACTORY_NEW_BODY(thisClass); }
473#define vtkAbstractObjectFactoryNewMacro(thisClass) \
474 thisClass* thisClass::New() { VTK_ABSTRACT_OBJECT_FACTORY_NEW_BODY(thisClass); }
create and manipulate ordered lists of objects
a simple class to control print indentation
maintain a list of object factories
vtkObjectFactoryRegistryCleanup()
~vtkObjectFactoryRegistryCleanup()
abstract base class for vtkObjectFactories
virtual const char * GetClassOverrideWithName(int index)
Return the name of the class that will override the class at the given index.
virtual const char * GetDescription()=0
Return a descriptive string describing the factory.
virtual void Disable(const char *className)
Set all enable flags for the given class to 0.
void PrintSelf(ostream &os, vtkIndent indent) override
Print ObjectFactory to stream.
static void SetAllEnableFlags(vtkTypeBool flag, const char *className)
Set the enable flag for a given named class for all registered factories.
static vtkObject * CreateInstance(const char *vtkclassname, bool isAbstract=false)
Create and return an instance of the named vtk object.
virtual vtkTypeBool GetEnableFlag(int index)
Return the enable flag for the class at the given index.
virtual const char * GetVTKSourceVersion()=0
All sub-classes of vtkObjectFactory should must return the version of VTK they were built with.
virtual const char * GetClassOverrideName(int index)
Return the name of a class override at the given index.
static vtkObjectFactoryCollection * GetRegisteredFactories()
Return the list of all registered factories.
virtual int GetNumberOfOverrides()
Return number of overrides this factory can create.
static void GetOverrideInformation(const char *name, vtkOverrideInformationCollection *)
Fill the given collection with all the overrides for the class with the given name.
char ** OverrideClassNames
virtual void SetEnableFlag(vtkTypeBool flag, const char *className, const char *subclassName)
Set and Get the Enable flag for the specific override of className.
virtual const char * GetOverrideDescription(int index)
Return the description for a the class override at the given index.
static void CreateAllInstance(const char *vtkclassname, vtkCollection *retList)
Create all possible instances of the named vtk object.
OverrideInformation * OverrideArray
static void UnRegisterFactory(vtkObjectFactory *)
Remove a factory from the list of registered factories.
void RegisterOverride(const char *classOverride, const char *overrideClassName, const char *description, int enableFlag, CreateFunction createFunction)
Register object creation information with the factory.
virtual vtkTypeBool GetEnableFlag(const char *className, const char *subclassName)
Set and Get the Enable flag for the specific override of className.
static int HasOverrideAny(const char *className)
return 1 if one of the registered factories overrides the given class name
virtual vtkObject * CreateObject(const char *vtkclassname)
This method is provided by sub-classes of vtkObjectFactory.
virtual int HasOverride(const char *className)
Return 1 if this factory overrides the given class name, 0 otherwise.
static void ReHash()
Re-check the VTK_AUTOLOAD_PATH for new factory libraries.
static void UnRegisterAllFactories()
Unregister all 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.
~vtkObjectFactory() override
static void RegisterFactory(vtkObjectFactory *)
Register a factory so it can be used to create vtk objects.
vtkGetFilePathMacro(LibraryPath)
This returns the path to a dynamically loaded factory.
virtual int HasOverride(const char *className, const char *subclassName)
Return 1 if this factory overrides the given class name, 0 otherwise.
abstract base class for most VTK objects
static vtkObjectFactoryRegistryCleanup vtkObjectFactoryRegistryCleanupInstance