@itwin/core-geometry 5.0.0-dev.1 → 5.0.0-dev.100

package/lib/cjs/solid/RuledSweep.js.map

@@ -1 +1 @@
-{"version":3,"file":"RuledSweep.js","sourceRoot":"","sources":["../../../src/solid/RuledSweep.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sFAAmF;AAEnF,8DAAuE;AACvE,4DAAyD;AAEzD,0CAAuC;AAIvC,qDAAkD;AAClD,iDAA8C;AAQ9C;;;;GAIG;AACH,MAAa,UAAW,SAAQ,+BAAc;IAK5C,YAAoB,QAAwB,EAAE,MAAe;QAC3D,KAAK,CAAC,MAAM,CAAC,CAAC;QALhB,wCAAwC;QACxB,uBAAkB,GAAG,YAAY,CAAC;QAKhD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IACD;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,QAAoB,EAAE,MAAe;QACxD,MAAM,aAAa,GAAG,EAAE,CAAC;QACzB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,SAAS,GAAG,2BAAY,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,SAAS;gBAAE,OAAO,SAAS,CAAC;YAC9C,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,IAAI,UAAU,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IACD,uDAAuD;IAChD,gBAAgB,KAAqB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACpE;;OAEG;IACI,kBAAkB;QACvB,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;OAEG;IACI,aAAa;QAClB,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,0BAA0B;IACnB,KAAK;QACV,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IACD,uCAAuC;IAChC,mBAAmB,CAAC,SAAoB;QAC7C,IAAI,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE;YAC/B,OAAO,KAAK,CAAC;QACf,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,iCAAiC;IAC1B,gBAAgB,CAAC,SAAoB;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC5B,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;OAIG;IACI,oBAAoB;QACzB,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAClD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;IACrD,CAAC;IACD,uDAAuD;IAChD,mBAAmB,CAAC,KAAU,IAAa,OAAO,KAAK,YAAY,UAAU,CAAC,CAAC,CAAC;IACvF,8CAA8C;IAC9B,aAAa,CAAC,KAAoB;QAChD,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;YAC/C,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;YACnE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBACtD,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,kEAAkE;IAC3D,yBAAyB,CAAC,OAAwB;QACvD,OAAO,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IACD;;;OAGG;IACI,gBAAgB,CAAC,SAAiB;QACvC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QACzC,IAAI,UAAU,GAAG,CAAC;YAChB,OAAO,SAAS,CAAC;QACnB,MAAM,CAAC,GAAG,SAAS,GAAG,UAAU,CAAC;QACjC,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,SAAS,IAAI,GAAG;YAClB,QAAQ,GAAG,UAAU,GAAG,CAAC,CAAC;;YAE1B,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,QAAQ,GAAG,CAAC,IAAI,UAAU;YAC5B,QAAQ,GAAG,UAAU,GAAG,CAAC,CAAC;QAC5B,MAAM,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC;QAC9B,MAAM,aAAa,GAAG,mBAAQ,CAAC,eAAe,CAAC,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACnE,OAAO,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,EAC/F,CAAC,UAA0B,EAAE,UAA0B,EAA8B,EAAE;YACrF,MAAM,YAAY,GAAG,yDAA2B,CAAC,kBAAkB,CAAC,UAAU,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC;YAC3G,IAAI,YAAY,YAAY,+BAAc;gBAAE,OAAO,YAAY,CAAC;YAChE,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IACD,yCAAyC;IAClC,WAAW,CAAC,aAAsB,EAAE,SAAqB;QAC9D,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS;YAClC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,WAA4B,EAAE,WAA4B,EAAE,gBAAuC;QAC9H,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,WAAW,CAAC;YAC/C,OAAO,SAAS,CAAC;QACnB,IAAI,WAAW,YAAY,4BAAU,IAAI,WAAW,YAAY,4BAAU,EAAE,CAAC;YAC3E,MAAM,MAAM,GAAG,WAAW,CAAC;YAC3B,MAAM,MAAM,GAAG,WAAW,CAAC;YAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,EAAgB,CAAC;YACrD,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;YAClC,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;YAClC,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM;gBACvC,OAAO,SAAS,CAAC;YACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9D,IAAI,CAAC,QAAQ;oBACX,OAAO,SAAS,CAAC;gBACnB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;aAAM,IAAI,WAAW,YAAY,iCAAe,IAAI,WAAW,YAAY,iCAAe,EAAE,CAAC;YAC5F,MAAM,WAAW,GAAG,WAAW,CAAC,cAAc,EAAE,CAAC;YACjD,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC;YACvC,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC;YACvC,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC;YACvC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM;gBACxH,OAAO,SAAS,CAAC;YACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC5B,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC5B,IAAI,MAAM,YAAY,+BAAc,IAAI,MAAM,YAAY,+BAAc,EAAE,CAAC;oBACzE,MAAM,YAAY,GAAG,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBACtD,IAAI,CAAC,YAAY;wBACf,OAAO,SAAS,CAAC;oBACnB,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC/B,CAAC;qBAAM,IAAI,MAAM,YAAY,iCAAe,IAAI,MAAM,YAAY,iCAAe,EAAE,CAAC;oBAClF,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC;oBACvE,IAAI,CAAC,QAAQ;wBACX,OAAO,SAAS,CAAC;oBACnB,IAAI,QAAQ,YAAY,iCAAe;wBACrC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC7B,CAAC;YACH,CAAC;YACD,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;;;OAIG;IACH,IAAW,cAAc;QACvB,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QAChC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1F,CAAC;CAEF;AApLD,gCAoLC","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 Solid\r\n */\r\n\r\nimport { ConstructCurveBetweenCurves } from \"../curve/ConstructCurveBetweenCurves\";\r\nimport { AnyCurve } from \"../curve/CurveTypes\";\r\nimport { CurveChain, CurveCollection } from \"../curve/CurveCollection\";\r\nimport { CurvePrimitive } from \"../curve/CurvePrimitive\";\r\nimport { GeometryQuery } from \"../curve/GeometryQuery\";\r\nimport { Geometry } from \"../Geometry\";\r\nimport { GeometryHandler } from \"../geometry3d/GeometryHandler\";\r\nimport { Range3d } from \"../geometry3d/Range\";\r\nimport { Transform } from \"../geometry3d/Transform\";\r\nimport { SolidPrimitive } from \"./SolidPrimitive\";\r\nimport { SweepContour } from \"./SweepContour\";\r\n\r\n/**\r\n * * type for a function argument taking 2 curves and returning another curve or failing with undefined.\r\n * * This is used (for instance) by `RuleSweep.mutatePartners`\r\n * @public\r\n */\r\nexport type CurvePrimitiveMutator = (primitiveA: CurvePrimitive, primitiveB: CurvePrimitive) => CurvePrimitive | undefined;\r\n/**\r\n * A ruled sweep (surface) is a collection of 2 or more contours.\r\n * * All contours must have identical number and type of geometry. (paths, loops, parity regions, lines, arcs, other curves)\r\n * @public\r\n */\r\nexport class RuledSweep extends SolidPrimitive {\r\n  /** String name for schema properties */\r\n  public readonly solidPrimitiveType = \"ruledSweep\";\r\n\r\n  private _contours: SweepContour[];\r\n  private constructor(contours: SweepContour[], capped: boolean) {\r\n    super(capped);\r\n    this._contours = contours;\r\n  }\r\n  /**\r\n   * Create a ruled sweep from an array of contours.\r\n   * * the contours are CAPTURED (not cloned)\r\n   */\r\n  public static create(contours: AnyCurve[], capped: boolean): RuledSweep | undefined {\r\n    const sweepContours = [];\r\n    for (const contour of contours) {\r\n      const sweepable = SweepContour.createForLinearSweep(contour);\r\n      if (sweepable === undefined) return undefined;\r\n      sweepContours.push(sweepable);\r\n    }\r\n    return new RuledSweep(sweepContours, capped);\r\n  }\r\n  /** Return a reference to the array of SweepContour. */\r\n  public sweepContoursRef(): SweepContour[] { return this._contours; }\r\n  /** Return clones of all the sweep contours\r\n   * * See also cloneContours, which returns the spatial contours without their local coordinate system definitions)\r\n   */\r\n  public cloneSweepContours(): SweepContour[] {\r\n    const result = [];\r\n    for (const sweepable of this._contours) {\r\n      result.push(sweepable.clone());\r\n    }\r\n    return result;\r\n  }\r\n  /** Return clones of all the contours\r\n   * * See also cloneContours, which returns the contours in their local coordinate systems\r\n   */\r\n  public cloneContours(): CurveCollection[] {\r\n    const result = [];\r\n    for (const sweepable of this._contours) {\r\n      result.push(sweepable.curves.clone());\r\n    }\r\n    return result;\r\n  }\r\n  /** Return a deep clone */\r\n  public clone(): RuledSweep {\r\n    return new RuledSweep(this.cloneSweepContours(), this.capped);\r\n  }\r\n  /** Transform all contours in place. */\r\n  public tryTransformInPlace(transform: Transform): boolean {\r\n    if (transform.matrix.isSingular())\r\n      return false;\r\n    for (const contour of this._contours) {\r\n      contour.tryTransformInPlace(transform);\r\n    }\r\n    return true;\r\n  }\r\n  /** Return a cloned transform. */\r\n  public cloneTransformed(transform: Transform): RuledSweep {\r\n    const result = this.clone();\r\n    result.tryTransformInPlace(transform);\r\n    return result;\r\n  }\r\n  /** Return a coordinate frame (right handed unit vectors)\r\n   * * origin on base contour\r\n   * * x, y directions from base contour.\r\n   * * z direction perpendicular\r\n   */\r\n  public getConstructiveFrame(): Transform | undefined {\r\n    if (this._contours.length === 0) return undefined;\r\n    return this._contours[0].localToWorld.cloneRigid();\r\n  }\r\n  /** Test if `other` is an instance of a `RuledSweep` */\r\n  public isSameGeometryClass(other: any): boolean { return other instanceof RuledSweep; }\r\n  /** test same contour geometry and capping. */\r\n  public override isAlmostEqual(other: GeometryQuery): boolean {\r\n    if (other instanceof RuledSweep) {\r\n      if (this.capped !== other.capped) return false;\r\n      if (this._contours.length !== other._contours.length) return false;\r\n      for (let i = 0; i < this._contours.length; i++) {\r\n        if (!this._contours[i].isAlmostEqual(other._contours[i]))\r\n          return false;\r\n      }\r\n      return true;\r\n    }\r\n    return false;\r\n  }\r\n  /** dispatch to strongly typed `handler.handleRuledSweep(this)` */\r\n  public dispatchToGeometryHandler(handler: GeometryHandler): any {\r\n    return handler.handleRuledSweep(this);\r\n  }\r\n  /**\r\n   * Return the section curves at a fraction of the sweep\r\n   * @param vFraction fractional position along the sweep direction\r\n   */\r\n  public constantVSection(vFraction: number): CurveCollection | undefined {\r\n    const numSection = this._contours.length;\r\n    if (numSection < 2)\r\n      return undefined;\r\n    const q = vFraction * numSection;\r\n    let section0 = 0;\r\n    if (vFraction >= 1.0)\r\n      section0 = numSection - 1;\r\n    else\r\n      section0 = Math.floor(q);\r\n    if (section0 + 1 >= numSection)\r\n      section0 = numSection - 2;\r\n    const section1 = section0 + 1;\r\n    const localFraction = Geometry.clampToStartEnd(q - section0, 0, 1);\r\n    return RuledSweep.mutatePartners(this._contours[section0].curves, this._contours[section1].curves,\r\n      (primitive0: CurvePrimitive, primitive1: CurvePrimitive): CurvePrimitive | undefined => {\r\n        const newPrimitive = ConstructCurveBetweenCurves.interpolateBetween(primitive0, localFraction, primitive1);\r\n        if (newPrimitive instanceof CurvePrimitive) return newPrimitive;\r\n        return undefined;\r\n      });\r\n  }\r\n  /** Pass each contour to `extendRange` */\r\n  public extendRange(rangeToExtend: Range3d, transform?: Transform): void {\r\n    for (const contour of this._contours)\r\n      contour.curves.extendRange(rangeToExtend, transform);\r\n  }\r\n\r\n  /** Construct a CurveCollection with the same structure as collectionA and collectionB, with primitives constructed by the caller-supplied primitiveMutator function.\r\n   * @returns Returns undefined if there is any type mismatch between the two collections.\r\n   */\r\n  public static mutatePartners(collectionA: CurveCollection, collectionB: CurveCollection, primitiveMutator: CurvePrimitiveMutator): CurveCollection | undefined {\r\n    if (!collectionA.isSameGeometryClass(collectionB))\r\n      return undefined;\r\n    if (collectionA instanceof CurveChain && collectionB instanceof CurveChain) {\r\n      const chainA = collectionA;\r\n      const chainB = collectionB;\r\n      const chainC = chainA.cloneEmptyPeer() as CurveChain;\r\n      const childrenA = chainA.children;\r\n      const childrenB = chainB.children;\r\n      if (childrenA.length !== childrenB.length)\r\n        return undefined;\r\n      for (let i = 0; i < childrenA.length; i++) {\r\n        const newChild = primitiveMutator(childrenA[i], childrenB[i]);\r\n        if (!newChild)\r\n          return undefined;\r\n        chainC.children.push(newChild);\r\n      }\r\n      return chainC;\r\n    } else if (collectionA instanceof CurveCollection && collectionB instanceof CurveCollection) {\r\n      const collectionC = collectionA.cloneEmptyPeer();\r\n      const childrenA = collectionA.children;\r\n      const childrenB = collectionB.children;\r\n      const childrenC = collectionC.children;\r\n      if (childrenA === undefined || childrenB === undefined || childrenC === undefined || childrenA.length !== childrenB.length)\r\n        return undefined;\r\n      for (let i = 0; i < childrenA.length; i++) {\r\n        const childA = childrenA[i];\r\n        const childB = childrenB[i];\r\n        if (childA instanceof CurvePrimitive && childB instanceof CurvePrimitive) {\r\n          const newPrimitive = primitiveMutator(childA, childB);\r\n          if (!newPrimitive)\r\n            return undefined;\r\n          childrenC.push(newPrimitive);\r\n        } else if (childA instanceof CurveCollection && childB instanceof CurveCollection) {\r\n          const newChild = this.mutatePartners(childA, childB, primitiveMutator);\r\n          if (!newChild)\r\n            return undefined;\r\n          if (newChild instanceof CurveCollection)\r\n            childrenC.push(newChild);\r\n        }\r\n      }\r\n      return collectionC;\r\n    }\r\n    return undefined;\r\n  }\r\n  /**\r\n   * Return true if this is a closed volume, as observed by\r\n   * * cap flag\r\n   * identical first and last contours.\r\n   */\r\n  public get isClosedVolume(): boolean {\r\n    const n = this._contours.length;\r\n    return n > 1 && (this.capped || this._contours[0].isAlmostEqual(this._contours[n - 1]));\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"RuledSweep.js","sourceRoot":"","sources":["../../../src/solid/RuledSweep.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sFAAmF;AAEnF,8DAAuE;AACvE,4DAAyD;AAEzD,0CAAuC;AAIvC,qDAAkD;AAClD,iDAA8C;AAQ9C;;;;GAIG;AACH,MAAa,UAAW,SAAQ,+BAAc;IAC5C,yCAAyC;IACzB,kBAAkB,GAAG,YAAY,CAAC;IAE1C,SAAS,CAAiB;IAClC,YAAoB,QAAwB,EAAE,MAAe;QAC3D,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IACD;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,QAAoB,EAAE,MAAe;QACxD,MAAM,aAAa,GAAG,EAAE,CAAC;QACzB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,SAAS,GAAG,2BAAY,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,SAAS;gBACzB,OAAO,SAAS,CAAC;YACnB,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,IAAI,UAAU,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IACD,uDAAuD;IAChD,gBAAgB;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD;;;OAGG;IACI,kBAAkB;QACvB,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;OAGG;IACI,aAAa;QAClB,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,2BAA2B;IACpB,KAAK;QACV,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IACD;;;OAGG;IACI,mBAAmB,CAAC,SAAoB;QAC7C,IAAI,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE;YAC/B,OAAO,KAAK,CAAC;QACf,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC;gBACzC,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;OAGG;IACI,gBAAgB,CAAC,SAAoB;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC5B,OAAO,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACpE,CAAC;IACD;;;;;OAKG;IACI,oBAAoB;QACzB,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YAC7B,OAAO,SAAS,CAAC;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;IACrD,CAAC;IACD,wDAAwD;IACjD,mBAAmB,CAAC,KAAU;QACnC,OAAO,KAAK,YAAY,UAAU,CAAC;IACrC,CAAC;IACD,iDAAiD;IACjC,aAAa,CAAC,KAAoB;QAChD,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;gBAC9B,OAAO,KAAK,CAAC;YACf,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC,MAAM;gBAClD,OAAO,KAAK,CAAC;YACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBACtD,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,mEAAmE;IAC5D,yBAAyB,CAAC,OAAwB;QACvD,OAAO,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IACD;;;OAGG;IACI,gBAAgB,CAAC,SAAiB;QACvC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QACzC,IAAI,UAAU,GAAG,CAAC;YAChB,OAAO,SAAS,CAAC;QACnB,MAAM,CAAC,GAAG,SAAS,GAAG,UAAU,CAAC;QACjC,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,SAAS,IAAI,GAAG;YAClB,QAAQ,GAAG,UAAU,GAAG,CAAC,CAAC;;YAE1B,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,QAAQ,GAAG,CAAC,IAAI,UAAU;YAC5B,QAAQ,GAAG,UAAU,GAAG,CAAC,CAAC;QAC5B,MAAM,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC;QAC9B,MAAM,aAAa,GAAG,mBAAQ,CAAC,eAAe,CAAC,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACnE,OAAO,UAAU,CAAC,cAAc,CAC9B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,EAC/B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,EAC/B,CAAC,UAA0B,EAAE,UAA0B,EAA8B,EAAE;YACrF,MAAM,YAAY,GAAG,yDAA2B,CAAC,kBAAkB,CAAC,UAAU,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC;YAC3G,IAAI,YAAY,YAAY,+BAAc;gBAAE,OAAO,YAAY,CAAC;YAChE,OAAO,SAAS,CAAC;QACnB,CAAC,CACF,CAAC;IACJ,CAAC;IACD,0CAA0C;IACnC,WAAW,CAAC,aAAsB,EAAE,SAAqB;QAC9D,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS;YAClC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAC1B,WAA4B,EAAE,WAA4B,EAAE,gBAAuC;QAEnG,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,WAAW,CAAC;YAC/C,OAAO,SAAS,CAAC;QACnB,IAAI,WAAW,YAAY,4BAAU,IAAI,WAAW,YAAY,4BAAU,EAAE,CAAC;YAC3E,MAAM,MAAM,GAAG,WAAW,CAAC;YAC3B,MAAM,MAAM,GAAG,WAAW,CAAC;YAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,EAAgB,CAAC;YACrD,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;YAClC,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;YAClC,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM;gBACvC,OAAO,SAAS,CAAC;YACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9D,IAAI,CAAC,QAAQ;oBACX,OAAO,SAAS,CAAC;gBACnB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;aAAM,IAAI,WAAW,YAAY,iCAAe,IAAI,WAAW,YAAY,iCAAe,EAAE,CAAC;YAC5F,MAAM,WAAW,GAAG,WAAW,CAAC,cAAc,EAAE,CAAC;YACjD,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC;YACvC,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC;YACvC,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC;YACvC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM;gBACxH,OAAO,SAAS,CAAC;YACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC5B,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC5B,IAAI,MAAM,YAAY,+BAAc,IAAI,MAAM,YAAY,+BAAc,EAAE,CAAC;oBACzE,MAAM,YAAY,GAAG,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBACtD,IAAI,CAAC,YAAY;wBACf,OAAO,SAAS,CAAC;oBACnB,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC/B,CAAC;qBAAM,IAAI,MAAM,YAAY,iCAAe,IAAI,MAAM,YAAY,iCAAe,EAAE,CAAC;oBAClF,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC;oBACvE,IAAI,CAAC,QAAQ;wBACX,OAAO,SAAS,CAAC;oBACnB,IAAI,QAAQ,YAAY,iCAAe;wBACrC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC7B,CAAC;YACH,CAAC;YACD,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;OAEG;IACH,IAAW,cAAc;QACvB,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QAChC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1F,CAAC;CACF;AAzMD,gCAyMC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module Solid\n */\n\nimport { ConstructCurveBetweenCurves } from \"../curve/ConstructCurveBetweenCurves\";\nimport { AnyCurve } from \"../curve/CurveTypes\";\nimport { CurveChain, CurveCollection } from \"../curve/CurveCollection\";\nimport { CurvePrimitive } from \"../curve/CurvePrimitive\";\nimport { GeometryQuery } from \"../curve/GeometryQuery\";\nimport { Geometry } from \"../Geometry\";\nimport { GeometryHandler } from \"../geometry3d/GeometryHandler\";\nimport { Range3d } from \"../geometry3d/Range\";\nimport { Transform } from \"../geometry3d/Transform\";\nimport { SolidPrimitive } from \"./SolidPrimitive\";\nimport { SweepContour } from \"./SweepContour\";\n\n/**\n * Type for a function argument taking 2 curves and returning another curve or failing with undefined.\n * * This is used (for instance) by `RuleSweep.mutatePartners`.\n * @public\n */\nexport type CurvePrimitiveMutator = (primitiveA: CurvePrimitive, primitiveB: CurvePrimitive) => CurvePrimitive | undefined;\n/**\n * A ruled sweep (surface) is a collection of 2 or more contours.\n * * All contours must have identical number and type of geometry. (paths, loops, parity regions, lines, arcs, other curves).\n * @public\n */\nexport class RuledSweep extends SolidPrimitive {\n  /** String name for schema properties. */\n  public readonly solidPrimitiveType = \"ruledSweep\";\n\n  private _contours: SweepContour[];\n  private constructor(contours: SweepContour[], capped: boolean) {\n    super(capped);\n    this._contours = contours;\n  }\n  /**\n   * Create a ruled sweep from an array of contours.\n   * * The contours are CAPTURED (not cloned).\n   */\n  public static create(contours: AnyCurve[], capped: boolean): RuledSweep | undefined {\n    const sweepContours = [];\n    for (const contour of contours) {\n      const sweepable = SweepContour.createForLinearSweep(contour);\n      if (sweepable === undefined)\n        return undefined;\n      sweepContours.push(sweepable);\n    }\n    return new RuledSweep(sweepContours, capped);\n  }\n  /** Return a reference to the array of SweepContour. */\n  public sweepContoursRef(): SweepContour[] {\n    return this._contours;\n  }\n  /**\n   * Return clones of the sweep contours.\n   * * See also [[cloneContours]], which returns the contours without their local coordinate system definitions.\n   */\n  public cloneSweepContours(): SweepContour[] {\n    const result = [];\n    for (const sweepable of this._contours) {\n      result.push(sweepable.clone());\n    }\n    return result;\n  }\n  /**\n   * Return clones of the sweep contours, each as a [[CurveCollection]].\n   * * See also [[cloneSweepContours]], which returns the contours with their local coordinate system definitions.\n   */\n  public cloneContours(): CurveCollection[] {\n    const result = [];\n    for (const sweepable of this._contours) {\n      result.push(sweepable.curves.clone());\n    }\n    return result;\n  }\n  /** Return a deep clone. */\n  public clone(): RuledSweep {\n    return new RuledSweep(this.cloneSweepContours(), this.capped);\n  }\n  /**\n   * Transform all contours in place.\n   * * This fails if the transformation is singular.\n   */\n  public tryTransformInPlace(transform: Transform): boolean {\n    if (transform.matrix.isSingular())\n      return false;\n    for (const contour of this._contours) {\n      if (!contour.tryTransformInPlace(transform))\n        return false;\n    }\n    return true;\n  }\n  /**\n   * Return a transformed clone.\n   * * This fails if the transformation is singular.\n   */\n  public cloneTransformed(transform: Transform): RuledSweep | undefined {\n    const result = this.clone();\n    return result.tryTransformInPlace(transform) ? result : undefined;\n  }\n  /**\n   * Return a coordinate frame (right handed unit vectors)\n   * * origin on base contour.\n   * * x, y directions from base contour.\n   * * z direction perpendicular.\n   */\n  public getConstructiveFrame(): Transform | undefined {\n    if (this._contours.length === 0)\n      return undefined;\n    return this._contours[0].localToWorld.cloneRigid();\n  }\n  /** Test if `other` is an instance of a `RuledSweep`. */\n  public isSameGeometryClass(other: any): boolean {\n    return other instanceof RuledSweep;\n  }\n  /** Test for near equality of two RuledSweeps. */\n  public override isAlmostEqual(other: GeometryQuery): boolean {\n    if (other instanceof RuledSweep) {\n      if (this.capped !== other.capped)\n        return false;\n      if (this._contours.length !== other._contours.length)\n        return false;\n      for (let i = 0; i < this._contours.length; i++) {\n        if (!this._contours[i].isAlmostEqual(other._contours[i]))\n          return false;\n      }\n      return true;\n    }\n    return false;\n  }\n  /** Dispatch to strongly typed `handler.handleRuledSweep(this)`. */\n  public dispatchToGeometryHandler(handler: GeometryHandler): any {\n    return handler.handleRuledSweep(this);\n  }\n  /**\n   * Return the section curves at a fraction of the sweep.\n   * @param vFraction fractional position along the sweep direction.\n   */\n  public constantVSection(vFraction: number): CurveCollection | undefined {\n    const numSection = this._contours.length;\n    if (numSection < 2)\n      return undefined;\n    const q = vFraction * numSection;\n    let section0 = 0;\n    if (vFraction >= 1.0)\n      section0 = numSection - 1;\n    else\n      section0 = Math.floor(q);\n    if (section0 + 1 >= numSection)\n      section0 = numSection - 2;\n    const section1 = section0 + 1;\n    const localFraction = Geometry.clampToStartEnd(q - section0, 0, 1);\n    return RuledSweep.mutatePartners(\n      this._contours[section0].curves,\n      this._contours[section1].curves,\n      (primitive0: CurvePrimitive, primitive1: CurvePrimitive): CurvePrimitive | undefined => {\n        const newPrimitive = ConstructCurveBetweenCurves.interpolateBetween(primitive0, localFraction, primitive1);\n        if (newPrimitive instanceof CurvePrimitive) return newPrimitive;\n        return undefined;\n      },\n    );\n  }\n  /** Pass each contour to `extendRange`. */\n  public extendRange(rangeToExtend: Range3d, transform?: Transform): void {\n    for (const contour of this._contours)\n      contour.curves.extendRange(rangeToExtend, transform);\n  }\n\n  /**\n   * Construct a CurveCollection with the same structure as collectionA and collectionB, with primitives constructed\n   * by the caller-supplied primitiveMutator function.\n   * @returns Returns undefined if there is any type mismatch between the two collections.\n   */\n  public static mutatePartners(\n    collectionA: CurveCollection, collectionB: CurveCollection, primitiveMutator: CurvePrimitiveMutator,\n  ): CurveCollection | undefined {\n    if (!collectionA.isSameGeometryClass(collectionB))\n      return undefined;\n    if (collectionA instanceof CurveChain && collectionB instanceof CurveChain) {\n      const chainA = collectionA;\n      const chainB = collectionB;\n      const chainC = chainA.cloneEmptyPeer() as CurveChain;\n      const childrenA = chainA.children;\n      const childrenB = chainB.children;\n      if (childrenA.length !== childrenB.length)\n        return undefined;\n      for (let i = 0; i < childrenA.length; i++) {\n        const newChild = primitiveMutator(childrenA[i], childrenB[i]);\n        if (!newChild)\n          return undefined;\n        chainC.children.push(newChild);\n      }\n      return chainC;\n    } else if (collectionA instanceof CurveCollection && collectionB instanceof CurveCollection) {\n      const collectionC = collectionA.cloneEmptyPeer();\n      const childrenA = collectionA.children;\n      const childrenB = collectionB.children;\n      const childrenC = collectionC.children;\n      if (childrenA === undefined || childrenB === undefined || childrenC === undefined || childrenA.length !== childrenB.length)\n        return undefined;\n      for (let i = 0; i < childrenA.length; i++) {\n        const childA = childrenA[i];\n        const childB = childrenB[i];\n        if (childA instanceof CurvePrimitive && childB instanceof CurvePrimitive) {\n          const newPrimitive = primitiveMutator(childA, childB);\n          if (!newPrimitive)\n            return undefined;\n          childrenC.push(newPrimitive);\n        } else if (childA instanceof CurveCollection && childB instanceof CurveCollection) {\n          const newChild = this.mutatePartners(childA, childB, primitiveMutator);\n          if (!newChild)\n            return undefined;\n          if (newChild instanceof CurveCollection)\n            childrenC.push(newChild);\n        }\n      }\n      return collectionC;\n    }\n    return undefined;\n  }\n  /**\n   * @return true if this is a closed volume.\n   */\n  public get isClosedVolume(): boolean {\n    const n = this._contours.length;\n    return n > 1 && (this.capped || this._contours[0].isAlmostEqual(this._contours[n - 1]));\n  }\n}\n"]}

