Skip to main content

Editor.Components.FaceInsetVisual

Class

Visual component for rendering an inset region of a face mesh with customizable borders.

Index

Example

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

// Create a FaceInsetVisual to isolate a face region (e.g., mouth)
const obj = scene.createSceneObject('MouthInset');
const visual = obj.addComponent('FaceInsetVisual') as Editor.Components.FaceInsetVisual;

// Configure for mouth region
visual.faceIndex = 0;
visual.faceRegion = Editor.Components.FaceInsetRegion.Mouth;
visual.sourceScale = new vec2(1.2, 1.2);
visual.innerBorderRadius = 0.1;
visual.outerBorderRadius = 0.2;
console.log(`FaceInset: region=Mouth, scale=(${visual.sourceScale.x}, ${visual.sourceScale.y})`);
console.log(` border: inner=${visual.innerBorderRadius}, outer=${visual.outerBorderRadius}`);

Extends

Properties

enabled

enabled: boolean

Whether the component is active.

Inherited from

MaterialMeshVisual.enabled


faceIndex

faceIndex: number

Index of the face to render the inset from.


faceRegion

faceRegion: FaceInsetRegion

Region of the face defining the inset boundaries.


flipX

flipX: boolean

Flip the inset horizontally.


flipY

flipY: boolean

Flip the inset vertically.


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

MaterialMeshVisual.hasPrefabChanges


horizontalAlignment

horizontalAlignment: Horizontal

Horizontal alignment of the mesh visual.

Inherited from

MaterialMeshVisual.horizontalAlignment


id

readonly id: Uuid

The unique id of the entity.

Inherited from

MaterialMeshVisual.id


innerBorderRadius

innerBorderRadius: number

Radius of the inner border curve.


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

MaterialMeshVisual.isPrefabInstanceRoot


mainMaterial

mainMaterial: Material

Primary material used for rendering.

Inherited from

MaterialMeshVisual.mainMaterial


materials

materials: Material[]

Array of all materials on this mesh visual.

Inherited from

MaterialMeshVisual.materials


meshShadowMode

meshShadowMode: MeshShadowMode

Shadow rendering mode for the mesh.

Inherited from

MaterialMeshVisual.meshShadowMode


meta

readonly meta: Meta

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

Inherited from

MaterialMeshVisual.meta


name

name: string

Name of the component.

Inherited from

MaterialMeshVisual.name


offset

offset: vec2

Position offset of the inset relative to its pivot.


outerBorderRadius

outerBorderRadius: number

Radius of the outer border curve.


pivot

pivot: vec2

Origin point for scaling and rotation transforms.


renderOrder

renderOrder: number

Determines the order in which this visual component is rendered relative to others.

Inherited from

MaterialMeshVisual.renderOrder


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

MaterialMeshVisual.sceneObject


shadowColor

shadowColor: vec4

Color of the mesh shadow.

Inherited from

MaterialMeshVisual.shadowColor


shadowDensity

shadowDensity: number

Opacity of the mesh shadow.

Inherited from

MaterialMeshVisual.shadowDensity


sourceScale

sourceScale: vec2

Scale factor applied to the source face region.


stretchMode

stretchMode: StretchMode

How the mesh stretches to fit its container.

Inherited from

MaterialMeshVisual.stretchMode


subDivisionCount

subDivisionCount: number

Number of mesh geometry subdivisions.


type

readonly type: string

The entity's type.

Inherited from

MaterialMeshVisual.type


verticalAlignment

verticalAlignment: Vertical

Vertical alignment of the mesh visual.

Inherited from

MaterialMeshVisual.verticalAlignment

Methods

addMaterialAt()

addMaterialAt(value, pos?): void

Insert a material at the specified index.

Parameters

ParameterType
valueMaterial
pos?number

Returns

void

Inherited from

MaterialMeshVisual.addMaterialAt


clearMaterials()

clearMaterials(): void

Remove all materials.

Returns

void

Inherited from

MaterialMeshVisual.clearMaterials


getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

MaterialMeshVisual.getDirectlyReferencedEntities


getMaterialAt()

getMaterialAt(pos): Material

Retrieve the material at the specified index.

Parameters

ParameterType
posnumber

Returns

Material

Inherited from

MaterialMeshVisual.getMaterialAt


getMaterialsCount()

getMaterialsCount(): number

Get the total number of materials.

Returns

number

Inherited from

MaterialMeshVisual.getMaterialsCount


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

MaterialMeshVisual.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

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

MaterialMeshVisual.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

MaterialMeshVisual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

MaterialMeshVisual.getTypeName


indexOfMaterial()

indexOfMaterial(value): number

Find the index of a given material.

Parameters

ParameterType
valueMaterial

Returns

number

Inherited from

MaterialMeshVisual.indexOfMaterial


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

MaterialMeshVisual.isSame


moveMaterial()

moveMaterial(origin, destination): void

Move a material from one index to another.

Parameters

ParameterType
originnumber
destinationnumber

Returns

void

Inherited from

MaterialMeshVisual.moveMaterial


removeMaterialAt()

removeMaterialAt(pos): void

Remove the material at the specified index.

Parameters

ParameterType
posnumber

Returns

void

Inherited from

MaterialMeshVisual.removeMaterialAt


setMaterialAt()

setMaterialAt(pos, value): void

Replace the material at the specified index.

Parameters

ParameterType
posnumber
valueMaterial

Returns

void

Inherited from

MaterialMeshVisual.setMaterialAt