API Reference › core-geometry › Serialization › IModelJson › IModelJson.BoxProps

IModelJson.BoxProps Interface

Interface for Box (or frustum with all rectangular sections parallel to primary xy section).

  • Orientation may be given in any AxesProps way (yawPitchRollAngles, xyVectors, zxVectors).
  • If topX or topY are omitted, each defaults to its baseX or baseY peer.
  • If topOrigin is given, height is unused.
  • If topOrigin is omitted and height is given, topOrigin is computed along the z axis at distance height.
  • If both topOrigin and height are omitted, height defaults to baseX, and topOrigin is computed as above.

Extends

Properties

Name Type Description
baseX number base x size (required)  
baseY undefined | number base y size.  
capped undefined | boolean optional capping flag.  
height undefined | number optional height.  
origin XYZProps Origin of the box coordinate system (required)  
topOrigin undefined | XYZProps top origin.  
topX undefined | number x size on top section.  
topY undefined | number y size on top section.  

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 Z direction then X direction.

Defined in

Last Updated: 16 April, 2024