RenderableComponent | @esengine/egret-framework

所有可渲染组件的基类

Hierarchy

Component
- RenderableComponent

Implements

IHashObject
IRenderable

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new RenderableComponent(): RenderableComponent

Inherited from Component.constructor
- Defined in lib/egret.d.ts:54
创建一个 HashObject 对象

version

Egret 2.4

platform

Web,Native

language

zh_CN

Returns RenderableComponent

Properties

Private $hashCode

$hashCode: number

Protected _areBoundsDirty

_areBoundsDirty: boolean = true

Protected _bounds

_bounds: Rectangle = new Rectangle()

Private _isVisible

_isVisible: boolean

Protected _localOffset

_localOffset: Vector2 = Vector2.zero

Protected _renderLayer

_renderLayer: number = 0

color

color: number = 0

用于着色器处理精灵

debugDisplayObject

debugDisplayObject: DisplayObjectContainer = new egret.DisplayObjectContainer()

用于装载debug使用的显示容器

debugRenderEnabled

debugRenderEnabled: boolean = true

displayObject

displayObject: DisplayObject = new egret.DisplayObject()

用于装载egret显示对象

entity

entity: Entity

此组件附加的实体

Readonly hashCode

hashCode: number

返回此对象唯一的哈希值,用于唯一确定一个对象。hashCode为大于等于1的整数。

version: Egret 2.4
platform: Web,Native
language: zh_CN

hollowShape

hollowShape: Shape = new egret.Shape()

pixelShape

pixelShape: Shape = new egret.Shape()

updateInterval

updateInterval: number = 1

更新该组件的时间间隔。这与实体的更新间隔无关。

Accessors

bounds

get bounds(): Rectangle

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:71
这个物体的AABB, 用于相机剔除

Returns Rectangle

enabled

get enabled(): boolean
set enabled(value: boolean): void

Inherited from Component.enabled
- Defined in src/ECS/Component.ts:36
如果组件和实体都已启用，则为。当启用该组件时，将调用该组件的生命周期方法。状态的改变会导致调用onEnabled/onDisable。

Returns boolean
Inherited from Component.enabled
- Defined in src/ECS/Component.ts:44
如果组件和实体都已启用，则为。当启用该组件时，将调用该组件的生命周期方法。状态的改变会导致调用onEnabled/onDisable。

Parameters
- value: boolean
Returns void

height

get height(): number

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:31
renderableComponent的高度如果你不重写bounds属性则需要实现这个

Returns number

isVisible

get isVisible(): boolean
set isVisible(value: boolean): void

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:86
可渲染的可见性。状态的改变会调用onBecameVisible/onBecameInvisible方法

Returns boolean
- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:94
可渲染的可见性。状态的改变会调用onBecameVisible/onBecameInvisible方法

Parameters
- value: boolean
Returns void

localOffset

get localOffset(): Vector2
set localOffset(value: Vector2): void

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:41
从父实体的偏移量。用于向需要特定定位的实体

Returns Vector2
- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:49
从父实体的偏移量。用于向需要特定定位的实体

Parameters
- value: Vector2
Returns void

renderLayer

get renderLayer(): number
set renderLayer(value: number): void

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:58
较低的渲染层在前面，较高的在后面

Returns number
- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:62
较低的渲染层在前面，较高的在后面

Parameters
- value: number
Returns void

transform

get transform(): Transform

Inherited from Component.transform
- Defined in src/ECS/Component.ts:27
快速访问 this.entity.transform

Returns Transform

updateOrder

get updateOrder(): number
set updateOrder(value: number): void

Inherited from Component.updateOrder
- Defined in src/ECS/Component.ts:51
更新此实体上组件的顺序

Returns number
Inherited from Component.updateOrder
- Defined in src/ECS/Component.ts:56
更新此实体上组件的顺序

Parameters
- value: number
Returns void

width

get width(): number

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:23
renderableComponent的宽度如果你不重写bounds属性则需要实现这个

Returns number

Methods

compareTo

compareTo(other: RenderableComponent): number

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:206
Parameters
- other: RenderableComponent
Returns number

debugRender

debugRender(camera: Camera): void

Implementation of IRenderable.debugRender

Overrides Component.debugRender
- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:115
Parameters
- camera: Camera
Returns void

initialize

initialize(): void

Inherited from Component.initialize
- Defined in src/ECS/Component.ts:63
当此组件已分配其实体，但尚未添加到实体的活动组件列表时调用。有用的东西，如物理组件，需要访问转换来修改碰撞体的属性。

