Editor.Assets.FaceCropTexture
ClassA 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
Properties
Methods
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
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
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
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
Inherited from
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
inputTexture
inputTexture:
Texture
Source texture containing the face to crop.
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
scale
scale:
vec2
Size multiplier for the cropped face region.
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
Texture.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