Skip to main content

HandTrackingScope

Class

The hand that a tracker should use.

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

The hand that a tracker should use. Allows you to apply the same hand index to a group of Components.

Index

Extends

Properties

handIndex

handIndex: number

The hand to track. The first hand is 0, the second is 1, and so on.

Since

Lens Scripting Version 372

Default Value

0

name

name: string

The name of the Asset in Lens Studio.

Default Value

""

Inherited from

TrackingScope.name


parentScope

parentScope: TextureTrackingScope

The scope that the current HandTrackingScope is based on.

Since

Lens Scripting Version 372

Default Value

null

uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

TrackingScope.uniqueIdentifier

Methods

getTypeName()

static getTypeName(): TypeName<HandTrackingScope>

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

Since

Lens Scripting Version 372

Overrides

TrackingScope.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

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

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

TrackingScope.isSame