vtkMaskFields Class Reference

#include <vtkMaskFields.h>

Inheritance diagram for vtkMaskFields:

Inheritance graph
[legend]
Collaboration diagram for vtkMaskFields:

Collaboration graph
[legend]

List of all members.


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

Definition at line 38 of file vtkMaskFields.h.


Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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 (vtkObject *o)
static vtkMaskFieldsNew ()

Protected Member Functions

 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]

Classes

struct  CopyFieldFlag

Member Typedef Documentation

Reimplemented from vtkDataSetAlgorithm.

Definition at line 41 of file vtkMaskFields.h.


Member Enumeration Documentation

Enumerator:
OBJECT_DATA 
POINT_DATA 
CELL_DATA 

Definition at line 115 of file vtkMaskFields.h.


Constructor & Destructor Documentation

vtkMaskFields::vtkMaskFields (  )  [protected]

virtual vtkMaskFields::~vtkMaskFields (  )  [protected, virtual]


Member Function Documentation

virtual const char* vtkMaskFields::GetClassName (  )  [virtual]

Reimplemented from vtkDataSetAlgorithm.

static int vtkMaskFields::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

virtual int vtkMaskFields::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

static vtkMaskFields* vtkMaskFields::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkDataSetAlgorithm.

void vtkMaskFields::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataSetAlgorithm.

static vtkMaskFields* vtkMaskFields::New (  )  [static]

Create a new vtkMaskFields.

Reimplemented from vtkDataSetAlgorithm.

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 57 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 58 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 73 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 74 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 80 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 81 of file vtkMaskFields.h.

void vtkMaskFields::CopyFieldsOn (  )  [inline]

Definition at line 84 of file vtkMaskFields.h.

void vtkMaskFields::CopyAttributesOn (  )  [inline]

Definition at line 85 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  
) [protected, virtual]

This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

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

Definition at line 139 of file vtkMaskFields.h.

Definition at line 140 of file vtkMaskFields.h.

int vtkMaskFields::CopyFields [protected]

Definition at line 151 of file vtkMaskFields.h.

Definition at line 152 of file vtkMaskFields.h.

char vtkMaskFields::FieldLocationNames[3][12] [static, protected]

Definition at line 154 of file vtkMaskFields.h.

char vtkMaskFields::AttributeNames[vtkDataSetAttributes::NUM_ATTRIBUTES][10] [static, protected]

Definition at line 155 of file vtkMaskFields.h.


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

Generated on Sat Dec 27 13:36:01 2008 for VTK by  doxygen 1.5.6