---

vtkBlankStructuredGrid Class Reference

translate point attribute data into a blanking field. More...

#include <vtkBlankStructuredGrid.h>

Inheritance diagram for vtkBlankStructuredGrid:

[legend]Collaboration diagram for vtkBlankStructuredGrid:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetMinBlankingValue (float)
virtual float	GetMinBlankingValue ()
virtual void	SetMaxBlankingValue (float)
virtual float	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 Methods
vtkBlankStructuredGrid *	New ()
int	IsTypeOf (const char *type)
vtkBlankStructuredGrid *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkBlankStructuredGrid ()
	~vtkBlankStructuredGrid ()
void	Execute ()
Protected Attributes
float	MinBlankingValue
float	MaxBlankingValue
char *	ArrayName
int	ArrayId
int	Component

---

Detailed Description

translate point attribute data into a blanking field.

Date:

2001/10/11 13:36:44

Revision:

1.5

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

Tests:

vtkBlankStructuredGrid (Tests)

Definition at line 68 of file vtkBlankStructuredGrid.h.

---

Constructor & Destructor Documentation

vtkBlankStructuredGrid::vtkBlankStructuredGrid (    )  [protected]

vtkBlankStructuredGrid::~vtkBlankStructuredGrid (    )  [protected]

---

Member Function Documentation

vtkBlankStructuredGrid* vtkBlankStructuredGrid::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkStructuredGridSource.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. 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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkStructuredGridToStructuredGridFilter.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. 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 vtkSource.

virtual void vtkBlankStructuredGrid::SetMinBlankingValue (  float    )  [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 float 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 (  float    )  [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 float 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

float vtkBlankStructuredGrid::MinBlankingValue [protected]

Definition at line 118 of file vtkBlankStructuredGrid.h.

float vtkBlankStructuredGrid::MaxBlankingValue [protected]

Definition at line 119 of file vtkBlankStructuredGrid.h.

char* vtkBlankStructuredGrid::ArrayName [protected]

Definition at line 120 of file vtkBlankStructuredGrid.h.

int vtkBlankStructuredGrid::ArrayId [protected]

Definition at line 121 of file vtkBlankStructuredGrid.h.

int vtkBlankStructuredGrid::Component [protected]

Definition at line 122 of file vtkBlankStructuredGrid.h.

---

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

• Graphics/vtkBlankStructuredGrid.h

---