InterfaceText3D`Beta`

The same entity as in Lens Scripting.

See

"Lens Scripting".Built-In.Text3D.

interface Text3D {
    advancedLayout: TextAdvancedLayout;
    capitalizationOverride: CapitalizationOverride;
    editable: boolean;
    enabled: boolean;
    extrudeDirection: ExtrudeDirection;
    extrusionDepth: number;
    font: Font;
    horizontalAlignment: Horizontal;
    horizontalOverflow: HorizontalOverflow;
    id: Uuid;
    letterSpacing: number;
    lineSpacing: number;
    mainMaterial: Material;
    materials: Material[];
    meshShadowMode: MeshShadowMode;
    name: string;
    renderOrder: number;
    sceneObject: SceneObject;
    shadowColor: vec4;
    shadowDensity: number;
    showEditingPreview: boolean;
    size: number;
    sizeToFit: boolean;
    stretchMode: StretchMode;
    text: string;
    touchHandler: InteractionComponent;
    type: string;
    verticalAlignment: Vertical;
    verticalOverflow: VerticalOverflow;
    worldSpaceRect: Editor.Rect;
    addMaterialAt(value: Material, pos?: number): void;
    clearMaterials(): void;
    getDirectlyReferencedEntities(): Entity[];
    getMaterialAt(pos: number): Material;
    getMaterialsCount(): number;
    getOwnedEntities(): Entity[];
    getTypeName(): string;
    indexOfMaterial(value: Material): number;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    moveMaterial(origin: number, destination: number): void;
    remapReferences(referenceMapping: object): void;
    removeMaterialAt(pos: number): void;
    setMaterialAt(pos: number, value: Material): void;
}

Hierarchy (view full)

MaterialMeshVisual
- Text3D

Properties

`Beta`advancedLayout

advancedLayout: TextAdvancedLayout

`Beta`capitalizationOverride

capitalizationOverride: CapitalizationOverride

`Beta`editable

editable: boolean

`Beta`enabled

enabled: boolean

`Beta`extrudeDirection

extrudeDirection: ExtrudeDirection

`Beta`extrusionDepth

extrusionDepth: number

`Beta`font

font: Font

`Beta`horizontalAlignment

horizontalAlignment: Horizontal

`Beta`horizontalOverflow

horizontalOverflow: HorizontalOverflow

`Readonly` `Beta`id

id: Uuid

The unique id of the entity.

`Beta`letterSpacing

letterSpacing: number

`Beta`lineSpacing

lineSpacing: number

`Beta`mainMaterial

mainMaterial: Material

`Beta`materials

materials: Material[]

`Beta`meshShadowMode

meshShadowMode: MeshShadowMode

`Beta`name

name: string

`Beta`renderOrder

renderOrder: number

`Readonly` `Beta`sceneObject

sceneObject: SceneObject

`Beta`shadowColor

shadowColor: vec4

`Beta`shadowDensity

shadowDensity: number

`Beta`showEditingPreview

showEditingPreview: boolean

`Beta`size

size: number

`Beta`sizeToFit

sizeToFit: boolean

`Beta`stretchMode

stretchMode: StretchMode

`Beta`text

text: string

`Beta`touchHandler

touchHandler: InteractionComponent

`Readonly` `Beta`type

type: string

The entity's type.

`Beta`verticalAlignment

verticalAlignment: Vertical

`Beta`verticalOverflow

verticalOverflow: VerticalOverflow

`Beta`worldSpaceRect

worldSpaceRect: Editor.Rect

Methods

addMaterialAt

addMaterialAt(value, pos?): void
Beta
Parameters
- value: Material
- Optionalpos: number
Returns void
Inherited from MaterialMeshVisual.addMaterialAt

clearMaterials

clearMaterials(): void
Beta
Returns void
Inherited from MaterialMeshVisual.clearMaterials

getDirectlyReferencedEntities

getDirectlyReferencedEntities(): Entity[]
Beta
A list of entities which this entity has a reference to.

Returns Entity[]
Inherited from MaterialMeshVisual.getDirectlyReferencedEntities

getMaterialAt

getMaterialAt(pos): Material
Beta
Parameters
- pos: number
Returns Material
Inherited from MaterialMeshVisual.getMaterialAt

getMaterialsCount

getMaterialsCount(): number
Beta
Returns number
Inherited from MaterialMeshVisual.getMaterialsCount

getOwnedEntities

getOwnedEntities(): Entity[]
Beta
A list of entities which has a reference to this entity.

Returns Entity[]
Inherited from MaterialMeshVisual.getOwnedEntities

getTypeName

getTypeName(): string
Beta
Returns string
Inherited from MaterialMeshVisual.getTypeName

indexOfMaterial

indexOfMaterial(value): number
Beta
Parameters
- value: Material
Returns number
Inherited from MaterialMeshVisual.indexOfMaterial

isOfType

isOfType(type): boolean
Beta
Parameters
- type: string
Returns boolean
Inherited from MaterialMeshVisual.isOfType

isSame

isSame(other): boolean
Beta
Parameters
- other: ScriptObject
Returns boolean
Inherited from MaterialMeshVisual.isSame

moveMaterial

moveMaterial(origin, destination): void
Beta
Parameters
- origin: number
- destination: number
Returns void
Inherited from MaterialMeshVisual.moveMaterial

remapReferences

remapReferences(referenceMapping): void
Beta
Swap this entity for another one based on a JSON of the current entity id and the target entity id.
Parameters
- referenceMapping: object
Returns void
Inherited from MaterialMeshVisual.remapReferences

removeMaterialAt

removeMaterialAt(pos): void
Beta
Parameters
- pos: number
Returns void
Inherited from MaterialMeshVisual.removeMaterialAt

setMaterialAt

setMaterialAt(pos, value): void
Beta
Parameters
- pos: number
- value: Material
Returns void
Inherited from MaterialMeshVisual.setMaterialAt