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

vtkGenerateIndexArray More...

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

List of all members.

Public Types

enum  CELL_DATA_WrapperEnum {
  CELL_DATA = 2, EDGE_DATA = 4, POINT_DATA = 1, ROW_DATA = 0,
  VERTEX_DATA = 3
}
 Specifies whether the index array should be marked as pedigree ids. Default: false. More...

Public Member Functions

 vtkGenerateIndexArray (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkGenerateIndexArray ()
 Undocumented Block.
virtual string GetArrayName ()
 Control the output index array name. Default: "index".
virtual int GetFieldType ()
 Control the location where the index array will be stored.
virtual int GetPedigreeID ()
 Specifies whether the index array should be marked as pedigree ids. Default: false.
virtual string GetReferenceArrayName ()
 Specifies an optional reference array for index-generation.
override int IsA (string type)
 Undocumented Block.
new vtkGenerateIndexArray NewInstance ()
 Undocumented Block.
virtual void SetArrayName (string _arg)
 Control the output index array name. Default: "index".
virtual void SetFieldType (int _arg)
 Control the location where the index array will be stored.
virtual void SetPedigreeID (int _arg)
 Specifies whether the index array should be marked as pedigree ids. Default: false.
virtual void SetReferenceArrayName (string _arg)
 Specifies an optional reference array for index-generation.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "21vtkGenerateIndexArray"
 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 vtkGenerateIndexArray_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkGenerateIndexArray_GetArrayName_01 (HandleRef pThis)
static internal int vtkGenerateIndexArray_GetFieldType_02 (HandleRef pThis)
static internal int vtkGenerateIndexArray_GetPedigreeID_03 (HandleRef pThis)
static internal IntPtr vtkGenerateIndexArray_GetReferenceArrayName_04 (HandleRef pThis)
static internal int vtkGenerateIndexArray_IsA_05 (HandleRef pThis, string type)
static internal int vtkGenerateIndexArray_IsTypeOf_06 (string type)
static internal IntPtr vtkGenerateIndexArray_NewInstance_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkGenerateIndexArray_SafeDownCast_09 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGenerateIndexArray_SetArrayName_10 (HandleRef pThis, string _arg)
static internal void vtkGenerateIndexArray_SetFieldType_11 (HandleRef pThis, int _arg)
static internal void vtkGenerateIndexArray_SetPedigreeID_12 (HandleRef pThis, int _arg)
static internal void vtkGenerateIndexArray_SetReferenceArrayName_13 (HandleRef pThis, string _arg)

Static Private Member Functions

static vtkGenerateIndexArray ()
 Automatically generated type registration mechanics.

Detailed Description

vtkGenerateIndexArray

Description Generates a new vtkIdTypeArray containing zero-base indices.

vtkGenerateIndexArray operates in one of two distinct "modes". By default, it simply generates an index array containing monotonically-increasing integers in the range [0, N), where N is appropriately sized for the field type that will store the results. This mode is useful for generating a unique ID field for datasets that have none.

The second "mode" uses an existing array from the input data object as a "reference". Distinct values from the reference array are sorted in ascending order, and an integer index in the range [0, N) is assigned to each. The resulting map is used to populate the output index array, mapping each value in the reference array to its corresponding index and storing the result in the output array. This mode is especially useful when generating tensors, since it allows us to "map" from an array with arbitrary contents to an index that can be used as tensor coordinates.


Member Enumeration Documentation

Specifies whether the index array should be marked as pedigree ids. Default: false.

Enumerator:
CELL_DATA 

enum member

EDGE_DATA 

enum member

POINT_DATA 

enum member

ROW_DATA 

enum member

VERTEX_DATA 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkGenerateIndexArray.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 string Kitware.VTK.vtkGenerateIndexArray.GetArrayName ( ) [virtual]

Control the output index array name. Default: "index".

Control the location where the index array will be stored.

Specifies whether the index array should be marked as pedigree ids. Default: false.

Specifies an optional reference array for index-generation.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

static new int Kitware.VTK.vtkGenerateIndexArray.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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkGenerateIndexArray.SetArrayName ( string  _arg) [virtual]

Control the output index array name. Default: "index".

virtual void Kitware.VTK.vtkGenerateIndexArray.SetFieldType ( int  _arg) [virtual]

Control the location where the index array will be stored.

virtual void Kitware.VTK.vtkGenerateIndexArray.SetPedigreeID ( int  _arg) [virtual]

Specifies whether the index array should be marked as pedigree ids. Default: false.

virtual void Kitware.VTK.vtkGenerateIndexArray.SetReferenceArrayName ( string  _arg) [virtual]

Specifies an optional reference array for index-generation.

static internal IntPtr Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_GetArrayName_01 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_GetFieldType_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_GetPedigreeID_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_GetReferenceArrayName_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_IsA_05 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_IsTypeOf_06 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_NewInstance_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_SafeDownCast_09 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_SetArrayName_10 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_SetFieldType_11 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_SetPedigreeID_12 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGenerateIndexArray.vtkGenerateIndexArray_SetReferenceArrayName_13 ( HandleRef  pThis,
string  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkGenerateIndexArray.MRClassNameKey = "21vtkGenerateIndexArray" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataObjectAlgorithm.


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