vtkDataSetSubdivisionAlgorithm Class Reference

a subclass of vtkSubdivisionAlgorithm for vtkDataSet objects. More...

#include <vtkDataSetSubdivisionAlgorithm.h>

Inheritance diagram for vtkDataSetSubdivisionAlgorithm:

[legend]Collaboration diagram for vtkDataSetSubdivisionAlgorithm:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkDataSetSubdivisionAlgorithm, vtkSubdivisionAlgorithm)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetMesh (vtkDataSet *)
vtkDataSet *	GetMesh ()
const vtkDataSet *	GetMesh () const
virtual void	SetCellId (vtkIdType cell)
vtkIdType	GetCellId () const
vtkIdType &	GetCellId ()
vtkCell *	GetCell ()
const vtkCell *	GetCell () const
virtual bool	EvaluateEdge (const double *p0, double *midpt, const double *p1, int field_start)
double *	EvaluateFields (double *vertex, double *weights, int field_start)
virtual void	ResetFieldError2 ()
void	EvaluatePointDataField (double *result, double *weights, int field)
void	EvaluateCellDataField (double *result, double *weights, int field)
virtual void	SetChordError2 (double)
virtual double	GetChordError2 ()
virtual void	SetFieldError2 (int s, double err)
double	GetFieldError2 (int s) const
virtual int	GetActiveFieldCriteria ()
int	GetActiveFieldCriteria () const
Static Public Member Functions
vtkDataSetSubdivisionAlgorithm *	New ()
Protected Member Functions
	vtkDataSetSubdivisionAlgorithm ()
virtual	~vtkDataSetSubdivisionAlgorithm ()
Protected Attributes
vtkDataSet *	CurrentMesh
vtkIdType	CurrentCellId
vtkCell *	CurrentCellData
double	ChordError2
double *	FieldError2
int	FieldError2Length
int	FieldError2Capacity
int	ActiveFieldCriteria

---

Detailed Description

a subclass of vtkSubdivisionAlgorithm for vtkDataSet objects.

Date

2004/08/24 14:50:23

Revision

1.2

This is a subclass of vtkSubdivisionAlgorithm that is used for tessellating cells of a vtkDataSet, particularly nonlinear cells.

