VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDataSetEdgeSubdivisionCriterion Class Reference

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

#include <vtkDataSetEdgeSubdivisionCriterion.h>

Inheritance diagram for vtkDataSetEdgeSubdivisionCriterion:
[legend]
Collaboration diagram for vtkDataSetEdgeSubdivisionCriterion:
[legend]

Public Types

typedef vtkEdgeSubdivisionCriterion Superclass
 
- Public Types inherited from vtkEdgeSubdivisionCriterion
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDataSetEdgeSubdivisionCriterionNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetMesh (vtkDataSet *)
 
vtkDataSetGetMesh ()
 
const vtkDataSetGetMesh () const
 
virtual void SetCellId (vtkIdType cell)
 
vtkIdType GetCellId () const
 
vtkIdTypeGetCellId ()
 
vtkCellGetCell ()
 
const vtkCellGetCell () const
 
virtual bool EvaluateEdge (const double *p0, double *midpt, const double *p1, int field_start)
 
doubleEvaluateFields (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
 
- Public Member Functions inherited from vtkEdgeSubdivisionCriterion
vtkEdgeSubdivisionCriterionNewInstance () const
 
virtual int PassField (int sourceId, int sourceSize, vtkStreamingTessellator *t)
 
virtual void ResetFieldList ()
 
virtual bool DontPassField (int sourceId, vtkStreamingTessellator *t)
 
const intGetFieldIds () const
 
const intGetFieldOffsets () const
 
int GetOutputField (int fieldId) const
 
int GetNumberOfFields () const
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkDataSetEdgeSubdivisionCriterionSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetEdgeSubdivisionCriterionNew ()
 
- Static Public Member Functions inherited from vtkEdgeSubdivisionCriterion
static int IsTypeOf (const char *type)
 
static vtkEdgeSubdivisionCriterionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataSetEdgeSubdivisionCriterion ()
 
virtual ~vtkDataSetEdgeSubdivisionCriterion ()
 
- Protected Member Functions inherited from vtkEdgeSubdivisionCriterion
 vtkEdgeSubdivisionCriterion ()
 
virtual ~vtkEdgeSubdivisionCriterion ()
 
bool ViewDependentEval (const double *p0, double *p1, double *p1_actual, const double *p2, int field_start, vtkMatrix4x4 *viewtrans, const double *pixelSize, double allowableChordErr) const
 
bool FixedFieldErrorEval (const double *p0, double *p1, double *p1_actual, const double *p2, int field_start, int field_criteria, double *allowableFieldErr) const
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkDataSetCurrentMesh
 
vtkIdType CurrentCellId
 
vtkCellCurrentCellData
 
double ChordError2
 
doubleFieldError2
 
int FieldError2Length
 
int FieldError2Capacity
 
int ActiveFieldCriteria
 
- Protected Attributes inherited from vtkEdgeSubdivisionCriterion
intFieldIds
 
intFieldOffsets
 
int NumberOfFields
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a subclass of vtkEdgeSubdivisionCriterion for vtkDataSet objects.

This is a subclass of vtkEdgeSubdivisionCriterion 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
vtkEdgeSubdivisionCriterion

Definition at line 44 of file vtkDataSetEdgeSubdivisionCriterion.h.

Member Typedef Documentation

Definition at line 47 of file vtkDataSetEdgeSubdivisionCriterion.h.

Constructor & Destructor Documentation

vtkDataSetEdgeSubdivisionCriterion::vtkDataSetEdgeSubdivisionCriterion ( )
protected
virtual vtkDataSetEdgeSubdivisionCriterion::~vtkDataSetEdgeSubdivisionCriterion ( )
protectedvirtual

Member Function Documentation

static int vtkDataSetEdgeSubdivisionCriterion::IsTypeOf ( const char *  type)
static
virtual int vtkDataSetEdgeSubdivisionCriterion::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkEdgeSubdivisionCriterion.

static vtkDataSetEdgeSubdivisionCriterion* vtkDataSetEdgeSubdivisionCriterion::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkDataSetEdgeSubdivisionCriterion::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkEdgeSubdivisionCriterion.

vtkDataSetEdgeSubdivisionCriterion* vtkDataSetEdgeSubdivisionCriterion::NewInstance ( ) const
static vtkDataSetEdgeSubdivisionCriterion* vtkDataSetEdgeSubdivisionCriterion::New ( )
static
virtual void vtkDataSetEdgeSubdivisionCriterion::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 vtkEdgeSubdivisionCriterion.

virtual void vtkDataSetEdgeSubdivisionCriterion::SetMesh ( vtkDataSet )
virtual
vtkDataSet * vtkDataSetEdgeSubdivisionCriterion::GetMesh ( )
inline

Definition at line 162 of file vtkDataSetEdgeSubdivisionCriterion.h.

const vtkDataSet * vtkDataSetEdgeSubdivisionCriterion::GetMesh ( ) const
inline

Definition at line 163 of file vtkDataSetEdgeSubdivisionCriterion.h.

virtual void vtkDataSetEdgeSubdivisionCriterion::SetCellId ( vtkIdType  cell)
virtual
vtkIdType vtkDataSetEdgeSubdivisionCriterion::GetCellId ( ) const
inline

Definition at line 160 of file vtkDataSetEdgeSubdivisionCriterion.h.

vtkIdType & vtkDataSetEdgeSubdivisionCriterion::GetCellId ( )
inline

Definition at line 159 of file vtkDataSetEdgeSubdivisionCriterion.h.

vtkCell * vtkDataSetEdgeSubdivisionCriterion::GetCell ( )
inline

Definition at line 165 of file vtkDataSetEdgeSubdivisionCriterion.h.

const vtkCell * vtkDataSetEdgeSubdivisionCriterion::GetCell ( ) const
inline

Definition at line 166 of file vtkDataSetEdgeSubdivisionCriterion.h.

virtual bool vtkDataSetEdgeSubdivisionCriterion::EvaluateEdge ( const double p0,
double p1,
const double p2,
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 vtkEdgeSubdivisionCriterion.

double* vtkDataSetEdgeSubdivisionCriterion::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 vtkEdgeSubdivisionCriterion::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 vtkEdgeSubdivisionCriterion::PassDefaultFields() or vtkEdgeSubdivisionCriterion::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();
vtkEdgeSubdivisionCriterion* 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 vtkDataSetEdgeSubdivisionCriterion::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 vtkDataSetEdgeSubdivisionCriterion::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 vtkDataSetEdgeSubdivisionCriterion::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 vtkDataSetEdgeSubdivisionCriterion::GetChordError2 ( )
virtual

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

virtual void vtkDataSetEdgeSubdivisionCriterion::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 vtkDataSetEdgeSubdivisionCriterion::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 vtkDataSetEdgeSubdivisionCriterion::ResetFieldError2 ( )
virtual

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

virtual int vtkDataSetEdgeSubdivisionCriterion::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 vtkDataSetEdgeSubdivisionCriterion::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 134 of file vtkDataSetEdgeSubdivisionCriterion.h.

Member Data Documentation

vtkDataSet* vtkDataSetEdgeSubdivisionCriterion::CurrentMesh
protected

Definition at line 141 of file vtkDataSetEdgeSubdivisionCriterion.h.

vtkIdType vtkDataSetEdgeSubdivisionCriterion::CurrentCellId
protected

Definition at line 142 of file vtkDataSetEdgeSubdivisionCriterion.h.

vtkCell* vtkDataSetEdgeSubdivisionCriterion::CurrentCellData
protected

Definition at line 143 of file vtkDataSetEdgeSubdivisionCriterion.h.

double vtkDataSetEdgeSubdivisionCriterion::ChordError2
protected

Definition at line 145 of file vtkDataSetEdgeSubdivisionCriterion.h.

double* vtkDataSetEdgeSubdivisionCriterion::FieldError2
protected

Definition at line 146 of file vtkDataSetEdgeSubdivisionCriterion.h.

int vtkDataSetEdgeSubdivisionCriterion::FieldError2Length
protected

Definition at line 147 of file vtkDataSetEdgeSubdivisionCriterion.h.

int vtkDataSetEdgeSubdivisionCriterion::FieldError2Capacity
protected

Definition at line 148 of file vtkDataSetEdgeSubdivisionCriterion.h.

int vtkDataSetEdgeSubdivisionCriterion::ActiveFieldCriteria
protected

Definition at line 149 of file vtkDataSetEdgeSubdivisionCriterion.h.


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