Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkBlankStructuredGrid Class Reference

#include <vtkBlankStructuredGrid.h>

Inheritance diagram for vtkBlankStructuredGrid:

Inheritance graph
[legend]
Collaboration diagram for vtkBlankStructuredGrid:

Collaboration graph
[legend]
List of all members.

Detailed Description

translate point attribute data into a blanking field

vtkBlankStructuredGrid is a filter that sets the blanking field in a vtkStructuredGrid dataset. The blanking field is set by examining a specified point attribute data array (e.g., scalars) and converting values in the data array to either a "1" (visible) or "0" (blanked) value in the blanking array. The values to be blanked are specified by giving a min/max range. All data values in the data array indicated and laying within the range specified (inclusive on both ends) are translated to a "off" blanking value.

See also:
vtkStructuredGrid
Created by:
  • Schroeder, Will
CVS contributions (if > 5%):
  • Schroeder, Will (80%)
  • Martin, Ken (13%)
CVS logs (CVSweb):
  • .cxx (/Graphics/vtkBlankStructuredGrid.cxx)
  • .h (/Graphics/vtkBlankStructuredGrid.h)
Tests:
vtkBlankStructuredGrid (Tests)

Definition at line 51 of file vtkBlankStructuredGrid.h.

Public Types

typedef vtkStructuredGridToStructuredGridFilter Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetMinBlankingValue (double)
virtual double GetMinBlankingValue ()
virtual void SetMaxBlankingValue (double)
virtual double GetMaxBlankingValue ()
virtual void SetArrayName (const char *)
virtual char * GetArrayName ()
virtual void SetArrayId (int)
virtual int GetArrayId ()
virtual void SetComponent (int)
virtual int GetComponent ()

Static Public Member Functions

vtkBlankStructuredGridNew ()
int IsTypeOf (const char *type)
vtkBlankStructuredGridSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkBlankStructuredGrid ()
 ~vtkBlankStructuredGrid ()
void Execute ()

Protected Attributes

double MinBlankingValue
double MaxBlankingValue
char * ArrayName
int ArrayId
int Component


Member Typedef Documentation

typedef vtkStructuredGridToStructuredGridFilter vtkBlankStructuredGrid::Superclass
 

Reimplemented from vtkStructuredGridToStructuredGridFilter.

Definition at line 55 of file vtkBlankStructuredGrid.h.


Constructor & Destructor Documentation

vtkBlankStructuredGrid::vtkBlankStructuredGrid  )  [protected]
 

vtkBlankStructuredGrid::~vtkBlankStructuredGrid  )  [protected]
 


Member Function Documentation

vtkBlankStructuredGrid* vtkBlankStructuredGrid::New  )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkBlankStructuredGrid::GetClassName  )  [virtual]
 

Reimplemented from vtkStructuredGridToStructuredGridFilter.

int vtkBlankStructuredGrid::IsTypeOf const char *  type  )  [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 vtkStructuredGridToStructuredGridFilter.

virtual int vtkBlankStructuredGrid::IsA const char *  type  )  [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 vtkStructuredGridToStructuredGridFilter.

vtkBlankStructuredGrid* vtkBlankStructuredGrid::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkStructuredGridToStructuredGridFilter.

void vtkBlankStructuredGrid::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 vtkStructuredGridToStructuredGridFilter.

virtual void vtkBlankStructuredGrid::SetMinBlankingValue double   )  [virtual]
 

Specify the lower data value in the data array specified which will be converted into a "blank" (or off) value in the blanking array.

virtual double vtkBlankStructuredGrid::GetMinBlankingValue  )  [virtual]
 

Specify the lower data value in the data array specified which will be converted into a "blank" (or off) value in the blanking array.

virtual void vtkBlankStructuredGrid::SetMaxBlankingValue double   )  [virtual]
 

Specify the upper data value in the data array specified which will be converted into a "blank" (or off) value in the blanking array.

virtual double vtkBlankStructuredGrid::GetMaxBlankingValue  )  [virtual]
 

Specify the upper data value in the data array specified which will be converted into a "blank" (or off) value in the blanking array.

virtual void vtkBlankStructuredGrid::SetArrayName const char *   )  [virtual]
 

Specify the data array name to use to generate the blanking field. Alternatively, you can specify the array id. (If both are set, the array name takes precedence.)

virtual char* vtkBlankStructuredGrid::GetArrayName  )  [virtual]
 

Specify the data array name to use to generate the blanking field. Alternatively, you can specify the array id. (If both are set, the array name takes precedence.)

virtual void vtkBlankStructuredGrid::SetArrayId int   )  [virtual]
 

Specify the data array id to use to generate the blanking field. Alternatively, you can specify the array name. (If both are set, the array name takes precedence.)

virtual int vtkBlankStructuredGrid::GetArrayId  )  [virtual]
 

Specify the data array id to use to generate the blanking field. Alternatively, you can specify the array name. (If both are set, the array name takes precedence.)

virtual void vtkBlankStructuredGrid::SetComponent int   )  [virtual]
 

Specify the component in the data array to use to generate the blanking field.

virtual int vtkBlankStructuredGrid::GetComponent  )  [virtual]
 

Specify the component in the data array to use to generate the blanking field.

void vtkBlankStructuredGrid::Execute  )  [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.


Member Data Documentation

double vtkBlankStructuredGrid::MinBlankingValue [protected]
 

Definition at line 101 of file vtkBlankStructuredGrid.h.

double vtkBlankStructuredGrid::MaxBlankingValue [protected]
 

Definition at line 102 of file vtkBlankStructuredGrid.h.

char* vtkBlankStructuredGrid::ArrayName [protected]
 

Definition at line 103 of file vtkBlankStructuredGrid.h.

int vtkBlankStructuredGrid::ArrayId [protected]
 

Definition at line 104 of file vtkBlankStructuredGrid.h.

int vtkBlankStructuredGrid::Component [protected]
 

Definition at line 105 of file vtkBlankStructuredGrid.h.


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