Class Text

Text字体组件

Export

Date

2024.03.19

Author

lmz

Hierarchy

  • Renderable
    • Text

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _renderOrder isRenderable queryMask userData

Accessors

bounds color enabled engine entity font fontSize fontWeight letterSpacing lineHeight maxWidth object3D opacity outlineBlur outlineColor outlineOffsetX outlineOffsetY outlineOpacity outlineWidth position quaternion renderOrder rotation scale strokeColor strokeOpacity strokeWidth text textIndent visible worldPosition worldQuaternion worldScale

Methods

_destroy _onAwake _onDestroy _onDisable _onEnable _updateBounds _updateMatrixWorld _updateRenderOrder addEventListener destroy dispatchEvent dispose localToWorld raycast recoverMaterial removeAllEventListeners removeEventListener removeEventListenerByEventId replaceMaterial setActive setClipping setHighlight setStencil setTransform updateProperties worldToLocal

Constructors

constructor

  • new Text(entity, parameters): Text

  • Parameters

    Returns Text

Properties

Protected _bounds

_bounds: Box3

Protected _boundsUpdateFlag

_boundsUpdateFlag: BoolUpdateFlag

Protected _engine

_engine: Engine

Protected _entity

_entity: Entity

Protected _object3D

_object3D: Object3D<Object3DEventMap>

Protected _renderOrder

_renderOrder: RenderOrder

Readonly isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

queryMask

queryMask: number

查询遮罩值

Memberof

Renderable

userData

userData: {
    [key: string]: any;
}

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

bounds

  • get bounds(): Readonly<Box3>

  • 获取世界外包范围

    Returns Readonly<Box3>

    Memberof

    Renderable

color

  • get color(): ColorRepresentation

  • 获取文本颜色

    Returns ColorRepresentation

    Memberof

    text3D

  • set color(value): void

  • 设置文本颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    text3D

enabled

  • get enabled(): boolean

  • 获取组件是否启用

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • 启用或禁用组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

entity

  • get entity(): Entity

  • 获取组件所属实体

    Returns Entity

    Memberof

    Component

font

  • get font(): string

  • 获取文本样式

    Returns string

    Memberof

    text3D

  • set font(value): void

  • 设置文本样式

    Parameters

    • value: string

    Returns void

    Memberof

    text3D

fontSize

  • get fontSize(): number

  • 获取文字尺寸

    Returns number

    Memberof

    text3D

  • set fontSize(value): void

  • 设置文字尺寸

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

fontWeight

  • get fontWeight(): number | "normal" | "bold"

  • 获取字体粗细

    Returns number | "normal" | "bold"

    Memberof

    text3D

  • set fontWeight(value): void

  • 设置字体粗细

    Parameters

    • value: number | "normal" | "bold"

    Returns void

    Memberof

    text3D

letterSpacing

  • get letterSpacing(): number

  • 获取字体间距

    Returns number

    Memberof

    text3D

  • set letterSpacing(value): void

  • 设置 字体间距

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

lineHeight

  • get lineHeight(): number | "normal"

  • 获取行文本高度

    Returns number | "normal"

    Memberof

    text3D

  • set lineHeight(value): void

  • 设置行文本高度

    Parameters

    • value: number | "normal"

    Returns void

    Memberof

    text3D

maxWidth

  • get maxWidth(): number

  • 获取文本块宽度

    Returns number

    Memberof

    text3D

  • set maxWidth(value): void

  • 设置文本块宽度

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

object3D

  • get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

  • 获取渲染组件对应的Object3D（three.js）对象

    Returns Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

    Memberof

    Renderable

opacity

  • get opacity(): number

  • 获取文本透明度

    Returns number

    Memberof

    text3D

  • set opacity(value): void

  • 设置文本透明度

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

outlineBlur

  • get outlineBlur(): number

  • 获取边缘模糊半径

    Returns number

    Memberof

    text3D

  • set outlineBlur(value): void

  • 设置边缘模糊半径

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

