Objects that compute geometry-based error during cell tessellation. More...

#include <vtkGeometricErrorMetric.h>

Inheritance diagram for vtkGeometricErrorMetric:

Collaboration diagram for vtkGeometricErrorMetric:

Public Member Functions
void	SetAbsoluteGeometricTolerance (double value)

int	GetRelative ()


virtual double	GetAbsoluteGeometricTolerance ()


void	SetRelativeGeometricTolerance (double value, vtkGenericDataSet *ds)


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 vtkGenericAdaptorCell *	GetGenericCell ()

void	SetDataSet (vtkGenericDataSet *ds)

virtual vtkGenericDataSet *	GetDataSet ()

vtkGenericSubdivisionErrorMetric *	NewInstance () const

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () 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)

vtkCommand *	GetCommand (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 vtkGeometricErrorMetric *	New ()

Static Public Member Functions inherited from vtkGenericSubdivisionErrorMetric
static int	IsTypeOf (const char *type)

static vtkGenericSubdivisionErrorMetric *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

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 vtkObjectBase *	New ()

Protected Member Functions
	vtkGeometricErrorMetric ()

virtual	~vtkGeometricErrorMetric ()


double	Distance2LinePoint (double x[3], double y[3], double z[3])

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	AbsoluteGeometricTolerance

double	SmallestSize

int	Relative

Protected Attributes inherited from vtkGenericSubdivisionErrorMetric
vtkGenericAdaptorCell *	GenericCell

vtkGenericDataSet *	DataSet

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 vtkGeometricErrorMetric *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkGeometricErrorMetric *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () 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 geometry-based error during cell tessellation.

It is a concrete error metric, based on a geometric criterium: the variation of the edge from a straight line.

See also: vtkGenericCellTessellator vtkGenericSubdivisionErrorMetric

Tests:: vtkGeometricErrorMetric (Tests)

Definition at line 38 of file vtkGeometricErrorMetric.h.

Member Typedef Documentation

typedef vtkGenericSubdivisionErrorMetric vtkGeometricErrorMetric::Superclass

Standard VTK type and error macros.

Definition at line 47 of file vtkGeometricErrorMetric.h.

Constructor & Destructor Documentation

vtkGeometricErrorMetric::vtkGeometricErrorMetric ( )

protected

virtual vtkGeometricErrorMetric::~vtkGeometricErrorMetric ( )

protectedvirtual

Member Function Documentation

static vtkGeometricErrorMetric* vtkGeometricErrorMetric::New ( )

static

Construct the error metric with a default squared absolute geometric accuracy equal to 1.

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

static

Standard VTK type and error macros.

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

virtual

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

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

static

Standard VTK type and error macros.

virtual vtkObjectBase* vtkGeometricErrorMetric::NewInstanceInternal ( ) const

protectedvirtual

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

vtkGeometricErrorMetric* vtkGeometricErrorMetric::NewInstance ( ) const

Standard VTK type and error macros.

void vtkGeometricErrorMetric::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Standard VTK type and error macros.

Reimplemented from vtkGenericSubdivisionErrorMetric.

virtual double vtkGeometricErrorMetric::GetAbsoluteGeometricTolerance ( )

virtual

Return the squared absolute geometric accuracy. See SetAbsoluteGeometricTolerance() for details.

Postcondition: positive_result: result>0

void vtkGeometricErrorMetric::SetAbsoluteGeometricTolerance ( double value )

Set the geometric accuracy with a squared absolute value. This is the geometric object-based accuracy. Subdivision will be required if the square distance between the real point and the straight line passing through the vertices of the edge is greater than `value'. For instance 0.01 will give better result than 0.1.

Precondition: positive_value: value>0

void vtkGeometricErrorMetric::SetRelativeGeometricTolerance	(	double	value,
		vtkGenericDataSet *	ds
	)

Set the geometric accuracy with a value relative to the length of the bounding box of the dataset. Internally compute the absolute tolerance. For instance 0.01 will give better result than 0.1.

Precondition: valid_range_value: value>0 && value<1; ds_exists: ds!=0

int vtkGeometricErrorMetric::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 and the 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 vtkGeometricErrorMetric::GetError	(	double *	leftPoint,
		double *	midPoint,
		double *	rightPoint,
		double	alpha
	)

virtual

Return the error at the mid-point. It will return an error relative to the bounding box size if GetRelative() is true, a square absolute error otherwise. 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.

int vtkGeometricErrorMetric::GetRelative ( )

Return the type of output of GetError()

double vtkGeometricErrorMetric::Distance2LinePoint	(	double	x[3],
		double	y[3],
		double	z[3]
	)

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

protected

Definition at line 123 of file vtkGeometricErrorMetric.h.

double vtkGeometricErrorMetric::SmallestSize

protected

Definition at line 124 of file vtkGeometricErrorMetric.h.

int vtkGeometricErrorMetric::Relative

protected

Definition at line 125 of file vtkGeometricErrorMetric.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkGeometricErrorMetric.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation