Class CanvasRenderer

可在画布上渲染组件，使得拥有该组件的Object3D可以在画布上渲染。

Hierarchy

Mesh3D
- CanvasRenderer

Constructors

constructor

new CanvasRenderer(...args: any[]): CanvasRenderer
Parameters
- Rest ...args: any[]
Returns CanvasRenderer
Inherited from Mesh3D.constructor
- Defined in src/ecs/Component.ts:122

Properties

class

__class__: "Mesh3D"

`Protected` _entity

_entity: Entity

`Protected` _globalBounds

_globalBounds: Box3

`Protected` _localBounds

_localBounds: Box3

castShadows

castShadows: boolean = true

是否投射阴影

emitter

emitter: EventEmitter<Node3DEventMap>

enabled

enabled: boolean = true

是否启用update方法

hideFlags

hideFlags: HideFlags = HideFlags.None

隐藏标记，用于控制是否在层级界面、检查器显示，是否保存

material

material: Material = ...

材质

receiveShadows

receiveShadows: boolean = true

是否接受阴影

`Readonly` renderAtomic

renderAtomic: RenderAtomic = ...

渲染原子（该对象会收集一切渲染所需数据以及参数）

runEnvironment

runEnvironment: RunEnvironment = RunEnvironment.all

可运行环境

Accessors

entity

get entity(): Entity
此组件附加到的游戏对象。组件总是附加到游戏对象上。

Returns Entity
Inherited from Mesh3D.entity
- Defined in src/ecs/Component.ts:117

geometry

get geometry(): PlaneGeometry | UIGeometry | CapsuleGeometry | CircleGeometry | CylinderGeometry | ConeGeometry | CubeGeometry | CustomGeometry | IcosahedronGeometry | LatheGeometry | OctahedronGeometry | ParametricGeometry | PointGeometry | QuadGeometry | RingGeometry | SegmentGeometry | SphereGeometry | TetrahedronGeometry | TorusGeometry | TorusKnotGeometry | Terrain3DGeometry
几何体

Returns PlaneGeometry | UIGeometry | CapsuleGeometry | CircleGeometry | CylinderGeometry | ConeGeometry | CubeGeometry | CustomGeometry | IcosahedronGeometry | LatheGeometry | OctahedronGeometry | ParametricGeometry | PointGeometry | QuadGeometry | RingGeometry | SegmentGeometry | SphereGeometry | TetrahedronGeometry | TorusGeometry | TorusKnotGeometry | Terrain3DGeometry
Inherited from Mesh3D.geometry
- Defined in src/3d/core/Mesh3D.ts:34
set geometry(v: PlaneGeometry | UIGeometry | CapsuleGeometry | CircleGeometry | CylinderGeometry | ConeGeometry | CubeGeometry | CustomGeometry | IcosahedronGeometry | LatheGeometry | OctahedronGeometry | ParametricGeometry | PointGeometry | QuadGeometry | RingGeometry | SegmentGeometry | SphereGeometry | TetrahedronGeometry | TorusGeometry | TorusKnotGeometry | Terrain3DGeometry): void
Parameters
- v: PlaneGeometry | UIGeometry | CapsuleGeometry | CircleGeometry | CylinderGeometry | ConeGeometry | CubeGeometry | CustomGeometry | IcosahedronGeometry | LatheGeometry | OctahedronGeometry | ParametricGeometry | PointGeometry | QuadGeometry | RingGeometry | SegmentGeometry | SphereGeometry | TetrahedronGeometry | TorusGeometry | TorusKnotGeometry | Terrain3DGeometry
Returns void
Inherited from Mesh3D.geometry
- Defined in src/3d/core/Mesh3D.ts:40

globalBounds

get globalBounds(): Box3
全局包围盒

Returns Box3
Inherited from Mesh3D.globalBounds
- Defined in src/3d/core/Renderable3D.ts:44

isLoaded

get isLoaded(): boolean
是否加载完成

Returns boolean
Inherited from Mesh3D.isLoaded
- Defined in src/3d/core/Mesh3D.ts:186

