Skip to main content

Editor.Components.ObjectTracking3D

Class

Tracks and matches 3D objects in the scene using pose estimation.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;
const assetManager = model.project.assetManager;

// Create hand tracking assets (same pattern as PresetsRegistry)
const assetsPath = new Editor.Path('3D Hand Tracking Assets');
const rightHandAsset = assetManager.createNativeAsset(
'HandTracking3DAsset', 'Hand Tracking Right', assetsPath as unknown as Editor.Model.SourcePath
) as Editor.Assets.HandTracking3DAsset;
rightHandAsset.handType = Editor.Assets.HandTracking3DHandType.Right;

// Create a scene object and add ObjectTracking3D
const obj = scene.createSceneObject('3D Hand Tracking Right');
const tracking = obj.addComponent('ObjectTracking3D') as Editor.Components.ObjectTracking3D;
tracking.trackingAsset = rightHandAsset;
console.log(`ObjectTracking3D: asset="${rightHandAsset.name}", handType=${rightHandAsset.handType}`);

Extends

Properties

enabled

enabled: boolean

Whether the component is active.

Inherited from

Component.enabled


hasPrefabChanges

readonly hasPrefabChanges: boolean

Whether this entity differs from its counterpart in the prefab or was added to the prefab instance. Always false outside prefab instances.

Inherited from

Component.hasPrefabChanges


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Component.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

Component.isPrefabInstanceRoot


matchingRootObject

matchingRootObject: SceneObject

Scene object root matched to the tracked asset.


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

Component.meta


name

name: string

Name of the component.

Inherited from

Component.name


objectIndex

objectIndex: number

Index of the matched object in the tracking results.


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

Component.sceneObject


trackingAsset

trackingAsset: Object3DAsset

3D asset to track.


trackingMode

trackingMode: TrackingMode

Transform properties to track.


trackPosition

trackPosition: boolean

Whether position tracking is applied.


type

readonly type: string

The entity's type.

Inherited from

Component.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

Component.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Component.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

Component.getOwnedEntities


getPrefabInstanceRoot()

getPrefabInstanceRoot(): Prefabable

Returns the nearest prefab instance root that contains this entity, starting with the entity itself, or null if it is not part of a prefab instance.

Returns

Prefabable

Inherited from

Component.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Component.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Component.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Component.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Component.isSame

Nested types

Enumerations

EnumerationDescription
TrackingModeEnum specifying how 3D object tracking data is interpreted.