Interface ObjectTracking3D

Component used for tracking objects in 3D space.

Example

// @input Component.ObjectTracking3D objectTracking3D

script.objectTracking3D.onTrackingStarted = function(){
    print("ObjectTracking3D Started Tracking");
}

script.objectTracking3D.onTrackingLost = function(){
    print("ObjectTracking3D Lost Tracking");
}
interface ObjectTracking3D {
    attachmentModeInheritRotation: boolean;
    attachmentModeInheritScale: boolean;
    enabled: boolean;
    objectIndex: number;
    onTrackingLost: (() => void);
    onTrackingStarted: (() => void);
    sceneObject: SceneObject;
    trackingAsset: Object3DAsset;
    trackingMode: ObjectTracking3D.TrackingMode;
    trackPosition: boolean;
    uniqueIdentifier: string;
    addAttachmentPoint(name: string, object: SceneObject): void;
    createAttachmentPoint(name: string): SceneObject;
    destroy(): void;
    getAttachedObjects(name: string): SceneObject[];
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isAttachmentPointTracking(name: string): boolean;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    isTracking(): boolean;
    removeAttachmentPoint(object: SceneObject): void;
}

Hierarchy (view full)

Properties

attachmentModeInheritRotation attachmentModeInheritScale enabled objectIndex onTrackingLost onTrackingStarted sceneObject trackingAsset trackingMode trackPosition uniqueIdentifier

Methods

addAttachmentPoint createAttachmentPoint destroy getAttachedObjects getSceneObject getTransform getTypeName isAttachmentPointTracking isOfType isSame isTracking removeAttachmentPoint

Properties

attachmentModeInheritRotation

attachmentModeInheritRotation: boolean

Whether world rotation is applied or not.

attachmentModeInheritScale

attachmentModeInheritScale: boolean

Whether world scale is applied or not.

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

objectIndex

objectIndex: number

Index of the object to track, starting at 0. Useful when tracking multiple instances of the same type of object.

onTrackingLost

onTrackingLost: (() => void)

Function called when tracking is lost.

onTrackingStarted

onTrackingStarted: (() => void)

Function called when tracking begins.

ReadonlysceneObject

sceneObject: SceneObject

trackingAsset

trackingAsset: Object3DAsset

Asset containing tracking parameters, such as the tracking model and specific options.

trackingMode

trackingMode: ObjectTracking3D.TrackingMode

Strategy for updating attached SceneObjects.

trackPosition

trackPosition: boolean

When true, the attached root SceneObject's world position will be updated to match the tracked object's world position.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

addAttachmentPoint

  • addAttachmentPoint(name, object): void

  • Attaches the SceneObject to the specified attachment point.

    Parameters

    Returns void

createAttachmentPoint

  • createAttachmentPoint(name): SceneObject

  • Creates a SceneObject which is attached to the specified attachment point.

    Parameters

    • name: string

    Returns SceneObject

destroy

  • destroy(): void

  • Destroys the component.

    Returns void

getAttachedObjects

  • getAttachedObjects(name): SceneObject[]

  • Returns all SceneObjects currently attached to the specified point.

    Parameters

    • name: string

    Returns SceneObject[]

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isAttachmentPointTracking

  • isAttachmentPointTracking(name): boolean

  • Returns whether the specified attachment point is being tracked.

    Parameters

    • name: string

    Returns boolean

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

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

    Returns boolean

isTracking

  • isTracking(): boolean

  • Returns whether this object is currently being tracked.

    Returns boolean

removeAttachmentPoint

  • removeAttachmentPoint(object): void

  • Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods