Class Sprite

文本标签组件

Export

Date

2022.7.27

Author

yj

Hierarchy

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _renderOrder isRenderable queryMask userData

Accessors

autoCulling bounds enabled engine entity fillStyle horizontalOrigin object3D occluded opacity outline outlineColor position quaternion renderOrder rotation scale size sizeAttenuation spriteAlign text verticalOrigin visible visibleDistance weight worldPosition worldQuaternion worldScale

Methods

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

Constructors

constructor

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 = 0

查询遮罩值

Memberof

Renderable

userData

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

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

autoCulling

  • get autoCulling(): boolean

  • 获取是否自动剔除

    Returns boolean

    Memberof

    Sprite

  • set autoCulling(value): void

  • 设置是否自动剔除

    Parameters

    • value: boolean

    Returns void

    Memberof

    Sprite

bounds

  • get bounds(): Readonly<Box3>

  • 获取世界外包范围

    Returns Readonly<Box3>

    Memberof

    Renderable

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

fillStyle

  • get fillStyle(): string

  • 获取文字颜色

    Returns string

    Memberof

    Sprite

  • set fillStyle(value): void

  • 设置文字颜色

    Parameters

    • value: string

    Returns void

    Memberof

    Sprite

horizontalOrigin

  • get horizontalOrigin(): HorizontalOrigin

  • 获取标签水平方向中心位置

    Returns HorizontalOrigin

    Memberof

    Sprite

  • set horizontalOrigin(value): void

  • 设置标签水平方向中心位置

    Parameters

    Returns void

    Memberof

    Sprite

object3D

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

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

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

    Memberof

    Renderable

occluded

  • get occluded(): boolean

  • 获取标签是否可被遮挡

    Returns boolean

    Memberof

    Sprite

  • set occluded(value): void

  • 设置标签是否可被遮挡

    Parameters

    • value: boolean

    Returns void

    Memberof

    Sprite

opacity

  • get opacity(): number

  • 获取标签透明度

    Returns number

    Memberof

    Sprite

  • set opacity(value): void

  • 设置标签透明度

    Parameters

    • value: number

    Returns void

    Memberof

    Sprite

outline

  • set outline(value): void

  • 启用文本外边框

    Parameters

    • value: boolean

    Returns void

    Memberof

    Sprite

outlineColor

  • set outlineColor(value): void

  • 设置文本外边框颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Sprite

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

    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

size

  • get size(): number

  • 获取基准高度尺寸

    Returns number

    Memberof

    Sprite

  • set size(value): void

  • 设置基准高度尺寸

    Parameters

    • value: number

    Returns void

    Memberof

    Sprite

sizeAttenuation

  • get sizeAttenuation(): boolean

  • 获取标签是否随深度衰减

    Returns boolean

    Memberof

    Sprite

  • set sizeAttenuation(value): void

  • 设置标签是否随深度衰减

    Parameters

    • value: boolean

    Returns void

    Memberof

    Sprite

spriteAlign

  • get spriteAlign(): TextAlign

  • 获取文本对齐方式

    Returns TextAlign

    Memberof

    Sprite

  • set spriteAlign(value): void

  • 设置文本对齐方式

    Parameters

    Returns void

    Memberof

    Sprite

text

  • get text(): string

  • 获取文本内容

    Returns string

    Memberof

    Sprite

  • set text(value): void

  • 设置文本内容

    Parameters

    • value: string

    Returns void

    Memberof

    Sprite

verticalOrigin

  • get verticalOrigin(): VerticalOrigin

  • 获取标签竖直方向中心位置

    Returns VerticalOrigin

    Memberof

    Sprite

  • set verticalOrigin(value): void

  • 设置标签竖直方向中心位置

    Parameters

    Returns void

    Memberof

    Sprite

visible

  • get visible(): boolean

  • 获取是否可见

    Returns boolean

    Memberof

    Renderable

  • set visible(value): void

  • 设置是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Renderable

visibleDistance

  • get visibleDistance(): number

  • 获取可见距离

    Returns number

    Memberof

    Sprite

weight

  • get weight(): number

  • 获取剔除权重

    Returns number

    Memberof

    Sprite

  • set weight(value): void

  • 设置剔除权重

    Parameters

    • value: number

    Returns void

    Memberof

    Sprite

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

    Sprite

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

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

getRect

  • 获取标签的像素范围

    Returns {
        maxX: number;
        maxY: number;
        minX: number;
        minY: number;
    }

    像素范围

    • maxX: number
    • maxY: number
    • minX: number
    • minY: number

    Memberof

    Sprite

localToWorld

  • 本地坐标转世界坐标

    Parameters

    • vector: number[] | Vector3

      本地坐标

    Returns Vector3

    Memberof

    Renderable

pause

  • 暂停Lottie动画

    Returns void

    Memberof

    Sprite

play

  • 播放Lottie动画

    Returns void

    Memberof

    Sprite

raycast

  • 射线拾取

    Parameters

    • raycaster: Raycaster

    Returns Intersection<Object3D<Object3DEventMap>>

    Memberof

    Sprite

recoverMaterial

removeAllEventListeners

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

setDirection

  • 设置Lottie动画播放方向

    Parameters

    • direction: AnimationDirection

    Returns void

    Memberof

    Sprite

setHighlight

  • 设置是否高亮

    Parameters

    Returns void

    Memberof

    Renderable

setSpeed

  • 设置Lottie动画播放速度

    Parameters

    • speed: number

    Returns void

    Memberof

    Sprite

setStencil

  • 设置模板参数

    Parameters

    Returns void

    Memberof

    Renderable

setTransform

  • 设置本地方位信息

    Parameters

    Returns void

    Memberof

    Renderable

stop

  • 停止Lottie动画

    Returns void

    Memberof

    Sprite

updateProperties

worldToLocal

  • 世界坐标转本地坐标

    Parameters

    • vector: number[] | Vector3

      世界坐标

    Returns Vector3

    Memberof

    Renderable

Settings

Member Visibility

Theme

On This Page