outlineColor

  • get outlineColor(): ColorRepresentation

  • 获取字体颜色

    Returns ColorRepresentation

    Memberof

    text3D

  • set outlineColor(value): void

  • 设置字体颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    text3D

outlineOffsetX

  • get outlineOffsetX(): number

  • 获取水平偏移量

    Returns number

    Memberof

    text3D

  • set outlineOffsetX(value): void

  • 设置水平偏移量

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

outlineOffsetY

  • get outlineOffsetY(): number

  • 获取垂直偏移量

    Returns number

    Memberof

    text3D

  • set outlineOffsetY(value): void

  • 设置垂直偏移量

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

outlineOpacity

  • get outlineOpacity(): number

  • 获取文本轮廓透明度

    Returns number

    Memberof

    text3D

  • set outlineOpacity(value): void

  • 设置文本轮廓透明度

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

outlineWidth

  • get outlineWidth(): number

  • 获取文本轮廓宽度

    Returns number

    Memberof

    text3D

  • set outlineWidth(value): void

  • 设置文本轮廓宽度

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

position

  • get position(): Vector3

  • 获取本地位置

    Returns Vector3

    Memberof

    Renderable

  • set position(value): void

  • 设置本地位置

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    Renderable

quaternion

  • get quaternion(): Quaternion

  • 获取本地旋转四元数

    Returns Quaternion

    Memberof

    Renderable

  • set quaternion(value): void

  • 设置本地旋转四元数

    Parameters

    • value: number[] | Quaternion

    Returns void

    Memberof

    Renderable

renderOrder

  • get renderOrder(): RenderOrder

  • 获取渲染顺序

    Returns RenderOrder

    Memberof

    Renderable

  • set renderOrder(value): void

  • 设置渲染顺序

    Parameters

    • value: RenderOrder

    Returns void

    Memberof

    Renderable

rotation

  • get rotation(): Euler

  • 获取本地旋转角（单位：弧度）

    Returns Euler

    Memberof

    Renderable

  • set rotation(value): void

  • 设置本地旋转角（单位：弧度）

    Parameters

    • value: number[] | Euler

    Returns void

    Memberof

    Renderable

scale

  • get scale(): Vector3

  • 获取本地缩放

    Returns Vector3

    Memberof

    Renderable

  • set scale(value): void

  • 设置本地缩放

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    Renderable

strokeColor

  • get strokeColor(): ColorRepresentation

  • 获取描边颜色

    Returns ColorRepresentation

    Memberof

    text3D

  • set strokeColor(value): void

  • 设置描边颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    text3D

strokeOpacity

  • get strokeOpacity(): number

  • 获取文本描边透明度

    Returns number

    Memberof

    text3D

  • set strokeOpacity(value): void

  • 设置文本描边透明度

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

strokeWidth

  • get strokeWidth(): number

  • 获取文本描边宽度

    Returns number

    Memberof

    text3D

  • set strokeWidth(value): void

  • 设置文本描边宽度

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

text

  • get text(): string

  • 获取文本内容

    Returns string

    Memberof

    text3D

  • set text(value): void

  • 设置文本内容

    Parameters

    • value: string

    Returns void

    Memberof

    text3D

textIndent

  • get textIndent(): number

  • 获取文本缩进

    Returns number

    Memberof

    text3D

  • set textIndent(value): void

  • 设置文本缩进

    Parameters

    • value: number

    Returns void

    Memberof

    text3D

visible

  • get visible(): boolean

  • 获取是否可见

    Returns boolean

    Memberof

    Renderable

  • set visible(value): void

  • 设置是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Renderable

worldPosition

  • get worldPosition(): Vector3

  • 获取世界位置

    Returns Vector3

    Memberof

    Renderable

worldQuaternion

  • get worldQuaternion(): Quaternion

  • 获取世界旋转四元数

    Returns Quaternion

    Memberof

    Renderable

