Skip to main content

HandTracking3DAsset

Class

Enables Hand Tracking 3D for the ObjectTracking3D component.

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

Since Lens Scripting v153

Index

Extends

Properties

name

name: string

The name of the Asset in Lens Studio.

Default Value

""

Inherited from

Object3DAsset.name


trackingScope

trackingScope: HandTrackingScope

The HandTrackingScope to use as the input source for hand tracking. When this scope is parented to a TextureTrackingScope, hand tracking runs on that texture instead of the device camera.

Since

Lens Scripting Version 372

Default Value

null

uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

Object3DAsset.uniqueIdentifier

Methods

getTypeName()

static getTypeName(): TypeName<HandTracking3DAsset>

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

Since

Lens Scripting Version 153

Overrides

Object3DAsset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

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

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

Object3DAsset.isSame

See also

3D Body and Hand Tracking guide.