VTK
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)
 
virtual double GetPixelTolerance ()
 
virtual vtkViewportGetViewport ()
 
void SetViewport (vtkViewport *viewport)
 
int RequiresEdgeSubdivision (double *leftPoint, double *midPoint, double *rightPoint, double alpha)
 
double GetError (double *leftPoint, double *midPoint, double *rightPoint, double alpha)
 
- Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
void SetGenericCell (vtkGenericAdaptorCell *cell)
 
virtual vtkGenericAdaptorCellGetGenericCell ()
 
void SetDataSet (vtkGenericDataSet *ds)
 
virtual vtkGenericDataSetGetDataSet ()
 
vtkGenericSubdivisionErrorMetricNewInstance () 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 vtkViewDependentErrorMetricNew ()
 
- Static Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
static int IsTypeOf (const char *type)
 
static vtkGenericSubdivisionErrorMetricSafeDownCast (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

 vtkViewDependentErrorMetric ()
 
 ~vtkViewDependentErrorMetric ()
 
double Distance2LinePoint (double x[2], double y[2], double z[2])
 
- Protected Member Functions inherited from vtkGenericSubdivisionErrorMetric
 vtkGenericSubdivisionErrorMetric ()
 
 ~vtkGenericSubdivisionErrorMetric ()
 
- 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

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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkGenericSubdivisionErrorMetric Superclass
 
static int IsTypeOf (const char *type)
 
static vtkViewDependentErrorMetricSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkViewDependentErrorMetricNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBaseNewInstanceInternal () const
 

Additional Inherited Members

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

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
Tests:
vtkViewDependentErrorMetric (Tests)

Definition at line 40 of file vtkViewDependentErrorMetric.h.

Member Typedef Documentation

Standard VTK type and error macros.

Definition at line 49 of file vtkViewDependentErrorMetric.h.

Constructor & Destructor Documentation

vtkViewDependentErrorMetric::vtkViewDependentErrorMetric ( )
protected
vtkViewDependentErrorMetric::~vtkViewDependentErrorMetric ( )
protected

Member Function Documentation

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

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

Standard VTK type and error macros.

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

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

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

Standard VTK type and error macros.

virtual vtkObjectBase* vtkViewDependentErrorMetric::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

vtkViewDependentErrorMetric* vtkViewDependentErrorMetric::NewInstance ( ) const

Standard VTK type and error macros.

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

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

virtual double vtkViewDependentErrorMetric::GetPixelTolerance ( )
virtual

Return the squared screen-based geometric accurary measured in pixels. An accuracy less or equal to 0.25 (0.5^2) ensures that the screen-space interpolation of a mid-point matchs 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
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
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.

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.

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

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.

double vtkViewDependentErrorMetric::GetError ( double leftPoint,
double midPoint,
double rightPoint,
double  alpha 
)
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

Implements vtkGenericSubdivisionErrorMetric.

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

double vtkViewDependentErrorMetric::PixelTolerance
protected

Definition at line 125 of file vtkViewDependentErrorMetric.h.

vtkViewport* vtkViewDependentErrorMetric::Viewport
protected

Definition at line 126 of file vtkViewDependentErrorMetric.h.

vtkCoordinate* vtkViewDependentErrorMetric::Coordinate
protected

Definition at line 128 of file vtkViewDependentErrorMetric.h.


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