import {DistanceMeasurement} from '@xeokit/xeokit-sdk/src/plugins/DistanceMeasurementsPlugin/DistanceMeasurement.js'

public class | source

DistanceMeasurement

Extends:

Component → DistanceMeasurement

Measures the distance between two 3D points.

See DistanceMeasurementsPlugin for more info.

Member Summary

Public Members
public set	approximate: Boolean Sets whether this DistanceMeasurement indicates that its measurement is approximate.
public get	approximate: Boolean Gets whether this DistanceMeasurement indicates that its measurement is approximate.
public set	axesBasis(value: number[]) Sets the axes basis for the measurement.
public get	axesBasis: number[] Gets the axes basis for the measurement.
public set	axisEnabled: Boolean Sets if the axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are enabled.
public get	axisEnabled: Boolean Gets if the axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are enabled.
public set	axisVisible: Boolean Sets if the axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are visible.
public get	axisVisible: Boolean Gets if the axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are visible.
public set	clickable: Boolean Sets if the wires, dots ad labels will fire "mouseOver" "mouseLeave" and "contextMenu" events, or ignore mouse events altogether.
public get	clickable: Boolean Gets if the wires, dots ad labels will fire "mouseOver" "mouseLeave" and "contextMenu" events.
public get	color: *
public set	color
public set	labelsOnWires: Boolean Sets if labels should be positioned on the wires.
public get	labelsOnWires: Boolean Gets if labels should be positioned on the wires.
public set	labelsVisible: Boolean Sets if the labels are visible except the length label.
public get	labelsVisible: Boolean Gets if the labels are visible.
public get	length: Number Gets the World-space direct point-to-point distance between DistanceMeasurement#origin and DistanceMeasurement#target.
public set	lengthLabelEnabled: Boolean Sets if the length label is enabled.
public get	lengthLabelEnabled: Boolean Gets if the length label is enabled.
public get	origin: Dot3D Gets the origin Dot3D.
public set	originVisible: Boolean Sets if the origin Dot3D is visible.
public get	originVisible: Boolean Gets if the origin Dot3D is visible.
public	plugin: DistanceMeasurementsPlugin The DistanceMeasurementsPlugin that owns this DistanceMeasurement.
public get	target: Dot3D Gets the target Dot3D.
public set	targetVisible: Boolean Sets if the target Dot3D is visible.
public get	targetVisible: Boolean Gets if the target Dot3D is visible.
public set	useRotationAdjustment: Boolean Sets if the measurement is adjusted based on rotation
public get	useRotationAdjustment: Boolean Gets if the measurement is adjusted based on rotation
public set	visible: Boolean Sets whether this DistanceMeasurement is visible or not.
public get	visible: Boolean Gets whether this DistanceMeasurement is visible or not.
public set	wireVisible: Boolean Sets if the direct point-to-point wire between DistanceMeasurement#origin and DistanceMeasurement#target is visible.
public get	wireVisible: Boolean Gets if the direct point-to-point wire between DistanceMeasurement#origin and DistanceMeasurement#target is visible.
public set	xAxisVisible: Boolean Sets if the X-axis-aligned wire between DistanceMeasurement#origin and DistanceMeasurement#target is visible.
public get	xAxisVisible: Boolean Gets if the X-axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are visible.
public set	xLabelEnabled: Boolean Sets if the x label is enabled.
public get	xLabelEnabled: Boolean Gets if the x label is enabled.
public set	yAxisVisible: Boolean Sets if the Y-axis-aligned wire between DistanceMeasurement#origin and DistanceMeasurement#target is visible.
public get	yAxisVisible: Boolean Gets if the Y-axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are visible.
public set	yLabelEnabled: Boolean Sets if the y label is enabled.
public get	yLabelEnabled: Boolean Gets if the y label is enabled.
public set	zAxisVisible: Boolean Sets if the Z-axis-aligned wire between DistanceMeasurement#origin and DistanceMeasurement#target is visible.
public get	zAxisVisible: Boolean Gets if the Z-axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are visible.
public set	zLabelEnabled: Boolean Sets if the z label is enabled.
public get	zLabelEnabled: Boolean Gets if the z label is enabled.

Method Summary

Public Methods
public	setHighlighted(highlighted: *) Sets if this DistanceMeasurement appears highlighted.

Inherited Summary

From class Component
public get	owner: Component The Component that owns the lifecycle of this Component, if any.
public	destroyed: Boolean True as soon as this Component has been destroyed
public	id: String \| Number ID of this Component, unique within the Scene.
public	meta: * Arbitrary, user-defined metadata on this component.
public	scene: Scene The parent Scene that contains this Component.
public	viewer: Viewer The viewer that contains this Scene.
public	clear() Destroys all Components that are owned by this.
public	destroy() Destroys this component.
public	error(message: String) Logs an error for this component to the JavaScript console.
public	fire(event: String, value: Object, forget: Boolean) Fires an event on this component.
public	hasSubs(event: String): Boolean Returns true if there are any subscribers to the given event on this component.
public	isType(type: ): : Boolean Tests if this component is of the given type, or is a subclass of the given type.
public	log(message: String) Logs a console debugging message for this component.
public	off(subId: String) Cancels an event subscription that was previously made with Component#on or Component#once.
public	on(event: String, callback: Function, scope: Object): String Subscribes to an event on this component.
public	once(event: String, callback: Function, scope: Object) Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.
public	scheduleTask(task: *) Schedule a task to perform on the next browser interval
public	warn(message: String) Logs a warning for this component to the JavaScript console.

