m4m.framework.canvascontainer

@meta4d/engine / Exports / m4m / framework / canvascontainer

Class: canvascontainer

m4m.framework.canvascontainer

language zh_CN

classdesc UI画布容器组件

version m4m 1.0

Implements

• INodeComponent

Table of contents

Accessors

• canvas

• renderMode

• sortOrder

Constructors

• constructor

Properties

• gameObject

• ClassName

Methods

• getOverLay

• onPlay

• setOverLay

• start

• update

Accessors

canvas

• get canvas(): canvas

language zh_CN

classdesc UI canvas

version m4m 1.0

Returns

canvas

Defined in

framework/component/canvascontainer.ts:34

---

renderMode

• get renderMode(): canvasRenderMode

language zh_CN

classdesc renderMode UI render模式

version m4m 1.0

Returns

canvasRenderMode

Defined in

framework/component/canvascontainer.ts:79

• set renderMode(mode): void

language zh_CN

classdesc renderMode UI render模式

version m4m 1.0

Parameters

Name	Type
mode	canvasRenderMode

Returns

void

Defined in

framework/component/canvascontainer.ts:80

---

sortOrder

• get sortOrder(): number

Returns

number

Defined in

framework/component/canvascontainer.ts:52

• set sortOrder(order): void

Parameters

Name	Type
order	number

Returns

void

Defined in

framework/component/canvascontainer.ts:55

Constructors

constructor

• new canvascontainer()

Defined in

framework/component/canvascontainer.ts:15

Properties

gameObject

• gameObject: gameObject

language zh_CN

classdesc 挂载的gameobject

version m4m 1.0

Implementation of

INodeComponent.gameObject

Defined in

framework/component/canvascontainer.ts:25

---

ClassName

▪ Static Readonly ClassName: string = "canvascontainer"

Defined in

framework/component/canvascontainer.ts:13

Methods

getOverLay

▸ getOverLay(): overlay2D

Returns

overlay2D

Defined in

framework/component/canvascontainer.ts:47

---

onPlay

▸ onPlay(): void

Returns

void

Implementation of

INodeComponent.onPlay

Defined in

framework/component/canvascontainer.ts:109

---

setOverLay

▸ setOverLay(lay): void

Parameters

Name	Type
lay	overlay2D

Returns

void

Defined in

framework/component/canvascontainer.ts:42

---

start

▸ start(): void

Returns

void

Implementation of

INodeComponent.start

Defined in

framework/component/canvascontainer.ts:104

---

update

▸ update(delta): void

Parameters

Name	Type
delta	number

Returns

void

Implementation of

INodeComponent.update

Defined in

framework/component/canvascontainer.ts:114