Skip to main content

Editor.Assets.Material

Class

Material asset defining rendering passes and their properties.

Index

Example

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

// Find a Material and configure its rendering properties
const materials = assetManager.assets.filter(a => a.isOfType('Material')) as Editor.Assets.Material[];
if (materials.length === 0) return;

const mat = materials[0];

if (mat.passInfos.length > 0) {
const pass = mat.passInfos[0];

// Configure blending for transparency
pass.blendMode = Editor.Assets.BlendMode.Normal;
pass.depthWrite = false;

// Enable two-sided rendering
pass.twoSided = true;

// List pass property names (shader uniforms)
const props = pass.getPropertyNames();
console.log(`Material "${mat.name}" pass 0 configured (blend=Normal, twoSided=true); properties: ${props.join(', ')}`);
}

Extends

Properties

cacheFile

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

Asset.cacheFile


fileMeta

readonly fileMeta: AssetImportMetadata

Import metadata for the asset.

Inherited from

Asset.fileMeta


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Asset.id


meta

readonly meta: Meta

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

Inherited from

Asset.meta


name

readonly name: string

The name of the asset.

Inherited from

Asset.name


passInfos

passInfos: PassInfo[]

Array of pass information objects for each rendering pass.


type

readonly type: string

The entity's type.

Inherited from

Asset.type

Methods

addPass()

addPass(pass): PassInfo

Add a pass to the material and return its PassInfo.

Parameters

ParameterType
passPass

Returns

PassInfo


getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Asset.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Asset.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Asset.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Asset.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

Asset.isSame