Editor.Components.ObjectTracking3D
ClassTracks and matches 3D objects in the scene using pose estimation.
Index
Properties
Methods
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
hasPrefabChanges
readonlyhasPrefabChanges: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
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
isPrefabInstanceRoot
readonlyisPrefabInstanceRoot: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
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
name:
string
Name of the component.
Inherited from
objectIndex
objectIndex:
number
Index of the matched object in the tracking results.
sceneObject
readonlysceneObject:SceneObject
Scene object this component is attached to.
Inherited from
trackingAsset
trackingAsset:
Object3DAsset
3D asset to track.
trackingMode
trackingMode:
TrackingMode
Transform properties to track.
trackPosition
trackPosition:
boolean
Whether position tracking is applied.
type
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
Component.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
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
Inherited from
Component.getPrefabInstanceRoot
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
Nested types
Enumerations
| Enumeration | Description |
|---|---|
| TrackingMode | Enum specifying how 3D object tracking data is interpreted. |