Skip to main content

Editor.Components.BaseMeshVisual

Class

Base class for mesh-based visual components.

Index

Example

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

// Create a RenderMeshVisual (extends BaseMeshVisual) and configure its properties
const obj = scene.createSceneObject('MeshObj');
const visual = obj.addComponent('RenderMeshVisual') as Editor.Components.RenderMeshVisual;

// Configure shadow casting
visual.meshShadowMode = Editor.Components.MeshShadowMode.Caster;
visual.shadowDensity = 0.8;
console.log(`Shadow: mode=${visual.meshShadowMode}, density=${visual.shadowDensity}`);

// Set stretch and alignment
visual.stretchMode = Editor.Components.StretchMode.Fit;
visual.horizontalAlignment = Editor.Alignment.Horizontal.Center;
visual.verticalAlignment = Editor.Alignment.Vertical.Center;
console.log(`Stretch: ${visual.stretchMode}, align: h=${visual.horizontalAlignment}, v=${visual.verticalAlignment}`);

Extends

Extended by

Properties

enabled

enabled: boolean

Whether the component is active.

Inherited from

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

Visual.hasPrefabChanges


horizontalAlignment

horizontalAlignment: Horizontal

Horizontal alignment of the mesh visual.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Visual.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

Visual.isPrefabInstanceRoot


meshShadowMode

meshShadowMode: MeshShadowMode

Shadow rendering mode for the mesh.


meta

readonly meta: Meta

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

Inherited from

Visual.meta


name

name: string

Name of the component.

Inherited from

Visual.name


renderOrder

renderOrder: number

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

Inherited from

Visual.renderOrder


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

Visual.sceneObject


shadowColor

shadowColor: vec4

Color of the mesh shadow.


shadowDensity

shadowDensity: number

Opacity of the mesh shadow.


stretchMode

stretchMode: StretchMode

How the mesh stretches to fit its container.


type

readonly type: string

The entity's type.

Inherited from

Visual.type


verticalAlignment

verticalAlignment: Vertical

Vertical alignment of the mesh visual.

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Visual.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Visual.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

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

Visual.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Visual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Visual.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

Visual.isSame