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

vtkMaskFields - Allow control of which fields get passed to the output More...

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

List of all members.

Public Types

enum  FieldLocation { CELL_DATA = 2, OBJECT_DATA = 0, POINT_DATA = 1 }
 Turn off copying of all data. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array. More...

Public Member Functions

 vtkMaskFields (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkMaskFields ()
 Create a new vtkMaskFields.
virtual void CopyAllOff ()
 Turn off copying of all data. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array.
virtual void CopyAllOn ()
 Turn on copying of all data. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array.
void CopyAttributeOff (int attributeLocation, int attributeType)
 Turn on/off the copying of the attribute or specified by vtkDataSetAttributes:AttributeTypes. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array An attribute type and a location must be specified. For example:
void CopyAttributeOff (string attributeLoc, string attributeType)
 Helper methods used by other language bindings. Allows the caller to specify arguments as strings instead of enums.
void CopyAttributeOn (int attributeLocation, int attributeType)
 Turn on/off the copying of the attribute or specified by vtkDataSetAttributes:AttributeTypes. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array An attribute type and a location must be specified. For example:
void CopyAttributeOn (string attributeLoc, string attributeType)
 Helper methods used by other language bindings. Allows the caller to specify arguments as strings instead of enums.
void CopyAttributesOff ()
 Convenience methods which operate on all field data or attribute data. More specific than CopyAllOn or CopyAllOff.
void CopyAttributesOn ()
 Convenience methods which operate on all field data or attribute data. More specific than CopyAllOn or CopyAllOff.
void CopyFieldOff (int fieldLocation, string name)
 Turn on/off the copying of the field or specified by name. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array A field name and a location must be specified. For example:
void CopyFieldOff (string fieldLoc, string name)
 Helper methods used by other language bindings. Allows the caller to specify arguments as strings instead of enums.
void CopyFieldOn (int fieldLocation, string name)
 Turn on/off the copying of the field or specified by name. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array A field name and a location must be specified. For example:
void CopyFieldOn (string fieldLoc, string name)
 Helper methods used by other language bindings. Allows the caller to specify arguments as strings instead of enums.
void CopyFieldsOff ()
 Convenience methods which operate on all field data or attribute data. More specific than CopyAllOn or CopyAllOff.
void CopyFieldsOn ()
 Convenience methods which operate on all field data or attribute data. More specific than CopyAllOn or CopyAllOff.
override int IsA (string type)
 Undocumented Block.
new vtkMaskFields NewInstance ()
 Undocumented Block.

Static Public Member Functions

static new vtkMaskFields New ()
 Create a new vtkMaskFields.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkMaskFields SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "13vtkMaskFields"
 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 vtkMaskFields_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkMaskFields_CopyAllOff_01 (HandleRef pThis)
static internal void vtkMaskFields_CopyAllOn_02 (HandleRef pThis)
static internal void vtkMaskFields_CopyAttributeOff_03 (HandleRef pThis, int attributeLocation, int attributeType)
static internal void vtkMaskFields_CopyAttributeOff_04 (HandleRef pThis, string attributeLoc, string attributeType)
static internal void vtkMaskFields_CopyAttributeOn_05 (HandleRef pThis, int attributeLocation, int attributeType)
static internal void vtkMaskFields_CopyAttributeOn_06 (HandleRef pThis, string attributeLoc, string attributeType)
static internal void vtkMaskFields_CopyAttributesOff_07 (HandleRef pThis)
static internal void vtkMaskFields_CopyAttributesOn_08 (HandleRef pThis)
static internal void vtkMaskFields_CopyFieldOff_09 (HandleRef pThis, int fieldLocation, string name)
static internal void vtkMaskFields_CopyFieldOff_10 (HandleRef pThis, string fieldLoc, string name)
static internal void vtkMaskFields_CopyFieldOn_11 (HandleRef pThis, int fieldLocation, string name)
static internal void vtkMaskFields_CopyFieldOn_12 (HandleRef pThis, string fieldLoc, string name)
static internal void vtkMaskFields_CopyFieldsOff_13 (HandleRef pThis)
static internal void vtkMaskFields_CopyFieldsOn_14 (HandleRef pThis)
static internal int vtkMaskFields_IsA_15 (HandleRef pThis, string type)
static internal int vtkMaskFields_IsTypeOf_16 (string type)
static internal IntPtr vtkMaskFields_NewInstance_18 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkMaskFields_SafeDownCast_19 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)

Static Private Member Functions

static vtkMaskFields ()
 Automatically generated type registration mechanics.

Detailed Description

vtkMaskFields - Allow control of which fields get passed to the output

Description vtkMaskFields is used to mark which fields in the input dataset get copied to the output. The output will contain only those fields marked as on by the filter.


Member Enumeration Documentation

Turn off copying of all data. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array.

