Reference Source
public class | source

DistanceMeasurement

Extends:

Component → DistanceMeasurement

Measures the distance between two 3D points.

See DistanceMeasurementsPlugin for more info.

Member Summary

Public Members
public get

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

public set

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

public get

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

public get

Gets the origin Marker.

public get

Gets if the origin Marker is visible.

public set

Sets if the origin Marker is visible.

public

The DistanceMeasurementsPlugin that owns this DistanceMeasurement.

public get

Gets the target Marker.

public set

Sets if the target Marker is visible.

public get

Gets if the target Marker is visible.

public get

visible: *

Gets whether this DistanceMeasurement is visible or not.

public set

visible: *

Sets whether this DistanceMeasurement is visible or not.

public set

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

public get

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

Inherited Summary

From class Component
public get

The Component that owns the lifecycle of this Component, if any.

public

True as soon as this Component has been destroyed

public

ID of this Component, unique within the Scene.

public

meta: *

Arbitrary, user-defined metadata on this component.

public

The parent Scene that contains this Component.

public

The viewer that contains this Scene.

public

clear()

Destroys all Components that are owned by this.

public

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

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

warn(message: String)

Logs a warning for this component to the JavaScript console.

Public Members

public get axisVisible: Boolean source

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

public set axisVisible: Boolean source

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

public get length: Number source

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

public get origin: Marker source

Gets the origin Marker.

public get originVisible: Boolean source

Gets if the origin Marker is visible.

public set originVisible: Boolean source

Sets if the origin Marker is visible.

public plugin: DistanceMeasurementsPlugin source

The DistanceMeasurementsPlugin that owns this DistanceMeasurement.

public get target: Marker source

Gets the target Marker.

public set targetVisible: Boolean source

Sets if the target Marker is visible.

public get targetVisible: Boolean source

Gets if the target Marker is visible.

public get visible: * source

Gets whether this DistanceMeasurement is visible or not.

public set visible: * source

Sets 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.