AnchorModule.Anchor
ClassA saved place the system can recognise and track — an identity plus metadata.
- 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
Since Lens Scripting v376
A saved place the system can recognise and track — an identity plus metadata. Passive: holding an Anchor does not track it (set it on an AnchorComponent to track). Always obtained from an AnchorModule.AnchorSession (create, discover, or resolve).
Index
Properties
Methods
Extends
Extended by
Properties
anchorType
readonlyanchorType:AnchorType
SPECS
What kind of anchor this is.
Since
Lens Scripting Version 376
area
readonlyarea:string
SPECS
The area this anchor belongs to, or null if created in a session without an area.
Since
Lens Scripting Version 376
id
readonlyid:string
SPECS
A string you can store to refer to this anchor later, then restore it with resolveAnchor().
Since
Lens Scripting Version 376
scope
readonlyscope:Private
SPECS
Who can access this anchor.
Since
Lens Scripting Version 376
Methods
getTypeName()
staticgetTypeName():TypeName<Anchor>
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<Anchor>
Since
Lens Scripting Version 376
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean