Skip to main content

Editor.Components.MaterialMeshVisual

Class

Base class for mesh visual components that render with materials.

Index

Example

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

const obj = scene.createSceneObject('MatMeshObj');
const visual = obj.addComponent('RenderMeshVisual') as Editor.Components.RenderMeshVisual;

const mainMat = visual.mainMaterial;
console.log(`mainMaterial: ${Editor.isNull(mainMat) ? 'none' : mainMat.name}`);
console.log(`Materials count: ${visual.getMaterialsCount()}`);

const materials = assetManager.assets.filter(a => a.isOfType('Material')) as Editor.Assets.Material[];
if (materials.length > 0) {
visual.addMaterialAt(materials[0]);
console.log(`Added material "${materials[0].name}", count now: ${visual.getMaterialsCount()}`);
console.log(`Material[0]: "${visual.getMaterialAt(0).name}"`);
}

Extends

Extended by

Properties

enabled

enabled: boolean

Whether the component is active.

Inherited from

BaseMeshVisual.enabled


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

BaseMeshVisual.hasPrefabChanges


horizontalAlignment

horizontalAlignment: Horizontal

Horizontal alignment of the mesh visual.

Inherited from

BaseMeshVisual.horizontalAlignment


id

readonly id: Uuid

The unique id of the entity.

Inherited from

BaseMeshVisual.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

BaseMeshVisual.isPrefabInstanceRoot


mainMaterial

mainMaterial: Material

Primary material used for rendering.


materials

materials: Material[]

Array of all materials on this mesh visual.


meshShadowMode

meshShadowMode: MeshShadowMode

Shadow rendering mode for the mesh.

Inherited from

BaseMeshVisual.meshShadowMode


meta

readonly meta: Meta

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

Inherited from

BaseMeshVisual.meta


name

name: string

Name of the component.

Inherited from

BaseMeshVisual.name


renderOrder

renderOrder: number

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

Inherited from

BaseMeshVisual.renderOrder


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

BaseMeshVisual.sceneObject


shadowColor

shadowColor: vec4

Color of the mesh shadow.

Inherited from

BaseMeshVisual.shadowColor


shadowDensity

shadowDensity: number

Opacity of the mesh shadow.

Inherited from

BaseMeshVisual.shadowDensity


stretchMode

stretchMode: StretchMode

How the mesh stretches to fit its container.

Inherited from

BaseMeshVisual.stretchMode


type

readonly type: string

The entity's type.

Inherited from

BaseMeshVisual.type


verticalAlignment

verticalAlignment: Vertical

Vertical alignment of the mesh visual.

Inherited from

BaseMeshVisual.verticalAlignment

Methods

addMaterialAt()

addMaterialAt(value, pos?): void

Insert a material at the specified index.

Parameters

ParameterType
valueMaterial
pos?number

Returns

void


clearMaterials()

clearMaterials(): void

Remove all materials.

Returns

void


getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

BaseMeshVisual.getDirectlyReferencedEntities


getMaterialAt()

getMaterialAt(pos): Material

Retrieve the material at the specified index.

Parameters

ParameterType
posnumber

Returns

Material


getMaterialsCount()

getMaterialsCount(): number

Get the total number of materials.

Returns

number


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

BaseMeshVisual.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

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

BaseMeshVisual.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

BaseMeshVisual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

BaseMeshVisual.getTypeName


indexOfMaterial()

indexOfMaterial(value): number

Find the index of a given material.

Parameters

ParameterType
valueMaterial

Returns

number


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

BaseMeshVisual.isSame


moveMaterial()

moveMaterial(origin, destination): void

Move a material from one index to another.

Parameters

ParameterType
originnumber
destinationnumber

Returns

void


removeMaterialAt()

removeMaterialAt(pos): void

Remove the material at the specified index.

Parameters

ParameterType
posnumber

Returns

void


setMaterialAt()

setMaterialAt(pos, value): void

Replace the material at the specified index.

Parameters

ParameterType
posnumber
valueMaterial

Returns

void