worldScale

  • get worldScale(): Vector3

  • 获取世界缩放

    Returns Vector3

    Memberof

    Renderable

Methods

Protected _destroy

  • _destroy(): void
  • Protected

    销毁接口

    Returns void

    Memberof

    Text

Protected _onAwake

  • _onAwake(): void
  • Protected

    唤醒组件

    Returns void

    Memberof

    Component

Protected _onDestroy

  • _onDestroy(): void
  • Protected

    销毁渲染组件

    Returns void

    Memberof

    Renderable

Protected _onDisable

  • _onDisable(): void
  • Protected

    禁用渲染组件

    Returns void

    Memberof

    Renderable

Protected _onEnable

  • _onEnable(): void
  • Protected

    启用渲染组件

    Returns void

    Memberof

    Renderable

Protected _updateBounds

  • _updateBounds(): void
  • Protected

    更新渲染组件外包盒

    Returns void

    Memberof

    Renderable

Protected _updateMatrixWorld

  • _updateMatrixWorld(): void
  • Protected

    更新渲染组件世界矩阵

    Returns void

    Memberof

    Renderable

Protected _updateRenderOrder

  • _updateRenderOrder(): void
  • Protected

    更新渲染顺序

    Returns void

    Memberof

    Renderable

addEventListener

  • 添加事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • callback: ((event) => void)

      事件监听回调

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    • Optional parameters: {
          priority?: Priority;
          target?: any;
      }

      事件参数

      • Optional priority?: Priority
      • Optional target?: any

    Returns number

    Memberof

    EventDispatcher

destroy

  • 销毁组件

    Returns void

    Memberof

    Component

dispatchEvent

  • 分发事件

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

dispose

  • 释放接口

    Returns void

    Memberof

    EventDispatcher

localToWorld

  • 本地坐标转世界坐标

    Parameters

    • vector: number[] | Vector3

      本地坐标

    Returns Vector3

    Memberof

    Renderable

raycast

  • 射线拾取

    Parameters

    • raycaster: Raycaster

    Returns Intersection<Object3D<Object3DEventMap>>

    Memberof

    Text

recoverMaterial

  • 恢复材质

    Returns void

    Memberof

    Renderable

removeAllEventListeners

  • 移除所有事件监听器

    Returns void

    Memberof

    EventDispatcher

removeEventListener

  • 移除事件监听器

    Parameters

    • type: string

      事件类型（不区分大小写）

    • Optional callback: ((event) => void)

      事件监听回调（可选，不设置则表示移除所有监听器）

        • (event): void

        • Parameters

          • event: {
                type: string;
                [key: string]: any;
            }
            • [key: string]: any
            • type: string

          Returns void

    Returns void

    Memberof

    EventDispatcher

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

replaceMaterial

  • 替换材质

    Parameters

    • material: any

      材质对象

    Returns void

    Memberof

    Renderable

setActive

  • 激活或冻结组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

setClipping

  • 设置裁剪

    Parameters

    • Optional parameters: ClippingParameters

      裁剪参数

    Returns void

    Memberof

    Renderable

setHighlight

  • 设置是否高亮

    Parameters

    • highlight: boolean

      是否高亮

    • Optional parameters: HighlightParameters

      高亮参数

    Returns void

    Memberof

    Renderable

setStencil

  • 设置模板参数

    Parameters

    • Optional parameters: StencilParameters

      模板参数

    Returns void

    Memberof

    Renderable

setTransform

  • 设置本地方位信息

    Parameters

    • transformation: Transformation

      方位信息

    Returns void

    Memberof

    Renderable

updateProperties

  • 批量更新Text组件属性

    Parameters

    Returns Promise<void>

    Memberof

    Text

worldToLocal

  • 世界坐标转本地坐标

    Parameters

    • vector: number[] | Vector3

      世界坐标

    Returns Vector3

    Memberof

    Renderable

Settings

Member Visibility

Theme

On This Page