vtkDataSetEdgeSubdivisionCriterion Class Reference

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

#include <vtkDataSetEdgeSubdivisionCriterion.h>

Inheritance diagram for vtkDataSetEdgeSubdivisionCriterion:

Collaboration diagram for vtkDataSetEdgeSubdivisionCriterion:

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.
vtkDataSetEdgeSubdivisionCriterion *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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
bool	EvaluateLocationAndFields (double *midpt, int field_start) override
	You must implement this member function in a subclass.
double *	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.
virtual void	ResetFieldError2 ()
	Tell the subdivider not to use any field values as subdivision criteria.
void	EvaluatePointDataField (double *result, double *weights, int field)
	Evaluate either a cell or nodal field.
void	EvaluateCellDataField (double *result, double *weights, int field)
	Evaluate either a cell or nodal field.
virtual void	SetChordError2 (double)
	Get/Set the square of the allowable chord error at any edge's midpoint.
virtual double	GetChordError2 ()
	Get/Set the square of the allowable chord error at any edge's midpoint.
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.
double	GetFieldError2 (int s) const
	Get/Set the square of the allowable error magnitude for the scalar field s at any edge's midpoint.
virtual int	GetActiveFieldCriteria ()
	Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions).
int	GetActiveFieldCriteria () const
	Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions).
Public Member Functions inherited from vtkEdgeSubdivisionCriterion
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkEdgeSubdivisionCriterion *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual bool	EvaluateLocationAndFields (double *p1, int field_start)=0
	You must implement this member function in a subclass.
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.
virtual void	ResetFieldList ()
	Don't pass any field values in the vertex pointer.
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).
const int *	GetFieldIds () const
	Return the map from output field id to input field ids.
const int *	GetFieldOffsets () const
	Return the offset into an output vertex array of all fields.
int	GetOutputField (int fieldId) const
	Return the output ID of an input field.
int	GetNumberOfFields () const
	Return the number of fields being evaluated at each output vertex.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkDataSetEdgeSubdivisionCriterion *	SafeDownCast (vtkObjectBase *o)
static vtkDataSetEdgeSubdivisionCriterion *	New ()
Static Public Member Functions inherited from vtkEdgeSubdivisionCriterion
static vtkTypeBool	IsTypeOf (const char *type)
static vtkEdgeSubdivisionCriterion *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDataSetEdgeSubdivisionCriterion ()
	~vtkDataSetEdgeSubdivisionCriterion () override
Protected Member Functions inherited from vtkEdgeSubdivisionCriterion
virtual vtkObjectBase *	NewInstanceInternal () const
	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.
bool	FixedFieldErrorEval (double *p1, double *p1_actual, int field_start, int field_criteria, double *allowableFieldErr) const
	Perform the core logic for a fixed multi-criterion, scalar-field based subdivision.
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkDataSet *	CurrentMesh
vtkIdType	CurrentCellId
vtkCell *	CurrentCellData
double	ChordError2
double *	FieldError2
int	FieldError2Length
int	FieldError2Capacity
int	ActiveFieldCriteria
Protected Attributes inherited from vtkEdgeSubdivisionCriterion
int *	FieldIds
int *	FieldOffsets
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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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 EvaluateLocationAndFields() whenever the result of EvaluateLocationAndFields() 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

typedef vtkEdgeSubdivisionCriterion vtkDataSetEdgeSubdivisionCriterion::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 182 of file vtkDataSetEdgeSubdivisionCriterion.h.

GetMesh() [2/2]

const vtkDataSet * vtkDataSetEdgeSubdivisionCriterion::GetMesh ( ) const

inline

Definition at line 186 of file vtkDataSetEdgeSubdivisionCriterion.h.

SetCellId()

virtual void vtkDataSetEdgeSubdivisionCriterion::SetCellId ( vtkIdType  cell )

virtual

GetCellId() [1/2]

vtkIdType vtkDataSetEdgeSubdivisionCriterion::GetCellId ( ) const

inline

Definition at line 177 of file vtkDataSetEdgeSubdivisionCriterion.h.

GetCellId() [2/2]

vtkIdType & vtkDataSetEdgeSubdivisionCriterion::GetCellId ( )

inline

Definition at line 173 of file vtkDataSetEdgeSubdivisionCriterion.h.

GetCell() [1/2]

vtkCell * vtkDataSetEdgeSubdivisionCriterion::GetCell ( )

inline

Definition at line 191 of file vtkDataSetEdgeSubdivisionCriterion.h.

GetCell() [2/2]

const vtkCell * vtkDataSetEdgeSubdivisionCriterion::GetCell ( ) const

inline

Definition at line 195 of file vtkDataSetEdgeSubdivisionCriterion.h.

EvaluateLocationAndFields()

bool vtkDataSetEdgeSubdivisionCriterion::EvaluateLocationAndFields ( double *  p1, 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
	)

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?

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

GetChordError2()

virtual double vtkDataSetEdgeSubdivisionCriterion::GetChordError2 ( )

virtual

Get/Set the square of the allowable chord error at any edge's midpoint.

This value is used by EvaluateLocationAndFields.

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

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.

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

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 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:

• Filters/Core/vtkDataSetEdgeSubdivisionCriterion.h