Class LocatedAtComponent

Enables placing a SceneObject at a real world location provided by LocationAsset and specified relative position.

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

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

Methods

createMappingOptions createMappingSession destroy getSceneObject getTransform getTypeName isOfType isSame

Constructors

Protectedconstructor

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

The scene object this component is on.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

StaticcreateMappingOptions

StaticcreateMappingSession

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: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): 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

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR