Editor.Assets.HandMesh
ClassA render mesh that follows a tracked hand.
A render mesh that follows a tracked hand. Assign it to a RenderMeshVisual's mesh to render the user's hand.
Index
Properties
Methods
Example
// Render a mesh of the user's left hand: create a Hand Mesh asset and show it with a RenderMeshVisual.
export function addHandMesh(
project: Editor.Model.Project,
handType: Editor.Assets.HandTracking3DHandType,
material: Editor.Assets.Material,
): Editor.Components.RenderMeshVisual {
const destination = new Editor.Model.SourcePath(new Editor.Path(''), Editor.Model.SourceRootDirectory.Assets);
const handMesh = project.assetManager.createNativeAsset('HandMesh', 'Hand Mesh', destination) as Editor.Assets.HandMesh;
handMesh.handType = handType;
const sceneObject = project.scene.createSceneObject('Hand Mesh');
const visual = sceneObject.addComponent('RenderMeshVisual');
visual.mesh = handMesh;
visual.materials = [material];
return visual;
}
// For example: addHandMesh(project, Editor.Assets.HandTracking3DHandType.Left, material);
Extends
Properties
cacheFile
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
fileMeta
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
Inherited from
handIndex
handIndex:
number
Index of the tracked hand that the mesh follows. Defaults to 0.
handType
handType:
HandTracking3DHandType
Which hand the mesh follows, left or right. Defaults to Right.
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
readonlyname:string
The name of the asset.
Inherited from
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
RenderMesh.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
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