NurbsCurveFitParameters

References
The NURBS curve fit tool creates a NURBS curve that approximates an existing curve. The NurbsCurveFitParameters class contains the paramters that determine NURBS curve properties (degree, point count, ...) and other fitting contstraints.

Constructors

NurbsCurveFitParameters

#Since v5.0
Initializes a new instance of the NurbsCurveFitParameters class.
public NurbsCurveFitParameters()

NurbsCurveFitParameters

#Since v9.0
Creates a new instance of the NurbsCurveFitParameters class as a copy of an existing instance.
public NurbsCurveFitParameters(
NurbsCurveFitParameters
other
The instance to copy
)

Finalizer

~NurbsCurveFitParameters

#
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
~NurbsCurveFitParameters()

Properties

ApplyTangentMatchingAtKinks

#Since v9.0
If true, the TangentMatching setting is applied at kinks. Otherwise, TangentMatching applies only to the ends of curves.
public bool ApplyTangentMatchingAtKinks { get; set; }

ClampedControlPointCount

#Since v9.0
Number of control points if the NURBS curve will be clamped. Number of total control points if the NURBS curve will be periodic. This number is >= PointCount() Includes SubDFriendly constrained points and the duplicated point for a clamped closed curve.
public int ClampedControlPointCount { get; }

Closed

#Since v9.0
Number of total control points if the NURBS curve will be periodic. This number is >= PointCount() and includes periodic duplicates.
public bool Closed { get; set; }

ConstrainedPointCount

#Since v9.0
If Closed() is true, the number of constrained points is (TangentMatchStart() || TangentMatchEnd() ? 1 : 0)
  • (TangentMatchStart()?1:0)
  • (TangentMatchEnd()?1:0).
If Closed() is false, the number of constrained points is 2
  • (SubDFriendly() ? 2 : 0)
  • (TangentMatchStart()?1:0)
  • (TangentMatchEnd()?1:0).
public int ConstrainedPointCount { get; }
Number of constrained points.

CurvatureBiasCoefficient

#Since v9.0
When CurvatureBiasIntensity == NurbsCurveFitParameters.Intensity::Custom, this value is used as the curvature bias parameter.
public double CurvatureBiasCoefficient { get; set; }

CurvatureBiasIntensity

#Since v9.0
Curvature bias is used to make the fit curve stay close to regions of relatively high curvature. Use CurvatureBiasCoefficient() to convert this enum to the the value passed to the optimizer.
public NurbsCurveFitParameters.Intensity CurvatureBiasIntensity { get; set; }

DefaultDegree

#Since v9.0
The default degree of the fit
public static int DefaultDegree { get; }

DefaultSampleCount

#Since v9.0
Default number of points to sample from input curves and pass to the fitter that creates the output NURBS curve.
public static int DefaultSampleCount { get; }

Degree

#Since v9.0
The degree of the resulting curve
public int Degree { get; set; }

KinkAngleDegrees

#Since v9.0
The angle, in degrees, used to determine if when an abrupt change in tangent or curvature vector direction is a kink.
public double KinkAngleDegrees { get; set; }

KinkAngleRadians

#Since v9.0
The angle, in radians, used to determine if when an abrupt change in tangent or curvature vector direction is a kink.
public double KinkAngleRadians { get; set; }

KinkSplitting

#Since v9.0
Gets or sets the kink splitting behavior used when fitting a NURBS curve. See also NurbsCurveFitParameters.KinkSplit
public NurbsCurveFitParameters.KinkSplit KinkSplitting { get; set; }
Remarks: This property determines how the curve fitting algorithm handles kinks or sharp changes in direction. Adjusting this value can influence the smoothness and accuracy of the resulting curve. Choose an appropriate value based on whether preserving or smoothing out kinks is desired for your application.

MaximumDegree

#Since v9.0
The maximum degree of the fit
public static int MaximumDegree { get; }

MaximumPointCount

#Since v9.0
Gets the maximum number of points supported for NURBS curve fitting operations.
public static int MaximumPointCount { get; }

MaximumSampleCount

#Since v9.0
Maximum number of points to sample from input curves and pass to the fitter that creates the output NURBS curve.
public static int MaximumSampleCount { get; }

MinimumClampedPointCount

#Since v9.0
The minimum clamped point count
public static int MinimumClampedPointCount { get; }

MinimumClosedPointCount

#Since v9.0
The minimum closed point count
public static int MinimumClosedPointCount { get; }

MinimumDegree

#Since v9.0
The minimum degree of the fit
public static int MinimumDegree { get; }

MinimumSampleCount

#Since v9.0
Minimum number of points to sample from input curves and pass to the fitter that creates the output NURBS curve.
public static int MinimumSampleCount { get; }

OptimizeCurve

#Since v9.0
If OptimizeCurve = false, then all options below are ignored and the Greville interpolant is returned. Rhino 1 - Rhino 8 Rebuild command created a result similar to what's created when m_bOptimizeCurve = false.
public bool OptimizeCurve { get; set; }

PeriodicControlPointCount

#Since v9.0
Number of total control points if the NURBS curve will be periodic. This number is >= PointCount() and includes periodic duplicates.
public int PeriodicControlPointCount { get; }

PointCount

#Since v9.0
Number of distinct control points in the NURBS curve fit. If a range of point counts is possible, this is the minimum number.
public int PointCount { get; set; }

PointCountRange

#Since v9.0
Gets or sets the point count range as an IndexPair.
public IndexPair PointCountRange { get; set; }

PointCountRangeMaximum

#Since v9.0
public int PointCountRangeMaximum { get; }
Maximum number of distinct control points in the NURBS curve fit.

PointCountRangeMinimum

