InterpolationCurve3dOptions Class

fitPoints and end condition data for InterpolationCurve3d

  • This is a "typed object" version of the serializer-friendly InterpolationCurve3dProps
  • Typical use cases rarely require all parameters, so the constructor does not itemize them as parameters.

Methods

Name Description
constructor(fitPoints?: Point3d[], knots?: number[]): InterpolationCurve3dOptions    
captureOptionalProps(order: undefined | number, closed: undefined | boolean, isChordLenKnots: undefined | number, isColinearTangents: undefined | number, isChordLenTangent: undefined | number, isNaturalTangents: undefined | number, startTangent: undefined | Vector3d, endTangent: undefined | Vector3d): void One step setup of properties not named in constructor.  
clone(): InterpolationCurve3dOptions Clone with strongly typed members reduced to simple json.  
cloneAsInterpolationCurve3dProps(): InterpolationCurve3dProps Clone with strongly typed members reduced to simple json, with "undefined" members omitted  
reverseInPlace(): void reverse the order or sense of all start-to-end related properties.  
areAlmostEqual(dataA: undefined | InterpolationCurve3dOptions, dataB: undefined | InterpolationCurve3dOptions): boolean Static    
create(source: InterpolationCurve3dProps): InterpolationCurve3dOptions Static Clone with strongly typed members reduced to simple json.  

Properties

Name Type Description
closed Accessor ReadOnly boolean closed as property with default false  
endTangent Accessor ReadOnly undefined | Vector3d access POSSIBLY UNDEFINED end tangent.  
fitPoints Accessor ReadOnly Point3d[] access POINTER TO fitPoints  
isChordLenKnots Accessor ReadOnly number isChordLenKnots as property with default 0  
isChordLenTangent Accessor ReadOnly number isChordLenTangent as property with default 0  
isColinearTangents Accessor ReadOnly number isColinearTangents as property with default 0  
isNaturalTangents Accessor ReadOnly number isNaturalTangents as property with default 0  
knots Accessor ReadOnly undefined | number[] access POSSIBLY UNDEFINED knots array.  
order Accessor ReadOnly number order as property with default 4 (cubic)  
startTangent Accessor ReadOnly undefined | Vector3d access POSSIBLY UNDEFINED start tangent.  

Defined in

Last Updated: 12 June, 2024