Class Bar

柱状对象渲染组件

Export

Date

2022.9.13

Author

yj

Hierarchy

  • Renderable
    • Bar

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _renderOrder isRenderable queryMask userData

Accessors

bounds enabled engine entity innerColor innerEdgeColor innerEdgeOpacity innerEdgeVisible innerEdgeWidth innerEndColor innerHeight innerOccluded innerOpacity innerStartColor innerVisible object3D outerColor outerEdgeColor outerEdgeOpacity outerEdgeVisible outerEdgeWidth outerEndColor outerHeight outerOccluded outerOpacity outerStartColor outerVisible position quaternion renderOrder rotation scale 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

  • Parameters

    Returns Bar

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

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

innerColor

  • set innerColor(value): void

  • 设置内部Bar颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Bar

innerEdgeColor

  • get innerEdgeColor(): ColorRepresentation

  • 获取内部Bar边框颜色

    Returns ColorRepresentation

    Memberof

    Bar

  • set innerEdgeColor(value): void

  • 设置内部Bar边框颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Bar

innerEdgeOpacity

  • get innerEdgeOpacity(): number

  • 获取内部Bar边框透明度

    Returns number

    Memberof

    Bar

  • set innerEdgeOpacity(value): void

  • 设置内部Bar边框透明度

    Parameters

    • value: number

    Returns void

    Memberof

    Bar

innerEdgeVisible

  • get innerEdgeVisible(): boolean

  • 获取内部Bar边框可见性

    Returns boolean

    Memberof

    Bar

  • set innerEdgeVisible(value): void

  • 设置内部Bar边框可见性

    Parameters

    • value: boolean

    Returns void

    Memberof

    Bar

innerEdgeWidth

  • get innerEdgeWidth(): number

  • 获取内部Bar边框宽度

    Returns number

    Memberof

    Bar

  • set innerEdgeWidth(value): void

  • 设置内部Bar边框宽度

    Parameters

    • value: number

    Returns void

    Memberof

    Bar

innerEndColor

  • get innerEndColor(): ColorRepresentation

  • 获取内部bar终点颜色

    Returns ColorRepresentation

    Memberof

    Bar

  • set innerEndColor(value): void

  • 设置内部bar终点颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Bar

innerHeight

  • get innerHeight(): number

  • 获取内部Bar高度

    Returns number

    Memberof

    Bar

  • set innerHeight(value): void

  • 设置内部Bar高度

    Parameters

    • value: number

    Returns void

    Memberof

    Bar

innerOccluded

  • get innerOccluded(): boolean

  • 获取内部Bar是否可被遮挡

    Returns boolean

    Memberof

    Bar

  • set innerOccluded(value): void

  • 设置内部Bar是否可被遮挡

    Parameters

    • value: boolean

    Returns void

    Memberof

    Bar

innerOpacity

  • get innerOpacity(): number

  • 获取内部Bar透明度

    Returns number

    Memberof

    Bar

  • set innerOpacity(value): void

  • 设置内部Bar透明度

    Parameters

    • value: number

    Returns void

    Memberof

    Bar

innerStartColor

  • get innerStartColor(): ColorRepresentation

  • 获取内部Bar起点颜色

    Returns ColorRepresentation

    Memberof

    Bar

  • set innerStartColor(value): void

  • 设置内部Bar起点颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Bar

innerVisible

  • get innerVisible(): boolean

  • 获取内部Bar是否可见

    Returns boolean

    Memberof

    Bar

  • set innerVisible(value): void

  • 设置内部Bar是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Bar

object3D

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

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

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

    Memberof

    Renderable

outerColor

  • set outerColor(value): void

  • 设置外部Bar颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Bar

outerEdgeColor

  • get outerEdgeColor(): ColorRepresentation

  • 获取外部Bar边框颜色

    Returns ColorRepresentation

    Memberof

    Bar

  • set outerEdgeColor(value): void

  • 设置外部Bar边框颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Bar

outerEdgeOpacity

  • get outerEdgeOpacity(): number

  • 获取外部Bar边框透明度

    Returns number

    Memberof

    Bar

  • set outerEdgeOpacity(value): void

  • 设置外部Bar边框透明度

    Parameters

    • value: number

    Returns void

    Memberof

    Bar

outerEdgeVisible

  • get outerEdgeVisible(): boolean

  • 获取外部Bar边框可见性

    Returns boolean

    Memberof

    Bar

  • set outerEdgeVisible(value): void

  • 设置外部Bar边框可见性

    Parameters

    • value: boolean

    Returns void

    Memberof

    Bar

outerEdgeWidth

  • get outerEdgeWidth(): number

  • 获取外部Bar边框宽度

    Returns number

    Memberof

    Bar

  • set outerEdgeWidth(value): void

  • 设置外部Bar边框宽度

    Parameters

    • value: number

    Returns void

    Memberof

    Bar

outerEndColor

  • get outerEndColor(): ColorRepresentation

  • 获取外部Bar终点颜色

    Returns ColorRepresentation

    Memberof

    Bar

  • set outerEndColor(value): void

  • 设置外部bar终点颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Bar

outerHeight

  • get outerHeight(): number

  • 获取外部Bar高度

    Returns number

    Memberof

    Bar

  • set outerHeight(value): void

  • 设置外部Bar高度

    Parameters

    • value: number

    Returns void

    Memberof

    Bar

outerOccluded

  • get outerOccluded(): boolean

  • 获取外部Bar是否可被遮挡

    Returns boolean

    Memberof

    Bar

  • set outerOccluded(value): void

  • 设置外部Bar是否可被遮挡

    Parameters

    • value: boolean

    Returns void

    Memberof

    Bar

outerOpacity

  • get outerOpacity(): number

  • 获取透明度

    Returns number

    Memberof

    Bar

  • set outerOpacity(value): void

  • 设置外部Bar透明度

    Parameters

    • value: number

    Returns void

    Memberof

    Bar

outerStartColor

  • get outerStartColor(): ColorRepresentation

  • 获取外部Bar起点颜色

    Returns ColorRepresentation

    Memberof

    Bar

  • set outerStartColor(value): void

  • 设置外部Bar起点颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Bar

outerVisible

  • get outerVisible(): boolean

  • 获取外部Bar是否可见

    Returns boolean

    Memberof

    Bar

  • set outerVisible(value): void

  • 设置外部Bar是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Bar

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

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

    Bar

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

    {void}

    Memberof

    Bar

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

    Bar

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

  • 批量更新组件属性

    Parameters

    • parameters: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns Promise<void>

    Memberof

    Component

worldToLocal

  • 世界坐标转本地坐标

    Parameters

    • vector: number[] | Vector3

      世界坐标

    Returns Vector3

    Memberof

    Renderable

Settings

Member Visibility

Theme

On This Page