isVisibleAndEnabled

get isVisibleAndEnabled(): boolean
Has the Behaviour had enabled called. 是否所在Object3D显示且该行为已启动。

Returns boolean
Inherited from Mesh3D.isVisibleAndEnabled
- Defined in src/core/NodeComponent.ts:26

localBounds

get localBounds(): Box3
局部包围盒

Returns Box3
Inherited from Mesh3D.localBounds
- Defined in src/3d/core/Renderable3D.ts:31

node

get node(): Node
2D节点。

Returns Node
Inherited from Mesh3D.node
- Defined in src/core/NodeComponent.ts:17

node3d

get node3d(): Node3D
2D节点。

Returns Node3D
Inherited from Mesh3D.node3d
- Defined in src/3d/core/Component3D.ts:17

useGeometry

get useGeometry(): PlaneGeometry | UIGeometry | CapsuleGeometry | CircleGeometry | CylinderGeometry | ConeGeometry | CubeGeometry | CustomGeometry | IcosahedronGeometry | LatheGeometry | OctahedronGeometry | ParametricGeometry | PointGeometry | QuadGeometry | RingGeometry | SegmentGeometry | SphereGeometry | TetrahedronGeometry | TorusGeometry | TorusKnotGeometry | Terrain3DGeometry
当前渲染使用的几何体。

Returns PlaneGeometry | UIGeometry | CapsuleGeometry | CircleGeometry | CylinderGeometry | ConeGeometry | CubeGeometry | CustomGeometry | IcosahedronGeometry | LatheGeometry | OctahedronGeometry | ParametricGeometry | PointGeometry | QuadGeometry | RingGeometry | SegmentGeometry | SphereGeometry | TetrahedronGeometry | TorusGeometry | TorusKnotGeometry | Terrain3DGeometry
Inherited from Mesh3D.useGeometry
- Defined in src/3d/core/Mesh3D.ts:79

useMaterial

get useMaterial(): Material
当前渲染使用的材质。

Returns Material
Inherited from Mesh3D.useMaterial
- Defined in src/3d/core/Mesh3D.ts:89

Methods

`Protected` _onBoundsInvalid

_onBoundsInvalid(): void
处理包围盒变换事件

Returns void
Inherited from Mesh3D._onBoundsInvalid
- Defined in src/3d/core/Renderable3D.ts:77

`Protected` _onGetSelfBounds

_onGetSelfBounds(event: IEvent<{
bounds: Box3[];
}>): void
Parameters
- event: IEvent<{
  bounds: Box3[];
  }>
Returns void
Inherited from Mesh3D._onGetSelfBounds
- Defined in src/3d/core/Mesh3D.ts:221

`Protected` _onScenetransformChanged

_onScenetransformChanged(): void
Returns void
Inherited from Mesh3D._onScenetransformChanged
- Defined in src/3d/core/Mesh3D.ts:211

`Protected` _updateBounds

_updateBounds(): void
Returns void
Overrides Mesh3D._updateBounds
- Defined in src/2d/core/CanvasRenderer.ts:58

`Protected` _updateGlobalBounds

_updateGlobalBounds(): void
更新全局边界

Returns void
Inherited from Mesh3D._updateGlobalBounds
- Defined in src/3d/core/Renderable3D.ts:69

addComponent

addComponent<K>(type: K): ComponentMap[K]
Adds a component class of type componentType to the game object.

Returns
被添加的组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- type: K
  
  组件类定义。
Returns ComponentMap[K]
Inherited from Mesh3D.addComponent
- Defined in src/ecs/Component.ts:148

beforeRender

beforeRender(renderAtomic: RenderAtomic, scene: Scene3D, camera: Camera3D): void
渲染前执行函数

可用于渲染前收集渲染数据，或者更新显示效果等
Parameters
- renderAtomic: RenderAtomic
- scene: Scene3D
- camera: Camera3D
Returns void
Inherited from Mesh3D.beforeRender
- Defined in src/3d/core/Mesh3D.ts:114

