VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
vtkMaskFields Class Reference

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

#include <vtkMaskFields.h>

Inherits vtkDataSetAlgorithm.

Collaboration diagram for vtkMaskFields:
[legend]

Classes

struct  CopyFieldFlag
 

Public Types

enum  FieldLocation { OBJECT_DATA =0, POINT_DATA =1, CELL_DATA =2 }
 
typedef vtkDataSetAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkMaskFieldsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void CopyFieldsOn ()
 
void CopyAttributesOn ()
 
virtual void CopyAllOn ()
 
virtual void CopyAllOff ()
 
void CopyFieldOn (int fieldLocation, const char *name)
 
void CopyFieldOff (int fieldLocation, const char *name)
 
void CopyAttributeOn (int attributeLocation, int attributeType)
 
void CopyAttributeOff (int attributeLocation, int attributeType)
 
void CopyFieldsOff ()
 
void CopyAttributesOff ()
 
void CopyAttributeOn (const char *attributeLoc, const char *attributeType)
 
void CopyAttributeOff (const char *attributeLoc, const char *attributeType)
 
void CopyFieldOn (const char *fieldLoc, const char *name)
 
void CopyFieldOff (const char *fieldLoc, const char *name)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMaskFieldsSafeDownCast (vtkObjectBase *o)
 
static vtkMaskFieldsNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkMaskFields ()
 
virtual ~vtkMaskFields ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void CopyFieldOnOff (int fieldLocation, const char *name, int onOff)
 
void CopyAttributeOnOff (int attributeLocation, int attributeType, int onOff)
 
void ClearFieldFlags ()
 
int FindFlag (const char *field, int location)
 
int FindFlag (int arrayType, int location)
 
int GetFlag (const char *field, int location)
 
int GetFlag (int arrayType, int location)
 
int GetAttributeLocation (const char *loc)
 
int GetAttributeType (const char *type)
 

Protected Attributes

CopyFieldFlagCopyFieldFlags
 
int NumberOfFieldFlags
 
int CopyFields
 
int CopyAttributes
 

Static Protected Attributes

static char FieldLocationNames [3][12]
 
static char AttributeNames [vtkDataSetAttributes::NUM_ATTRIBUTES][10]
 

Detailed Description

Allow control of which fields get passed to the output.

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.

See Also
vtkFieldData vtkDataSet vtkDataObjectToDataSetFilter vtkDataSetAttributes vtkDataArray vtkRearrangeFields vtkSplitField vtkMergeFields vtkAssignAttribute
Examples:
vtkMaskFields (Examples)
Tests:
vtkMaskFields (Tests)

Definition at line 45 of file vtkMaskFields.h.

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkMaskFields::Superclass

Definition at line 48 of file vtkMaskFields.h.

Member Enumeration Documentation

Enumerator
OBJECT_DATA 
POINT_DATA 
CELL_DATA 

Definition at line 122 of file vtkMaskFields.h.

Constructor & Destructor Documentation

vtkMaskFields::vtkMaskFields ( )
protected
virtual vtkMaskFields::~vtkMaskFields ( )
protectedvirtual

Member Function Documentation

static int vtkMaskFields::IsTypeOf ( const char *  type)
static
virtual int vtkMaskFields::IsA ( const char *  type)
virtual
static vtkMaskFields* vtkMaskFields::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkMaskFields::NewInstanceInternal ( ) const
protectedvirtual
vtkMaskFields* vtkMaskFields::NewInstance ( ) const
void vtkMaskFields::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkMaskFields* vtkMaskFields::New ( )
static

Create a new vtkMaskFields.

void vtkMaskFields::CopyFieldOn ( int  fieldLocation,
const char *  name 
)
inline

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.

Definition at line 64 of file vtkMaskFields.h.

void vtkMaskFields::CopyFieldOff ( int  fieldLocation,
const char *  name 
)
inline

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.

Definition at line 65 of file vtkMaskFields.h.

void vtkMaskFields::CopyAttributeOn ( int  attributeLocation,
int  attributeType 
)
inline

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.

Definition at line 80 of file vtkMaskFields.h.

void vtkMaskFields::CopyAttributeOff ( int  attributeLocation,
int  attributeType 
)
inline

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.

Definition at line 81 of file vtkMaskFields.h.

void vtkMaskFields::CopyFieldsOff ( )
inline

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

Definition at line 87 of file vtkMaskFields.h.

void vtkMaskFields::CopyAttributesOff ( )
inline

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

Definition at line 88 of file vtkMaskFields.h.

void vtkMaskFields::CopyFieldsOn ( )
inline

Definition at line 91 of file vtkMaskFields.h.

void vtkMaskFields::CopyAttributesOn ( )
inline

Definition at line 92 of file vtkMaskFields.h.

void vtkMaskFields::CopyAttributeOn ( const char *  attributeLoc,
const char *  attributeType 
)

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

void vtkMaskFields::CopyAttributeOff ( const char *  attributeLoc,
const char *  attributeType 
)

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

void vtkMaskFields::CopyFieldOn ( const char *  fieldLoc,
const char *  name 
)

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

void vtkMaskFields::CopyFieldOff ( const char *  fieldLoc,
const char *  name 
)

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

virtual void 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

virtual void 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 int vtkMaskFields::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
void vtkMaskFields::CopyFieldOnOff ( int  fieldLocation,
const char *  name,
int  onOff 
)
protected
void vtkMaskFields::CopyAttributeOnOff ( int  attributeLocation,
int  attributeType,
int  onOff 
)
protected
void vtkMaskFields::ClearFieldFlags ( )
protected
int vtkMaskFields::FindFlag ( const char *  field,
int  location 
)
protected
int vtkMaskFields::FindFlag ( int  arrayType,
int  location 
)
protected
int vtkMaskFields::GetFlag ( const char *  field,
int  location 
)
protected
int vtkMaskFields::GetFlag ( int  arrayType,
int  location 
)
protected
int vtkMaskFields::GetAttributeLocation ( const char *  loc)
protected
int vtkMaskFields::GetAttributeType ( const char *  type)
protected

Member Data Documentation

CopyFieldFlag* vtkMaskFields::CopyFieldFlags
protected

Definition at line 146 of file vtkMaskFields.h.

int vtkMaskFields::NumberOfFieldFlags
protected

Definition at line 147 of file vtkMaskFields.h.

int vtkMaskFields::CopyFields
protected

Definition at line 158 of file vtkMaskFields.h.

int vtkMaskFields::CopyAttributes
protected

Definition at line 159 of file vtkMaskFields.h.

char vtkMaskFields::FieldLocationNames[3][12]
staticprotected

Definition at line 161 of file vtkMaskFields.h.

char vtkMaskFields::AttributeNames[vtkDataSetAttributes::NUM_ATTRIBUTES][10]
staticprotected

Definition at line 162 of file vtkMaskFields.h.


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