#Since v9.0
public int PointCountRangeMinimum { get; }
Minimum number of distinct control points in the NURBS curve fit.

PointCountRangeTolerance

#Since v9.0
When a range of point counts is permitted and PointCountRangeTolerance greater than 0, then searching for the NURBS curve fit terminates if the separation is less than or equal to PointCountRangeTolerance.
public double PointCountRangeTolerance { get; }
The desired or target separation value used when a ranged of point counts is permitted.

SampleCount

#Since v9.0
This is the number of points the NURBS curve is fit through. Is it common for these points to be sampled from an input curve.
public int SampleCount { get; }

SmoothingCoefficient

#Since v9.0
When SmoothingIntensity == NurbsCurveFitParameters.Intensity::Custom, this value is used as the smoothing parameter.
public double SmoothingCoefficient { get; set; }

SmoothingIntensity

#Since v9.0
Smoothing penalty used to make triples of consecutive control polygon points colinear. Use SmoothingCoefficient() to convert this enum to the the value passed to the optimizer.
public NurbsCurveFitParameters.Intensity SmoothingIntensity { get; set; }

SubDFriendly

#Since v9.0
Gets or sets the SubDFriendly property. When true, the resulting curve will be more likely to have good subdivision surface properties, such as fewer kinks and more even parameterization. This is accomplished by using a more aggressive kink splitting strategy and by using the SmoothingCoefficient to bias the fit towards smoother curves.
public bool SubDFriendly { get; set; }

TangentMatching

#Since v9.0
Gets ot Sets the TangentMatching value
public NurbsCurveFitParameters.TangentMatch TangentMatching { get; set; }

UniformityCoefficient

#Since v9.0
When UniformityIntensity == NurbsCurveFitParameters.Intensity::Custom, this value is used as the uniformity parameter.
public double UniformityCoefficient { get; set; }

UniformityIntensity

#Since v9.0
Uniformity penalty used to make the distance between control points more equal. Use UniformityCoefficient() to convert this enum to the the value passed to the optimizer.
public NurbsCurveFitParameters.Intensity UniformityIntensity { get; set; }

VariablePointCount

#Since v9.0
public int VariablePointCount { get; }
Returns true if the best fit in a range of point counts should be returned.

Methods

Clone

#Since v9.0
Supports the ICloneable inteface and creates a new NurbsCurveFitParameters object with the same property values as this instance.
public object Clone()

Dispose

#Since v5.0
Actively reclaims unmanaged resources that this instance uses.
public void Dispose()

Dispose

#
For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

protected virtual void Dispose(
disposing
true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.
)

GetCurvatureBiasCoefficientFromIntensity

#Since v9.0
Returns the Curvature bias coefficient that corresponds to a given NurbsCurveFitParameters.Intensity value.
public double GetCurvatureBiasCoefficientFromIntensity(
intensity
)

GetCurvatureBiasIntensityFromCoefficient

#Since v9.0
Returns the NurbsCurveFitParameters.Intensity value that corresponds to a given curvature bias coefficient.
public NurbsCurveFitParameters.Intensity GetCurvatureBiasIntensityFromCoefficient(
coefficient
)

GetPointCountRange

#Since v9.0
Get the point count range and tolerance.
public void GetPointCountRange(
out int
minimum,
out int
maximum,
out double
tolerance
)

GetSmoothingCoefficientFromIntensity

#Since v9.0
Returns the smoothing coefficient that corresponds to a given NurbsCurveFitParameters.Intensity value.
public double GetSmoothingCoefficientFromIntensity(
intensity
)

GetSmoothingIntensityFromCoefficient

#Since v9.0
Returns the NurbsCurveFitParameters.Intensity value that corresponds to a given smoothing coefficient.
public NurbsCurveFitParameters.Intensity GetSmoothingIntensityFromCoefficient(
coefficient
)

GetUniformityCoefficientFromIntensity

#Since v9.0
Returns the uniformity coefficient that corresponds to a given NurbsCurveFitParameters.Intensity value.
public double GetUniformityCoefficientFromIntensity(
intensity
)

GetUniformityIntensityFromCoefficient

#Since v9.0
Returns the NurbsCurveFitParameters.Intensity value that corresponds to a given uniformity coefficient.
public NurbsCurveFitParameters.Intensity GetUniformityIntensityFromCoefficient(
coefficient
)

MaximumPointCountForDegree

#Since v9.0
Given a point count and periodic setting, determine the maximum degree.
public static int MaximumPointCountForDegree(
degree,
Degree of output NURBS curve.
bClosed,
True if the output NURBS curve will be closed.
bSubDFriendly
True if the output NURBS curve will be SubDFriendly.
)
Maximum permitted degree.

MinimumPointCountForDegree

#Since v9.0
Give a degree and periodic setting, determine the minimum point count.
public static int MinimumPointCountForDegree(
degree,
Degree of output NURBS curve.
bClosed,
True if the output NURBS curve will be closed.
bSubDFriendly
True if the output NURBS curve will be SubDFriendly.
)
Minimum permitted point count.

SetPointCountRange

#Since v9.0
Set the point count range and tolerance.
public void SetPointCountRange(
minimum,
maximum,
tolerance
)

SetPointCountRange

#Since v9.0
Set the point count range and tolerance.
public void SetPointCountRange(
minimum,
maximum
)

ValidInput

#
returns true if the input values are within the acceptable ranges for NURBS curve fitting. If false is returned, the input values should be adjusted before calling the curve fitting function. See also MinimumPointCountForDegree() and MaximumPointCountForDegree().
public static bool ValidInput(
sample_point_count,
degree,
control_point_count,
bClosed,
curve_domain
)