Skip to main content

AnchorModule.WorldAnchor

Class

A spatial anchor fixed to a point in the user's mapped space.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported — Available on SPECS only
  • SPECSFully supported
  • Camera Kit WebNot supported — Available on SPECS only
  • Camera Kit MobileNot supported — Available on SPECS only

Platform details

  • Snapchat — Not supported — Available on SPECS only.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported — Available on SPECS only.

  • Camera Kit Mobile — Not supported — Available on SPECS only.

Since Lens Scripting v376

A spatial anchor fixed to a point in the user's mapped space.

Index

Extends

Properties

anchorType

readonly anchorType: AnchorType

SPECS

What kind of anchor this is.

Since

Lens Scripting Version 376

Inherited from

Anchor.anchorType


area

readonly area: string

SPECS

The area this anchor belongs to, or null if created in a session without an area.

Since

Lens Scripting Version 376

Inherited from

Anchor.area


id

readonly id: string

SPECS

A string you can store to refer to this anchor later, then restore it with resolveAnchor().

Since

Lens Scripting Version 376

Inherited from

Anchor.id


scope

readonly scope: Private

SPECS

Who can access this anchor.

Since

Lens Scripting Version 376

Inherited from

Anchor.scope

Methods

getTypeName()

static getTypeName(): TypeName<WorldAnchor>

SPECS

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<WorldAnchor>

Since

Lens Scripting Version 376

Overrides

Anchor.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

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

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

Anchor.isSame