CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdGiProgressiveMeshGeneratorOptions Class Reference

#include <GiProgressiveMesh.h>

Public Member Functions

 OdGiProgressiveMeshGeneratorOptions ()
 
 ~OdGiProgressiveMeshGeneratorOptions ()
 
OdUInt32 minVertices () const
 
void setMinVertices (OdUInt32 n)
 
OdUInt32 minFaces () const
 
void setMinFaces (OdUInt32 n)
 
double worstDiherial () const
 
void setWorstDiherial (double d)
 
double smallestCost () const
 
void setSmallestCost (double d)
 
double worstCost () const
 
void setWorstCost (double d)
 
double infinity () const
 
void setInfinity (double d)
 
bool getFitNormals () const
 
double normalErrorFactor () const
 
void setFitNormals (bool bFit, double errorFactor)
 
bool getFitColors () const
 
double colorErrorFactor () const
 
void setFitColors (bool bFit, double errorFactor)
 
double sharpEdgesScaleFactor () const
 
void setSharpEdgesScaleFactor (double d)
 
double nextCostThresholdFactor () const
 
void setNextCostThresholdFactor (double d)
 
bool getDiffMaxPenalty () const
 
double diffMaxPenaltyFactor () const
 
void setDiffMaxPenalty (bool bSet, double factor)
 
bool getSumPenalty () const
 
double sumPenaltyFactor () const
 
void setSumPenalty (bool bSet, double factor)
 
OdUInt8 strictSharp () const
 
OdUInt32 numFaceSamplePoints () const
 
void setNumFaceSamplePoints (OdUInt32 n)
 

Detailed Description

This class presents mesh simplification options

Remarks
Some parameters are internal so they changing may be undesirable Error (penalty) factors specifies how mush current error (penalty) affects on simplification step cost.
See also
<link gi_geometry_progressive_mesh_usage, Usage of the Progressive Meshes in the OdGi Library>

Definition at line 431 of file GiProgressiveMesh.h.

Constructor & Destructor Documentation

◆ OdGiProgressiveMeshGeneratorOptions()

OdGiProgressiveMeshGeneratorOptions::OdGiProgressiveMeshGeneratorOptions ( )

Default constructor for the OdGiProgressiveMeshGeneratorOptions class.

◆ ~OdGiProgressiveMeshGeneratorOptions()

OdGiProgressiveMeshGeneratorOptions::~OdGiProgressiveMeshGeneratorOptions ( )

Destructor for the OdGiProgressiveMeshGeneratorOptions class.

Member Function Documentation

◆ colorErrorFactor()

double OdGiProgressiveMeshGeneratorOptions::colorErrorFactor ( ) const
inline

Returns color error factor

Definition at line 535 of file GiProgressiveMesh.h.

◆ diffMaxPenaltyFactor()

double OdGiProgressiveMeshGeneratorOptions::diffMaxPenaltyFactor ( ) const
inline

Returns height of descendant tree penalty factor

Definition at line 579 of file GiProgressiveMesh.h.

◆ getDiffMaxPenalty()

bool OdGiProgressiveMeshGeneratorOptions::getDiffMaxPenalty ( ) const
inline

Returns true if mesh simplification should respect height of descendant tree while estimating simplification step cost

Definition at line 575 of file GiProgressiveMesh.h.

◆ getFitColors()

bool OdGiProgressiveMeshGeneratorOptions::getFitColors ( ) const
inline

Returns true if mesh simplification should respect color difference while estimating simplification step cost

Definition at line 531 of file GiProgressiveMesh.h.

◆ getFitNormals()

bool OdGiProgressiveMeshGeneratorOptions::getFitNormals ( ) const
inline

Returns true if mesh simplification should respect normal difference while estimating simplification step cost

Definition at line 511 of file GiProgressiveMesh.h.

◆ getSumPenalty()

bool OdGiProgressiveMeshGeneratorOptions::getSumPenalty ( ) const
inline

Returns true if mesh simplification should respect number of descendants while estimating simplification step cost

Definition at line 596 of file GiProgressiveMesh.h.

◆ infinity()

double OdGiProgressiveMeshGeneratorOptions::infinity ( ) const
inline

Returns infinity value

Definition at line 500 of file GiProgressiveMesh.h.

◆ minFaces()

OdUInt32 OdGiProgressiveMeshGeneratorOptions::minFaces ( ) const
inline

Returns minimum face count

Definition at line 457 of file GiProgressiveMesh.h.

◆ minVertices()

OdUInt32 OdGiProgressiveMeshGeneratorOptions::minVertices ( ) const
inline

Returns minimum vertex count

Definition at line 447 of file GiProgressiveMesh.h.

◆ nextCostThresholdFactor()

double OdGiProgressiveMeshGeneratorOptions::nextCostThresholdFactor ( ) const
inline

Returns next cost threshold factor

Definition at line 562 of file GiProgressiveMesh.h.

◆ normalErrorFactor()

double OdGiProgressiveMeshGeneratorOptions::normalErrorFactor ( ) const
inline

Returns normal error factor

Definition at line 515 of file GiProgressiveMesh.h.

◆ numFaceSamplePoints()

OdUInt32 OdGiProgressiveMeshGeneratorOptions::numFaceSamplePoints ( ) const
inline

Returns number of face sample points

Definition at line 627 of file GiProgressiveMesh.h.

◆ setDiffMaxPenalty()

void OdGiProgressiveMeshGeneratorOptions::setDiffMaxPenalty ( bool bSet,
double factor )
inline

Specifies should simplification respect height of descendant tree or not

