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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDataSetEdgeSubdivisionCriterionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetMesh (vtkDataSet *)
 
vtkDataSetGetMesh ()
 
const vtkDataSetGetMesh () const
 
virtual void SetCellId (vtkIdType cell)
 
vtkIdType GetCellId () const
 
vtkIdTypeGetCellId ()
 
vtkCellGetCell ()
 
const vtkCellGetCell () const
 
bool EvaluateEdge (const double *p0, double *midpt, const double *p1, int field_start) override
 You must implement this member function in a subclass. More...
 
doubleEvaluateFields (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. More...
 
void EvaluatePointDataField (double *result, double *weights, int field)
 Evaluate either a cell or nodal field. More...
 
void EvaluateCellDataField (double *result, double *weights, int field)
 
virtual void SetChordError2 (double)
 Get/Set the square of the allowable chord error at any edge's midpoint. More...
 
virtual double GetChordError2 ()
 
virtual void SetFieldError2 (int s, double err)
 Get/Set the square of the allowable error magnitude for the scalar field s at any edge's midpoint. More...
 
double GetFieldError2 (int s) const
 
virtual void ResetFieldError2 ()
 Tell the subdivider not to use any field values as subdivision criteria. More...
 
virtual int GetActiveFieldCriteria ()
 Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). More...
 
int GetActiveFieldCriteria () const
 
- Public Member Functions inherited from vtkEdgeSubdivisionCriterion
vtkEdgeSubdivisionCriterionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int PassField (int sourceId, int sourceSize, vtkStreamingTessellator *t)
 This is a helper routine called by PassFields() which you may also call directly; it adds sourceSize to the size of the output vertex field values. More...
 
virtual void ResetFieldList ()
 Don't pass any field values in the vertex pointer. More...
 
virtual bool DontPassField (int sourceId, vtkStreamingTessellator *t)
 This does the opposite of PassField(); it removes a field from the output (assuming the field was set to be passed). More...
 
const intGetFieldIds () const
 Return the map from output field id to input field ids. More...
 
const intGetFieldOffsets () const
 Return the offset into an output vertex array of all fields. More...
 
int GetOutputField (int fieldId) const
 Return the output ID of an input field. More...
 
int GetNumberOfFields () const
 Return the number of fields being evaluated at each output vertex. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetEdgeSubdivisionCriterionSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetEdgeSubdivisionCriterionNew ()
 
- Static Public Member Functions inherited from vtkEdgeSubdivisionCriterion
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkEdgeSubdivisionCriterionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataSetEdgeSubdivisionCriterion ()
 
 ~vtkDataSetEdgeSubdivisionCriterion () override
 
- Protected Member Functions inherited from vtkEdgeSubdivisionCriterion
 vtkEdgeSubdivisionCriterion ()
 
 ~vtkEdgeSubdivisionCriterion () override
 
bool ViewDependentEval (const double *p0, double *p1, double *p1_actual, const double *p2, int field_start, vtkMatrix4x4 *viewtrans, const double *pixelSize, double allowableChordErr) const
 Perform the core logic for a view-dependent subdivision. More...
 
bool FixedFieldErrorEval (const double *p0, double *p1, double *p1_actual, const double *p2, int field_start, int field_criteria, double *allowableFieldErr) const
 Perform the core logic for a fixed multi-criterion, scalar-field based subdivision. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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
std::atomic< int32_t > 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 45 of file vtkDataSetEdgeSubdivisionCriterion.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkDataSetEdgeSubdivisionCriterion.h.

Constructor & Destructor Documentation

◆ vtkDataSetEdgeSubdivisionCriterion()

vtkDataSetEdgeSubdivisionCriterion::vtkDataSetEdgeSubdivisionCriterion ( )
protected

◆ ~vtkDataSetEdgeSubdivisionCriterion()

vtkDataSetEdgeSubdivisionCriterion::~vtkDataSetEdgeSubdivisionCriterion ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkDataSetEdgeSubdivisionCriterion::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkDataSetEdgeSubdivisionCriterion* vtkDataSetEdgeSubdivisionCriterion::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDataSetEdgeSubdivisionCriterion::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkEdgeSubdivisionCriterion.

