Skip to main content

Editor.Assets.FaceMesh

Class

A 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

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

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

RenderMesh.cacheFile


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

readonly fileMeta: AssetImportMetadata

Import metadata for the asset.

Inherited from

RenderMesh.fileMeta


id

readonly id: Uuid

The unique id of the entity.

Inherited from

RenderMesh.id


meta

readonly meta: Meta

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

Inherited from

RenderMesh.meta


mouthGeometryEnabled

mouthGeometryEnabled: boolean

Enable mouth geometry rendering.


name

readonly name: string

The name of the asset.

Inherited from

RenderMesh.name


skullGeometryEnabled

skullGeometryEnabled: boolean

Enable skull geometry rendering.


type

readonly type: string

The entity's type.

Inherited from

RenderMesh.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

RenderMesh.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

RenderMesh.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

RenderMesh.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

RenderMesh.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

RenderMesh.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

RenderMesh.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

RenderMesh.isSame