Skip to main content

MarkerAsset

Class

Represents a texture to be tracked with MarkerTrackingComponent.

  • 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

Example

// Set the MarkerAsset on a MarkerTracking component

//@input Component.MarkerTrackingComponent markerTracker
//@input Asset.MarkerAsset marker

script.markerTracker.marker = script.marker;

Extends

Properties

height

height: number

The height of the marker asset in real-life centimeters. Used to provide accurate transformation. A MarkerTrackingComponent using this MarkerAsset will be scaled so that one unit in the SceneObject's local space is equal to one centimeter in real life.

Default Value

1

name

name: string

The name of the Asset in Lens Studio.

Default Value

""

Inherited from

Asset.name


uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

Asset.uniqueIdentifier

Methods

getAspectRatio()

getAspectRatio(): number

Returns the aspect ratio (width / height) of the texture used by the marker asset.

Returns

number


getTypeName()

static getTypeName(): TypeName<MarkerAsset>

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

Overrides

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

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

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

Asset.isSame

See also

Marker Tracking guide.