Skip to main content
Version: 4.x

Type Alias: AxisBoxConfig

AxisBoxConfig: object

Configuration of AxisViewTool.

Type declaration​

animationSpeed?​

optional animationSpeed: number

How long the camera animation lasts when clicking a face of the orientation box.

compass?​

optional compass: AxisBoxCompassConfig

Configuration of the compass "base" of the tool.

faces?​

optional faces: object

Configuration for each of the faces of the orientation box. Note that Reveal uses a right-handed Y up coordinate system, which might differ from the original model space. To account for this, you might want to reassign labels of the faces.

faces.xNegativeFace?​

optional xNegativeFace: AxisBoxFaceConfig

faces.xPositiveFace?​

optional xPositiveFace: AxisBoxFaceConfig

faces.yNegativeFace?​

optional yNegativeFace: AxisBoxFaceConfig

faces.yPositiveFace?​

optional yPositiveFace: AxisBoxFaceConfig

faces.zNegativeFace?​

optional zNegativeFace: AxisBoxFaceConfig

faces.zPositiveFace?​

optional zPositiveFace: AxisBoxFaceConfig

position?​

optional position: AbsolutePosition | RelativePosition

Position, either absolute or relative.

size?​

optional size: number

Size in pixels of the axis tool.

Defined in​

packages/tools/src/AxisView/types.ts:12