Skip to main content

Editor.Assets.FaceCropTexture

Class

A native asset that provides a cropped region of the input texture, calculated based on face position.

A native asset that provides a cropped region of the input texture, calculated based on face position. Import with Editor.Model.AssetManager#createNativeAsset. Learn more in LensScripting.FaceCropTextureProvider

Index

Example

// FaceCropTexture is a native asset that crops the camera feed around a detected face.
// It exposes properties like faceIndex, faceCenterMouthWeight, and scale.

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 faceCrop = assetManager.createNativeAsset(
'FaceCropTexture',
'MyFaceCrop',
sourcePath
) as Editor.Assets.FaceCropTexture;

if (!Editor.isNull(faceCrop)) {
// Configure which face to track (0 = first detected face)
faceCrop.faceIndex = 0;

// Set the crop scale (width, height multiplier)
faceCrop.scale = new vec2(1.5, 1.5);

console.log(`Created FaceCropTexture "${faceCrop.name}": faceIndex=${faceCrop.faceIndex}, scale=${faceCrop.scale}`);
}

Extends

Properties

cacheFile

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

Texture.cacheFile


faceCenterMouthWeight

faceCenterMouthWeight: number

Weight blending the crop between face center and mouth.


faceIndex

faceIndex: number

Index of the face to crop from the input texture.


fileMeta

readonly fileMeta: AssetImportMetadata

Import metadata for the asset.

Inherited from

Texture.fileMeta


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Texture.id


inputTexture

inputTexture: Texture

Source texture containing the face to crop.


meta

readonly meta: Meta

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

Inherited from

Texture.meta


name

readonly name: string

The name of the asset.

Inherited from

Texture.name


scale

scale: vec2

Size multiplier for the cropped face region.


type

readonly type: string

The entity's type.

Inherited from

Texture.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Texture.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Texture.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Texture.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Texture.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Texture.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

Texture.isSame