Lens Scripting API
    Preparing search index...

    Class LocationAsset

    Provides a frame of reference in which to localize objects to the real world. Use with LocatedAtComponent.

    // @input Asset.Texture myTexture

    const currentObj = script.sceneObject;
    const imageComponent = currentObj.createComponent("Component.Image");
    const imageMaterial = imageComponent.mainPass;
    imageMaterial.baseTex = script.myTexture;

    @component
    export class AssetExample extends BaseScriptComponent {
      @input()
      myTexture: Texture;

      onAwake() {
        const currentObj = this.sceneObject
        const imageComponent = currentObj.createComponent("Component.Image");
        const imageMaterial = imageComponent.mainPass;
        imageMaterial.baseTex = this.myTexture;
      }
    }

    Hierarchy (View Summary)

    Index

    Properties

    name uniqueIdentifier

    Methods

    adjacentTile fromSerialized getAROrigin getGeoAnchoredPosition getNearby getProxy getProxyId getTypeName isOfType isSame toSerialized

    Properties

    name: string

    The name of the Asset in Lens Studio.

    uniqueIdentifier: string

    Methods

    • Returns the LocationAsset Tile that is specified by the containing tile and the specified xOffset, yOffset and zoomOffset. When zooming in, index offset is relative to the center. When zooming out or not zooming, index offset is relative to the containing tile.

      Parameters

      • xOffset: number
      • yOffset: number
      • zoomOffset: number

      Returns LocationAsset

    • Exposes User Data Wearable Only

      Deserialize the provided serialized LocationAsset.

      Parameters

      • serialized: string

      Returns LocationAsset

    • Get an Anchor based on the given GPS coordinate.

      Parameters

      • longitude: number
      • latitude: number

      Returns Anchor

    • Gets nearby LocationAsset tiles, where each argument represents the x,y,z position relative to the current LocationAsset.

      Parameters

      • xOffset: number
      • yOffset: number
      • zoomOffset: number

      Returns LocationAsset

    • Get a Proxy LocationAsset with the proxyId embedded in the locationId. proxyId must not be null, must start with an alpha char, and consist only of alphanumerics or ".".

      Parameters

      • proxyId: string

      Returns LocationAsset

    • Gets the Proxy LocationID if the LocationAsset is a proxyLocation; returns null otherwise. This is useful in instances where a callback may return a mix of different location assets, and the creator of the proxy asset has specific handling in mind for particular proxy locations.

      Returns string

    • Returns the name of this object's type.

      Returns string

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

      Parameters

      • type: string

      Returns 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

    • Exposes User Data Wearable Only

      Serialize the LocationAsset to a string representation.

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods