API Reference > geometry-core > Serialization > IModelJson > IModelJson.TorusPipeProps

IModelJson.TorusPipeProps Interface

Interface for TorusPipe data

  • Orientation may be given in any AxesProps way (yawPitchRoll, xyVectors, zxVectors)
  • Both radii are required.
  • axes are required
  • Axis definition is
  • xy plane contains the major circle
  • x axis points from donut hole center to flow center at start of pipe.
  • z axis points through the hole.

Extends

Properties

Name Type Description
capped undefined | false | true optional capping flag.  
center XYZProps Center of the full torus coordinate system.  
majorRadius number primary radius (elbow radius)  
minorRadius undefined | number pipe radius  
sweepAngle undefined | AngleProps sweep angle.  

Inherited properties

Name Type Inherited from Description
xyVectors undefined | [XYZProps, XYZProps] IModelJson.AxesProps Cartesian coordinate directions defined by X direction then Y direction.
yawPitchRollAngles undefined | YawPitchRollProps IModelJson.AxesProps See YawPitchAngles class for further information about using 3 rotations to specify orientation.
zxVectors undefined | [XYZProps, XYZProps] IModelJson.AxesProps Cartesian coordinate directions defined by X direction then Y direction.

Defined in

Last Updated: 13 June, 2024