ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkAttributesErrorMetric Class Reference

vtkAttributesErrorMetric - Objects that compute attribute-based error during cell tessellation. More...

Inheritance diagram for Kitware.VTK.vtkAttributesErrorMetric:
[legend]
Collaboration diagram for Kitware.VTK.vtkAttributesErrorMetric:
[legend]

List of all members.

Public Member Functions

 vtkAttributesErrorMetric (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkAttributesErrorMetric ()
 Construct the error metric with a default relative attribute accuracy equal to 0.1.
virtual double GetAbsoluteAttributeTolerance ()
 Absolute tolerance of the active scalar (attribute+component). Subdivision is required if the square distance between the real attribute at the mid point on the edge and the interpolated attribute is greater than AbsoluteAttributeTolerance. This is the attribute accuracy. 0.01 will give better result than 0.1.
virtual double GetAttributeTolerance ()
 Relative tolerance of the active scalar (attribute+component). Subdivision is required if the square distance between the real attribute at the mid point on the edge and the interpolated attribute is greater than AttributeTolerance. This is the attribute accuracy. 0.01 will give better result than 0.1.
override double GetError (IntPtr leftPoint, IntPtr midPoint, IntPtr rightPoint, double alpha)
 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.
override int IsA (string type)
 Standard VTK type and error macros.
new vtkAttributesErrorMetric NewInstance ()
 Standard VTK type and error macros.
override int RequiresEdgeSubdivision (IntPtr leftPoint, IntPtr midPoint, IntPtr rightPoint, double alpha)
 Does the edge need to be subdivided according to the distance between the value of the active attribute/component at the midpoint and the mean value between the endpoints? 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)
void SetAbsoluteAttributeTolerance (double value)
 Set the absolute attribute accuracy to `value'. See GetAbsoluteAttributeTolerance() for details. It is particularly useful when some concrete implementation of vtkGenericAttribute does not support GetRange() request, called internally in SetAttributeTolerance(). It may happen when the implementation support higher order attributes but cannot compute the range.
void SetAttributeTolerance (double value)
 Set the relative attribute accuracy to `value'. See GetAttributeTolerance() for details.

Static Public Member Functions

static new vtkAttributesErrorMetric New ()
 Construct the error metric with a default relative attribute accuracy equal to 0.1.
static new int IsTypeOf (string type)
 Standard VTK type and error macros.
static new vtkAttributesErrorMetric SafeDownCast (vtkObjectBase o)
 Standard VTK type and error macros.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkAttributesErrorMetric"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "24vtkAttributesErrorMetric"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkAttributesErrorMetric_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtkAttributesErrorMetric_GetAbsoluteAttributeTolerance_01 (HandleRef pThis)
static internal double vtkAttributesErrorMetric_GetAttributeTolerance_02 (HandleRef pThis)
static internal double vtkAttributesErrorMetric_GetError_03 (HandleRef pThis, IntPtr leftPoint, IntPtr midPoint, IntPtr rightPoint, double alpha)
static internal int vtkAttributesErrorMetric_IsA_04 (HandleRef pThis, string type)
static internal int vtkAttributesErrorMetric_IsTypeOf_05 (string type)
static internal IntPtr vtkAttributesErrorMetric_NewInstance_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkAttributesErrorMetric_RequiresEdgeSubdivision_08 (HandleRef pThis, IntPtr leftPoint, IntPtr midPoint, IntPtr rightPoint, double alpha)
static internal IntPtr vtkAttributesErrorMetric_SafeDownCast_09 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkAttributesErrorMetric_SetAbsoluteAttributeTolerance_10 (HandleRef pThis, double value)
static internal void vtkAttributesErrorMetric_SetAttributeTolerance_11 (HandleRef pThis, double value)

Static Private Member Functions

static vtkAttributesErrorMetric ()
 Automatically generated type registration mechanics.

Detailed Description

vtkAttributesErrorMetric - Objects that compute attribute-based error during cell tessellation.

Description It is a concrete error metric, based on an attribute criterium: the variation of the active attribute/component value from a linear ramp

vtkGenericCellTessellator vtkGenericSubdivisionErrorMetric


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkAttributesErrorMetric.vtkAttributesErrorMetric ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Construct the error metric with a default relative attribute accuracy equal to 0.1.


Member Function Documentation

