Skip to main content

Editor.Assets.SegmentationTexture

Class

A native asset that provides information for segmentation texture.

A native asset that provides information for segmentation texture. Import with Editor.Model.AssetManager#createNativeAsset.

Index

Example

const model = pluginSystem.findInterface(Editor.Model.IModel);
const assetManager = model.project.assetManager;

const destination new Editor.Path('');
const segmentationType = Editor.Assets.SegmentationType.PortraitHair;

const result = assetManager.createNativeAsset('SegmentationTexture', 'Segmentation Texture', destination);
result.segmentationType = segmentationType;

Extends

Properties

cacheFile

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

Texture.cacheFile


feathering

feathering: number

Softness amount applied to the segmentation mask edges.


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


invertMask

invertMask: boolean

Whether the segmentation mask is inverted.


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


refineEdge

refineEdge: boolean

Whether edge refinement is applied for better mask accuracy.


segmentationType

segmentationType: SegmentationType

Type of segmentation to apply.


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