VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkGenericSubdivisionErrorMetric Class Referenceabstract

Objects that compute error during cell tessellation. More...

#include <vtkGenericSubdivisionErrorMetric.h>

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

Public Types

typedef vtkObject Superclass
 Standard VTK type and error macros. More...
 

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...
 
vtkGenericSubdivisionErrorMetricNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int RequiresEdgeSubdivision (double *leftPoint, double *midPoint, double *rightPoint, double alpha)=0
 Does the edge need to be subdivided according to the implemented computation? The edge is defined by its ‘leftPoint’ and its ‘rightPoint’. More...
 
virtual double GetError (double *leftPoint, double *midPoint, double *rightPoint, double alpha)=0
 Return the error at the mid-point. More...
 
void SetGenericCell (vtkGenericAdaptorCell *cell)
 The cell that the edge belongs to. More...
 
virtual vtkGenericAdaptorCellGetGenericCell ()
 
void SetDataSet (vtkGenericDataSet *ds)
 Set/Get the dataset to be tessellated. More...
 
virtual vtkGenericDataSetGetDataSet ()
 
- 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 vtkGenericSubdivisionErrorMetricSafeDownCast (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
 
 vtkGenericSubdivisionErrorMetric ()
 
 ~vtkGenericSubdivisionErrorMetric () override
 
- 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

vtkGenericAdaptorCellGenericCell
 
vtkGenericDataSetDataSet
 
- 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

Objects that compute error during cell tessellation.

Objects of that class answer the following question during the cell subdivision: "does the edge need to be subdivided?" through RequiresEdgeSubdivision(). The answer depends on the criterium actually used in the subclass of this abstract class: a geometric-based error metric (variation of edge from a straight line), an attribute-based error metric (variation of the active attribute/component value from a linear ramp) , a view-depend error metric, ... Cell subdivision is performed in the context of the adaptor framework: higher-order, or complex cells, are automatically tessellated into simplices so that they can be processed with conventional visualization algorithms.

See also
vtkGenericCellTessellator

Definition at line 48 of file vtkGenericSubdivisionErrorMetric.h.

Member Typedef Documentation

◆ Superclass

Standard VTK type and error macros.

Definition at line 55 of file vtkGenericSubdivisionErrorMetric.h.

Constructor & Destructor Documentation

◆ vtkGenericSubdivisionErrorMetric()

vtkGenericSubdivisionErrorMetric::vtkGenericSubdivisionErrorMetric ( )
protected

◆ ~vtkGenericSubdivisionErrorMetric()

vtkGenericSubdivisionErrorMetric::~vtkGenericSubdivisionErrorMetric ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkGenericSubdivisionErrorMetric::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 vtkObjectBase.

Reimplemented in vtkSmoothErrorMetric, vtkViewDependentErrorMetric, vtkAttributesErrorMetric, and vtkGeometricErrorMetric.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGenericSubdivisionErrorMetric::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkGenericSubdivisionErrorMetric* vtkGenericSubdivisionErrorMetric::NewInstance ( ) const

◆ PrintSelf()

void vtkGenericSubdivisionErrorMetric::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.

Reimplemented in vtkSmoothErrorMetric, vtkViewDependentErrorMetric, and vtkGeometricErrorMetric.

◆ RequiresEdgeSubdivision()

virtual int vtkGenericSubdivisionErrorMetric::RequiresEdgeSubdivision ( double leftPoint,
double midPoint,
double rightPoint,
double  alpha 
)
pure virtual

Does the edge need to be subdivided according to the implemented computation? The edge is defined by its ‘leftPoint’ and its ‘rightPoint’.

‘leftPoint’, ‘midPoint’ and ‘rightPoint’ have to be initialized before calling RequiresEdgeSubdivision(). Their format is global coordinates, parametric coordinates and point centered attributes: xyx rst abc de... ‘alpha’ is the normalized abscissa of the midpoint along the edge. (close to 0 means close to the left point, close to 1 means close to the right point)

Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6

Implemented in vtkAttributesErrorMetric, vtkViewDependentErrorMetric, vtkGeometricErrorMetric, and vtkSmoothErrorMetric.

◆ GetError()

virtual double vtkGenericSubdivisionErrorMetric::GetError ( double leftPoint,
double midPoint,
double rightPoint,
double  alpha 
)
pure virtual

Return the error at the mid-point.

The type of error depends on the state of the concrete error metric. For instance, it can return an absolute or relative error metric. See RequiresEdgeSubdivision() for a description of the arguments.

Precondition
leftPoint_exists: leftPoint!=0
midPoint_exists: midPoint!=0
rightPoint_exists: rightPoint!=0
clamped_alpha: alpha>0 && alpha<1
valid_size: sizeof(leftPoint)=sizeof(midPoint)=sizeof(rightPoint) =GetAttributeCollection()->GetNumberOfPointCenteredComponents()+6
Postcondition
positive_result: result>=0

Implemented in vtkAttributesErrorMetric, vtkViewDependentErrorMetric, vtkGeometricErrorMetric, and vtkSmoothErrorMetric.

◆ SetGenericCell()

void vtkGenericSubdivisionErrorMetric::SetGenericCell ( vtkGenericAdaptorCell cell)

The cell that the edge belongs to.

◆ GetGenericCell()

virtual vtkGenericAdaptorCell* vtkGenericSubdivisionErrorMetric::GetGenericCell ( )
virtual

◆ SetDataSet()

void vtkGenericSubdivisionErrorMetric::SetDataSet ( vtkGenericDataSet ds)

Set/Get the dataset to be tessellated.

◆ GetDataSet()

virtual vtkGenericDataSet* vtkGenericSubdivisionErrorMetric::GetDataSet ( )
virtual

Member Data Documentation

◆ GenericCell

vtkGenericAdaptorCell* vtkGenericSubdivisionErrorMetric::GenericCell
protected

Definition at line 116 of file vtkGenericSubdivisionErrorMetric.h.

◆ DataSet

vtkGenericDataSet* vtkGenericSubdivisionErrorMetric::DataSet
protected

Definition at line 117 of file vtkGenericSubdivisionErrorMetric.h.


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