override void Kitware.VTK.vtkAttributesErrorMetric.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkGenericSubdivisionErrorMetric.

Absolute tolerance of the active scalar (attribute+component). Subdivision is required if the square distance between the real attribute at the mid point on the edge and the interpolated attribute is greater than AbsoluteAttributeTolerance. This is the attribute accuracy. 0.01 will give better result than 0.1.

Relative tolerance of the active scalar (attribute+component). Subdivision is required if the square distance between the real attribute at the mid point on the edge and the interpolated attribute is greater than AttributeTolerance. This is the attribute accuracy. 0.01 will give better result than 0.1.

override double Kitware.VTK.vtkAttributesErrorMetric.GetError ( IntPtr  leftPoint,
IntPtr  midPoint,
IntPtr  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

Reimplemented from Kitware.VTK.vtkGenericSubdivisionErrorMetric.

override int Kitware.VTK.vtkAttributesErrorMetric.IsA ( string  type) [virtual]

Standard VTK type and error macros.

Reimplemented from Kitware.VTK.vtkGenericSubdivisionErrorMetric.

static new int Kitware.VTK.vtkAttributesErrorMetric.IsTypeOf ( string  type) [static]

Standard VTK type and error macros.

Reimplemented from Kitware.VTK.vtkGenericSubdivisionErrorMetric.

Construct the error metric with a default relative attribute accuracy equal to 0.1.

Reimplemented from Kitware.VTK.vtkObject.

Standard VTK type and error macros.

Reimplemented from Kitware.VTK.vtkGenericSubdivisionErrorMetric.

override int Kitware.VTK.vtkAttributesErrorMetric.RequiresEdgeSubdivision ( IntPtr  leftPoint,
IntPtr  midPoint,
IntPtr  rightPoint,
double  alpha 
) [virtual]

Does the edge need to be subdivided according to the distance between the value of the active attribute/component at the midpoint and the mean value between the endpoints? 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

Reimplemented from Kitware.VTK.vtkGenericSubdivisionErrorMetric.

Standard VTK type and error macros.

Reimplemented from Kitware.VTK.vtkGenericSubdivisionErrorMetric.

Here is the call graph for this function:

Set the absolute attribute accuracy to `value'. See GetAbsoluteAttributeTolerance() for details. It is particularly useful when some concrete implementation of vtkGenericAttribute does not support GetRange() request, called internally in SetAttributeTolerance(). It may happen when the implementation support higher order attributes but cannot compute the range.

Precondition:
valid_range_value: value>0

Set the relative attribute accuracy to `value'. See GetAttributeTolerance() for details.

Precondition:
valid_range_value: value>0 && value<1
static internal double Kitware.VTK.vtkAttributesErrorMetric.vtkAttributesErrorMetric_GetError_03 ( HandleRef  pThis,
IntPtr  leftPoint,
IntPtr  midPoint,
IntPtr  rightPoint,
double  alpha 
) [private]
static internal int Kitware.VTK.vtkAttributesErrorMetric.vtkAttributesErrorMetric_IsA_04 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkAttributesErrorMetric.vtkAttributesErrorMetric_IsTypeOf_05 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkAttributesErrorMetric.vtkAttributesErrorMetric_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkAttributesErrorMetric.vtkAttributesErrorMetric_NewInstance_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkAttributesErrorMetric.vtkAttributesErrorMetric_RequiresEdgeSubdivision_08 ( HandleRef  pThis,
IntPtr  leftPoint,
IntPtr  midPoint,
IntPtr  rightPoint,
double  alpha 
) [private]
static internal IntPtr Kitware.VTK.vtkAttributesErrorMetric.vtkAttributesErrorMetric_SafeDownCast_09 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkAttributesErrorMetric.vtkAttributesErrorMetric_SetAbsoluteAttributeTolerance_10 ( HandleRef  pThis,
double  value 
) [private]
static internal void Kitware.VTK.vtkAttributesErrorMetric.vtkAttributesErrorMetric_SetAttributeTolerance_11 ( HandleRef  pThis,
double  value 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkAttributesErrorMetric.MRClassNameKey = "24vtkAttributesErrorMetric" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGenericSubdivisionErrorMetric.

new const string Kitware.VTK.vtkAttributesErrorMetric.MRFullTypeName = "Kitware.VTK.vtkAttributesErrorMetric"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGenericSubdivisionErrorMetric.


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