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.vtkInstantiator Class Reference

vtkInstantiator - create an instance of any VTK class from its name. More...

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

List of all members.

Public Member Functions

 vtkInstantiator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkInstantiator ()
 Undocumented Block.
delegate IntPtr CreateFunction ()
 Create an instance of the class whose name is given. If creation fails, a NULL pointer is returned.
override int IsA (string type)
 Undocumented Block.
new vtkInstantiator NewInstance ()
 Undocumented Block.

Static Public Member Functions

static new vtkInstantiator New ()
 Undocumented Block.
static vtkObject CreateInstance (string className)
 Create an instance of the class whose name is given. If creation fails, a NULL pointer is returned.
static new int IsTypeOf (string type)
 Undocumented Block.
static void RegisterInstantiator (string className, CreateFunction createFunction)
 Create an instance of the class whose name is given. If creation fails, a NULL pointer is returned.
static new vtkInstantiator SafeDownCast (vtkObjectBase o)
 Undocumented Block.
static void UnRegisterInstantiator (string className, CreateFunction createFunction)
 Create an instance of the class whose name is given. If creation fails, a NULL pointer is returned.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkInstantiator"
 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 IntPtr vtkInstantiator_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkInstantiator_CreateInstance_01 (string className, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkInstantiator_IsA_02 (HandleRef pThis, string type)
static internal int vtkInstantiator_IsTypeOf_03 (string type)
static internal IntPtr vtkInstantiator_NewInstance_05 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkInstantiator_RegisterInstantiator_06 (string className, CreateFunction createFunction)
static internal IntPtr vtkInstantiator_SafeDownCast_07 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkInstantiator_UnRegisterInstantiator_08 (string className, CreateFunction createFunction)

Static Private Member Functions

static vtkInstantiator ()
 Automatically generated type registration mechanics.

Detailed Description

vtkInstantiator - create an instance of any VTK class from its name.

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


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

Create an instance of the class whose name is given. If creation fails, a NULL pointer is returned.

static vtkObject Kitware.VTK.vtkInstantiator.CreateInstance ( string  className) [static]

Create an instance of the class whose name is given. If creation fails, a NULL pointer is returned.

override void Kitware.VTK.vtkInstantiator.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.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static void Kitware.VTK.vtkInstantiator.RegisterInstantiator ( string  className,
CreateFunction  createFunction 
) [static]

Create an instance of the class whose name is given. If creation fails, a NULL pointer is returned.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

static void Kitware.VTK.vtkInstantiator.UnRegisterInstantiator ( string  className,
CreateFunction  createFunction 
) [static]

Create an instance of the class whose name is given. If creation fails, a NULL pointer is returned.

static internal IntPtr Kitware.VTK.vtkInstantiator.vtkInstantiator_CreateInstance_01 ( string  className,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkInstantiator.vtkInstantiator_IsA_02 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkInstantiator.vtkInstantiator_IsTypeOf_03 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkInstantiator.vtkInstantiator_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkInstantiator.vtkInstantiator_NewInstance_05 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkInstantiator.vtkInstantiator_RegisterInstantiator_06 ( string  className,
CreateFunction  createFunction 
) [private]
static internal IntPtr Kitware.VTK.vtkInstantiator.vtkInstantiator_SafeDownCast_07 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkInstantiator.vtkInstantiator_UnRegisterInstantiator_08 ( string  className,
CreateFunction  createFunction 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkInstantiator.MRClassNameKey = "15vtkInstantiator" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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