Class Renderable`Abstract`

渲染器组件基类

Export

Abstract

Date

2022.3.23

Author

lyx

Hierarchy

Constructors

constructor

new Renderable(entity, parameters?): Renderable
Parameters
- entity: Entity
- parameters: RenderableParameters = {}
Returns Renderable

Overrides Component.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

bounds

get bounds(): Readonly<Box3>
获取世界外包范围

Returns Readonly<Box3>

Memberof
Renderable

enabled

get enabled(): boolean
获取组件是否启用

Returns boolean

Memberof
Component

Inherited from Component.enabled
set enabled(value): void
启用或禁用组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Component.enabled

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from Component.engine

entity

get entity(): Entity
获取组件所属实体

Returns Entity

Memberof
Component

Inherited from Component.entity

object3D

get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
获取渲染组件对应的Object3D（three.js）对象

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

Memberof
Renderable

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` `Abstract` _destroy

_destroy(): void
Protected
销毁接口

Returns void

Abstract

Memberof
Renderable

`Protected` _onAwake

_onAwake(): void
Protected
唤醒组件

Returns void

Memberof
Component

Inherited from Component._onAwake

`Protected` _onDestroy

_onDestroy(): void
Protected
销毁渲染组件

Returns void

Memberof
Renderable

Overrides Component._onDestroy

`Protected` _onDisable

_onDisable(): void
Protected
禁用渲染组件

Returns void

Memberof
Renderable

Overrides Component._onDisable

`Protected` _onEnable

_onEnable(): void
Protected
启用渲染组件

Returns void

Memberof
Renderable

Overrides Component._onEnable

`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

addEventListener(type, callback, parameters?): number
添加事件监听器
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

Inherited from Component.addEventListener

destroy

destroy(): void
销毁组件

Returns void

Memberof
Component

Inherited from Component.destroy

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from Component.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from Component.dispose

localToWorld

localToWorld(vector): Vector3
本地坐标转世界坐标
Parameters
- vector: number[] | Vector3
  
  本地坐标
Returns Vector3

Memberof
Renderable

`Abstract` raycast

raycast(raycaster): Intersection<Object3D<Object3DEventMap>>
射线拾取
Parameters
- raycaster: Raycaster
  
  射线拾取器
Returns Intersection<Object3D<Object3DEventMap>>

Abstract

Memberof
Renderable

recoverMaterial

recoverMaterial(): void
恢复材质

Returns void

Memberof
Renderable

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from Component.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
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

Inherited from Component.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from Component.removeEventListenerByEventId

replaceMaterial

replaceMaterial(material): void
替换材质
Parameters
- material: any
  
  材质对象
Returns void

Memberof
Renderable

setActive

setActive(value): void
激活或冻结组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Component.setActive

setClipping

setClipping(parameters?): void
设置裁剪
Parameters
- Optional parameters: ClippingParameters = {}
  
  裁剪参数
Returns void

Memberof
Renderable

setHighlight

setHighlight(highlight, parameters?): void
设置是否高亮
Parameters
- highlight: boolean
  
  是否高亮
- Optional parameters: HighlightParameters = {}
  
  高亮参数
Returns void

Memberof
Renderable

setStencil

setStencil(parameters?): void
设置模板参数
Parameters
- Optional parameters: StencilParameters = {}
  
  模板参数
Returns void

Memberof
Renderable

setTransform

setTransform(transformation): void
设置本地方位信息
Parameters
- transformation: Transformation
  
  方位信息
Returns void

Memberof
Renderable

updateProperties

updateProperties(parameters): Promise<void>
批量更新组件属性
Parameters
- parameters: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<void>

Memberof
Component

Inherited from Component.updateProperties

worldToLocal

worldToLocal(vector): Vector3
世界坐标转本地坐标
Parameters
- vector: number[] | Vector3
  
  世界坐标
Returns Vector3

Memberof
Renderable