dispose

dispose(): void
销毁

Returns void
Inherited from Mesh3D.dispose
- Defined in src/3d/core/Mesh3D.ts:204

getComponent

getComponent<K>(component: K): ComponentMap[K]
返回游戏对象附加的一个指定类型的组件，如果没有，则返回 null。

使用 Entity.GetComponent 将返回找到的第一个组件。如果您希望有多个相同类型的组件，请改用 Entity.GetComponents，并循环通过返回的组件测试某些唯一属性。

Returns
要检索的组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  要检索的组件类型。
Returns ComponentMap[K]
Inherited from Mesh3D.getComponent
- Defined in src/ecs/Component.ts:161

getComponentInChildren

getComponentInChildren<K>(component: K, includeInactive?: boolean): ComponentMap[K]
使用深度优先搜索返回 Entity 或其任何子项中的 Type 组件。

Returns
匹配类型的组件（如果找到）。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  要检索的组件类型。
- includeInactive: boolean = false
  
  是否包含不活跃组件。
Returns ComponentMap[K]
Inherited from Mesh3D.getComponentInChildren
- Defined in src/core/NodeComponent.ts:40

getComponentInParent

getComponentInParent<K>(component: K, includeInactive?: boolean): ComponentMap[K]
检索 Entity 或其任何父项type中的 Type 组件。

此方法向上递归，直到找到具有匹配组件的 Entity。仅匹配活动游戏对象上的组件。

Returns
如果找到与类型匹配的组件，则返回一个组件。否则返回 null。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  要查找的组件类型。
- includeInactive: boolean = false
  
  是否包含不活跃组件。
Returns ComponentMap[K]
Inherited from Mesh3D.getComponentInParent
- Defined in src/core/NodeComponent.ts:54

getComponents

getComponents<K>(type: K, results?: ComponentMap[K][]): ComponentMap[K][]
返回Entity中指定类型的所有组件。

Returns
实体中指定类型的所有组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- type: K
  
  要检索的组件类型。
- results: ComponentMap[K][] = []
  
  列出接收找到的组件。
Returns ComponentMap[K][]
Inherited from Mesh3D.getComponents
- Defined in src/ecs/Component.ts:173

getComponentsInChildren

getComponentsInChildren<K>(component: K, includeInactive?: boolean, results?: ComponentMap[K][]): ComponentMap[K][]
使用深度优先搜索返回当前实体或其任何子子项中 Type 的所有组件。递归工作。

在子游戏对象上递归搜索组件。这意味着它还包括目标实体的所有子实体，以及所有后续子实体。

Returns
所有找到的组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  要检索的组件类型。
- includeInactive: boolean = false
  
  非活动游戏对象上的组件是否应该包含在搜索结果中？
- results: ComponentMap[K][] = []
  
  列出接收找到的组件。
Returns ComponentMap[K][]
Inherited from Mesh3D.getComponentsInChildren
- Defined in src/core/NodeComponent.ts:68

getComponentsInParent

getComponentsInParent<K>(component: K, includeInactive?: boolean, results?: ComponentMap[K][]): ComponentMap[K][]
返回当前实体或其任何父级中指定的所有组件。

Returns
实体或其任何父级中指定的所有组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  要检索的组件类型。
- includeInactive: boolean = false
  
  非活动组件是否应该包含在搜索结果中？
- results: ComponentMap[K][] = []
  
  列出找到的组件。
Returns ComponentMap[K][]
Inherited from Mesh3D.getComponentsInParent
- Defined in src/core/NodeComponent.ts:81

getShareTargets

getShareTargets(): Entity[]
把事件分享到实体上。

Returns Entity[]
Inherited from Mesh3D.getShareTargets
- Defined in src/ecs/Component.ts:181

globalRayIntersection

globalRayIntersection(globalRay: Ray3): PickingCollisionVO
与全局空间射线相交

Returns
相交信息
Parameters
- globalRay: Ray3
  
  全局空间射线