Enumerator:
CELL_DATA 

enum member

OBJECT_DATA 

enum member

POINT_DATA 

enum member


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Create a new vtkMaskFields.


Member Function Documentation

virtual void Kitware.VTK.vtkMaskFields.CopyAllOff ( ) [virtual]

Turn off copying of all data. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array.

virtual void Kitware.VTK.vtkMaskFields.CopyAllOn ( ) [virtual]

Turn on copying of all data. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array.

void Kitware.VTK.vtkMaskFields.CopyAttributeOff ( int  attributeLocation,
int  attributeType 
)

Turn on/off the copying of the attribute or specified by vtkDataSetAttributes:AttributeTypes. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array An attribute type and a location must be specified. For example:

   /// maskFields->CopyAttributeOff(vtkMaskFields::POINT_DATA, vtkDataSetAttributes::SCALARS);
   /// 

causes the scalars on the input point data to not get copied to the output.

void Kitware.VTK.vtkMaskFields.CopyAttributeOff ( string  attributeLoc,
string  attributeType 
)

Helper methods used by other language bindings. Allows the caller to specify arguments as strings instead of enums.

void Kitware.VTK.vtkMaskFields.CopyAttributeOn ( int  attributeLocation,
int  attributeType 
)

Turn on/off the copying of the attribute or specified by vtkDataSetAttributes:AttributeTypes. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array An attribute type and a location must be specified. For example:

   /// maskFields->CopyAttributeOff(vtkMaskFields::POINT_DATA, vtkDataSetAttributes::SCALARS);
   /// 

causes the scalars on the input point data to not get copied to the output.

void Kitware.VTK.vtkMaskFields.CopyAttributeOn ( string  attributeLoc,
string  attributeType 
)

Helper methods used by other language bindings. Allows the caller to specify arguments as strings instead of enums.

Convenience methods which operate on all field data or attribute data. More specific than CopyAllOn or CopyAllOff.

Convenience methods which operate on all field data or attribute data. More specific than CopyAllOn or CopyAllOff.

void Kitware.VTK.vtkMaskFields.CopyFieldOff ( int  fieldLocation,
string  name 
)

Turn on/off the copying of the field or specified by name. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array A field name and a location must be specified. For example:

   /// maskFields->CopyFieldOff(vtkMaskFields::CELL_DATA, "foo");
   /// 

causes the field "foo" on the input cell data to not get copied to the output.

void Kitware.VTK.vtkMaskFields.CopyFieldOff ( string  fieldLoc,
string  name 
)

Helper methods used by other language bindings. Allows the caller to specify arguments as strings instead of enums.

void Kitware.VTK.vtkMaskFields.CopyFieldOn ( int  fieldLocation,
string  name 
)

Turn on/off the copying of the field or specified by name. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array A field name and a location must be specified. For example:

   /// maskFields->CopyFieldOff(vtkMaskFields::CELL_DATA, "foo");
   /// 

causes the field "foo" on the input cell data to not get copied to the output.

void Kitware.VTK.vtkMaskFields.CopyFieldOn ( string  fieldLoc,
string  name 
)

Helper methods used by other language bindings. Allows the caller to specify arguments as strings instead of enums.

Convenience methods which operate on all field data or attribute data. More specific than CopyAllOn or CopyAllOff.

Convenience methods which operate on all field data or attribute data. More specific than CopyAllOn or CopyAllOff.

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

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Create a new vtkMaskFields.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Here is the call graph for this function:

static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyAllOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyAllOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyAttributeOff_03 ( HandleRef  pThis,
int  attributeLocation,
int  attributeType 
) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyAttributeOff_04 ( HandleRef  pThis,
string  attributeLoc,
string  attributeType 
) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyAttributeOn_05 ( HandleRef  pThis,
int  attributeLocation,
int  attributeType 
) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyAttributeOn_06 ( HandleRef  pThis,
string  attributeLoc,
string  attributeType 
) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyAttributesOff_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyAttributesOn_08 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyFieldOff_09 ( HandleRef  pThis,
int  fieldLocation,
string  name 
) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyFieldOff_10 ( HandleRef  pThis,
string  fieldLoc,
string  name 
) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyFieldOn_11 ( HandleRef  pThis,
int  fieldLocation,
string  name 
) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyFieldOn_12 ( HandleRef  pThis,
string  fieldLoc,
string  name 
) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyFieldsOff_13 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMaskFields.vtkMaskFields_CopyFieldsOn_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkMaskFields.vtkMaskFields_IsA_15 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkMaskFields.vtkMaskFields_IsTypeOf_16 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkMaskFields.vtkMaskFields_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkMaskFields.vtkMaskFields_NewInstance_18 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkMaskFields.vtkMaskFields_SafeDownCast_19 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]

Member Data Documentation

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.


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