It provides functions for setting the current cell being tessellated and a convenience routine, EvaluateFields() to evaluate field values at a point. You should call EvaluateFields() from inside EvaluateEdge() whenever the result of EvaluateEdge() will be true. Otherwise, do not call EvaluateFields() as the midpoint is about to be discarded. (Implementor's note: This isn't true if UGLY_ASPECT_RATIO_HACK has been defined. But in that case, we don't want the exact field values; we need the linearly interpolated ones at the midpoint for continuity.)

See also:

vtkSubdivisionAlgorithm

Definition at line 46 of file vtkDataSetSubdivisionAlgorithm.h.

---

Constructor & Destructor Documentation

vtkDataSetSubdivisionAlgorithm::vtkDataSetSubdivisionAlgorithm (   )  [protected]

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

---

Member Function Documentation

vtkDataSetSubdivisionAlgorithm::vtkTypeRevisionMacro (  vtkDataSetSubdivisionAlgorithm  , vtkSubdivisionAlgorithm  )

vtkDataSetSubdivisionAlgorithm* vtkDataSetSubdivisionAlgorithm::New (   )  [static]

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

Reimplemented from vtkSubdivisionAlgorithm.

virtual void vtkDataSetSubdivisionAlgorithm::SetMesh (  vtkDataSet *   )  [virtual]

vtkDataSet * vtkDataSetSubdivisionAlgorithm::GetMesh (   )  [inline]

Definition at line 160 of file vtkDataSetSubdivisionAlgorithm.h. References CurrentMesh.

const vtkDataSet * vtkDataSetSubdivisionAlgorithm::GetMesh (   )  const [inline]

Definition at line 161 of file vtkDataSetSubdivisionAlgorithm.h. References CurrentMesh.

virtual void vtkDataSetSubdivisionAlgorithm::SetCellId (  vtkIdType  cell  )  [virtual]

vtkIdType vtkDataSetSubdivisionAlgorithm::GetCellId (   )  const [inline]

Definition at line 158 of file vtkDataSetSubdivisionAlgorithm.h. References CurrentCellId.

vtkIdType & vtkDataSetSubdivisionAlgorithm::GetCellId (   )  [inline]

Definition at line 157 of file vtkDataSetSubdivisionAlgorithm.h. References CurrentCellId.

vtkCell * vtkDataSetSubdivisionAlgorithm::GetCell (   )  [inline]

Definition at line 163 of file vtkDataSetSubdivisionAlgorithm.h. References CurrentCellData.

const vtkCell * vtkDataSetSubdivisionAlgorithm::GetCell (   )  const [inline]

Definition at line 164 of file vtkDataSetSubdivisionAlgorithm.h. References CurrentCellData.

virtual bool vtkDataSetSubdivisionAlgorithm::EvaluateEdge (  const double *  p0, double *  midpt, const double *  p1, int  field_start )  [virtual]

You must implement this member function in a subclass. It will be called by vtkStreamingTessellator for each edge in each primitive that vtkStreamingTessellator generates. Implements vtkSubdivisionAlgorithm.

double* vtkDataSetSubdivisionAlgorithm::EvaluateFields (  double *  vertex, double *  weights, int  field_start )

Evaluate all of the fields that should be output with the given vertex and store them just past the parametric coordinates of vertex, at the offsets given by vtkSubdivisionAlgorithm::GetFieldOffsets() plus field_start. field_start contains the number of world-space coordinates (always 3) plus the embedding dimension (the size of the parameter-space in which the cell is embedded). It will range between 3 and 6, inclusive. You must have called SetCellId() before calling this routine or there will not be a mesh over which to evaluate the fields. You must have called vtkSubdivisionAlgorithm::PassDefaultFields() or vtkSubdivisionAlgorithm::PassField() or there will be no fields defined for the output vertex. This routine is public and returns its input argument so that it may be used as an argument to vtkStreamingTessellator::AdaptivelySamplekFacet(): vtkStreamingTessellator* t = vtkStreamingTessellator::New(); vtkSubdivisionAlgorithm* s; ... t->AdaptivelySample1Facet( s->EvaluateFields( p0 ), s->EvaluateFields( p1 ) ); ... Although this will work, using EvaluateFields() in this manner should be avoided. It's much more efficient to fetch the corner values for each attribute and copy them into p0, p1, ... as opposed to performing shape function evaluations. The only case where you wouldn't want to do this is when the field you are interpolating is discontinuous at cell borders, such as with a discontinuous galerkin method or when all the Gauss points for quadrature are interior to the cell. The final argument, weights, is the array of weights to apply to each point's data when interpolating the field. This is returned by vtkCell::EvaluateLocation() when evaluating the geometry.

void vtkDataSetSubdivisionAlgorithm::EvaluatePointDataField (  double *  result, double *  weights, int  field )

Evaluate either a cell or nodal field. This exists because of the funky way that Exodus data will be handled. Sure, it's a hack, but what are ya gonna do?

void vtkDataSetSubdivisionAlgorithm::EvaluateCellDataField (  double *  result, double *  weights, int  field )

Evaluate either a cell or nodal field. This exists because of the funky way that Exodus data will be handled. Sure, it's a hack, but what are ya gonna do?

virtual void vtkDataSetSubdivisionAlgorithm::SetChordError2 (  double   )  [virtual]

Get/Set the square of the allowable chord error at any edge's midpoint. This value is used by EvaluateEdge.

virtual double vtkDataSetSubdivisionAlgorithm::GetChordError2 (   )  [virtual]

Get/Set the square of the allowable chord error at any edge's midpoint. This value is used by EvaluateEdge.

virtual void vtkDataSetSubdivisionAlgorithm::SetFieldError2 (  int  s, double  err )  [virtual]

Get/Set the square of the allowable error magnitude for the scalar field s at any edge's midpoint. A value less than or equal to 0 indicates that the field should not be used as a criterion for subdivision.

double vtkDataSetSubdivisionAlgorithm::GetFieldError2 (  int  s  )  const

Get/Set the square of the allowable error magnitude for the scalar field s at any edge's midpoint. A value less than or equal to 0 indicates that the field should not be used as a criterion for subdivision.

virtual void vtkDataSetSubdivisionAlgorithm::ResetFieldError2 (   )  [virtual]

Tell the subdivider not to use any field values as subdivision criteria. Effectively calls SetFieldError2( a, -1. ) for all fields.

virtual int vtkDataSetSubdivisionAlgorithm::GetActiveFieldCriteria (   )  [virtual]

Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster.

int vtkDataSetSubdivisionAlgorithm::GetActiveFieldCriteria (   )  const [inline]

Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster. Definition at line 132 of file vtkDataSetSubdivisionAlgorithm.h.

---

Member Data Documentation

vtkDataSet* vtkDataSetSubdivisionAlgorithm::CurrentMesh [protected]

Definition at line 139 of file vtkDataSetSubdivisionAlgorithm.h. Referenced by GetMesh().

vtkIdType vtkDataSetSubdivisionAlgorithm::CurrentCellId [protected]

Definition at line 140 of file vtkDataSetSubdivisionAlgorithm.h. Referenced by GetCellId().

vtkCell* vtkDataSetSubdivisionAlgorithm::CurrentCellData [protected]

Definition at line 141 of file vtkDataSetSubdivisionAlgorithm.h. Referenced by GetCell().

double vtkDataSetSubdivisionAlgorithm::ChordError2 [protected]

Definition at line 143 of file vtkDataSetSubdivisionAlgorithm.h.

double* vtkDataSetSubdivisionAlgorithm::FieldError2 [protected]

Definition at line 144 of file vtkDataSetSubdivisionAlgorithm.h.

int vtkDataSetSubdivisionAlgorithm::FieldError2Length [protected]

Definition at line 145 of file vtkDataSetSubdivisionAlgorithm.h.

int vtkDataSetSubdivisionAlgorithm::FieldError2Capacity [protected]

Definition at line 146 of file vtkDataSetSubdivisionAlgorithm.h.

int vtkDataSetSubdivisionAlgorithm::ActiveFieldCriteria [protected]

Definition at line 147 of file vtkDataSetSubdivisionAlgorithm.h.

---

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

• Servers/Filters/vtkDataSetSubdivisionAlgorithm.h

---