Skip to main content

Editor.Components.Text3D

Class

3D text rendering component with font, layout, and styling options.

Index

Example

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

const obj = scene.createSceneObject('Text3DObj');
const text3d = obj.addComponent('Text3D') as Editor.Components.Text3D;

text3d.text = 'Hello 3D';
text3d.extrusionDepth = 0.5;
text3d.italic = false;
text3d.letterSpacing = 0.02;
text3d.lineSpacing = 1.0;
console.log(`Text3D: text="${text3d.text}", extrusion=${text3d.extrusionDepth}, letterSpacing=${text3d.letterSpacing}`);

Extends

Properties

advancedLayout

advancedLayout: TextAdvancedLayout

Advanced text layout settings.


capitalizationOverride

capitalizationOverride: CapitalizationOverride

Text capitalization style override.


debugRenderLayoutRect

debugRenderLayoutRect: boolean

If enabled, draws the Text3D.layoutRect bounds as a wireframe for debugging text layout. Has no effect when a Editor.Components.ScreenTransform is attached to the same SceneObject, since the ScreenTransform supersedes the layoutRect.


editable

editable: boolean

Enable editing text content at runtime.


enableBatching

enableBatching: boolean

Optimize rendering by batching geometry.


enabled

enabled: boolean

Whether the component is active.

Inherited from

MaterialMeshVisual.enabled


enableRichText

enableRichText: boolean

If enabled, inputted text will be interpreted as rich text.


extrudeDirection

extrudeDirection: ExtrudeDirection

Direction to extrude text geometry.


extrusionDepth

extrusionDepth: number

Depth value for text extrusion.


font

font: Font

Font asset used for text rendering.


fontSource

fontSource: Font | FontCollection | FontFamily

The font source for this text component. Can be a Font, FontFamily, or FontCollection asset.


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

MaterialMeshVisual.hasPrefabChanges


horizontalAlignment

horizontalAlignment: Horizontal

Horizontal alignment of the mesh visual.

Inherited from

MaterialMeshVisual.horizontalAlignment


horizontalOverflow

horizontalOverflow: HorizontalOverflow

Behavior when text exceeds horizontal bounds.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

MaterialMeshVisual.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.

Inherited from

MaterialMeshVisual.isPrefabInstanceRoot


italic?

optional italic?: boolean

Apply italic style to text.


layoutRect

layoutRect: Rect

The rectangular bounds the text is laid out within. Controls text wrapping and alignment, and defines the area Text3D.horizontalOverflow, Text3D.verticalOverflow, and Text3D.sizeToFit are evaluated against. Each bound is defined as an offset in world units from the SceneObject's position. If a Editor.Components.ScreenTransform is attached to the same SceneObject, it always supersedes this property text is laid out within the ScreenTransform's rect instead, and changes to layoutRect have no effect.


letterSpacing

letterSpacing: number

Space between individual characters.


lineSpacing

lineSpacing: number

Space between text lines.


mainMaterial

mainMaterial: Material

Primary material used for rendering.

Inherited from

MaterialMeshVisual.mainMaterial


materials

materials: Material[]

Array of all materials on this mesh visual.

Inherited from

MaterialMeshVisual.materials


meshShadowMode

meshShadowMode: MeshShadowMode

Shadow rendering mode for the mesh.

Inherited from

MaterialMeshVisual.meshShadowMode


meta

readonly meta: Meta

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

Inherited from

MaterialMeshVisual.meta


name

name: string

Name of the component.

Inherited from

MaterialMeshVisual.name


preferredStyle

preferredStyle: string

Controls style applied to the text. Accepts a Editor.Components.FontStyles constant (e.g. FontStyles.Bold). If Text3D.fontSource is assigned to a variable font or a font collection with variable fonts, this also accepts a named instance name or custom variation style name that belongs to the variable font. Matching is case-insensitive and ignores whitespace and hyphens, so "Bold Italic", "bolditalic", and "bold-italic" all resolve to the same style. If Text3D.weight or Text3D.italic are explicitly assigned, they will override any weight or italic axis value in preferredStyle.


renderOrder

renderOrder: number

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

Inherited from

MaterialMeshVisual.renderOrder


sceneObject

readonly sceneObject: SceneObject

Scene object this component is attached to.

Inherited from

MaterialMeshVisual.sceneObject


shadowColor

shadowColor: vec4

Color of the mesh shadow.

Inherited from

MaterialMeshVisual.shadowColor


shadowDensity

shadowDensity: number

Opacity of the mesh shadow.

Inherited from

MaterialMeshVisual.shadowDensity


showEditingPreview

showEditingPreview: boolean

Display text editing preview in editor.


size

size: number

Font size in pixels.


sizeToFit

sizeToFit: boolean

Automatically scale text to fit bounds.


stretchMode

stretchMode: StretchMode

How the mesh stretches to fit its container.

Inherited from

MaterialMeshVisual.stretchMode


text

text: string

Text string content to render.


touchHandler

touchHandler: InteractionComponent

Enable touch input handling on text.


type

readonly type: string

The entity's type.

Inherited from

MaterialMeshVisual.type


verticalAlignment

verticalAlignment: Vertical

Vertical alignment of the mesh visual.

Inherited from

MaterialMeshVisual.verticalAlignment


verticalOverflow

verticalOverflow: VerticalOverflow

Behavior when text exceeds vertical bounds.


weight?

optional weight?: number

Font weight value.

Methods

addMaterialAt()

addMaterialAt(value, pos?): void

Insert a material at the specified index.

Parameters

ParameterType
valueMaterial
pos?number

Returns

void

Inherited from

MaterialMeshVisual.addMaterialAt


clearMaterials()

clearMaterials(): void

Remove all materials.

Returns

void

Inherited from

MaterialMeshVisual.clearMaterials


getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

MaterialMeshVisual.getDirectlyReferencedEntities


getMaterialAt()

getMaterialAt(pos): Material

Retrieve the material at the specified index.

Parameters

ParameterType
posnumber

Returns

Material

Inherited from

MaterialMeshVisual.getMaterialAt


getMaterialsCount()

getMaterialsCount(): number

Get the total number of materials.

Returns

number

Inherited from

MaterialMeshVisual.getMaterialsCount


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

MaterialMeshVisual.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

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

MaterialMeshVisual.getPrefabInstanceRoot


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

MaterialMeshVisual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

MaterialMeshVisual.getTypeName


indexOfMaterial()

indexOfMaterial(value): number

Find the index of a given material.

Parameters

ParameterType
valueMaterial

Returns

number

Inherited from

MaterialMeshVisual.indexOfMaterial


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

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

MaterialMeshVisual.isSame


moveMaterial()

moveMaterial(origin, destination): void

Move a material from one index to another.

Parameters

ParameterType
originnumber
destinationnumber

Returns

void

Inherited from

MaterialMeshVisual.moveMaterial


removeMaterialAt()

removeMaterialAt(pos): void

Remove the material at the specified index.

Parameters

ParameterType
posnumber

Returns

void

Inherited from

MaterialMeshVisual.removeMaterialAt


setMaterialAt()

setMaterialAt(pos, value): void

Replace the material at the specified index.

Parameters

ParameterType
posnumber
valueMaterial

Returns

void

Inherited from

MaterialMeshVisual.setMaterialAt