类 BaseRenderNode2D

2D 渲染基类

层级 (查看层级一览)

Component
- BaseRenderNode2D

属性

_extra

_extra: IComponentExtra

En

Extra data of the node.

Zh

组件的额外数据。IDE内部使用。

_id

_id: number

En

Unique identifier for the component.

Zh

组件的唯一标识。

_singleton

_singleton: boolean

En

Whether the component is a singleton, meaning only one instance of this type of script can be added to the same node.

Zh

是否为单例，即同一个节点只能添加此类型的脚本一次。

owner

owner: Sprite

En

Gets the owner Node to which the component belongs.

Zh

获取组件所属的 Node 节点。

runInEditor

runInEditor: boolean

En

Whether the script can run in the IDE environment.

Zh

是否可以在 IDE 环境中运行。

scriptPath

scriptPath: string

En

The path of the script file.

Zh

脚本文件的路径。

`静态`BASERENDER2DCOLOR

BASERENDER2DCOLOR: number

渲染节点颜色ID

`静态`BASERENDER2DTEXTURE

BASERENDER2DTEXTURE: number

渲染节点纹理ID

`静态`BASERENDERSIZE

BASERENDERSIZE: number

渲染节点size ID

`静态`NMATRIX_0

NMATRIX_0: number

渲染矩阵第一个vector3属性ID

`静态`NMATRIX_1

NMATRIX_1: number

渲染矩阵第二个vector3属性ID

`静态`NORMAL2DSTRENGTH

NORMAL2DSTRENGTH: number

`静态`NORMAL2DTEXTURE

NORMAL2DTEXTURE: number

渲染节点纹理ID

`静态`SHADERDEFINE_BASERENDER2D

SHADERDEFINE_BASERENDER2D: ShaderDefine

2D渲染节点宏

`静态`SHADERDEFINE_LIGHT2D_ADDMODE

SHADERDEFINE_LIGHT2D_ADDMODE: ShaderDefine

`静态`SHADERDEFINE_LIGHT2D_EMPTY

SHADERDEFINE_LIGHT2D_EMPTY: ShaderDefine

`静态`SHADERDEFINE_LIGHT2D_ENABLE

SHADERDEFINE_LIGHT2D_ENABLE: ShaderDefine

2D灯光宏

`静态`SHADERDEFINE_LIGHT2D_NORMAL_PARAM

SHADERDEFINE_LIGHT2D_NORMAL_PARAM: ShaderDefine

`静态`SHADERDEFINE_LIGHT2D_SUBMODE

SHADERDEFINE_LIGHT2D_SUBMODE: ShaderDefine

访问器

awaked

get awaked(): boolean
返回 boolean
En
whether the component has been awakened.

Zh
组件是否已经被唤醒。
继承自 Component.awaked
- 定义于 src/layaAir/laya/components/Component.ts:133

destroyed

get destroyed(): boolean
返回 boolean
En
whether the component has been destroyed.

Zh
组件是否已经被销毁。
继承自 Component.destroyed
- 定义于 src/layaAir/laya/components/Component.ts:141

enabled

get enabled(): boolean
返回 boolean
En
whether the component is enabled.

Zh
是否启用组件。
继承自 Component.enabled
- 定义于 src/layaAir/laya/components/Component.ts:117
set enabled(value: boolean): void
参数
- value: boolean
返回 void
继承自 Component.enabled
- 定义于 src/layaAir/laya/components/Component.ts:121

hideFlags

get hideFlags(): number
返回 number
En
The hide flags that determine the hiding behavior of the component.

Zh
确定组件隐藏行为的标志。
继承自 Component.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:67
set hideFlags(value: number): void
参数
- value: number
返回 void
继承自 Component.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:71

id

get id(): number
返回 number
En
The unique identifier for the component.

Zh
组件的唯一标识。
继承自 Component.id
- 定义于 src/layaAir/laya/components/Component.ts:109

layer

get layer(): number
返回 number
En
render layer