Returns PickingCollisionVO
Overrides Mesh3D.globalRayIntersection
- Defined in src/2d/core/CanvasRenderer.ts:32

init

init(): void
初始化组件

在添加到Entity时立即被调用。

Returns void
Overrides Mesh3D.init
- Defined in src/2d/core/CanvasRenderer.ts:20

localRayIntersection

localRayIntersection(localRay: Ray3): PickingCollisionVO
与局部空间射线相交

Returns
相交信息
Parameters
- localRay: Ray3
  
  局部空间射线
Returns PickingCollisionVO
Inherited from Mesh3D.localRayIntersection
- Defined in src/3d/core/Mesh3D.ts:156

onLoadCompleted

onLoadCompleted(callback: (() => void)): void
已加载完成或者加载完成时立即调用
Parameters
- callback: (() => void)
  
  完成回调
  - - (): void
    - Returns void
Returns void
Inherited from Mesh3D.onLoadCompleted
- Defined in src/3d/core/Mesh3D.ts:195

`Private` setEntity

setEntity(entity: Entity): void
Private
该方法仅在Entity中使用
Parameters
- entity: Entity
  
  游戏对象
Returns void
Inherited from Mesh3D.setEntity
- Defined in src/ecs/Component.ts:206

`Static` `Private` create

__create__<T>(this: Constructor<T>): T
Private
组件无法直接使用关键字 new 来构造。

Returns
新建的组件实例。

See
getInstance
Type Parameters
- T
Parameters
- this: Constructor<T>
Returns T
Inherited from Mesh3D.__create__
- Defined in src/ecs/Component.ts:230

`Static` getDependencies

getDependencies<K>(component: K): (keyof ComponentMap)[]
获取组件依赖列表
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  组件类定义
Returns (keyof ComponentMap)[]
Inherited from Mesh3D.getDependencies
- Defined in src/ecs/Component.ts:240

`Static` isSingleComponent

isSingleComponent<K>(component: K | ComponentMap[K] | Constructor<ComponentMap[K]>): boolean
判断组件是否为唯一组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K | ComponentMap[K] | Constructor<ComponentMap[K]>
  
  组件类定义
Returns boolean
Inherited from Mesh3D.isSingleComponent
- Defined in src/ecs/Component.ts:260

Class CanvasRenderer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Rest ...args: any[]

Returns CanvasRenderer

Properties

__class__

Protected _entity

Protected _globalBounds

Protected _localBounds

castShadows

emitter

enabled

hideFlags

material

receiveShadows

Readonly renderAtomic

runEnvironment

Accessors

entity

Returns Entity

geometry

Parameters

Returns void

globalBounds

Returns Box3

isLoaded

Returns boolean

isVisibleAndEnabled

Returns boolean

localBounds

Returns Box3

node

Returns Node

node3d

Returns Node3D

useGeometry

useMaterial

Returns Material

Methods

Protected _onBoundsInvalid

Returns void

Protected _onGetSelfBounds

Parameters

event: IEvent<{ bounds: Box3[]; }>

Returns void

Protected _onScenetransformChanged

Returns void

Protected _updateBounds

Returns void

Protected _updateGlobalBounds

Returns void

addComponent

Returns

Type Parameters

K extends keyof ComponentMap

Parameters

type: K

Returns ComponentMap[K]

beforeRender

Parameters

renderAtomic: RenderAtomic

scene: Scene3D

camera: Camera3D

Returns void

dispose

Returns void

getComponent

Returns

Type Parameters

K extends keyof ComponentMap

Parameters

component: K

`Rest` ...args: any[]

class

`Protected` _entity

`Protected` _globalBounds

`Protected` _localBounds

`Readonly` renderAtomic

`Protected` _onBoundsInvalid

`Protected` _onGetSelfBounds

event: IEvent<{
bounds: Box3[];
}>

`Protected` _onScenetransformChanged

`Protected` _updateBounds

`Protected` _updateGlobalBounds

`Private` setEntity

`Static` `Private` create