Skip to main content

LocatedAtComponent

Class

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

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Index

Extends

Properties

distanceToLocation

readonly distanceToLocation: number

Since

Lens Scripting Version 197


enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

Default Value

true

Inherited from

Component.enabled


isBeingDestroyed

readonly isBeingDestroyed: boolean

Returns true if this Component is currently being destroyed. Becomes true as soon as destruction begins via Component#destroy or destruction of its owning SceneObject, before any OnDestroyEvent callbacks fire.

Since

Lens Scripting Version 364

Example

if (!script.isBeingDestroyed) {
// Component is still fully alive
}

Inherited from

Component.isBeingDestroyed


isEnabledInHierarchy

readonly isEnabledInHierarchy: boolean

Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

Inherited from

Component.isEnabledInHierarchy


location

location: LocationAsset

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

Since

Lens Scripting Version 172

Default Value

null

onCannotTrack

readonly onCannotTrack: event0<void>

Since

Lens Scripting Version 197


onCanTrack

readonly onCanTrack: event0<void>

Since

Lens Scripting Version 197


onError

readonly onError: event0<void>

Since

Lens Scripting Version 197


onFound

readonly onFound: event0<void>

Since

Lens Scripting Version 197


onLost

readonly onLost: event0<void>

Since

Lens Scripting Version 197


onReady

readonly onReady: event0<void>

Since

Lens Scripting Version 197


position

position: vec3

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

Since

Lens Scripting Version 172

Default Value

(0, 0, 0)

proximityStatus

readonly proximityStatus: LocationProximityStatus


sceneObject

readonly sceneObject: SceneObject

The SceneObject this component is on.

Inherited from

Component.sceneObject


uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

Component.uniqueIdentifier

Methods

createMappingOptions()

static createMappingOptions(): MappingOptions

Creates an option object for the LocatedAtComponent.

Returns

MappingOptions

Since

Lens Scripting Version 229


createMappingSession()

static createMappingSession(options): MappingSession

Creates a mapping session.

Parameters

ParameterType
optionsMappingOptions

Returns

MappingSession

Since

Lens Scripting Version 229


destroy()

destroy(): void

Destroys the component.

Returns

void

Inherited from

Component.destroy


getSceneObject()

getSceneObject(): SceneObject

Returns the SceneObject the component is attached to.

Returns

SceneObject

Inherited from

Component.getSceneObject


getTransform()

getTransform(): Transform

Returns the Transform this component is attached to.

Returns

Transform

Inherited from

Component.getTransform


getTypeName()

static getTypeName(): TypeName<LocatedAtComponent>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<LocatedAtComponent>

Overrides

Component.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Component.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Component.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Component.isSame