Interface BoxOptions

interface BoxOptions {
    axis?: VectorE3;
    color?: {
        b: number;
        g: number;
        r: number;
    };
    colored?: boolean;
    depth?: number;
    height?: number;
    meridian?: VectorE3;
    mode?:
        | GeometryMode
        | "mesh"
        | "wire"
        | "point";
    offset?: VectorE3;
    openBack?: boolean;
    openBase?: boolean;
    openCap?: boolean;
    openFront?: boolean;
    openLeft?: boolean;
    openRight?: boolean;
    textured?: boolean;
    tilt?: SpinorE3;
    transparent?: boolean;
    width?: number;
}

Hierarchy

  • Record<string, unknown>
    • BoxOptions

Properties

axis?: VectorE3
color?: {
    b: number;
    g: number;
    r: number;
}
colored?: boolean
depth?: number

The extent of the box in the z-axis direction.

height?: number

The extent of the box in the y-axis direction.

meridian?: VectorE3
mode?:
    | GeometryMode
    | "mesh"
    | "wire"
    | "point"
offset?: VectorE3
openBack?: boolean
openBase?: boolean
openCap?: boolean
openFront?: boolean
openLeft?: boolean
openRight?: boolean
textured?: boolean
tilt?: SpinorE3

Rotation (spinor) to be applied to the geometry at construction time to establish the reference orientation. This cannot be changed once the object has been created because it is burned-in to the vertex locations.

transparent?: boolean
width?: number

The extent of the box in the x-axis direction.