Class ObjectTracking

Used to track objects in 2D space, such as body parts, pet, hand.

Remarks

Moves the local ScreenTransform to match the detected image.

See

Object Tracking guide. @seeHand Gestures guide.

Example

// @input Component.ObjectTracking objectTracking

script.objectTracking.onObjectFound = function() {
    print("Object has been found!");
};

script.objectTracking.onObjectLost = function() {
    print("Object has been lost!");
};

// @input Component.ObjectTracking  handTracking

var descriptor = "open";
// All possible descriptors for Hand Tracking are:
// "victory", "open", "index_finger", "horns", "close", "thumb"

script.handTracking.registerDescriptorStart(descriptor, function () {
    print(descriptor + " gesture was detected!");
});

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

autoEnableWhenTracking enabled objectIndex objectSpecificData onObjectFound onObjectLost sceneObject uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame isTracking registerDescriptorEnd registerDescriptorStart

Constructors

Protectedconstructor

Properties

autoEnableWhenTracking

autoEnableWhenTracking: boolean

If true, child objects of this Component's SceneObject will be disabled when the object is not being tracked.

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

objectIndex

objectIndex: number

The index of the object being tracked.

ReadonlyobjectSpecificData

objectSpecificData: ObjectSpecificData

Gets additional data of the current object being tracked.

onObjectFound

onObjectFound: () => void

Function that gets called when the tracked object is found.

onObjectLost

onObjectLost: () => void

Function that gets called when the tracked object is lost.

ReadonlysceneObject

sceneObject: SceneObject

The scene object this component is on.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

destroy

  • destroy(): void

    Destroys the component.

    Returns void

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

    Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type: string): boolean

    Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): boolean

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

isTracking

  • isTracking(): boolean

    Returns true if the object is currently being tracked on camera.

    Returns boolean

registerDescriptorEnd

  • registerDescriptorEnd(
        descriptor: string,
        callback: (descriptor: string) => void,
    ): void

    Registers a callback to be executed when the passed in descriptor ends for this tracked object. For example, the possible descriptors for hand tracking are: "victory", "open", "index_finger", "horns", "close", "thumb".

    Parameters

    • descriptor: string
    • callback: (descriptor: string) => void

    Returns void

registerDescriptorStart

  • registerDescriptorStart(
        descriptor: string,
        callback: (descriptor: string) => void,
    ): void

    Registers a callback to be executed when the passed in descriptor starts for this tracked object. For example, the possible descriptors for hand tracking are: "victory", "open", "index_finger", "horns", "close", "thumb".

    Parameters

    • descriptor: string
    • callback: (descriptor: string) => void

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR