VTK  9.1.20211115
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkViewDependentErrorMetric Class Reference

Objects that compute a screen-based error during cell tessellation. More...

#include <vtkViewDependentErrorMetric.h>

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

Public Member Functions

void SetPixelTolerance (double value)
 Set the squared screen-based geometric accuracy measured in pixels. More...
 
int RequiresEdgeSubdivision (double *leftPoint, double *midPoint, double *rightPoint, double alpha) override
 Does the edge need to be subdivided according to the distance between the line passing through its endpoints in screen space and the projection of its mid point? The edge is defined by its ‘leftPoint’ and its ‘rightPoint’. More...
 
double GetError (double *leftPoint, double *midPoint, double *rightPoint, double alpha) override
 Return the error at the mid-point. More...
 
virtual double GetPixelTolerance ()
 Return the squared screen-based geometric accuracy measured in pixels. More...
 
virtual vtkViewportGetViewport ()
 Set/Get the renderer with ‘renderer’ on which the error metric is based. More...
 
void SetViewport (vtkViewport *viewport)
 Set/Get the renderer with ‘renderer’ on which the error metric is based. More...
 
- Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
void SetGenericCell (vtkGenericAdaptorCell *cell)
 The cell that the edge belongs to. More...
 
virtual vtkGenericAdaptorCellGetGenericCell ()
 The cell that the edge belongs to. More...
 
void SetDataSet (vtkGenericDataSet *ds)
 Set/Get the dataset to be tessellated. More...
 
virtual vtkGenericDataSetGetDataSet ()
 Set/Get the dataset to be tessellated. More...
 
vtkGenericSubdivisionErrorMetricNewInstance () const
 Standard VTK type and error macros. 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...
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkViewDependentErrorMetricNew ()
 Construct the error metric with a default squared screen-based geometric accuracy measured in pixels equal to 0.25 (0.5^2). More...
 
- Static Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
static vtkTypeBool IsTypeOf (const char *type)
 Standard VTK type and error macros. More...
 
static vtkGenericSubdivisionErrorMetricSafeDownCast (vtkObjectBase *o)
 Standard VTK type and error macros. More...
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

 vtkViewDependentErrorMetric ()
 
 ~vtkViewDependentErrorMetric () override
 
double Distance2LinePoint (double x[2], double y[2], double z[2])
 Square distance between a straight line (defined by points x and y) and a point z. More...
 
- Protected Member Functions inherited from vtkGenericSubdivisionErrorMetric
 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double PixelTolerance
 
vtkViewportViewport
 
vtkCoordinateCoordinate
 
- Protected Attributes inherited from vtkGenericSubdivisionErrorMetric
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
 
typedef vtkGenericSubdivisionErrorMetric Superclass
 Standard VTK type and error macros. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard VTK type and error macros. More...
 
static vtkViewDependentErrorMetricSafeDownCast (vtkObjectBase *o)
 Standard VTK type and error macros. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard VTK type and error macros. More...
 
vtkViewDependentErrorMetricNewInstance () const
 Standard VTK type and error macros. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard VTK type and error macros. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard VTK type and error macros. More...
 

Additional Inherited Members

- Public Types inherited from vtkGenericSubdivisionErrorMetric
typedef vtkObject Superclass
 Standard VTK type and error macros. More...
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Objects that compute a screen-based error during cell tessellation.

It is a concrete error metric, based on a geometric criterium in the screen space: the variation of the projected edge from a projected straight line

See also
vtkGenericCellTessellator vtkGenericSubdivisionErrorMetric

Definition at line 38 of file vtkViewDependentErrorMetric.h.

Member Typedef Documentation

◆ Superclass

Standard VTK type and error macros.

Definition at line 51 of file vtkViewDependentErrorMetric.h.

Constructor & Destructor Documentation

◆ vtkViewDependentErrorMetric()

vtkViewDependentErrorMetric::vtkViewDependentErrorMetric ( )
protected

◆ ~vtkViewDependentErrorMetric()

vtkViewDependentErrorMetric::~vtkViewDependentErrorMetric ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkViewDependentErrorMetric* vtkViewDependentErrorMetric::New ( )
static

Construct the error metric with a default squared screen-based geometric accuracy measured in pixels equal to 0.25 (0.5^2).

◆ IsTypeOf()

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

Standard VTK type and error macros.

◆ IsA()

virtual vtkTypeBool vtkViewDependentErrorMetric::IsA ( const char *  type)
virtual

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

◆ SafeDownCast()

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

Standard VTK type and error macros.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkViewDependentErrorMetric::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

◆ NewInstance()

vtkViewDependentErrorMetric* vtkViewDependentErrorMetric::NewInstance ( ) const

Standard VTK type and error macros.

◆ PrintSelf()

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

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

◆ GetPixelTolerance()

virtual double vtkViewDependentErrorMetric::GetPixelTolerance ( )
virtual

Return the squared screen-based geometric accuracy measured in pixels.

An accuracy less or equal to 0.25 (0.5^2) ensures that the screen-space interpolation of a mid-point matches exactly with the projection of the mid-point (a value less than 1 but greater than 0.25 is not enough, because of 8-neighbors). Maybe it is useful for lower accuracy in case of anti-aliasing?

Postcondition
positive_result: result>0

◆ SetPixelTolerance()

void vtkViewDependentErrorMetric::SetPixelTolerance ( double  value)

Set the squared screen-based geometric accuracy measured in pixels.

Subdivision will be required if the square distance between the projection of the real point and the straight line passing through the projection of the vertices of the edge is greater than ‘value’. For instance, 0.25 will give better result than 1.

Precondition
positive_value: value>0

◆ GetViewport()

virtual vtkViewport* vtkViewDependentErrorMetric::GetViewport ( )
virtual

Set/Get the renderer with ‘renderer’ on which the error metric is based.

The error metric use the active camera of the renderer.

◆ SetViewport()

void vtkViewDependentErrorMetric::SetViewport ( vtkViewport viewport)

Set/Get the renderer with ‘renderer’ on which the error metric is based.

The error metric use the active camera of the renderer.

◆ RequiresEdgeSubdivision()

int vtkViewDependentErrorMetric::RequiresEdgeSubdivision ( double *  leftPoint,
double *  midPoint,
double *  rightPoint,
double  alpha 
)
overridevirtual

Does the edge need to be subdivided according to the distance between the line passing through its endpoints in screen space and the projection of its mid point? 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

Implements vtkGenericSubdivisionErrorMetric.

◆ GetError()

double vtkViewDependentErrorMetric::GetError ( double *  leftPoint,
double *  midPoint,
double *  rightPoint,
double  alpha 
)
overridevirtual

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

Implements vtkGenericSubdivisionErrorMetric.

◆ Distance2LinePoint()

double vtkViewDependentErrorMetric::Distance2LinePoint ( double  x[2],
double  y[2],
double  z[2] 
)
protected

Square distance between a straight line (defined by points x and y) and a point z.

Property: if x and y are equal, the line is a point and the result is the square distance between points x and z.

Member Data Documentation

◆ PixelTolerance

double vtkViewDependentErrorMetric::PixelTolerance
protected

Definition at line 135 of file vtkViewDependentErrorMetric.h.

◆ Viewport

vtkViewport* vtkViewDependentErrorMetric::Viewport
protected

Definition at line 136 of file vtkViewDependentErrorMetric.h.

◆ Coordinate

vtkCoordinate* vtkViewDependentErrorMetric::Coordinate
protected

Definition at line 138 of file vtkViewDependentErrorMetric.h.


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