Class Terrain3D

The Terrain component renders the terrain.

Hierarchy

Component
- Terrain3D

Index

Constructors

Properties

__class__ _entity assign emitter enabled hideFlags runEnvironment

Accessors

Methods

addComponent beforeRender dispose getComponent getComponents getShareTargets init setEntity __create__ getDependencies isSingleComponent

Constructors

constructor

new Terrain3D(): Terrain3D
Returns Terrain3D
Overrides Component.constructor
- Defined in src/3d/terrain/Terrain3D.ts:26

Properties

class

__class__: "Terrain"

`Protected` _entity

_entity: Entity

assign

assign: TerrainData

地形资源

`Readonly` emitter

emitter: EventEmitter<EntityEventMap> = ...

事件发射器。

enabled

enabled: boolean = true

是否启用update方法

hideFlags

hideFlags: HideFlags = HideFlags.None

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

runEnvironment

runEnvironment: RunEnvironment = RunEnvironment.all

可运行环境

Accessors

entity

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

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

Methods

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 Component.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 Component.beforeRender
- Defined in src/ecs/Component.ts:195

dispose

dispose(): void
销毁

Returns void
Overrides Component.dispose
- Defined in src/3d/terrain/Terrain3D.ts:38

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 Component.getComponent
- Defined in src/ecs/Component.ts:161

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 Component.getComponents
- Defined in src/ecs/Component.ts:173

getShareTargets

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

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

init

init(): void
初始化组件

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

Returns void
Overrides Component.init
- Defined in src/3d/terrain/Terrain3D.ts:31

`Private` setEntity

setEntity(entity: Entity): void
Private
该方法仅在Entity中使用
Parameters
- entity: Entity
  
  游戏对象
Returns void
Inherited from Component.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 Component.__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 Component.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 Component.isSingleComponent
- Defined in src/ecs/Component.ts:260

Generated using TypeDoc