@itwin/core-geometry 3.1.0-dev.26 → 3.1.0-dev.31

package/lib/cjs/curve/spiral/TransitionSpiral3d.js.map

@@ -1 +1 @@
-{"version":3,"file":"TransitionSpiral3d.js","sourceRoot":"","sources":["../../../../src/curve/spiral/TransitionSpiral3d.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sDAAmD;AAEnD,0DAAuD;AACvD,0DAAuD;AAEvD,6CAA0C;AAmC1C;;;;;;;;;;;;GAYG;AACH,MAAsB,kBAAmB,SAAQ,+BAAc;IAmB7D,YAAsB,UAA8B,EAAE,YAAuB,EAAE,sBAA6C,EAAE,gBAA6D;QACzL,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,mBAAmB,CAAC;QACjE,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,qBAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1G,CAAC;IAfD,wEAAwE;IACxE,IAAW,sBAAsB,KAAgB,OAAO,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;IAKvF,0CAA0C;IAC1C,IAAW,YAAY,KAAgB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAUnE,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,iIAAiI;IAC1H,MAAM,CAAC,iBAAiB,CAAC,MAAc,IAAY,OAAO,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC;IAEzG,+GAA+G;IACxG,MAAM,CAAC,iBAAiB,CAAC,SAAiB;QAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,mBAAQ,CAAC,iBAAiB;YAClD,OAAO,GAAG,CAAC;QACb,OAAO,GAAG,GAAG,SAAS,CAAC;IACzB,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,gBAAgB,CAAC,YAAuB;QACpD,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/H,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,oBAAoB,CAAC,EAAU,EAAE,EAAU;QACvD,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;IACrG,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,wBAAwB,CAAC,EAAU,EAAE,QAAgB,EAAE,EAAU;QAC7E,OAAO,mBAAQ,CAAC,WAAW,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5H,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,mCAAmC,CAAC,OAAe,EAAE,OAAe,EAAE,YAAoB;QACtG,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,kBAAkB,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,gCAAgC,CAAC,OAAe,EAAE,OAAe,EAAE,SAAiB;QAChG,OAAO,kBAAkB,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC/E,CAAC;IAED,sFAAsF;IAC/E,MAAM,CAAC,kCAAkC,CAAC,OAAe,EAAE,SAAiB,EAAE,YAAoB;QACvG,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,GAAG,GAAG,YAAY,GAAG,SAAS,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAChI,CAAC;IACD,sFAAsF;IAC/E,MAAM,CAAC,kCAAkC,CAAC,OAAe,EAAE,SAAiB,EAAE,YAAoB;QACvG,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,GAAG,GAAG,YAAY,GAAG,SAAS,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAChI,CAAC;IACD,iFAAiF;IACjF,IAAW,gBAAgB,KAAkD,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC7G;;;;;OAKG;IACO,yBAAyB,CAAC,UAAqB;QACvD,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAC;QACjE,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,6BAA6B;YAC7B,8DAA8D;YAC9D,MAAM,WAAW,GAAG,UAAU,CAAC,0BAA0B,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC7E,gDAAgD;YAChD,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACnF,IAAI,CAAC,aAAa,GAAG,qBAAS,CAAC,qBAAqB,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAClF,IAAI,IAAI,CAAC,gBAAgB;gBACvB,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAE1D,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AArGD,gDAqGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module Curve\r\n */\r\n\r\nimport { CurvePrimitive } from \"../CurvePrimitive\";\r\nimport { Matrix3d } from \"../../geometry3d/Matrix3d\";\r\nimport { Segment1d } from \"../../geometry3d/Segment1d\";\r\nimport { Transform } from \"../../geometry3d/Transform\";\r\nimport { TransitionConditionalProperties } from \"./TransitionConditionalProperties\";\r\nimport { Geometry } from \"../../Geometry\";\r\nimport { LineString3d } from \"../LineString3d\";\r\n/**\r\n * This is the set of valid type names for \"integrated\" spirals\r\n * * Behavior is expressed by a `NormalizedTransition` snap function.\r\n * * The snap function varies smoothly from f(0)=0 to f(1)=1\r\n * * The various snap functions are:\r\n *   * clothoid: linear\r\n *   * biquadratic: 2 quadratics pieced together, joining with 1st derivative continuity at f(0.) = 0.5, with zero slope f'(0)=0 and f'(1)= 0\r\n *   * bloss: A single cubic with zero slope at 0 and 1\r\n *   * cosine: half of a cosine wave, centered around 0.5\r\n *   * sine: full period of a sine wave added to the line f(u)=u\r\n * *\r\n * @public\r\n */\r\nexport type IntegratedSpiralTypeName = \"clothoid\" | \"bloss\" | \"biquadratic\" | \"cosine\" | \"sine\";\r\n\r\n/**\r\n * This is the set of valid type names for \"direct\" spirals.\r\n * \"Direct\" spirals can evaluate fractionToPoint by direct equations, i.e. not requiring the numeric integrations in \"Integrated\" spiral types.\r\n * @public\r\n */\r\nexport type DirectSpiralTypeName =\r\n   \"JapaneseCubic\"  // 1 term from each of the X,Y clothoid series expansions:  y = x^3 / (6RL)\r\n  | \"Arema\"       // 2 terms from each of the X,Y clothoid series expansions.  Identical to ChineseCubic!\r\n  | \"ChineseCubic\"  // Identical to Arema!\r\n  | \"HalfCosine\"  // high continuity cosine variation from quadratic.\r\n  | \"AustralianRailCorp\" // cubic with high accuracy distance series\r\n  | \"WesternAustralian\"  // simple cubic -- 2 terms of x series, 1 term of y series.\r\n  | \"Czech\"  // simple cubic with two term distance approximation\r\n  | \"MXCubicAlongArc\"  // x obtained from fractional distance via 2-terms from series, y = x^3/ (6RL)\r\n  | \"Polish\"\r\n  | \"Italian\"\r\n  ;\r\n\r\n/**\r\n * TransitionSpiral3d is a base class for multiple variants of spirals.\r\n * * The menagerie of spiral types have 2 broad categories:\r\n *   * IntegratedSpiral3d -- a spiral whose direct function for curvature versus distance must be integrated to determine x,y\r\n *     * The IntegratedSpiral3d types are enumerated in `IntegratedSpiralTypes`\r\n *   * DirectSpiral3d -- a spiral implemented with direct calculation of x,y from fractional position along the spiral.\r\n *     * The direct spiral types are enumerated in the `DirectSpiralType`\r\n * * The method set for CurvePrimitive support includes a `handleTransitionSpiral(g: TransitionSpiral3d)` which receives all the spiral types.\r\n * * The spiral class may impose expectations that its inflection is at the origin, with tangent along the x axis.\r\n *   * This is generally necessary for direct spirals.\r\n *   * This is not necessary for integrated spirals.\r\n * @public\r\n */\r\nexport abstract class TransitionSpiral3d extends CurvePrimitive {\r\n  /** string name of spiral type */\r\n  protected _spiralType: string;\r\n  /** Original defining properties. */\r\n  protected _designProperties: TransitionConditionalProperties | undefined;\r\n\r\n  /** Fractional interval for the \"active\" part of a containing spiral.\r\n   * (The radius, angle, and length conditions define a complete spiral, and some portion of it is \"active\")\r\n   */\r\n  protected _activeFractionInterval: Segment1d;\r\n  /** Return (reference to) the active portion of the reference spiral. */\r\n  public get activeFractionInterval(): Segment1d { return this._activeFractionInterval; }\r\n  /** strokes in the active portion */\r\n  public abstract get activeStrokes(): LineString3d;\r\n  /** Placement transform */\r\n  protected _localToWorld: Transform;\r\n  /** (reference to) placement transform. */\r\n  public get localToWorld(): Transform { return this._localToWorld; }\r\n\r\n  protected constructor(spiralType: string | undefined, localToWorld: Transform, activeFractionInterval: Segment1d | undefined, designProperties: TransitionConditionalProperties | undefined) {\r\n    super();\r\n    this._spiralType = spiralType ? spiralType : \"unknownSpiralType\";\r\n    this._designProperties = designProperties;\r\n    this._localToWorld = localToWorld;\r\n    this._activeFractionInterval = activeFractionInterval ? activeFractionInterval : Segment1d.create(0, 1);\r\n  }\r\n\r\n  public get spiralType(): string { return this._spiralType; }\r\n  /** Return 1/r with convention that if true zero is given as radius it represents infinite radius (0 curvature, straight line) */\r\n  public static radiusToCurvature(radius: number): number { return (radius === 0.0) ? 0.0 : 1.0 / radius; }\r\n\r\n  /** Return 1/k with convention that if near-zero is given as curvature, its infinite radius is returned as 0 */\r\n  public static curvatureToRadius(curvature: number): number {\r\n    if (Math.abs(curvature) < Geometry.smallAngleRadians)\r\n      return 0.0;\r\n    return 1.0 / curvature;\r\n  }\r\n\r\n  /** Return the average of the start and end curvatures. */\r\n  public static averageCurvature(radiusLimits: Segment1d): number {\r\n    return 0.5 * (TransitionSpiral3d.radiusToCurvature(radiusLimits.x0) + TransitionSpiral3d.radiusToCurvature(radiusLimits.x1));\r\n  }\r\n  /**\r\n   * Given two radii (or zeros for 0 curvature) return the average curvature\r\n   * @param r0 start radius, or 0 for line\r\n   * @param r1 end radius, or 0 for line\r\n   */\r\n  public static averageCurvatureR0R1(r0: number, r1: number): number {\r\n    return 0.5 * (TransitionSpiral3d.radiusToCurvature(r0) + TransitionSpiral3d.radiusToCurvature(r1));\r\n  }\r\n  /**\r\n   * Given two radii (or zeros for 0 curvature) return the average curvature\r\n   * @param r0 start radius, or 0 for line\r\n   * @param r1 end radius, or 0 for line\r\n   */\r\n  public static interpolateCurvatureR0R1(r0: number, fraction: number, r1: number): number {\r\n    return Geometry.interpolate(TransitionSpiral3d.radiusToCurvature(r0), fraction, TransitionSpiral3d.radiusToCurvature(r1));\r\n  }\r\n\r\n  /** Return the arc length of a transition spiral with given sweep and radius pair. */\r\n  public static radiusRadiusSweepRadiansToArcLength(radius0: number, radius1: number, sweepRadians: number): number {\r\n    return Math.abs(sweepRadians / TransitionSpiral3d.averageCurvatureR0R1(radius0, radius1));\r\n  }\r\n\r\n  /** Return the turn angle for spiral of given length between two radii */\r\n  public static radiusRadiusLengthToSweepRadians(radius0: number, radius1: number, arcLength: number): number {\r\n    return TransitionSpiral3d.averageCurvatureR0R1(radius0, radius1) * arcLength;\r\n  }\r\n\r\n  /** Return the end radius for spiral of given start radius, length, and turn angle. */\r\n  public static radius0LengthSweepRadiansToRadius1(radius0: number, arcLength: number, sweepRadians: number) {\r\n    return TransitionSpiral3d.curvatureToRadius((2.0 * sweepRadians / arcLength) - TransitionSpiral3d.radiusToCurvature(radius0));\r\n  }\r\n  /** Return the start radius for spiral of given end radius, length, and turn angle. */\r\n  public static radius1LengthSweepRadiansToRadius0(radius1: number, arcLength: number, sweepRadians: number) {\r\n    return TransitionSpiral3d.curvatureToRadius((2.0 * sweepRadians / arcLength) - TransitionSpiral3d.radiusToCurvature(radius1));\r\n  }\r\n  /** Return the original defining properties (if any) saved by the constructor. */\r\n  public get designProperties(): TransitionConditionalProperties | undefined { return this._designProperties; }\r\n  /**\r\n   * * If transformA is rigid with uniform scale, apply the rigid part of transformA to the localToWorld transform and return the scale and rigid separation.\r\n   * * If not rigid, do nothing and return undefined.\r\n   * * Also apply the scale factor to the designProperties.\r\n   * @param transformA\r\n   */\r\n  protected applyRigidPartOfTransform(transformA: Transform): { rigidAxes: Matrix3d, scale: number } | undefined {\r\n    const rigidData = transformA.matrix.factorRigidWithSignedScale();\r\n    if (rigidData !== undefined) {\r\n      // [sQ a][R b] = [sQ*R sQb+a]\r\n      // but we save it as [Q*R sQb+a] with spiral data scaled by s.\r\n      const transformC0 = transformA.multiplyTransformTransform(this.localToWorld);\r\n      // BUT pull the scale part out of the matrix ...\r\n      const matrixC = rigidData.rigidAxes.multiplyMatrixMatrix(this.localToWorld.matrix);\r\n      this._localToWorld = Transform.createOriginAndMatrix(transformC0.origin, matrixC);\r\n      if (this.designProperties)\r\n        this.designProperties.applyScaleFactor(rigidData.scale);\r\n\r\n      return rigidData;\r\n    }\r\n    return undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"TransitionSpiral3d.js","sourceRoot":"","sources":["../../../../src/curve/spiral/TransitionSpiral3d.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sDAAmD;AAEnD,0DAAuD;AACvD,0DAAuD;AAEvD,6CAA0C;AAE1C,mFAAgF;AAChF,mFAAyE;AAkCzE;;;;;;;;;;;;GAYG;AACH,MAAsB,kBAAmB,SAAQ,+BAAc;IAmB7D,YAAsB,UAA8B,EAAE,YAAuB,EAAE,sBAA6C,EAAE,gBAA6D;QACzL,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,mBAAmB,CAAC;QACjE,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,qBAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1G,CAAC;IAfD,wEAAwE;IACxE,IAAW,sBAAsB,KAAgB,OAAO,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;IAKvF,0CAA0C;IAC1C,IAAW,YAAY,KAAgB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAUnE,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,iIAAiI;IAC1H,MAAM,CAAC,iBAAiB,CAAC,MAAc,IAAY,OAAO,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC;IAEzG,+GAA+G;IACxG,MAAM,CAAC,iBAAiB,CAAC,SAAiB;QAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,mBAAQ,CAAC,iBAAiB;YAClD,OAAO,GAAG,CAAC;QACb,OAAO,GAAG,GAAG,SAAS,CAAC;IACzB,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,gBAAgB,CAAC,YAAuB;QACpD,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/H,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,oBAAoB,CAAC,EAAU,EAAE,EAAU;QACvD,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;IACrG,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,wBAAwB,CAAC,EAAU,EAAE,QAAgB,EAAE,EAAU;QAC7E,OAAO,mBAAQ,CAAC,WAAW,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5H,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,mCAAmC,CAAC,OAAe,EAAE,OAAe,EAAE,YAAoB;QACtG,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,kBAAkB,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,gCAAgC,CAAC,OAAe,EAAE,OAAe,EAAE,SAAiB;QAChG,OAAO,kBAAkB,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC/E,CAAC;IAED,sFAAsF;IAC/E,MAAM,CAAC,kCAAkC,CAAC,OAAe,EAAE,SAAiB,EAAE,YAAoB;QACvG,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,GAAG,GAAG,YAAY,GAAG,SAAS,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAChI,CAAC;IACD,sFAAsF;IAC/E,MAAM,CAAC,kCAAkC,CAAC,OAAe,EAAE,SAAiB,EAAE,YAAoB;QACvG,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,GAAG,GAAG,YAAY,GAAG,SAAS,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAChI,CAAC;IACD,iFAAiF;IACjF,IAAW,gBAAgB,KAAkD,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC7G;;;;;OAKG;IACO,yBAAyB,CAAC,UAAqB;QACvD,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAC;QACjE,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,6BAA6B;YAC7B,8DAA8D;YAC9D,MAAM,WAAW,GAAG,UAAU,CAAC,0BAA0B,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC7E,gDAAgD;YAChD,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACnF,IAAI,CAAC,aAAa,GAAG,qBAAS,CAAC,qBAAqB,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAClF,IAAI,IAAI,CAAC,gBAAgB;gBACvB,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAE1D,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACa,iBAAiB,CAAC,uBAA+C;QAC/E,MAAM,OAAO,GAAG,oCAAa,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,IAAI,2CAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC3E,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;IAC/B,CAAC;CACF;AAlHD,gDAkHC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module Curve\r\n */\r\n\r\nimport { CurvePrimitive } from \"../CurvePrimitive\";\r\nimport { Matrix3d } from \"../../geometry3d/Matrix3d\";\r\nimport { Segment1d } from \"../../geometry3d/Segment1d\";\r\nimport { Transform } from \"../../geometry3d/Transform\";\r\nimport { TransitionConditionalProperties } from \"./TransitionConditionalProperties\";\r\nimport { Geometry } from \"../../Geometry\";\r\nimport { LineString3d } from \"../LineString3d\";\r\nimport { CurveOffsetXYHandler } from \"../internalContexts/CurveOffsetXYHandler\";\r\nimport { OffsetOptions } from \"../internalContexts/PolygonOffsetContext\";\r\n/**\r\n * This is the set of valid type names for \"integrated\" spirals\r\n * * Behavior is expressed by a `NormalizedTransition` snap function.\r\n * * The snap function varies smoothly from f(0)=0 to f(1)=1\r\n * * The various snap functions are:\r\n *   * clothoid: linear\r\n *   * biquadratic: 2 quadratics pieced together, joining with 1st derivative continuity at f(0.) = 0.5, with zero slope f'(0)=0 and f'(1)= 0\r\n *   * bloss: A single cubic with zero slope at 0 and 1\r\n *   * cosine: half of a cosine wave, centered around 0.5\r\n *   * sine: full period of a sine wave added to the line f(u)=u\r\n * *\r\n * @public\r\n */\r\nexport type IntegratedSpiralTypeName = \"clothoid\" | \"bloss\" | \"biquadratic\" | \"cosine\" | \"sine\";\r\n\r\n/**\r\n * This is the set of valid type names for \"direct\" spirals.\r\n * \"Direct\" spirals can evaluate fractionToPoint by direct equations, i.e. not requiring the numeric integrations in \"Integrated\" spiral types.\r\n * @public\r\n */\r\nexport type DirectSpiralTypeName =\r\n   \"JapaneseCubic\"  // 1 term from each of the X,Y clothoid series expansions:  y = x^3 / (6RL)\r\n  | \"Arema\"       // 2 terms from each of the X,Y clothoid series expansions.  Identical to ChineseCubic!\r\n  | \"ChineseCubic\"  // Identical to Arema!\r\n  | \"HalfCosine\"  // high continuity cosine variation from quadratic.\r\n  | \"AustralianRailCorp\" // cubic with high accuracy distance series\r\n  | \"WesternAustralian\"  // simple cubic -- 2 terms of x series, 1 term of y series.\r\n  | \"Czech\"  // simple cubic with two term distance approximation\r\n  | \"MXCubicAlongArc\"  // x obtained from fractional distance via 2-terms from series, y = x^3/ (6RL)\r\n  | \"Polish\"\r\n  | \"Italian\"\r\n  ;\r\n\r\n/**\r\n * TransitionSpiral3d is a base class for multiple variants of spirals.\r\n * * The menagerie of spiral types have 2 broad categories:\r\n *   * IntegratedSpiral3d -- a spiral whose direct function for curvature versus distance must be integrated to determine x,y\r\n *     * The IntegratedSpiral3d types are enumerated in `IntegratedSpiralTypes`\r\n *   * DirectSpiral3d -- a spiral implemented with direct calculation of x,y from fractional position along the spiral.\r\n *     * The direct spiral types are enumerated in the `DirectSpiralType`\r\n * * The method set for CurvePrimitive support includes a `handleTransitionSpiral(g: TransitionSpiral3d)` which receives all the spiral types.\r\n * * The spiral class may impose expectations that its inflection is at the origin, with tangent along the x axis.\r\n *   * This is generally necessary for direct spirals.\r\n *   * This is not necessary for integrated spirals.\r\n * @public\r\n */\r\nexport abstract class TransitionSpiral3d extends CurvePrimitive {\r\n  /** string name of spiral type */\r\n  protected _spiralType: string;\r\n  /** Original defining properties. */\r\n  protected _designProperties: TransitionConditionalProperties | undefined;\r\n\r\n  /** Fractional interval for the \"active\" part of a containing spiral.\r\n   * (The radius, angle, and length conditions define a complete spiral, and some portion of it is \"active\")\r\n   */\r\n  protected _activeFractionInterval: Segment1d;\r\n  /** Return (reference to) the active portion of the reference spiral. */\r\n  public get activeFractionInterval(): Segment1d { return this._activeFractionInterval; }\r\n  /** strokes in the active portion */\r\n  public abstract get activeStrokes(): LineString3d;\r\n  /** Placement transform */\r\n  protected _localToWorld: Transform;\r\n  /** (reference to) placement transform. */\r\n  public get localToWorld(): Transform { return this._localToWorld; }\r\n\r\n  protected constructor(spiralType: string | undefined, localToWorld: Transform, activeFractionInterval: Segment1d | undefined, designProperties: TransitionConditionalProperties | undefined) {\r\n    super();\r\n    this._spiralType = spiralType ? spiralType : \"unknownSpiralType\";\r\n    this._designProperties = designProperties;\r\n    this._localToWorld = localToWorld;\r\n    this._activeFractionInterval = activeFractionInterval ? activeFractionInterval : Segment1d.create(0, 1);\r\n  }\r\n\r\n  public get spiralType(): string { return this._spiralType; }\r\n  /** Return 1/r with convention that if true zero is given as radius it represents infinite radius (0 curvature, straight line) */\r\n  public static radiusToCurvature(radius: number): number { return (radius === 0.0) ? 0.0 : 1.0 / radius; }\r\n\r\n  /** Return 1/k with convention that if near-zero is given as curvature, its infinite radius is returned as 0 */\r\n  public static curvatureToRadius(curvature: number): number {\r\n    if (Math.abs(curvature) < Geometry.smallAngleRadians)\r\n      return 0.0;\r\n    return 1.0 / curvature;\r\n  }\r\n\r\n  /** Return the average of the start and end curvatures. */\r\n  public static averageCurvature(radiusLimits: Segment1d): number {\r\n    return 0.5 * (TransitionSpiral3d.radiusToCurvature(radiusLimits.x0) + TransitionSpiral3d.radiusToCurvature(radiusLimits.x1));\r\n  }\r\n  /**\r\n   * Given two radii (or zeros for 0 curvature) return the average curvature\r\n   * @param r0 start radius, or 0 for line\r\n   * @param r1 end radius, or 0 for line\r\n   */\r\n  public static averageCurvatureR0R1(r0: number, r1: number): number {\r\n    return 0.5 * (TransitionSpiral3d.radiusToCurvature(r0) + TransitionSpiral3d.radiusToCurvature(r1));\r\n  }\r\n  /**\r\n   * Given two radii (or zeros for 0 curvature) return the average curvature\r\n   * @param r0 start radius, or 0 for line\r\n   * @param r1 end radius, or 0 for line\r\n   */\r\n  public static interpolateCurvatureR0R1(r0: number, fraction: number, r1: number): number {\r\n    return Geometry.interpolate(TransitionSpiral3d.radiusToCurvature(r0), fraction, TransitionSpiral3d.radiusToCurvature(r1));\r\n  }\r\n\r\n  /** Return the arc length of a transition spiral with given sweep and radius pair. */\r\n  public static radiusRadiusSweepRadiansToArcLength(radius0: number, radius1: number, sweepRadians: number): number {\r\n    return Math.abs(sweepRadians / TransitionSpiral3d.averageCurvatureR0R1(radius0, radius1));\r\n  }\r\n\r\n  /** Return the turn angle for spiral of given length between two radii */\r\n  public static radiusRadiusLengthToSweepRadians(radius0: number, radius1: number, arcLength: number): number {\r\n    return TransitionSpiral3d.averageCurvatureR0R1(radius0, radius1) * arcLength;\r\n  }\r\n\r\n  /** Return the end radius for spiral of given start radius, length, and turn angle. */\r\n  public static radius0LengthSweepRadiansToRadius1(radius0: number, arcLength: number, sweepRadians: number) {\r\n    return TransitionSpiral3d.curvatureToRadius((2.0 * sweepRadians / arcLength) - TransitionSpiral3d.radiusToCurvature(radius0));\r\n  }\r\n  /** Return the start radius for spiral of given end radius, length, and turn angle. */\r\n  public static radius1LengthSweepRadiansToRadius0(radius1: number, arcLength: number, sweepRadians: number) {\r\n    return TransitionSpiral3d.curvatureToRadius((2.0 * sweepRadians / arcLength) - TransitionSpiral3d.radiusToCurvature(radius1));\r\n  }\r\n  /** Return the original defining properties (if any) saved by the constructor. */\r\n  public get designProperties(): TransitionConditionalProperties | undefined { return this._designProperties; }\r\n  /**\r\n   * * If transformA is rigid with uniform scale, apply the rigid part of transformA to the localToWorld transform and return the scale and rigid separation.\r\n   * * If not rigid, do nothing and return undefined.\r\n   * * Also apply the scale factor to the designProperties.\r\n   * @param transformA\r\n   */\r\n  protected applyRigidPartOfTransform(transformA: Transform): { rigidAxes: Matrix3d, scale: number } | undefined {\r\n    const rigidData = transformA.matrix.factorRigidWithSignedScale();\r\n    if (rigidData !== undefined) {\r\n      // [sQ a][R b] = [sQ*R sQb+a]\r\n      // but we save it as [Q*R sQb+a] with spiral data scaled by s.\r\n      const transformC0 = transformA.multiplyTransformTransform(this.localToWorld);\r\n      // BUT pull the scale part out of the matrix ...\r\n      const matrixC = rigidData.rigidAxes.multiplyMatrixMatrix(this.localToWorld.matrix);\r\n      this._localToWorld = Transform.createOriginAndMatrix(transformC0.origin, matrixC);\r\n      if (this.designProperties)\r\n        this.designProperties.applyScaleFactor(rigidData.scale);\r\n\r\n      return rigidData;\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Construct an offset of the instance curve as viewed in the xy-plane (ignoring z).\r\n   * * No attempt is made to join the offsets of smaller constituent primitives. To construct a fully joined offset\r\n   *   for an aggregate instance (e.g., LineString3d, CurveChainWithDistanceIndex), use RegionOps.constructCurveXYOffset() instead.\r\n   * @param offsetDistanceOrOptions offset distance (positive to left of the instance curve), or options object\r\n   */\r\n  public override constructOffsetXY(offsetDistanceOrOptions: number | OffsetOptions): CurvePrimitive | CurvePrimitive[] | undefined {\r\n    const options = OffsetOptions.create(offsetDistanceOrOptions);\r\n    const handler = new CurveOffsetXYHandler(this, options.leftOffsetDistance);\r\n    this.emitStrokableParts(handler, options.strokeOptions);\r\n    return handler.claimResult();\r\n  }\r\n}\r\n"]}

