ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkObjectFactory Class Reference

vtkObjectFactory - abstract base class for vtkObjectFactories More...

Inheritance diagram for Kitware.VTK.vtkObjectFactory:
[legend]
Collaboration diagram for Kitware.VTK.vtkObjectFactory:
[legend]

List of all members.

Public Member Functions

 vtkObjectFactory (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
delegate IntPtr CreateFunction ()
 This returns the path to a dynamically loaded factory.
virtual void Disable (string className)
 Set all enable flags for the given class to 0. This will mean that the factory will stop producing class with the given name.
virtual string GetClassOverrideName (int index)
 Return the name of a class override at the given index.
virtual string GetClassOverrideWithName (int index)
 Return the name of the class that will override the class at the given index.
virtual string GetDescription ()
 Return a descriptive string describing the factory.
virtual int GetEnableFlag (int index)
 Return the enable flag for the class at the given index.
virtual int GetEnableFlag (string className, string subclassName)
 Set and Get the Enable flag for the specific override of className. if subclassName is null, then it is ignored.
virtual string GetLibraryPath ()
 This returns the path to a dynamically loaded factory.
virtual int GetNumberOfOverrides ()
 Return number of overrides this factory can create.
virtual string GetOverrideDescription (int index)
 Return the description for a the class override at the given index.
virtual string GetVTKSourceVersion ()
 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.
virtual int HasOverride (string className)
 Return 1 if this factory overrides the given class name, 0 otherwise.
virtual int HasOverride (string className, string subclassName)
 Return 1 if this factory overrides the given class name, 0 otherwise.
override int IsA (string type)
 Methods from vtkObject.
new vtkObjectFactory NewInstance ()
 Methods from vtkObject.
virtual void SetEnableFlag (int flag, string className, string subclassName)
 Set and Get the Enable flag for the specific override of className. if subclassName is null, then it is ignored.

Static Public Member Functions

static void CreateAllInstance (string vtkclassname, vtkCollection retList)
 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.
static vtkObject CreateInstance (string vtkclassname)
 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.
static void GetOverrideInformation (string name, vtkOverrideInformationCollection arg1)
 Fill the given collection with all the overrides for the class with the given name.
static vtkObjectFactoryCollection GetRegisteredFactories ()
 Return the list of all registered factories. This is NOT a copy, do not remove items from this list!
static int HasOverrideAny (string className)
 return 1 if one of the registered factories overrides the given class name
static new int IsTypeOf (string type)
 Methods from vtkObject.
static void ReHash ()
 Re-check the VTK_AUTOLOAD_PATH for new factory libraries. This calls UnRegisterAll before re-loading.
static void RegisterFactory (vtkObjectFactory arg0)
 Register a factory so it can be used to create vtk objects.
static new vtkObjectFactory SafeDownCast (vtkObjectBase o)
 Methods from vtkObject.
static void SetAllEnableFlags (int flag, string className)
 Set the enable flag for a given named class for all registered factories.
static void SetAllEnableFlags (int flag, string className, string subclassName)
 Set the enable flag for a given named class subclass pair for all registered factories.
static void UnRegisterAllFactories ()
 Unregister all factories.
static void UnRegisterFactory (vtkObjectFactory arg0)
 Remove a factory from the list of registered factories.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkObjectFactory"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkObjectFactory"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal void vtkObjectFactory_CreateAllInstance_01 (string vtkclassname, HandleRef retList)
static internal IntPtr vtkObjectFactory_CreateInstance_02 (string vtkclassname, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkObjectFactory_Disable_03 (HandleRef pThis, string className)
static internal IntPtr vtkObjectFactory_GetClassOverrideName_04 (HandleRef pThis, int index)
static internal IntPtr vtkObjectFactory_GetClassOverrideWithName_05 (HandleRef pThis, int index)
static internal IntPtr vtkObjectFactory_GetDescription_06 (HandleRef pThis)
static internal int vtkObjectFactory_GetEnableFlag_07 (HandleRef pThis, int index)
static internal int vtkObjectFactory_GetEnableFlag_08 (HandleRef pThis, string className, string subclassName)
static internal IntPtr vtkObjectFactory_GetLibraryPath_09 (HandleRef pThis)
static internal int vtkObjectFactory_GetNumberOfOverrides_10 (HandleRef pThis)
static internal IntPtr vtkObjectFactory_GetOverrideDescription_11 (HandleRef pThis, int index)
static internal void vtkObjectFactory_GetOverrideInformation_12 (string name, HandleRef arg1)
static internal IntPtr vtkObjectFactory_GetRegisteredFactories_13 (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkObjectFactory_GetVTKSourceVersion_14 (HandleRef pThis)
static internal int vtkObjectFactory_HasOverride_15 (HandleRef pThis, string className)
static internal int vtkObjectFactory_HasOverride_16 (HandleRef pThis, string className, string subclassName)
static internal int vtkObjectFactory_HasOverrideAny_17 (string className)
static internal int vtkObjectFactory_IsA_18 (HandleRef pThis, string type)
static internal int vtkObjectFactory_IsTypeOf_19 (string type)
static internal IntPtr vtkObjectFactory_NewInstance_20 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkObjectFactory_ReHash_21 ()
static internal void vtkObjectFactory_RegisterFactory_22 (HandleRef arg0)
static internal IntPtr vtkObjectFactory_SafeDownCast_23 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkObjectFactory_SetAllEnableFlags_24 (int flag, string className)
static internal void vtkObjectFactory_SetAllEnableFlags_25 (int flag, string className, string subclassName)
static internal void vtkObjectFactory_SetEnableFlag_26 (HandleRef pThis, int flag, string className, string subclassName)
static internal void vtkObjectFactory_UnRegisterAllFactories_27 ()
static internal void vtkObjectFactory_UnRegisterFactory_28 (HandleRef arg0)

Static Private Member Functions

static vtkObjectFactory ()
 Automatically generated type registration mechanics.

Detailed Description

vtkObjectFactory - abstract base class for vtkObjectFactories

Description 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.


Constructor & Destructor Documentation

static Kitware.VTK.vtkObjectFactory.vtkObjectFactory ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkObjectFactory.vtkObjectFactory ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.


Member Function Documentation

static void Kitware.VTK.vtkObjectFactory.CreateAllInstance ( string  vtkclassname,
vtkCollection  retList 
) [static]

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.

This returns the path to a dynamically loaded factory.

static vtkObject Kitware.VTK.vtkObjectFactory.CreateInstance ( string  vtkclassname) [static]

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.

virtual void Kitware.VTK.vtkObjectFactory.Disable ( string  className) [virtual]

Set all enable flags for the given class to 0. This will mean that the factory will stop producing class with the given name.

override void Kitware.VTK.vtkObjectFactory.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkParallelFactory.

virtual string Kitware.VTK.vtkObjectFactory.GetClassOverrideName ( int  index) [virtual]

Return the name of a class override at the given index.

virtual string Kitware.VTK.vtkObjectFactory.GetClassOverrideWithName ( int  index) [virtual]

Return the name of the class that will override the class at the given index.

virtual string Kitware.VTK.vtkObjectFactory.GetDescription ( ) [virtual]

Return a descriptive string describing the factory.

Reimplemented in Kitware.VTK.vtkParallelFactory.

virtual int Kitware.VTK.vtkObjectFactory.GetEnableFlag ( int  index) [virtual]

Return the enable flag for the class at the given index.

virtual int Kitware.VTK.vtkObjectFactory.GetEnableFlag ( string  className,
string  subclassName 
) [virtual]

Set and Get the Enable flag for the specific override of className. if subclassName is null, then it is ignored.

virtual string Kitware.VTK.vtkObjectFactory.GetLibraryPath ( ) [virtual]

This returns the path to a dynamically loaded factory.

Return number of overrides this factory can create.

virtual string Kitware.VTK.vtkObjectFactory.GetOverrideDescription ( int  index) [virtual]

Return the description for a the class override at the given index.

Fill the given collection with all the overrides for the class with the given name.

Return the list of all registered factories. This is NOT a copy, do not remove items from this list!

Here is the call graph for this function:

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.

Reimplemented in Kitware.VTK.vtkParallelFactory.

virtual int Kitware.VTK.vtkObjectFactory.HasOverride ( string  className) [virtual]

Return 1 if this factory overrides the given class name, 0 otherwise.

virtual int Kitware.VTK.vtkObjectFactory.HasOverride ( string  className,
string  subclassName 
) [virtual]

Return 1 if this factory overrides the given class name, 0 otherwise.

static int Kitware.VTK.vtkObjectFactory.HasOverrideAny ( string  className) [static]

return 1 if one of the registered factories overrides the given class name

override int Kitware.VTK.vtkObjectFactory.IsA ( string  type) [virtual]

Methods from vtkObject.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkParallelFactory.

static new int Kitware.VTK.vtkObjectFactory.IsTypeOf ( string  type) [static]

Methods from vtkObject.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkParallelFactory.

Methods from vtkObject.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkParallelFactory.

Register a factory so it can be used to create vtk objects.

static void Kitware.VTK.vtkObjectFactory.ReHash ( ) [static]

Re-check the VTK_AUTOLOAD_PATH for new factory libraries. This calls UnRegisterAll before re-loading.

Methods from vtkObject.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkParallelFactory.

Here is the call graph for this function:

static void Kitware.VTK.vtkObjectFactory.SetAllEnableFlags ( int  flag,
string  className 
) [static]

Set the enable flag for a given named class for all registered factories.

static void Kitware.VTK.vtkObjectFactory.SetAllEnableFlags ( int  flag,
string  className,
string  subclassName 
) [static]

Set the enable flag for a given named class subclass pair for all registered factories.

virtual void Kitware.VTK.vtkObjectFactory.SetEnableFlag ( int  flag,
string  className,
string  subclassName 
) [virtual]

Set and Get the Enable flag for the specific override of className. if subclassName is null, then it is ignored.

Unregister all factories.

Remove a factory from the list of registered factories.

static internal void Kitware.VTK.vtkObjectFactory.vtkObjectFactory_CreateAllInstance_01 ( string  vtkclassname,
HandleRef  retList 
) [private]
static internal IntPtr Kitware.VTK.vtkObjectFactory.vtkObjectFactory_CreateInstance_02 ( string  vtkclassname,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkObjectFactory.vtkObjectFactory_Disable_03 ( HandleRef  pThis,
string  className 
) [private]
static internal IntPtr Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetClassOverrideName_04 ( HandleRef  pThis,
int  index 
) [private]
static internal IntPtr Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetClassOverrideWithName_05 ( HandleRef  pThis,
int  index 
) [private]
static internal IntPtr Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetDescription_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetEnableFlag_07 ( HandleRef  pThis,
int  index 
) [private]
static internal int Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetEnableFlag_08 ( HandleRef  pThis,
string  className,
string  subclassName 
) [private]
static internal IntPtr Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetLibraryPath_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetNumberOfOverrides_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetOverrideDescription_11 ( HandleRef  pThis,
int  index 
) [private]
static internal void Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetOverrideInformation_12 ( string  name,
HandleRef  arg1 
) [private]
static internal IntPtr Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetRegisteredFactories_13 ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkObjectFactory.vtkObjectFactory_GetVTKSourceVersion_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkObjectFactory.vtkObjectFactory_HasOverride_15 ( HandleRef  pThis,
string  className 
) [private]
static internal int Kitware.VTK.vtkObjectFactory.vtkObjectFactory_HasOverride_16 ( HandleRef  pThis,
string  className,
string  subclassName 
) [private]
static internal int Kitware.VTK.vtkObjectFactory.vtkObjectFactory_HasOverrideAny_17 ( string  className) [private]
static internal int Kitware.VTK.vtkObjectFactory.vtkObjectFactory_IsA_18 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkObjectFactory.vtkObjectFactory_IsTypeOf_19 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkObjectFactory.vtkObjectFactory_NewInstance_20 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkObjectFactory.vtkObjectFactory_RegisterFactory_22 ( HandleRef  arg0) [private]
static internal void Kitware.VTK.vtkObjectFactory.vtkObjectFactory_ReHash_21 ( ) [private]
static internal IntPtr Kitware.VTK.vtkObjectFactory.vtkObjectFactory_SafeDownCast_23 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkObjectFactory.vtkObjectFactory_SetAllEnableFlags_24 ( int  flag,
string  className 
) [private]
static internal void Kitware.VTK.vtkObjectFactory.vtkObjectFactory_SetAllEnableFlags_25 ( int  flag,
string  className,
string  subclassName 
) [private]
static internal void Kitware.VTK.vtkObjectFactory.vtkObjectFactory_SetEnableFlag_26 ( HandleRef  pThis,
int  flag,
string  className,
string  subclassName 
) [private]
static internal void Kitware.VTK.vtkObjectFactory.vtkObjectFactory_UnRegisterFactory_28 ( HandleRef  arg0) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkObjectFactory.MRClassNameKey = "16vtkObjectFactory" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkParallelFactory.

new const string Kitware.VTK.vtkObjectFactory.MRFullTypeName = "Kitware.VTK.vtkObjectFactory"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkParallelFactory.


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