Editor.Components.BaseMeshVisual
ClassBase class for mesh-based visual components.
Index
Properties
Methods
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
hasPrefabChanges
readonlyhasPrefabChanges: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
horizontalAlignment
horizontalAlignment:
Horizontal
Horizontal alignment of the mesh visual.
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
isPrefabInstanceRoot
readonlyisPrefabInstanceRoot:boolean
Whether this entity is the root of a prefab instance.
Inherited from
meshShadowMode
meshShadowMode:
MeshShadowMode
Shadow rendering mode for the mesh.
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
name:
string
Name of the component.
Inherited from
renderOrder
renderOrder:
number
Determines the order in which this visual component is rendered relative to others.
Inherited from
sceneObject
readonlysceneObject:SceneObject
Scene object this component is attached to.
Inherited from
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
readonlytype:string
The entity's type.
Inherited from
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()
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
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
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