package/lib/cjs/geometry3d/Matrix3d.d.ts

@@ -258,7 +258,7 @@ export declare class Matrix3d implements BeJSONFunctions {
      */
     static createUniformScale(scaleFactor: number): Matrix3d;
     /**
-     * Construct a rigid matrix using createHeadsUpPerpendicular to generate a vector perpendicular to vectorA..
+     * Construct a rigid matrix using createPerpendicularVectorFavorXYPlane to generate a vector perpendicular to vectorA.
      * *
      */
     static createRigidHeadsUp(vectorA: Vector3d, axisOrder?: AxisOrder, result?: Matrix3d): Matrix3d;
@@ -274,7 +274,7 @@ export declare class Matrix3d implements BeJSONFunctions {
      * return a vector that is perpendicular to the input direction.
      * * Among the infinite number of perpendiculars possible, this method
      * favors having one near the Z.
-     * That is achieved by crossing "this" vector with the result of createHeadsUpPerpendicularFavorXYPlane.
+     * That is achieved by crossing "this" vector with the result of createPerpendicularVectorFavorXYPlane.
      */
     static createPerpendicularVectorFavorPlaneContainingZ(vector: Vector3d, result?: Vector3d): Vector3d;
     /** Create a matrix with distinct x,y,z diagonal (scale) entries.
@@ -664,8 +664,8 @@ export declare class Matrix3d implements BeJSONFunctions {
      * * if either input cffA or coffB is undefined, set state to `InverseMatrixState.unknown` (but leave the inverseCoffs untouched)
      */
     private finishInverseCoffs;
-    /** Multiply two matrices.
-     *   @return the matrix result
+    /** Multiply the instance matrix A by the input matrix B.
+     *   @return the matrix product A * B
      */
     multiplyMatrixMatrix(other: Matrix3d, result?: Matrix3d): Matrix3d;
     private static _productBuffer;

package/lib/cjs/geometry3d/Matrix3d.js

@@ -472,7 +472,7 @@ class Matrix3d {
         return Matrix3d.createScale(scaleFactor, scaleFactor, scaleFactor);
     }
     /**
-     * Construct a rigid matrix using createHeadsUpPerpendicular to generate a vector perpendicular to vectorA..
+     * Construct a rigid matrix using createPerpendicularVectorFavorXYPlane to generate a vector perpendicular to vectorA.
      * *
      */
     static createRigidHeadsUp(vectorA, axisOrder = Geometry_1.AxisOrder.ZXY, result) {
@@ -503,7 +503,7 @@ class Matrix3d {
      * return a vector that is perpendicular to the input direction.
      * * Among the infinite number of perpendiculars possible, this method
      * favors having one near the Z.
-     * That is achieved by crossing "this" vector with the result of createHeadsUpPerpendicularFavorXYPlane.
+     * That is achieved by crossing "this" vector with the result of createPerpendicularVectorFavorXYPlane.
      */
     static createPerpendicularVectorFavorPlaneContainingZ(vector, result) {
         result = Matrix3d.createPerpendicularVectorFavorXYPlane(vector, result);
@@ -1542,8 +1542,8 @@ class Matrix3d {
      * 4) M = ATranspose * B       MInverse = BInverse * AInverseTranspose
      * 5) M = A * BTranspose       MInverse = BInverseTranspose * AInverse
     */
-    /** Multiply two matrices.
-     *   @return the matrix result
+    /** Multiply the instance matrix A by the input matrix B.
+     *   @return the matrix product A * B
      */
     multiplyMatrixMatrix(other, result) {
         result = result ? result : new Matrix3d();