Skip to main content

Interface: RectangleShapeOptions

Properties​

centerWorld​

centerWorld: Point3

The rectangle centre in world coordinates. For the planar form it is projected onto the annotation plane.

Defined in​

packages/core/src/utilities/voxelSlab/shapes/createRectangleShape.ts:41


depthHalfLength?​

optional depthHalfLength: number

Half length along the normal, in mm. Omit for a flat rectangle lying in the plane; supply it for a box reaching out of the plane on both sides.

Defined in​

packages/core/src/utilities/voxelSlab/shapes/createRectangleShape.ts:55


majorAxis​

majorAxis: Point3

Direction of the major axis. Need not be unit length, and need not already lie in the plane - its component along the normal is removed.

Defined in​

packages/core/src/utilities/voxelSlab/shapes/createRectangleShape.ts:46


majorHalfLength​

majorHalfLength: number

Half length along majorAxis, in mm.

Defined in​

packages/core/src/utilities/voxelSlab/shapes/createRectangleShape.ts:48


minorHalfLength​

minorHalfLength: number

Half length perpendicular to majorAxis within the plane, in mm.

Defined in​

packages/core/src/utilities/voxelSlab/shapes/createRectangleShape.ts:50


planePoint​

planePoint: Point3

The annotation plane anchor. Defines the plane's depth.

Defined in​

packages/core/src/utilities/voxelSlab/shapes/createRectangleShape.ts:34


viewPlaneNormal​

viewPlaneNormal: Point3

The annotation view plane normal. Unit length.

Defined in​

packages/core/src/utilities/voxelSlab/shapes/createRectangleShape.ts:36


volume​

volume: VolumeGeometry

The volume being measured. Pass an IImageVolume, or any object that has direction, spacing, origin and dimensions. The structural form lets a caller that holds no cached volume, such as a test, use this code.

Defined in​

packages/core/src/utilities/voxelSlab/shapes/createRectangleShape.ts:32