Zh
渲染层。
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:272
set layer(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:276

lightReceive

get lightReceive(): boolean
返回 boolean
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:303
set lightReceive(value: boolean): void
参数
- value: boolean
返回 void
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:289

sharedMaterial

get sharedMaterial(): Material
返回 Material
En
get first Material

Zh
第一个材质。
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:351
set sharedMaterial(value: Material): void
参数
- value: Material
返回 void
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:355

方法

_resetUpdateMark

_resetUpdateMark(): void
返回 void
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:307

_setRenderSize

_setRenderSize(x: number, y: number): void
参数
- x: number
- y: number
返回 void
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:203

_updateLight

_updateLight(): void
返回 void
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:311

`可选`addCMDCall

addCMDCall(context: Context, px: number, py: number): void
cmd run时调用，可以用来计算matrix等获得即时context属性
参数
- context: Context
- px: number
- py: number
返回 void
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:226

destroy

destroy(): void
返回 void
En
Destroy components

Zh
销毁组件
继承自 Component.destroy
- 定义于 src/layaAir/laya/components/Component.ts:289

getRenderID

getRenderID(): number
返回 number
获得ID

En
Get 2D render component ID

Zh
获得2D渲染组件标识ID
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:369

hasHideFlag

hasHideFlag(flag: number): boolean
参数
- flag: number
  The hide flag to check for.
返回 boolean
En
Checks if the component has a specific hide flag set.

Zh
检查组件是否设置了特定的隐藏标志。
继承自 Component.hasHideFlag
- 定义于 src/layaAir/laya/components/Component.ts:101

onAdded

onAdded(): void
返回 void
En
Called after the component is added to a node. Unlike Awake, onAdded is called even if the node is not active.

Zh
组件被添加到节点后调用，与 onAwake 不同的是，即使节点未激活也会调用 onAdded。
继承自 Component.onAdded
- 定义于 src/layaAir/laya/components/Component.ts:329

onAwake

onAwake(): void
返回 void
En
Executed after the component is activated. At this point, all nodes and components have been created. This method is executed only once.

Zh
组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。
继承自 Component.onAwake
- 定义于 src/layaAir/laya/components/Component.ts:344

onDestroy

onDestroy(): void
返回 void
En
Executed when the node is destroyed manually.

Zh
手动调用节点销毁时执行。
继承自 Component.onDestroy
- 定义于 src/layaAir/laya/components/Component.ts:395

onDisable

onDisable(): void
返回 void
En
Executed when the component is disabled, such as when the node is removed from the stage.

Zh
组件被禁用时执行，比如从节点从舞台移除后。
继承自 Component.onDisable
- 定义于 src/layaAir/laya/components/Component.ts:388

onEnable

onEnable(): void
返回 void
En
Executed after the component is enabled, such as when the node is added to the stage.

Zh
组件被启用后执行，比如节点被添加到舞台后。
继承自 Component.onEnable
- 定义于 src/layaAir/laya/components/Component.ts:351

`可选`onLateUpdate

onLateUpdate(): void
返回 void
En
Executed every frame during the late update phase, after the update phase.

Zh
每帧更新时执行，在 late update 阶段，update 阶段之后。
继承自 Component.onLateUpdate
- 定义于 src/layaAir/laya/components/Component.ts:370

`可选`onPostRender

onPostRender(): void
返回 void
En
Executed after rendering.

Zh
渲染之后执行。
继承自 Component.onPostRender
- 定义于 src/layaAir/laya/components/Component.ts:382

`可选`onPreRender

onPreRender(): void
返回 void
En
Executed before rendering.

Zh
渲染之前执行。
继承自 Component.onPreRender
- 定义于 src/layaAir/laya/components/Component.ts:376

`可选`onReset

onReset(): void
返回 void
En
Resets the component's parameters to their default values. If this function is implemented, the component will be reset and automatically recycled for future use. If not reset, it will not be recycled for reuse.

Zh
将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。如果没有重置，则不会进行回收复用。
继承自 Component.onReset
- 定义于 src/layaAir/laya/components/Component.ts:338

`可选`onStart

onStart(): void
返回 void
En
Executed once, before the first update.

Zh
在第一次执行 update 之前执行，只会执行一次。
继承自 Component.onStart
- 定义于 src/layaAir/laya/components/Component.ts:358

`可选`onUpdate

onUpdate(): void
返回 void
En
Executed every frame during the update phase. Avoid writing complex loop logic or using the getComponent method here.

Zh
每帧更新时执行，在 update 阶段。尽量不要在这里写大循环逻辑或使用 getComponent 方法。
继承自 Component.onUpdate
- 定义于 src/layaAir/laya/components/Component.ts:364

`可选`preRenderUpdate

preRenderUpdate(context: IRenderContext2D): void
渲染前更新，准备所需的渲染数据
参数
- context: IRenderContext2D
返回 void
- 定义于 src/layaAir/laya/NodeRender2D/BaseRenderNode2D.ts:239

类 BaseRenderNode2D

层级 (查看层级一览)

索引

属性

访问器

方法

属性

_extra

En

Zh

_id

En

Zh

_singleton

En

Zh

owner

En

Zh

runInEditor

En

Zh

scriptPath

En

Zh

静态BASERENDER2DCOLOR

静态BASERENDER2DTEXTURE

静态BASERENDERSIZE

静态NMATRIX_0

静态NMATRIX_1

静态NORMAL2DSTRENGTH

静态NORMAL2DTEXTURE

静态SHADERDEFINE_BASERENDER2D

静态SHADERDEFINE_LIGHT2D_ADDMODE

静态SHADERDEFINE_LIGHT2D_EMPTY

静态SHADERDEFINE_LIGHT2D_ENABLE

静态SHADERDEFINE_LIGHT2D_NORMAL_PARAM

静态SHADERDEFINE_LIGHT2D_SUBMODE

访问器

awaked

返回 boolean

En

Zh

destroyed

返回 boolean

En

Zh

enabled

返回 boolean

En

Zh

参数

返回 void

hideFlags

返回 number

En

Zh

参数

返回 void

id

返回 number

En

Zh

layer

返回 number

En

Zh

参数

返回 void

lightReceive

返回 boolean

参数

返回 void

sharedMaterial

返回 Material

En

Zh

参数

返回 void

方法

`静态`BASERENDER2DCOLOR

`静态`BASERENDER2DTEXTURE

`静态`BASERENDERSIZE

`静态`NMATRIX_0

`静态`NMATRIX_1

`静态`NORMAL2DSTRENGTH

`静态`NORMAL2DTEXTURE

`静态`SHADERDEFINE_BASERENDER2D

`静态`SHADERDEFINE_LIGHT2D_ADDMODE

`静态`SHADERDEFINE_LIGHT2D_EMPTY

`静态`SHADERDEFINE_LIGHT2D_ENABLE

`静态`SHADERDEFINE_LIGHT2D_NORMAL_PARAM

`静态`SHADERDEFINE_LIGHT2D_SUBMODE

`可选`addCMDCall

`可选`onLateUpdate

`可选`onPostRender

`可选`onPreRender

`可选`onReset

`可选`onStart

`可选`onUpdate

`可选`preRenderUpdate