CAD Exchanger SDK
cadex::ModelAlgo_BSplineConverterParameters Class Reference

Defines parameters used by ModelAlgo_BSplineConverter. More...

Public Types

enum  PriorityConstraintType { NumOfSpans, Degree }
 Defines the second-level constraints that can be prioritized. More...
 

Public Member Functions

 ModelAlgo_BSplineConverterParameters ()
 Constructor. More...
 
bool ProcessSurfaces () const
 Returns whether surfaces should be processed or ignored.
 
bool & ProcessSurfaces ()
 Returns whether surfaces should be processed or ignored.
 
void SetProcessSurfaces (bool theValue)
 Specifies whether surfaces should be processed or ignored.
 
bool ProcessCurves () const
 Returns whether 3D curves should be processed or ignored.
 
bool & ProcessCurves ()
 Returns whether 3D curves should be processed or ignored.
 
void SetProcessCurves (bool theValue)
 Specifies whether 3D curves should be processed or ignored.
 
bool ProcessCurves2d () const
 Returns whether 2D curves should be processed or ignored.
 
bool & ProcessCurves2d ()
 Returns whether 2D curves should be processed or ignored.
 
void SetProcessCurves2d (bool theValue)
 Specifies whether 2D curves should be processed or ignored.
 
int MaxDegree () const
 Returns maximum allowed degree of the resulting B-Spline representation.
 
int & MaxDegree ()
 Returns maximum allowed degree of the resulting B-Spline representation.
 
void SetMaxDegree (int theValue)
 Specifies maximum allowed degree of the resulting B-Spline representation.
 
int MaxNumOfSpans () const
 Returns maximum allowed number of spans between knots of the resulting B-Spline representation.
 
int & MaxNumOfSpans ()
 Returns maximum allowed number of spans between knots of the resulting B-Spline representation.
 
void SetMaxNumOfSpans (int theValue)
 Specifies maximum allowed number of spans between knots of the resulting B-Spline representation.
 
double MaxTolerance () const
 Returns maximum allowed deviation of the resulting B-Spline representation from the original geometry.
 
double & MaxTolerance ()
 Returns maximum allowed deviation of the resulting B-Spline representation from the original geometry.
 
void SetMaxTolerance (double theValue)
 Specifies maximum allowed deviation of the resulting B-Spline representation from the original geometry.
 
PriorityConstraintType PriorityConstraint () const
 Returns the constraint that is prioritized when the full set of constraints is conflicting.
 
PriorityConstraintTypePriorityConstraint ()
 Returns the constraint that is prioritized when the full set of constraints is conflicting.
 
void SetPriorityConstraint (PriorityConstraintType theValue)
 Specifies the constraint that is prioritized when the full set of constraints is conflicting.
 
const std::shared_ptr< internal::ModelAlgo_BSplineConverterParametersImpl > & Impl () const
 Returns an implementation object.
 

Detailed Description

Defines parameters used by ModelAlgo_BSplineConverter.

Contains parameters used by B-Spline converter (ModelAlgo_BSplineConverter) and allows to:

  • ignore/process surfaces in the model (processed by default);
  • ignore/process 3D curves in the model (processed by default);
  • ignore/process 2D curves in the model (processed by default);
  • specify maximum degree of the resulting B-Spline (9 by default).
  • specify maximum number of spans of the resulting B-Spline (10000 by default). Number of spans is equal to number of unique knots - 1 for non-periodic B-Splines and is the same as the number of unique knots for periodic one.
  • specify tolerance of approximation of original geometry (1e-6 by default).
  • specify whether to minimize degree or number of spans in case when the constraints for these two parameters can't be satisfied at once.
See also
ModelAlgo_BSplineConverter::Parameters().

Member Enumeration Documentation

◆ PriorityConstraintType

Defines the second-level constraints that can be prioritized.

In general, constraints on the degree and the number of spans of the B-Spline can't be satisfied at once. In such a situtaion one of the constraints is respected and the other is discarded. A value from this enumeration is used to specify which constraint should be respected in case of conflict.

Constructor & Destructor Documentation

◆ ModelAlgo_BSplineConverterParameters()

cadex::ModelAlgo_BSplineConverterParameters::ModelAlgo_BSplineConverterParameters ( )

Constructor.

Sets default parameter values.