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

vtkPassArrays - Passes a subset of arrays to the output More...

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

List of all members.

Public Member Functions

 vtkPassArrays (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPassArrays ()
 Undocumented Block.
virtual void AddArray (int fieldType, string name)
 Adds an array to pass through. fieldType where the array that should be passed (point data, cell data, etc.). It should be one of the constants defined in the vtkDataObject::AttributeTypes enumeration.
virtual void AddFieldType (int fieldType)
 Add a field type to process. fieldType where the array that should be passed (point data, cell data, etc.). It should be one of the constants defined in the vtkDataObject::AttributeTypes enumeration. NOTE: These are only used if UseFieldType is turned on.
virtual void ClearArrays ()
 Clear all arrays to pass through.
virtual void ClearFieldTypes ()
 Clear all field types to process.
virtual bool GetRemoveArrays ()
 Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.
virtual bool GetUseFieldTypes ()
 Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.
override int IsA (string type)
 Undocumented Block.
new vtkPassArrays NewInstance ()
 Undocumented Block.
virtual void RemoveArraysOff ()
 Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.
virtual void RemoveArraysOn ()
 Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.
virtual void SetRemoveArrays (bool _arg)
 Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.
virtual void SetUseFieldTypes (bool _arg)
 Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.
virtual void UseFieldTypesOff ()
 Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.
virtual void UseFieldTypesOn ()
 Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.

Static Public Member Functions

static new vtkPassArrays New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkPassArrays SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "13vtkPassArrays"
 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 vtkPassArrays_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPassArrays_AddArray_01 (HandleRef pThis, int fieldType, string name)
static internal void vtkPassArrays_AddFieldType_02 (HandleRef pThis, int fieldType)
static internal void vtkPassArrays_ClearArrays_03 (HandleRef pThis)
static internal void vtkPassArrays_ClearFieldTypes_04 (HandleRef pThis)
static internal byte vtkPassArrays_GetRemoveArrays_05 (HandleRef pThis)
static internal byte vtkPassArrays_GetUseFieldTypes_06 (HandleRef pThis)
static internal int vtkPassArrays_IsA_07 (HandleRef pThis, string type)
static internal int vtkPassArrays_IsTypeOf_08 (string type)
static internal IntPtr vtkPassArrays_NewInstance_10 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPassArrays_RemoveArraysOff_11 (HandleRef pThis)
static internal void vtkPassArrays_RemoveArraysOn_12 (HandleRef pThis)
static internal IntPtr vtkPassArrays_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPassArrays_SetRemoveArrays_14 (HandleRef pThis, byte _arg)
static internal void vtkPassArrays_SetUseFieldTypes_15 (HandleRef pThis, byte _arg)
static internal void vtkPassArrays_UseFieldTypesOff_16 (HandleRef pThis)
static internal void vtkPassArrays_UseFieldTypesOn_17 (HandleRef pThis)

Static Private Member Functions

static vtkPassArrays ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPassArrays - Passes a subset of arrays to the output

Description This filter preserves all the topology of the input, but only a subset of arrays are passed to the output. Add an array to be passed to the output data object with AddArray(). If RemoveArrays is on, the specified arrays will be the ones that are removed instead of the ones that are kept.

Arrays with special attributes (scalars, pedigree ids, etc.) will retain those attributes in the output.

By default, only those field types with at least one array specified through AddArray will be processed. If instead UseFieldTypes is turned on, you explicitly set which field types to process with AddFieldType.

Example 1:

<pre> passArray->AddArray(vtkDataObject::POINT, "velocity"); </pre>

The output will have only that one array "velocity" in the point data, but cell and field data will be untouched.

Example 2:

<pre> passArray->AddArray(vtkDataObject::POINT, "velocity"); passArray->UseFieldTypesOn(); passArray->AddFieldType(vtkDataObject::POINT); passArray->AddFieldType(vtkDataObject::CELL); </pre>

The point data would still contain the single array, but the cell data would be cleared since you did not specify any arrays to pass. Field data would still be untouched.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

virtual void Kitware.VTK.vtkPassArrays.AddArray ( int  fieldType,
string  name 
) [virtual]

Adds an array to pass through. fieldType where the array that should be passed (point data, cell data, etc.). It should be one of the constants defined in the vtkDataObject::AttributeTypes enumeration.

virtual void Kitware.VTK.vtkPassArrays.AddFieldType ( int  fieldType) [virtual]

Add a field type to process. fieldType where the array that should be passed (point data, cell data, etc.). It should be one of the constants defined in the vtkDataObject::AttributeTypes enumeration. NOTE: These are only used if UseFieldType is turned on.

virtual void Kitware.VTK.vtkPassArrays.ClearArrays ( ) [virtual]

Clear all arrays to pass through.

virtual void Kitware.VTK.vtkPassArrays.ClearFieldTypes ( ) [virtual]

Clear all field types to process.

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

virtual bool Kitware.VTK.vtkPassArrays.GetRemoveArrays ( ) [virtual]

Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.

virtual bool Kitware.VTK.vtkPassArrays.GetUseFieldTypes ( ) [virtual]

Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

virtual void Kitware.VTK.vtkPassArrays.RemoveArraysOff ( ) [virtual]

Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.

virtual void Kitware.VTK.vtkPassArrays.RemoveArraysOn ( ) [virtual]

Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkPassArrays.SetRemoveArrays ( bool  _arg) [virtual]

Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.

virtual void Kitware.VTK.vtkPassArrays.SetUseFieldTypes ( bool  _arg) [virtual]

Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.

virtual void Kitware.VTK.vtkPassArrays.UseFieldTypesOff ( ) [virtual]

Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.

virtual void Kitware.VTK.vtkPassArrays.UseFieldTypesOn ( ) [virtual]

Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.

static internal void Kitware.VTK.vtkPassArrays.vtkPassArrays_AddArray_01 ( HandleRef  pThis,
int  fieldType,
string  name 
) [private]
static internal void Kitware.VTK.vtkPassArrays.vtkPassArrays_AddFieldType_02 ( HandleRef  pThis,
int  fieldType 
) [private]
static internal void Kitware.VTK.vtkPassArrays.vtkPassArrays_ClearArrays_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPassArrays.vtkPassArrays_ClearFieldTypes_04 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkPassArrays.vtkPassArrays_GetRemoveArrays_05 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkPassArrays.vtkPassArrays_GetUseFieldTypes_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPassArrays.vtkPassArrays_IsA_07 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkPassArrays.vtkPassArrays_IsTypeOf_08 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkPassArrays.vtkPassArrays_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPassArrays.vtkPassArrays_NewInstance_10 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPassArrays.vtkPassArrays_RemoveArraysOff_11 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPassArrays.vtkPassArrays_RemoveArraysOn_12 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPassArrays.vtkPassArrays_SafeDownCast_13 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPassArrays.vtkPassArrays_SetRemoveArrays_14 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkPassArrays.vtkPassArrays_SetUseFieldTypes_15 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkPassArrays.vtkPassArrays_UseFieldTypesOff_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPassArrays.vtkPassArrays_UseFieldTypesOn_17 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkPassArrays.MRClassNameKey = "13vtkPassArrays" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.


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