Parameters
bSet[in] True if simplification should respect height of descendant tree
factor[in] Height of descendant tree penalty factor
Remarks
Height of descendant tree penalty factor is internal parameter. Height of descendant tree: For collapse v1-v2 -> v: DesH(v) = max( DesH( v1 ), DesH( v2 ) ) + 1

Definition at line 588 of file GiProgressiveMesh.h.

◆ setFitColors()

void OdGiProgressiveMeshGeneratorOptions::setFitColors ( bool bFit,
double errorFactor )
inline

Specifies should simplification respect color difference or not

Parameters
bFit[in] True if simplification should respect color difference
errorFactor[in] Color error factor
Remarks
Color error factor is internal parameter.

Definition at line 543 of file GiProgressiveMesh.h.

◆ setFitNormals()

void OdGiProgressiveMeshGeneratorOptions::setFitNormals ( bool bFit,
double errorFactor )
inline

Specifies should simplification respect normal difference or not

Parameters
bFit[in] True if simplification should respect normal difference
errorFactor[in] Normal error factor
Remarks
Normal error factor is internal parameter.

Definition at line 523 of file GiProgressiveMesh.h.

◆ setInfinity()

void OdGiProgressiveMeshGeneratorOptions::setInfinity ( double d)
inline

Specifies infinity value

Remarks
Internal parameter Infinity is used for prevent huge numbers comparison problems

Definition at line 507 of file GiProgressiveMesh.h.

◆ setMinFaces()

void OdGiProgressiveMeshGeneratorOptions::setMinFaces ( OdUInt32 n)
inline

Specifies minimum face count, mey be 0

Remarks
Mesh simplification stops if minimum face count is reached

Definition at line 463 of file GiProgressiveMesh.h.

◆ setMinVertices()

void OdGiProgressiveMeshGeneratorOptions::setMinVertices ( OdUInt32 n)
inline

Specifies minimum vertex count, mey be 0

Remarks
Mesh simplification stops if minimum vertex count is reached

Definition at line 453 of file GiProgressiveMesh.h.

◆ setNextCostThresholdFactor()

void OdGiProgressiveMeshGeneratorOptions::setNextCostThresholdFactor ( double d)
inline

Specifies next cost threshold factor

Remarks
Internal parameter. thresCost = currentCost + (nextCost - currentCost)*nextCostThresholdFactor() + smallestCost() If thresCost is more than threshold the cost of current simplification step will be re-estimated

Definition at line 570 of file GiProgressiveMesh.h.

◆ setNumFaceSamplePoints()

void OdGiProgressiveMeshGeneratorOptions::setNumFaceSamplePoints ( OdUInt32 n)
inline

Specifies number of face sample points

Remarks
Internal parameter.

Definition at line 633 of file GiProgressiveMesh.h.

◆ setSharpEdgesScaleFactor()

void OdGiProgressiveMeshGeneratorOptions::setSharpEdgesScaleFactor ( double d)
inline

Specifies scale number of sharp edge samples

Remarks
Internal parameter.

Definition at line 557 of file GiProgressiveMesh.h.

◆ setSmallestCost()

void OdGiProgressiveMeshGeneratorOptions::setSmallestCost ( double d)
inline

Specifies smallest simplification step cost

Remarks
Internal parameter. Smallest cost is used for prevent zero-comparison problems

Definition at line 485 of file GiProgressiveMesh.h.

◆ setSumPenalty()

void OdGiProgressiveMeshGeneratorOptions::setSumPenalty ( bool bSet,
double factor )
inline

Specifies should simplification respect number of descendants or not

Parameters
bSet[in] True if simplification should respect number of descendants
factor[in] Height of descendant tree penalty factor
Remarks
Number of descendants penalty factor is internal parameter. Number of descendants: For collapse v1-v2 -> v: DesN (v) = DesN( v1 ) + DesN( v2 )

Definition at line 609 of file GiProgressiveMesh.h.

◆ setWorstCost()

void OdGiProgressiveMeshGeneratorOptions::setWorstCost ( double d)
inline

Specifies worst simplification step cost

Remarks
Internal parameter. Mesh optimisation stops if all possible simplification steps cost more than worst cost

Definition at line 496 of file GiProgressiveMesh.h.

◆ setWorstDiherial()

void OdGiProgressiveMeshGeneratorOptions::setWorstDiherial ( double d)
inline

Specifies worst diherial value

Remarks
Internal parameter. Diherial is used to check dihedral admissible mesh configuration.

Definition at line 474 of file GiProgressiveMesh.h.

◆ sharpEdgesScaleFactor()

double OdGiProgressiveMeshGeneratorOptions::sharpEdgesScaleFactor ( ) const
inline

Returns scale number of sharp edge samples

Definition at line 551 of file GiProgressiveMesh.h.

◆ smallestCost()

double OdGiProgressiveMeshGeneratorOptions::smallestCost ( ) const
inline

Returns smallest simplification step cost

Definition at line 478 of file GiProgressiveMesh.h.

◆ strictSharp()

OdUInt8 OdGiProgressiveMeshGeneratorOptions::strictSharp ( ) const
inline

Returns possible curve topology type changes

Definition at line 617 of file GiProgressiveMesh.h.

◆ sumPenaltyFactor()

double OdGiProgressiveMeshGeneratorOptions::sumPenaltyFactor ( ) const
inline

Returns number of descendants penalty factor

Definition at line 600 of file GiProgressiveMesh.h.

◆ worstCost()

double OdGiProgressiveMeshGeneratorOptions::worstCost ( ) const
inline

Returns worst simplification step cost

Definition at line 489 of file GiProgressiveMesh.h.

◆ worstDiherial()

double OdGiProgressiveMeshGeneratorOptions::worstDiherial ( ) const
inline

Returns worst diherial value

Definition at line 467 of file GiProgressiveMesh.h.


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