Editor.Assets.FaceMesh
ClassA native asset that provides a 3D mesh of the user's face.
A native asset that provides a 3D mesh of the user's face. Import with Editor.Model.AssetManager#createNativeAsset. Learn more in the Face Mesh guide.
Index
Properties
Methods
Example
// FaceMesh is a native asset that provides a 3D mesh following a detected face.
// It offers fine-grained control over which geometry regions are enabled.
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const assetManager = model.project.assetManager;
const sourcePath = new Editor.Model.SourcePath(
new Editor.Path(''),
Editor.Model.SourceRootDirectory.Assets
);
const faceMesh = assetManager.createNativeAsset(
'FaceMesh',
'MyFaceMesh',
sourcePath
) as Editor.Assets.FaceMesh;
if (!Editor.isNull(faceMesh)) {
// Configure geometry regions
faceMesh.faceGeometryEnabled = true;
faceMesh.eyeGeometryEnabled = true;
faceMesh.eyeCornerGeometryEnabled = false;
faceMesh.mouthGeometryEnabled = true;
faceMesh.earGeometryEnabled = false;
faceMesh.skullGeometryEnabled = false;
// Set the face index and expression multiplier
faceMesh.faceIndex = 0;
faceMesh.expressionMultiplier = 1.0;
console.log(`Created FaceMesh: ${faceMesh.name}`);
}
Extends
Properties
cacheFile
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
earGeometryEnabled
earGeometryEnabled:
boolean
Enable ear geometry rendering.
expressionMultiplier
expressionMultiplier:
number
Scale factor applied to facial expressions.
externalMesh
externalMesh:
FileMesh
Custom mesh to replace the default face mesh.
externalMeshMapUV
externalMeshMapUV:
VertexAttribute
UV vertex attribute mapping for the external mesh.
externalScale
externalScale:
number
Scale factor for the external mesh.
eyeCornerGeometryEnabled
eyeCornerGeometryEnabled:
boolean
Enable eye corner geometry rendering.
eyeGeometryEnabled
eyeGeometryEnabled:
boolean
Enable eye geometry rendering.
faceGeometryEnabled
faceGeometryEnabled:
boolean
Enable face geometry rendering.
faceIndex
faceIndex:
number
Index of the tracked face this mesh represents.
fileMeta
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
Inherited from
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
mouthGeometryEnabled
mouthGeometryEnabled:
boolean
Enable mouth geometry rendering.
name
readonlyname:string
The name of the asset.
Inherited from
skullGeometryEnabled
skullGeometryEnabled:
boolean
Enable skull geometry rendering.
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