Interface DistanceMeasurementParams

Construction parameters for a single DistanceMeasurement.

Caller supplies the two world-space anchors; the plugin computes the length and the X/Y/Z component decomposition each frame.

interface DistanceMeasurementParams {
    axisVisible?: boolean;
    color?: string;
    id?: string;
    labelsVisible?: boolean;
    origin: Vec3;
    target: Vec3;
    visible?: boolean;
    wireVisible?: boolean;
}

Properties

axisVisible? color? id? labelsVisible? origin target visible? wireVisible?

Properties

OptionalaxisVisible

axisVisible?: boolean

If false, hide the X/Y/Z axis-decomposition wires (red/green/ blue) and their length labels. Default true.

Optionalcolor

color?: string

CSS color for the diagonal length wire and its label background. Default "#FFA500" (orange).

Optionalid

id?: string

Optional id. If omitted, the plugin assigns one (numeric, monotonic).

OptionallabelsVisible

labelsVisible?: boolean

If false, hide the numeric labels on the wires. Default true.

origin

origin: Vec3

World-space anchor at the origin end of the measurement.

target

target: Vec3

World-space anchor at the target end of the measurement.

Optionalvisible

visible?: boolean

If false, the measurement is created hidden. Default true.

OptionalwireVisible

wireVisible?: boolean

If false, hide the diagonal length wire (the orange one between the two anchors). The axis-decomposition wires keep their own visibility flag. Default true.

Settings

Member Visibility

On This Page

Properties