Returns void

isVisibleFromCamera

isVisibleFromCamera(camera: Camera): boolean

Implementation of IRenderable.isVisibleFromCamera
- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:148
如果renderableComponent的边界与camera.bounds相交返回true 用于处理isVisible标志的状态开关在渲染方法中使用这个方法来决定是否渲染

Parameters
- camera: Camera
Returns boolean

onAddedToEntity

onAddedToEntity(): void

Inherited from Component.onAddedToEntity
- Defined in src/ECS/Component.ts:69
在提交所有挂起的组件更改后，将该组件添加到场景时调用。此时，设置了实体字段和实体。场景也设定好了。

Returns void

Protected onBecameInvisible

onBecameInvisible(): void

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:227
当renderableComponent离开相机框架时调用如果渲染器不适用isVisibleFromCamera进行剔除检查这些方法不会被调用

Returns void

Protected onBecameVisible

onBecameVisible(): void

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:218
当renderableComponent进入相机框架时调用如果渲染器不适用isVisibleFromCamera进行剔除检查这些方法不会被调用

Returns void

onDisabled

onDisabled(): void

Inherited from Component.onDisabled
- Defined in src/ECS/Component.ts:100
禁用父实体或此组件时调用

Returns void

onEnabled

onEnabled(): void

Inherited from Component.onEnabled
- Defined in src/ECS/Component.ts:94
当父实体或此组件启用时调用

Returns void

onEntityTransformChanged

onEntityTransformChanged(comp: Component): void

Overrides Component.onEntityTransformChanged
- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:105
Parameters
- comp: Component
Returns void

onRemovedFromEntity

onRemovedFromEntity(): void

Inherited from Component.onRemovedFromEntity
- Defined in src/ECS/Component.ts:75
当此组件从其实体中移除时调用。在这里做所有的清理工作。

Returns void

Abstract render

render(camera: Camera): any

Implementation of IRenderable.render
- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:113
由渲染器调用。可以使用摄像机进行剔除

Parameters
- camera: Camera
Returns any

setColor

setColor(color: number): RenderableComponent

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:178
用于着色器处理精灵

Parameters
- color: number
Returns RenderableComponent

setEnabled

setEnabled(isEnabled: boolean): this

Inherited from Component.setEnabled
- Defined in src/ECS/Component.ts:109
Parameters
- isEnabled: boolean
Returns this

setLocalOffset

setLocalOffset(offset: Vector2): RenderableComponent

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:187
从父实体的偏移量。用于向需要特定定位的实体

Parameters
- offset: Vector2
Returns RenderableComponent

setRenderLayer

setRenderLayer(renderLayer: number): RenderableComponent

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:160
较低的渲染层在前面，较高的在后面

Parameters
- renderLayer: number
Returns RenderableComponent

setUpdateOrder

setUpdateOrder(updateOrder: number): this

Inherited from Component.setUpdateOrder
- Defined in src/ECS/Component.ts:123
Parameters
- updateOrder: number
Returns this

sync

sync(camera: Camera): void

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:198
进行状态同步

Parameters
- camera: Camera
Returns void

toString

toString(): string

- Defined in src/ECS/Components/Renderables/RenderableComponent.ts:210
Returns string

update

update(): void

Inherited from Component.update
- Defined in src/ECS/Component.ts:106
当该组件启用时每帧进行调用

Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns RenderableComponent

Properties

Private $hashCode

Protected _areBoundsDirty

Protected _bounds

Private _isVisible

Protected _localOffset

Protected _renderLayer

color

debugDisplayObject

debugRenderEnabled

displayObject

entity

Readonly hashCode

hollowShape

pixelShape

updateInterval

Accessors

bounds

Returns Rectangle

enabled

Returns boolean

Parameters

value: boolean

Returns void

height

Returns number

isVisible

Returns boolean

Parameters

value: boolean

Returns void

localOffset

Returns Vector2

Parameters

value: Vector2

Returns void

renderLayer

Returns number

Parameters

value: number

Returns void

transform

Returns Transform

updateOrder

Returns number

Parameters

value: number

Returns void

width

Returns number

Methods

compareTo

Parameters

other: RenderableComponent

Returns number

debugRender

Parameters

camera: Camera

Returns void

initialize

Returns void

isVisibleFromCamera

Parameters

camera: Camera

Returns boolean

onAddedToEntity

Returns void

Protected onBecameInvisible

Returns void

Protected onBecameVisible