Skip to main content

BodyTrackingAsset

Class

Configures 3D Body Tracking 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 v142

Index

Extends

Properties

handTrackingEnabled

handTrackingEnabled: boolean

When true, hand tracking will be enabled.

Since

Lens Scripting Version 182

Default Value

false

name

name: string

The name of the Asset in Lens Studio.

Default Value

""

Inherited from

Object3DAsset.name


trackingScope

trackingScope: PersonTrackingScope

The tracking context this effect is being applied to.

Since

Lens Scripting Version 142

Default Value

null

uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

Object3DAsset.uniqueIdentifier

Methods

getTypeName()

static getTypeName(): TypeName<BodyTrackingAsset>

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

Since

Lens Scripting Version 142

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.

Nested types

Variables

VariableDescription
HeadKey for Head attachment point.
HipsKey for Hips attachment point.
LeftArmKey for Left Arm attachment point.
LeftFootKey for Left Foot attachment point.
LeftForeArmKey for Left Forearm attachment point.
LeftHandKey for Left Hand attachment point.
LeftHandIndex1Key for Left Hand Index 1 attachment point.
LeftHandIndex2Key for Left Hand Index 2 attachment point.
LeftHandIndex3Key for Left Hand Index 3 attachment point.
LeftHandMiddle1Key for Left Hand Middle 1 attachment point.
LeftHandMiddle2Key for Left Hand Middle 2 attachment point.
LeftHandMiddle3Key for Left Hand Middle 3 attachment point.
LeftHandPinky1Key for Left Hand Pinky 1 attachment point.
LeftHandPinky2Key for Left Hand Pinky 2 attachment point.
LeftHandPinky3Key for Left Hand Pinky 3 attachment point.
LeftHandRing1Key for Left Hand Ring 1 attachment point.
LeftHandRing2Key for Left Hand Ring 2 attachment point.
LeftHandRing3Key for Left Hand Ring 3 attachment point.
LeftHandThumb1Key for Left Hand Thumb 1 attachment point.
LeftHandThumb2Key for Left Hand Thumb 2 attachment point.
LeftHandThumb3Key for Left Hand Thumb 3 attachment point.
LeftLegKey for Left Leg attachment point.
LeftShoulderKey for Left Shoulder attachment point.
LeftToeBaseKey for Left Toe Base attachment point.
LeftUpLegKey for Upper Left Leg attachment point.
NeckKey for Neck attachment point.
RightArmKey for Right Arm attachment point.
RightFootKey for Right Foot attachment point.
RightForeArmKey for Right Forearm attachment point.
RightHandKey for Right Hand attachment point.
RightHandIndex1Key for Right Hand Index 1 attachment point.
RightHandIndex2Key for Right Hand Index 2 attachment point.
RightHandIndex3Key for Right Hand Index 3 attachment point.
RightHandMiddle1Key for Right Hand Middle 1 attachment point.
RightHandMiddle2Key for Right Hand Middle 2 attachment point.
RightHandMiddle3Key for Right Hand Middle 3 attachment point.
RightHandPinky1Key for Right Hand Pinky 1 attachment point.
RightHandPinky2Key for Right Hand Pinky 2 attachment point.
RightHandPinky3Key for Right Hand Pinky 3 attachment point.
RightHandRing1Key for Right Hand Ring 1 attachment point.
RightHandRing2Key for Right Hand Ring 2 attachment point.
RightHandRing3Key for Right Hand Ring 3 attachment point.
RightHandThumb1Key for Right Hand Thumb 1 attachment point.
RightHandThumb2Key for Right Hand Thumb 2 attachment point.
RightHandThumb3Key for Right Hand Thumb 3 attachment point.
RightLegKey for Right Leg attachment point.
RightShoulderKey for Right Shoulder attachment point.
RightToeBaseKey for Right Toe Base attachment point.
RightUpLegKey for Upper Right Leg attachment point.
SpineKey for Spine attachment point.
Spine1Key for Spine1 attachment point.
Spine2Key for Spine2 attachment point.