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

generate scalars or field data from point and cell ids More...

#include <vtkIdFilter.h>

Inherits vtkDataSetAlgorithm.

Public Types

typedef vtkDataSetAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkIdFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetPointIds (int)
 
virtual int GetPointIds ()
 
virtual void PointIdsOn ()
 
virtual void PointIdsOff ()
 
virtual void SetCellIds (int)
 
virtual int GetCellIds ()
 
virtual void CellIdsOn ()
 
virtual void CellIdsOff ()
 
virtual void SetFieldData (int)
 
virtual int GetFieldData ()
 
virtual void FieldDataOn ()
 
virtual void FieldDataOff ()
 
virtual void SetIdsArrayName (const char *)
 
virtual char * GetIdsArrayName ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkIdFilterSafeDownCast (vtkObjectBase *o)
 
static vtkIdFilterNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkIdFilter ()
 
 ~vtkIdFilter ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

int PointIds
 
int CellIds
 
int FieldData
 
char * IdsArrayName
 

Detailed Description

generate scalars or field data from point and cell ids

vtkIdFilter is a filter to that generates scalars or field data using cell and point ids. That is, the point attribute data scalars or field data are generated from the point ids, and the cell attribute data scalars or field data are generated from the the cell ids.

Typically this filter is used with vtkLabeledDataMapper (and possibly vtkSelectVisiblePoints) to create labels for points and cells, or labels for the point or cell data scalar values.

Examples:
vtkIdFilter (Examples)
Tests:
vtkIdFilter (Tests)

Definition at line 41 of file vtkIdFilter.h.

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkIdFilter::Superclass

Definition at line 44 of file vtkIdFilter.h.

Constructor & Destructor Documentation

vtkIdFilter::vtkIdFilter ( )
protected
vtkIdFilter::~vtkIdFilter ( )
protected

Member Function Documentation

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

Construct object with PointIds and CellIds on; and ids being generated as scalars.

virtual void vtkIdFilter::SetPointIds ( int  )
virtual

Enable/disable the generation of point ids. Default is on.

virtual int vtkIdFilter::GetPointIds ( )
virtual

Enable/disable the generation of point ids. Default is on.

virtual void vtkIdFilter::PointIdsOn ( )
virtual

Enable/disable the generation of point ids. Default is on.

virtual void vtkIdFilter::PointIdsOff ( )
virtual

Enable/disable the generation of point ids. Default is on.

virtual void vtkIdFilter::SetCellIds ( int  )
virtual

Enable/disable the generation of point ids. Default is on.

virtual int vtkIdFilter::GetCellIds ( )
virtual

Enable/disable the generation of point ids. Default is on.

virtual void vtkIdFilter::CellIdsOn ( )
virtual

Enable/disable the generation of point ids. Default is on.

virtual void vtkIdFilter::CellIdsOff ( )
virtual

Enable/disable the generation of point ids. Default is on.

virtual void vtkIdFilter::SetFieldData ( int  )
virtual

Set/Get the flag which controls whether to generate scalar data or field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Default is off.

virtual int vtkIdFilter::GetFieldData ( )
virtual

Set/Get the flag which controls whether to generate scalar data or field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Default is off.

virtual void vtkIdFilter::FieldDataOn ( )
virtual

Set/Get the flag which controls whether to generate scalar data or field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Default is off.

virtual void vtkIdFilter::FieldDataOff ( )
virtual

Set/Get the flag which controls whether to generate scalar data or field data. If this flag is off, scalar data is generated. Otherwise, field data is generated. Default is off.

virtual void vtkIdFilter::SetIdsArrayName ( const char *  )
virtual

Set/Get the name of the Ids array if generated. By default the Ids are named "vtkIdFilter_Ids", but this can be changed with this function.

virtual char* vtkIdFilter::GetIdsArrayName ( )
virtual

Set/Get the name of the Ids array if generated. By default the Ids are named "vtkIdFilter_Ids", but this can be changed with this function.

int vtkIdFilter::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

Member Data Documentation

int vtkIdFilter::PointIds
protected

Definition at line 88 of file vtkIdFilter.h.

int vtkIdFilter::CellIds
protected

Definition at line 89 of file vtkIdFilter.h.

int vtkIdFilter::FieldData
protected

Definition at line 90 of file vtkIdFilter.h.

char* vtkIdFilter::IdsArrayName
protected

Definition at line 91 of file vtkIdFilter.h.


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