Public Members

public set approximate: Boolean source

Sets whether this DistanceMeasurement indicates that its measurement is approximate.

This is true by default.

public get approximate: Boolean source

Gets whether this DistanceMeasurement indicates that its measurement is approximate.

This is true by default.

public set axesBasis(value: number[]) source

Sets the axes basis for the measurement.

The value is a 4x4 matrix where each column-vector defines an axis and must have unit length.

This is the identity matrix by default, meaning the measurement axes are the same as the world axes.

public get axesBasis: number[] source

Gets the axes basis for the measurement.

The value is a 4x4 matrix where each column-vector defines an axis and must have unit length.

This is the identity matrix by default, meaning the measurement axes are the same as the world axes.

public set axisEnabled: Boolean source

Sets if the axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are enabled.

Wires are only shown if enabled and visible.

public get axisEnabled: Boolean source

Gets if the axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are enabled.

Wires are only shown if enabled and visible.

public set axisVisible: Boolean source

Sets if the axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are visible.

Wires are only shown if enabled and visible.

public get axisVisible: Boolean source

Gets if the axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are visible.

Wires are only shown if enabled and visible.

public set clickable: Boolean source

Sets if the wires, dots ad labels will fire "mouseOver" "mouseLeave" and "contextMenu" events, or ignore mouse events altogether.

public get clickable: Boolean source

Gets if the wires, dots ad labels will fire "mouseOver" "mouseLeave" and "contextMenu" events.

public get color: * source

public set color source

public set labelsOnWires: Boolean source

Sets if labels should be positioned on the wires.

public get labelsOnWires: Boolean source

Gets if labels should be positioned on the wires.

public set labelsVisible: Boolean source

Sets if the labels are visible except the length label.

public get labelsVisible: Boolean source

Gets if the labels are visible.

public get length: Number source

Gets the World-space direct point-to-point distance between DistanceMeasurement#origin and DistanceMeasurement#target.

public set lengthLabelEnabled: Boolean source

Sets if the length label is enabled.

public get lengthLabelEnabled: Boolean source

Gets if the length label is enabled.

public get origin: Dot3D source

Gets the origin Dot3D.

public set originVisible: Boolean source

Sets if the origin Dot3D is visible.

public get originVisible: Boolean source

Gets if the origin Dot3D is visible.

public plugin: DistanceMeasurementsPlugin source

The DistanceMeasurementsPlugin that owns this DistanceMeasurement.

public get target: Dot3D source

Gets the target Dot3D.

public set targetVisible: Boolean source

Sets if the target Dot3D is visible.

public get targetVisible: Boolean source

Gets if the target Dot3D is visible.

public set useRotationAdjustment: Boolean source

Sets if the measurement is adjusted based on rotation

public get useRotationAdjustment: Boolean source

Gets if the measurement is adjusted based on rotation

public set visible: Boolean source

Sets whether this DistanceMeasurement is visible or not.

public get visible: Boolean source

Gets whether this DistanceMeasurement is visible or not.

public set wireVisible: Boolean source

Sets if the direct point-to-point wire between DistanceMeasurement#origin and DistanceMeasurement#target is visible.

public get wireVisible: Boolean source

Gets if the direct point-to-point wire between DistanceMeasurement#origin and DistanceMeasurement#target is visible.

public set xAxisVisible: Boolean source

Sets if the X-axis-aligned wire between DistanceMeasurement#origin and DistanceMeasurement#target is visible.

Wires are only shown if enabled and visible.

public get xAxisVisible: Boolean source

Gets if the X-axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are visible.

Wires are only shown if enabled and visible.

public set xLabelEnabled: Boolean source

Sets if the x label is enabled.

public get xLabelEnabled: Boolean source

Gets if the x label is enabled.

public set yAxisVisible: Boolean source

Sets if the Y-axis-aligned wire between DistanceMeasurement#origin and DistanceMeasurement#target is visible.

Wires are only shown if enabled and visible.

public get yAxisVisible: Boolean source

Gets if the Y-axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are visible.

Wires are only shown if enabled and visible.

public set yLabelEnabled: Boolean source

Sets if the y label is enabled.

public get yLabelEnabled: Boolean source

Gets if the y label is enabled.

public set zAxisVisible: Boolean source

Sets if the Z-axis-aligned wire between DistanceMeasurement#origin and DistanceMeasurement#target is visible.

Wires are only shown if enabled and visible.

public get zAxisVisible: Boolean source

Gets if the Z-axis-aligned wires between DistanceMeasurement#origin and DistanceMeasurement#target are visible.

Wires are only shown if enabled and visible.

public set zLabelEnabled: Boolean source

Sets if the z label is enabled.

public get zLabelEnabled: Boolean source

Gets if the z label is enabled.

Public Methods

public setHighlighted(highlighted: *) source

Sets if this DistanceMeasurement appears highlighted.

Params:

Name	Type	Attribute	Description
highlighted	*