◆ NewInstance()

vtkDataSetEdgeSubdivisionCriterion* vtkDataSetEdgeSubdivisionCriterion::NewInstance ( ) const

◆ New()

static vtkDataSetEdgeSubdivisionCriterion* vtkDataSetEdgeSubdivisionCriterion::New ( )
static

◆ PrintSelf()

void vtkDataSetEdgeSubdivisionCriterion::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkObject.

◆ SetMesh()

virtual void vtkDataSetEdgeSubdivisionCriterion::SetMesh ( vtkDataSet )
virtual

◆ GetMesh() [1/2]

vtkDataSet * vtkDataSetEdgeSubdivisionCriterion::GetMesh ( )
inline

Definition at line 177 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ GetMesh() [2/2]

const vtkDataSet * vtkDataSetEdgeSubdivisionCriterion::GetMesh ( ) const
inline

Definition at line 178 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ SetCellId()

virtual void vtkDataSetEdgeSubdivisionCriterion::SetCellId ( vtkIdType  cell)
virtual

◆ GetCellId() [1/2]

vtkIdType vtkDataSetEdgeSubdivisionCriterion::GetCellId ( ) const
inline

Definition at line 175 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ GetCellId() [2/2]

vtkIdType & vtkDataSetEdgeSubdivisionCriterion::GetCellId ( )
inline

Definition at line 174 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ GetCell() [1/2]

vtkCell * vtkDataSetEdgeSubdivisionCriterion::GetCell ( )
inline

Definition at line 180 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ GetCell() [2/2]

const vtkCell * vtkDataSetEdgeSubdivisionCriterion::GetCell ( ) const
inline

Definition at line 181 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ EvaluateEdge()

bool vtkDataSetEdgeSubdivisionCriterion::EvaluateEdge ( const double p0,
double p1,
const double p2,
int  field_start 
)
overridevirtual

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.

◆ EvaluateFields()

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.

◆ EvaluatePointDataField()

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?

◆ EvaluateCellDataField()

void vtkDataSetEdgeSubdivisionCriterion::EvaluateCellDataField ( double result,
double weights,
int  field 
)

◆ SetChordError2()

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.

◆ GetChordError2()

virtual double vtkDataSetEdgeSubdivisionCriterion::GetChordError2 ( )
virtual

◆ SetFieldError2()

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.

◆ GetFieldError2()

double vtkDataSetEdgeSubdivisionCriterion::GetFieldError2 ( int  s) const

◆ ResetFieldError2()

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.

◆ GetActiveFieldCriteria() [1/2]

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.

◆ GetActiveFieldCriteria() [2/2]

int vtkDataSetEdgeSubdivisionCriterion::GetActiveFieldCriteria ( ) const
inline

Definition at line 151 of file vtkDataSetEdgeSubdivisionCriterion.h.

Member Data Documentation

◆ CurrentMesh

vtkDataSet* vtkDataSetEdgeSubdivisionCriterion::CurrentMesh
protected

Definition at line 158 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ CurrentCellId

vtkIdType vtkDataSetEdgeSubdivisionCriterion::CurrentCellId
protected

Definition at line 159 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ CurrentCellData

vtkCell* vtkDataSetEdgeSubdivisionCriterion::CurrentCellData
protected

Definition at line 160 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ ChordError2

double vtkDataSetEdgeSubdivisionCriterion::ChordError2
protected

Definition at line 162 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ FieldError2

double* vtkDataSetEdgeSubdivisionCriterion::FieldError2
protected

Definition at line 163 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ FieldError2Length

int vtkDataSetEdgeSubdivisionCriterion::FieldError2Length
protected

Definition at line 164 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ FieldError2Capacity

int vtkDataSetEdgeSubdivisionCriterion::FieldError2Capacity
protected

Definition at line 165 of file vtkDataSetEdgeSubdivisionCriterion.h.

◆ ActiveFieldCriteria

int vtkDataSetEdgeSubdivisionCriterion::ActiveFieldCriteria
protected

Definition at line 166 of file vtkDataSetEdgeSubdivisionCriterion.h.


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