package/lib/cjs/solid/SolidPrimitive.d.ts

@@ -11,8 +11,9 @@ import { RotationalSweep } from "./RotationalSweep";
 import { RuledSweep } from "./RuledSweep";
 import { Sphere } from "./Sphere";
 import { TorusPipe } from "./TorusPipe";
-/** Describes the concrete type of a [[SolidPrimitive]]. Each type name maps to a specific subclass and can be used for type-switching in conditional statements.
- *
+/**
+ * Describes the concrete type of a [[SolidPrimitive]]. Each type name maps to a specific subclass and can be used for
+ * type-switching in conditional statements.
  *  - "box" => [[Box]]
  *  - "cone" => [[Cone]]
  *  - "sphere" => [[Sphere]]
@@ -20,39 +21,39 @@ import { TorusPipe } from "./TorusPipe";
  *  - "rotationalSweep" => [[RotationalSweep]]
  *  - "ruledSweep" => [[RuledSweep]]
  *  - "torusPipe" => [[TorusPipe]]
- *
  * @public
  */
 export type SolidPrimitiveType = "box" | "cone" | "sphere" | "linearSweep" | "rotationalSweep" | "ruledSweep" | "torusPipe";
-/** Union type of all subclasses of [[SolidPrimitive]].
+/**
+ * Union type of all subclasses of [[SolidPrimitive]].
  * @public
  */
 export type AnySolidPrimitive = Box | Cone | Sphere | LinearSweep | RotationalSweep | RuledSweep | TorusPipe;
 /**
  * Base class for SolidPrimitive variants.
- *
  * * The base class holds capped flag for all derived classes.
  * @public
  */
 export declare abstract class SolidPrimitive extends GeometryQuery {
-    /** String name for schema properties */
+    /** String name for schema properties. */
     readonly geometryCategory = "solid";
-    /** String name for schema properties */
+    /** String name for schema properties. */
     abstract readonly solidPrimitiveType: SolidPrimitiveType;
-    /** flag indicating whether cap region is considered closed (i.e. a planar region, rather than just a wire in space) */
+    /** Flag indicating whether cap region is considered closed (i.e. a planar region, rather than just a wire in space). */
     protected _capped: boolean;
     protected constructor(capped: boolean);
-    /** Whether this is a capped solid */
+    /** Whether this is a capped solid. */
     get capped(): boolean;
     set capped(capped: boolean);
     /** Return a cross section at specified vFraction. */
     abstract constantVSection(_vFraction: number): CurveCollection | undefined;
-    /** Return a Transform from the local system of the solid to world.
+    /**
+     * Return a Transform from the local system of the solid to world.
      * * The particulars of origin and orientation are specific to each SolidPrimitive type.
      */
     abstract getConstructiveFrame(): Transform | undefined;
     /**
-     * @return true if this is a closed volume.
+     * Return true if this is a closed volume
      * * LinearSweep, Box, Cone only depend on capped.
      * * Sphere affected by capped and latitude sweep
      * * TorusPipe and RotationalSweep affected by capped and sweep

package/lib/cjs/solid/SolidPrimitive.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SolidPrimitive.d.ts","sourceRoot":"","sources":["../../../src/solid/SolidPrimitive.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,aAAa,GAAG,iBAAiB,GAAG,YAAY,GAAG,WAAW,CAAC;AAE5H;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7G;;;;;GAKG;AACH,8BAAsB,cAAe,SAAQ,aAAa;IACxD,wCAAwC;IACxC,SAAgB,gBAAgB,WAAW;IAC3C,wCAAwC;IACxC,kBAAyB,kBAAkB,EAAE,kBAAkB,CAAC;IAEhE,uHAAuH;IACvH,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,aAAa,MAAM,EAAE,OAAO;IACrC,qCAAqC;IACrC,IAAW,MAAM,IAAI,OAAO,CAAyB;IACrD,IAAW,MAAM,CAAC,MAAM,EAAE,OAAO,EAA4B;IAC7D,qDAAqD;aACrC,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IACjF;;OAEG;aACa,oBAAoB,IAAI,SAAS,GAAG,SAAS;IAC7D;;;;;;OAMG;IACH,aAAoB,cAAc,IAAI,OAAO,CAAC;CAC/C"}
+{"version":3,"file":"SolidPrimitive.d.ts","sourceRoot":"","sources":["../../../src/solid/SolidPrimitive.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,aAAa,GAAG,iBAAiB,GAAG,YAAY,GAAG,WAAW,CAAC;AAE5H;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7G;;;;GAIG;AACH,8BAAsB,cAAe,SAAQ,aAAa;IACxD,yCAAyC;IACzC,SAAgB,gBAAgB,WAAW;IAC3C,yCAAyC;IACzC,kBAAyB,kBAAkB,EAAE,kBAAkB,CAAC;IAChE,wHAAwH;IACxH,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,aAAa,MAAM,EAAE,OAAO;IAIrC,sCAAsC;IACtC,IAAW,MAAM,IAAI,OAAO,CAE3B;IACD,IAAW,MAAM,CAAC,MAAM,EAAE,OAAO,EAEhC;IACD,qDAAqD;aACrC,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IACjF;;;OAGG;aACa,oBAAoB,IAAI,SAAS,GAAG,SAAS;IAC7D;;;;;;OAMG;IACH,aAAoB,cAAc,IAAI,OAAO,CAAC;CAC/C"}

package/lib/cjs/solid/SolidPrimitive.js

@@ -8,20 +8,25 @@ exports.SolidPrimitive = void 0;
 const GeometryQuery_1 = require("../curve/GeometryQuery");
 /**
  * Base class for SolidPrimitive variants.
- *
  * * The base class holds capped flag for all derived classes.
  * @public
  */
 class SolidPrimitive extends GeometryQuery_1.GeometryQuery {
+    /** String name for schema properties. */
+    geometryCategory = "solid";
+    /** Flag indicating whether cap region is considered closed (i.e. a planar region, rather than just a wire in space). */
+    _capped;
     constructor(capped) {
         super();
-        /** String name for schema properties */
-        this.geometryCategory = "solid";
         this._capped = capped;
     }
-    /** Whether this is a capped solid */
-    get capped() { return this._capped; }
-    set capped(capped) { this._capped = capped; }
+    /** Whether this is a capped solid. */
+    get capped() {
+        return this._capped;
+    }
+    set capped(capped) {
+        this._capped = capped;
+    }
 }
 exports.SolidPrimitive = SolidPrimitive;
 //# sourceMappingURL=SolidPrimitive.js.map

package/lib/cjs/solid/SolidPrimitive.js.map

@@ -1 +1 @@
-{"version":3,"file":"SolidPrimitive.js","sourceRoot":"","sources":["../../../src/solid/SolidPrimitive.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAO/F,0DAAuD;AA6BvD;;;;;GAKG;AACH,MAAsB,cAAe,SAAQ,6BAAa;IAQxD,YAAsB,MAAe;QAAI,KAAK,EAAE,CAAC;QAPjD,wCAAwC;QACxB,qBAAgB,GAAG,OAAO,CAAC;QAMO,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAAC,CAAC;IAC1E,qCAAqC;IACrC,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACrD,IAAW,MAAM,CAAC,MAAe,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;CAe9D;AA1BD,wCA0BC","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 Solid\r\n */\r\n\r\nimport { CurveCollection } from \"../curve/CurveCollection\";\r\nimport { GeometryQuery } from \"../curve/GeometryQuery\";\r\nimport { Transform } from \"../geometry3d/Transform\";\r\nimport { Box } from \"./Box\";\r\nimport { Cone } from \"./Cone\";\r\nimport { LinearSweep } from \"./LinearSweep\";\r\nimport { RotationalSweep } from \"./RotationalSweep\";\r\nimport { RuledSweep } from \"./RuledSweep\";\r\nimport { Sphere } from \"./Sphere\";\r\nimport { TorusPipe } from \"./TorusPipe\";\r\n\r\n/** Describes the concrete type of a [[SolidPrimitive]]. Each type name maps to a specific subclass and can be used for type-switching in conditional statements.\r\n *\r\n *  - \"box\" => [[Box]]\r\n *  - \"cone\" => [[Cone]]\r\n *  - \"sphere\" => [[Sphere]]\r\n *  - \"linearSweep\" => [[LinearSweep]]\r\n *  - \"rotationalSweep\" => [[RotationalSweep]]\r\n *  - \"ruledSweep\" => [[RuledSweep]]\r\n *  - \"torusPipe\" => [[TorusPipe]]\r\n *\r\n * @public\r\n */\r\nexport type SolidPrimitiveType = \"box\" | \"cone\" | \"sphere\" | \"linearSweep\" | \"rotationalSweep\" | \"ruledSweep\" | \"torusPipe\";\r\n\r\n/** Union type of all subclasses of [[SolidPrimitive]].\r\n * @public\r\n */\r\nexport type AnySolidPrimitive = Box | Cone | Sphere | LinearSweep | RotationalSweep | RuledSweep | TorusPipe;\r\n\r\n/**\r\n * Base class for SolidPrimitive variants.\r\n *\r\n * * The base class holds capped flag for all derived classes.\r\n * @public\r\n */\r\nexport abstract class SolidPrimitive extends GeometryQuery {\r\n  /** String name for schema properties */\r\n  public readonly geometryCategory = \"solid\";\r\n  /** String name for schema properties */\r\n  public abstract readonly solidPrimitiveType: SolidPrimitiveType;\r\n\r\n  /** flag indicating whether cap region is considered closed (i.e. a planar region, rather than just a wire in space) */\r\n  protected _capped: boolean;\r\n  protected constructor(capped: boolean) { super(); this._capped = capped; }\r\n  /** Whether this is a capped solid */\r\n  public get capped(): boolean { return this._capped; }\r\n  public set capped(capped: boolean) { this._capped = capped; }\r\n  /** Return a cross section at specified vFraction. */\r\n  public abstract constantVSection(_vFraction: number): CurveCollection | undefined;\r\n  /** Return a Transform from the local system of the solid to world.\r\n   * * The particulars of origin and orientation are specific to each SolidPrimitive type.\r\n   */\r\n  public abstract getConstructiveFrame(): Transform | undefined;\r\n  /**\r\n   * @return true if this is a closed volume.\r\n   * * LinearSweep, Box, Cone only depend on capped.\r\n   * * Sphere affected by capped and latitude sweep\r\n   * * TorusPipe and RotationalSweep affected by capped and sweep\r\n   * * RuledSweep is affected by capped and match of first, last contour\r\n   */\r\n  public abstract get isClosedVolume(): boolean;\r\n}\r\n"]}
+{"version":3,"file":"SolidPrimitive.js","sourceRoot":"","sources":["../../../src/solid/SolidPrimitive.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAO/F,0DAAuD;AA8BvD;;;;GAIG;AACH,MAAsB,cAAe,SAAQ,6BAAa;IACxD,yCAAyC;IACzB,gBAAgB,GAAG,OAAO,CAAC;IAG3C,wHAAwH;IAC9G,OAAO,CAAU;IAC3B,YAAsB,MAAe;QACnC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IACD,sCAAsC;IACtC,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IACD,IAAW,MAAM,CAAC,MAAe;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;CAgBF;AAjCD,wCAiCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module Solid\n */\n\nimport { CurveCollection } from \"../curve/CurveCollection\";\nimport { GeometryQuery } from \"../curve/GeometryQuery\";\nimport { Transform } from \"../geometry3d/Transform\";\nimport { Box } from \"./Box\";\nimport { Cone } from \"./Cone\";\nimport { LinearSweep } from \"./LinearSweep\";\nimport { RotationalSweep } from \"./RotationalSweep\";\nimport { RuledSweep } from \"./RuledSweep\";\nimport { Sphere } from \"./Sphere\";\nimport { TorusPipe } from \"./TorusPipe\";\n\n/**\n * Describes the concrete type of a [[SolidPrimitive]]. Each type name maps to a specific subclass and can be used for\n * type-switching in conditional statements.\n *  - \"box\" => [[Box]]\n *  - \"cone\" => [[Cone]]\n *  - \"sphere\" => [[Sphere]]\n *  - \"linearSweep\" => [[LinearSweep]]\n *  - \"rotationalSweep\" => [[RotationalSweep]]\n *  - \"ruledSweep\" => [[RuledSweep]]\n *  - \"torusPipe\" => [[TorusPipe]]\n * @public\n */\nexport type SolidPrimitiveType = \"box\" | \"cone\" | \"sphere\" | \"linearSweep\" | \"rotationalSweep\" | \"ruledSweep\" | \"torusPipe\";\n\n/**\n * Union type of all subclasses of [[SolidPrimitive]].\n * @public\n */\nexport type AnySolidPrimitive = Box | Cone | Sphere | LinearSweep | RotationalSweep | RuledSweep | TorusPipe;\n\n/**\n * Base class for SolidPrimitive variants.\n * * The base class holds capped flag for all derived classes.\n * @public\n */\nexport abstract class SolidPrimitive extends GeometryQuery {\n  /** String name for schema properties. */\n  public readonly geometryCategory = \"solid\";\n  /** String name for schema properties. */\n  public abstract readonly solidPrimitiveType: SolidPrimitiveType;\n  /** Flag indicating whether cap region is considered closed (i.e. a planar region, rather than just a wire in space). */\n  protected _capped: boolean;\n  protected constructor(capped: boolean) {\n    super();\n    this._capped = capped;\n  }\n  /** Whether this is a capped solid. */\n  public get capped(): boolean {\n    return this._capped;\n  }\n  public set capped(capped: boolean) {\n    this._capped = capped;\n  }\n  /** Return a cross section at specified vFraction. */\n  public abstract constantVSection(_vFraction: number): CurveCollection | undefined;\n  /**\n   * Return a Transform from the local system of the solid to world.\n   * * The particulars of origin and orientation are specific to each SolidPrimitive type.\n   */\n  public abstract getConstructiveFrame(): Transform | undefined;\n  /**\n   * Return true if this is a closed volume\n   * * LinearSweep, Box, Cone only depend on capped.\n   * * Sphere affected by capped and latitude sweep\n   * * TorusPipe and RotationalSweep affected by capped and sweep\n   * * RuledSweep is affected by capped and match of first, last contour\n   */\n  public abstract get isClosedVolume(): boolean;\n}\n"]}

package/lib/cjs/solid/Sphere.d.ts

@@ -1,6 +1,10 @@
-import { CurveCollection } from "../curve/CurveCollection";
+/** @packageDocumentation
+ * @module Solid
+ */
+import { Arc3d } from "../curve/Arc3d";
 import { GeometryQuery } from "../curve/GeometryQuery";
 import { LineString3d } from "../curve/LineString3d";
+import { Loop } from "../curve/Loop";
 import { StrokeOptions } from "../curve/StrokeOptions";
 import { AngleSweep } from "../geometry3d/AngleSweep";
 import { GeometryHandler, UVSurface } from "../geometry3d/GeometryHandler";
@@ -12,11 +16,13 @@ import { Range3d } from "../geometry3d/Range";
 import { Transform } from "../geometry3d/Transform";
 import { SolidPrimitive } from "./SolidPrimitive";
 /**
- * A Sphere is
- *
- * * A unit sphere (but read on ....)
- * * mapped by an arbitrary (possibly skewed, non-uniform scaled) transform
- * * hence possibly the final geometry is ellipsoidal
+ * A unit sphere mapped by an arbitrary [[Transform]].
+ * * Typically, the stored matrix has orthogonal columns. In this case, if two columns have equal length, the
+ * resulting geometry is ellipsoidal; if all three columns have equal length, the resulting geometry is a sphere.
+ * * Creating a Sphere without orthogonal columns is possible but not recommended, for the resulting geometry
+ * lacks portability; for example, such a Sphere cannot be represented as a DGN element (see [[createDgnSphere]]).
+ * * An optional latitude sweep allows for partial spheres with or without caps.
+ * * Compare to [[Ellipsoid]], which has the same parameterization, but acts as a closed [[Clipper]].
  * @public
  */
 export declare class Sphere extends SolidPrimitive implements UVSurface {
@@ -32,28 +38,39 @@ export declare class Sphere extends SolidPrimitive implements UVSurface {
     private constructor();
     /** return a deep clone */
     clone(): Sphere;
-    /** Transform the sphere in place.
+    /**
+     * Transform the sphere in place.
      * * Fails if the transform is singular.
      */
     tryTransformInPlace(transform: Transform): boolean;
-    /** Return a transformed clone. */
+    /**
+     * Return a transformed clone.
+     * * Fails if the transform is singular.
+    */
     cloneTransformed(transform: Transform): Sphere | undefined;
-    /** Return a coordinate frame (right handed, unit axes)
-     * * origin at sphere center
-     * * equator in xy plane
-     * * z axis perpendicular
+    /**
+     * Construct a rigid coordinate frame from the local coordinate frame.
+     * * The returned frame is right-handed, with perpendicular unit axes.
+     * * Compare to [[cloneLocalToWorld]].
      */
     getConstructiveFrame(): Transform | undefined;
     /** Return the latitude sweep as fraction of south pole to north pole. */
     get latitudeSweepFraction(): number;
     /** Create from center and radius, with optional restricted latitudes. */
-    static createCenterRadius(center: Point3d, radius: number, latitudeSweep?: AngleSweep): Sphere;
+    static createCenterRadius(center: Point3d, radius: number, latitudeSweep?: AngleSweep, capped?: boolean): Sphere;
     /** Create an ellipsoid which is a unit sphere mapped to position by an (arbitrary, possibly skewed and scaled) transform. */
-    static createEllipsoid(localToWorld: Transform, latitudeSweep: AngleSweep, capped: boolean): Sphere | undefined;
-    /** Create a sphere from the typical parameters of the Dgn file */
-    static createDgnSphere(center: Point3d, vectorX: Vector3d, vectorZ: Vector3d, radiusXY: number, radiusZ: number, latitudeSweep: AngleSweep, capped: boolean): Sphere | undefined;
-    /** Create a sphere from the typical parameters of the Dgn file */
-    static createFromAxesAndScales(center: Point3d, axes: undefined | Matrix3d, radiusX: number, radiusY: number, radiusZ: number, latitudeSweep: AngleSweep | undefined, capped: boolean): Sphere | undefined;
+    static createEllipsoid(localToWorld: Transform, latitudeSweep?: AngleSweep, capped?: boolean): Sphere | undefined;
+    /**
+     * Create a sphere from the typical parameters of the DGN file.
+     * * This method normalizes the input vectors, squares `vectorX` against `vectorZ`, and scales the radii by the vectors' original lengths.
+     * * These restrictions allow the sphere to be represented by an element in the DGN file.
+     */
+    static createDgnSphere(center: Point3d, vectorX: Vector3d, vectorZ: Vector3d, radiusXY: number, radiusZ: number, latitudeSweep?: AngleSweep, capped?: boolean): Sphere | undefined;
+    /**
+     * Create a sphere.
+     * * If `axes` is supplied, its columns are scaled by the radii to form the sphere's local frame.
+    */
+    static createFromAxesAndScales(center: Point3d, axes: undefined | Matrix3d, radiusX: number, radiusY: number, radiusZ: number, latitudeSweep?: AngleSweep, capped?: boolean): Sphere | undefined;
     /** return (copy of) sphere center */
     cloneCenter(): Point3d;
     /** return the (full length, i.e. scaled by radius) X vector from the sphere transform */
@@ -72,6 +89,7 @@ export declare class Sphere extends SolidPrimitive implements UVSurface {
     maxAxisRadius(): number;
     /**
      * Return a (clone of) the sphere's local to world transformation.
+     * * Compare to [[getConstructiveFrame]].
      */
     cloneLocalToWorld(): Transform;
     /** Test if `other` is a `Sphere` */
@@ -79,19 +97,30 @@ export declare class Sphere extends SolidPrimitive implements UVSurface {
     /** Test for same geometry in `other` */
     isAlmostEqual(other: GeometryQuery): boolean;
     /**
-     *  return strokes for a cross-section (elliptic arc) at specified fraction v along the axis.
-     * * if strokeOptions is supplied, it is applied to the equator radii.
-     * @param v fractional position along the cone axis
-     * @param strokes stroke count or options.
+     * Return strokes for the elliptical arc cross-section at latitude sweep fraction v.
+     * * Optional inputs control the number of strokes along the cross-section:
+     *   * If `fixedStrokeCount` is supplied, it is taken as the cross-section stroke count.
+     *   * If `fixedStrokeCount` is undefined, stroke count is computed by applying `options` to the cross-section.
+     *   * If neither input is supplied, the stroke count default is 16.
+     *   * In any case, stroke count is clamped to the interval [4,64].
+     * @param v fractional position along the sphere axis
+     * @param fixedStrokeCount optional stroke count in u-direction
+     * @param options optional stroke options in u-direction
+     * @return strokes as line string
      */
-    strokeConstantVSection(v: number, fixedStrokeCount: number | undefined, options?: StrokeOptions): LineString3d;
+    strokeConstantVSection(v: number, fixedStrokeCount?: number, options?: StrokeOptions): LineString3d;
     /** Second step of double dispatch:  call `handler.handleSphere(this)` */
     dispatchToGeometryHandler(handler: GeometryHandler): any;
+    /**
+     * Return the Arc3d section at uFraction.  For the sphere, this is a meridian arc.
+     * @param uFraction fractional position along the equator.
+     */
+    constantUSection(uFraction: number): Arc3d;
     /**
      * Return the Arc3d section at vFraction.  For the sphere, this is a latitude circle.
      * @param vFraction fractional position along the sweep direction
      */
-    constantVSection(vFraction: number): CurveCollection | undefined;
+    constantVSection(vFraction: number): Loop;
     /** Extend a range to contain this sphere. */
     extendRange(range: Range3d, transform?: Transform): void;
     /** Evaluate as a uv surface

package/lib/cjs/solid/Sphere.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Sphere.d.ts","sourceRoot":"","sources":["../../../src/solid/Sphere.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;;;;GAOG;AACH,qBAAa,MAAO,SAAQ,cAAe,YAAW,SAAS;IAC7D,wCAAwC;IACxC,SAAgB,kBAAkB,YAAY;IAE9C,OAAO,CAAC,aAAa,CAAY;IACjC,OAAO,CAAC,cAAc,CAAa;IACnC,yDAAyD;IAClD,kBAAkB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG5C,0DAA0D;IACnD,kBAAkB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAI5C,kCAAkC;IAClC,OAAO;IAMP,0BAA0B;IACnB,KAAK,IAAI,MAAM;IAGtB;;OAEG;IACI,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAMzD,kCAAkC;IAC3B,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;IAUjE;;;;OAIG;IACI,oBAAoB,IAAI,SAAS,GAAG,SAAS;IAGpD,yEAAyE;IACzE,IAAW,qBAAqB,IAAI,MAAM,CAAuD;IACjG,yEAAyE;WAC3D,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,UAAU,GAAG,MAAM;IAIrG,6HAA6H;WAC/G,eAAe,CAAC,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAItH,kEAAkE;WACpD,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EACpH,aAAa,EAAE,UAAU,EACzB,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAWtC,kEAAkE;WACpD,uBAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,GAAG,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAClI,aAAa,EAAE,UAAU,GAAG,SAAS,EACrC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAMtC,qCAAqC;IAC9B,WAAW,IAAI,OAAO;IAC7B,yFAAyF;IAClF,YAAY,IAAI,QAAQ;IAC/B,yFAAyF;IAClF,YAAY,IAAI,QAAQ;IAC/B,yFAAyF;IAClF,YAAY,IAAI,QAAQ;IAC/B,mDAAmD;IAC5C,kBAAkB,IAAI,UAAU;IACvC,mHAAmH;IAC5G,gBAAgB,IAAI,MAAM,GAAG,SAAS;IAO7C;;OAEG;IACI,aAAa,IAAI,MAAM;IAI9B;;OAEG;IACI,iBAAiB,IAAI,SAAS;IACrC,oCAAoC;IAC7B,mBAAmB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IAC/C,wCAAwC;IACxB,aAAa,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO;IAQ5D;;;;;OAKG;IACI,sBAAsB,CAAC,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,SAAS,EAC3E,OAAO,CAAC,EAAE,aAAa,GAAG,YAAY;IAqDxC,yEAAyE;IAClE,yBAAyB,CAAC,OAAO,EAAE,eAAe,GAAG,GAAG;IAG/D;;;OAGG;IACI,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAUvE,6CAA6C;IACtC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI;IAiB/D;;;OAGG;IACI,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAUzF;;;OAGG;IACI,4BAA4B,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,yBAAyB;IAexI;;;;;OAKG;IACH,IAAW,cAAc,IAAI,OAAO,CAEnC;IACD;;;;OAIG;IACI,wBAAwB,IAAI,QAAQ;CAa5C"}
+{"version":3,"file":"Sphere.d.ts","sourceRoot":"","sources":["../../../src/solid/Sphere.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAGvD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;;;;;;GASG;AACH,qBAAa,MAAO,SAAQ,cAAe,YAAW,SAAS;IAC7D,wCAAwC;IACxC,SAAgB,kBAAkB,YAAY;IAE9C,OAAO,CAAC,aAAa,CAAY;IACjC,OAAO,CAAC,cAAc,CAAa;IACnC,yDAAyD;IAClD,kBAAkB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG5C,0DAA0D;IACnD,kBAAkB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAI5C,kCAAkC;IAClC,OAAO;IAMP,0BAA0B;IACnB,KAAK,IAAI,MAAM;IAGtB;;;OAGG;IACI,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAQzD;;;MAGE;IACK,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;IAIjE;;;;OAIG;IACI,oBAAoB,IAAI,SAAS,GAAG,SAAS;IAGpD,yEAAyE;IACzE,IAAW,qBAAqB,IAAI,MAAM,CAAuD;IACjG,yEAAyE;WAC3D,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM;IAIvH,6HAA6H;WAC/G,eAAe,CAAC,YAAY,EAAE,SAAS,EAAE,aAAa,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAIxH;;;;OAIG;WACW,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAWzL;;;MAGE;WACY,uBAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,GAAG,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAClI,aAAa,CAAC,EAAE,UAAU,EAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAMvC,qCAAqC;IAC9B,WAAW,IAAI,OAAO;IAC7B,yFAAyF;IAClF,YAAY,IAAI,QAAQ;IAC/B,yFAAyF;IAClF,YAAY,IAAI,QAAQ;IAC/B,yFAAyF;IAClF,YAAY,IAAI,QAAQ;IAC/B,mDAAmD;IAC5C,kBAAkB,IAAI,UAAU;IACvC,mHAAmH;IAC5G,gBAAgB,IAAI,MAAM,GAAG,SAAS;IAO7C;;OAEG;IACI,aAAa,IAAI,MAAM;IAI9B;;;OAGG;IACI,iBAAiB,IAAI,SAAS;IAGrC,oCAAoC;IAC7B,mBAAmB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IAC/C,wCAAwC;IACxB,aAAa,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO;IAQ5D;;;;;;;;;;;OAWG;IACI,sBAAsB,CAAC,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,YAAY;IAqD1G,yEAAyE;IAClE,yBAAyB,CAAC,OAAO,EAAE,eAAe,GAAG,GAAG;IAI/D;;;OAGG;IACI,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK;IAWjD;;;OAGG;IACI,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAUhD,6CAA6C;IACtC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI;IAiB/D;;;OAGG;IACI,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAUzF;;;OAGG;IACI,4BAA4B,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,yBAAyB;IAexI;;;;;OAKG;IACH,IAAW,cAAc,IAAI,OAAO,CAEnC;IACD;;;;OAIG;IACI,wBAAwB,IAAI,QAAQ;CAa5C"}

package/lib/cjs/solid/Sphere.js

@@ -13,6 +13,7 @@ const LineString3d_1 = require("../curve/LineString3d");
 const Loop_1 = require("../curve/Loop");
 const StrokeOptions_1 = require("../curve/StrokeOptions");
 const Geometry_1 = require("../Geometry");
+const Angle_1 = require("../geometry3d/Angle");
 const AngleSweep_1 = require("../geometry3d/AngleSweep");
 const Matrix3d_1 = require("../geometry3d/Matrix3d");
 const Plane3dByOriginAndVectors_1 = require("../geometry3d/Plane3dByOriginAndVectors");
@@ -21,14 +22,20 @@ const Point3dVector3d_1 = require("../geometry3d/Point3dVector3d");
 const Transform_1 = require("../geometry3d/Transform");
 const SolidPrimitive_1 = require("./SolidPrimitive");
 /**
- * A Sphere is
- *
- * * A unit sphere (but read on ....)
- * * mapped by an arbitrary (possibly skewed, non-uniform scaled) transform
- * * hence possibly the final geometry is ellipsoidal
+ * A unit sphere mapped by an arbitrary [[Transform]].
+ * * Typically, the stored matrix has orthogonal columns. In this case, if two columns have equal length, the
+ * resulting geometry is ellipsoidal; if all three columns have equal length, the resulting geometry is a sphere.
+ * * Creating a Sphere without orthogonal columns is possible but not recommended, for the resulting geometry
+ * lacks portability; for example, such a Sphere cannot be represented as a DGN element (see [[createDgnSphere]]).
+ * * An optional latitude sweep allows for partial spheres with or without caps.
+ * * Compare to [[Ellipsoid]], which has the same parameterization, but acts as a closed [[Clipper]].
  * @public
  */
 class Sphere extends SolidPrimitive_1.SolidPrimitive {
+    /** String name for schema properties */
+    solidPrimitiveType = "sphere";
+    _localToWorld; // local coordinates = unit sphere at origin
+    _latitudeSweep;
     /** Return the latitude (in radians) all fractional v. */
     vFractionToRadians(v) {
         return this._latitudeSweep.fractionToRadians(v);
@@ -40,40 +47,38 @@ class Sphere extends SolidPrimitive_1.SolidPrimitive {
     /** Constructor CAPTURES inputs */
     constructor(localToWorld, latitudeSweep, capped) {
         super(capped);
-        /** String name for schema properties */
-        this.solidPrimitiveType = "sphere";
         this._localToWorld = localToWorld;
-        this._latitudeSweep = latitudeSweep ? latitudeSweep : AngleSweep_1.AngleSweep.createFullLatitude();
+        this._latitudeSweep = latitudeSweep;
         this._latitudeSweep.capLatitudeInPlace();
     }
     /** return a deep clone */
     clone() {
         return new Sphere(this._localToWorld.clone(), this._latitudeSweep.clone(), this.capped);
     }
-    /** Transform the sphere in place.
+    /**
+     * Transform the sphere in place.
      * * Fails if the transform is singular.
      */
     tryTransformInPlace(transform) {
         if (transform.matrix.isSingular())
             return false;
         transform.multiplyTransformTransform(this._localToWorld, this._localToWorld);
+        if (transform.matrix.determinant() < 0.0)
+            this._latitudeSweep.reverseInPlace();
         return true;
     }
-    /** Return a transformed clone. */
+    /**
+     * Return a transformed clone.
+     * * Fails if the transform is singular.
+    */
     cloneTransformed(transform) {
-        const sphere1 = this.clone();
-        transform.multiplyTransformTransform(sphere1._localToWorld, sphere1._localToWorld);
-        if (transform.matrix.determinant() < 0.0) {
-            if (sphere1._latitudeSweep !== undefined) {
-                sphere1._latitudeSweep.reverseInPlace();
-            }
-        }
-        return sphere1;
+        const result = this.clone();
+        return result.tryTransformInPlace(transform) ? result : undefined;
     }
-    /** Return a coordinate frame (right handed, unit axes)
-     * * origin at sphere center
-     * * equator in xy plane
-     * * z axis perpendicular
+    /**
+     * Construct a rigid coordinate frame from the local coordinate frame.
+     * * The returned frame is right-handed, with perpendicular unit axes.
+     * * Compare to [[cloneLocalToWorld]].
      */
     getConstructiveFrame() {
         return this._localToWorld.cloneRigid();
@@ -81,30 +86,37 @@ class Sphere extends SolidPrimitive_1.SolidPrimitive {
     /** Return the latitude sweep as fraction of south pole to north pole. */
     get latitudeSweepFraction() { return this._latitudeSweep.sweepRadians / Math.PI; }
     /** Create from center and radius, with optional restricted latitudes. */
-    static createCenterRadius(center, radius, latitudeSweep) {
+    static createCenterRadius(center, radius, latitudeSweep, capped) {
         const localToWorld = Transform_1.Transform.createOriginAndMatrix(center, Matrix3d_1.Matrix3d.createUniformScale(radius));
-        return new Sphere(localToWorld, latitudeSweep ? latitudeSweep.clone() : AngleSweep_1.AngleSweep.createFullLatitude(), false);
+        return new Sphere(localToWorld, latitudeSweep ? latitudeSweep.clone() : AngleSweep_1.AngleSweep.createFullLatitude(), capped ?? false);
     }
     /** Create an ellipsoid which is a unit sphere mapped to position by an (arbitrary, possibly skewed and scaled) transform. */
     static createEllipsoid(localToWorld, latitudeSweep, capped) {
-        return new Sphere(localToWorld.clone(), latitudeSweep.clone(), capped);
+        return new Sphere(localToWorld.clone(), latitudeSweep ? latitudeSweep.clone() : AngleSweep_1.AngleSweep.createFullLatitude(), capped ?? false);
     }
-    /** Create a sphere from the typical parameters of the Dgn file */
+    /**
+     * Create a sphere from the typical parameters of the DGN file.
+     * * This method normalizes the input vectors, squares `vectorX` against `vectorZ`, and scales the radii by the vectors' original lengths.
+     * * These restrictions allow the sphere to be represented by an element in the DGN file.
+     */
     static createDgnSphere(center, vectorX, vectorZ, radiusXY, radiusZ, latitudeSweep, capped) {
-        const vectorY = vectorX.rotate90Around(vectorZ);
-        if (vectorY && !vectorX.isParallelTo(vectorZ)) {
-            const matrix = Matrix3d_1.Matrix3d.createColumns(vectorX, vectorY, vectorZ);
-            matrix.scaleColumns(radiusXY, radiusXY, radiusZ, matrix);
-            const frame = Transform_1.Transform.createOriginAndMatrix(center, matrix);
-            return new Sphere(frame, latitudeSweep.clone(), capped);
+        const rigidMatrix = Matrix3d_1.Matrix3d.createRigidFromColumns(vectorZ, vectorX, Geometry_1.AxisOrder.ZXY);
+        if (rigidMatrix) {
+            radiusXY *= vectorX.magnitude();
+            rigidMatrix.scaleColumns(radiusXY, radiusXY, radiusZ * vectorZ.magnitude(), rigidMatrix);
+            const frame = Transform_1.Transform.createOriginAndMatrix(center, rigidMatrix);
+            return new Sphere(frame, latitudeSweep ? latitudeSweep.clone() : AngleSweep_1.AngleSweep.createFullLatitude(), capped ?? false);
         }
         return undefined;
     }
-    /** Create a sphere from the typical parameters of the Dgn file */
+    /**
+     * Create a sphere.
+     * * If `axes` is supplied, its columns are scaled by the radii to form the sphere's local frame.
+    */
     static createFromAxesAndScales(center, axes, radiusX, radiusY, radiusZ, latitudeSweep, capped) {
         const localToWorld = Transform_1.Transform.createOriginAndMatrix(center, axes);
         localToWorld.matrix.scaleColumnsInPlace(radiusX, radiusY, radiusZ);
-        return new Sphere(localToWorld, latitudeSweep ? latitudeSweep.clone() : AngleSweep_1.AngleSweep.createFullLatitude(), capped);
+        return new Sphere(localToWorld, latitudeSweep ? latitudeSweep.clone() : AngleSweep_1.AngleSweep.createFullLatitude(), capped ?? false);
     }
     /** return (copy of) sphere center */
     cloneCenter() { return this._localToWorld.getOrigin(); }
@@ -134,8 +146,11 @@ class Sphere extends SolidPrimitive_1.SolidPrimitive {
     }
     /**
      * Return a (clone of) the sphere's local to world transformation.
+     * * Compare to [[getConstructiveFrame]].
      */
-    cloneLocalToWorld() { return this._localToWorld.clone(); }
+    cloneLocalToWorld() {
+        return this._localToWorld.clone();
+    }
     /** Test if `other` is a `Sphere` */
     isSameGeometryClass(other) { return other instanceof Sphere; }
     /** Test for same geometry in `other` */
@@ -150,10 +165,16 @@ class Sphere extends SolidPrimitive_1.SolidPrimitive {
         return false;
     }
     /**
-     *  return strokes for a cross-section (elliptic arc) at specified fraction v along the axis.
-     * * if strokeOptions is supplied, it is applied to the equator radii.
-     * @param v fractional position along the cone axis
-     * @param strokes stroke count or options.
+     * Return strokes for the elliptical arc cross-section at latitude sweep fraction v.
+     * * Optional inputs control the number of strokes along the cross-section:
+     *   * If `fixedStrokeCount` is supplied, it is taken as the cross-section stroke count.
+     *   * If `fixedStrokeCount` is undefined, stroke count is computed by applying `options` to the cross-section.
+     *   * If neither input is supplied, the stroke count default is 16.
+     *   * In any case, stroke count is clamped to the interval [4,64].
+     * @param v fractional position along the sphere axis
+     * @param fixedStrokeCount optional stroke count in u-direction
+     * @param options optional stroke options in u-direction
+     * @return strokes as line string
      */
     strokeConstantVSection(v, fixedStrokeCount, options) {
         let strokeCount = 16;
@@ -169,7 +190,7 @@ class Sphere extends SolidPrimitive_1.SolidPrimitive {
         const c1 = Math.cos(phi);
         const s1 = Math.sin(phi);
         let c0, s0;
-        const result = LineString3d_1.LineString3d.createForStrokes(fixedStrokeCount, options);
+        const result = LineString3d_1.LineString3d.createForStrokes(strokeCount, options);
         const deltaRadians = Math.PI * 2.0 / strokeCount;
         const fractions = result.fractions; // possibly undefined !!!
         const derivatives = result.packedDerivatives; // possibly undefined !!!
@@ -210,6 +231,20 @@ class Sphere extends SolidPrimitive_1.SolidPrimitive {
     dispatchToGeometryHandler(handler) {
         return handler.handleSphere(this);
     }
+    /**
+     * Return the Arc3d section at uFraction.  For the sphere, this is a meridian arc.
+     * @param uFraction fractional position along the equator.
+     */
+    constantUSection(uFraction) {
+        const phi = AngleSweep_1.AngleSweep.fractionToSignedPeriodicFractionStartEnd(uFraction, 0, Angle_1.Angle.pi2Radians, false);
+        const s1 = Math.sin(phi);
+        const c1 = Math.cos(phi);
+        const transform = this._localToWorld;
+        const center = transform.getOrigin();
+        const vector0 = transform.matrix.multiplyXYZ(c1, s1, 0);
+        const vector90 = transform.matrix.multiplyXYZ(0, 0, 1);
+        return Arc3d_1.Arc3d.create(center, vector0, vector90, this._latitudeSweep);
+    }
     /**
      * Return the Arc3d section at vFraction.  For the sphere, this is a latitude circle.
      * @param vFraction fractional position along the sweep direction