Interface LocatedAtComponent

A component which modifies the Transform of the object it is on to a position in the real world, based on a LocationAsset and a position.

interface LocatedAtComponent {
    distanceToLocation: number;
    enabled: boolean;
    location: LocationAsset;
    onCannotTrack: event0<void>;
    onCanTrack: event0<void>;
    onError: event0<void>;
    onFound: event0<void>;
    onLost: event0<void>;
    onReady: event0<void>;
    position: vec3;
    proximityStatus: LocationProximityStatus;
    sceneObject: SceneObject;
    uniqueIdentifier: string;
    destroy(): void;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

distanceToLocation enabled location onCannotTrack onCanTrack onError onFound onLost onReady position proximityStatus sceneObject uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame

Properties

ReadonlydistanceToLocation

distanceToLocation: number

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

location

location: LocationAsset

The LocationAsset which contains the position this object should be anchored to.

ReadonlyonCannotTrack

onCannotTrack: event0<void>

ReadonlyonCanTrack

onCanTrack: event0<void>

ReadonlyonError

onError: event0<void>

ReadonlyonFound

onFound: event0<void>

ReadonlyonLost

onLost: event0<void>

ReadonlyonReady

onReady: event0<void>

position

position: vec3

The geo anchored position within a LocationAsset that this object should be anchored to.

ReadonlyproximityStatus

proximityStatus: LocationProximityStatus

ReadonlysceneObject

sceneObject: SceneObject

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

destroy

  • destroy(): void

  • Destroys the component.

    Returns void

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods