IModelJson.BoxProps Interface
Interface for Box (or frustum with all rectangular sections parallel to primary xy section)
- Orientation may be given in any
AxesProp
s way (yawPitchRoll, xyVectors, zxVectors) - if topX or topY are omitted, each defaults to its baseX or baseY peer.
topOrigin
is determined with this priority order:topOrigin
overrides givenheight
- on the z axis at distance
height
- on the z axis at distance
- If both
topOrigin
andheight
are omitted,height
defaults tobaseX
- If both
Extends
Properties
Name | Type | Description | |
---|---|---|---|
baseX | number | base x size (required) | |
baseY | number | base size * if omitted, defaults to baseX. |
|
capped | undefined | false | true | 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 X direction then Y direction. |
Defined in
Last Updated: 08 January, 2020