Class: UIPanel

Container for UI components

Hierarchy

• UIImage

  ↳ UIPanel

  ↳↳ ViewPanel

  ↳↳ WorldPanel

Constructors

• constructor

Properties

• object3D
• isDestroyed
• space
• needUpdateGeometry
• panelOrder
• needSortOnCameraZ
• scissorEnable
• scissorCornerRadius
• scissorFadeOutSize
• panelRatio
• isUIPanel
• isUIShadow
• isShadowless
• needUpdateShadow

Accessors

• eventDispatcher
• isStart
• transform
• enable
• uiTransform
• visible
• sprite
• color
• imageType
• quadMaxCount
• renderer
• billboard
• cullMode
• mainQuads

Methods

• stop
• onEnable
• onDisable
• onLateUpdate
• onBeforeUpdate
• onCompute
• onGraphic
• onParentChange
• onAddChild
• onRemoveChild
• beforeDestroy
• cloneTo
• copyComponent
• init
• updateDrawCallSegment
• onUpdate
• destroy
• start
• setShadowRenderer
• setShadowSource
• getShadowRender

Constructors

constructor

• new UIPanel(): UIPanel

Returns

UIPanel

Inherited from

UIImage.constructor

Properties

object3D

• object3D: Object3D = null

owner object3D

Inherited from

UIImage.object3D

Defined in

src/components/ComponentBase.ts:17

---

isDestroyed

• Optional isDestroyed: boolean

Inherited from

UIImage.isDestroyed

Defined in

src/components/ComponentBase.ts:38

---

space

• Readonly space: number = GUISpace.World

Defined in

src/components/gui/uiComponents/UIPanel.ts:20

---

needUpdateGeometry

• needUpdateGeometry: boolean = true

Defined in

src/components/gui/uiComponents/UIPanel.ts:21

---

panelOrder

• panelOrder: number = 0

Defined in

src/components/gui/uiComponents/UIPanel.ts:22

---

needSortOnCameraZ

• Optional needSortOnCameraZ: boolean

Defined in

src/components/gui/uiComponents/UIPanel.ts:23

---

scissorEnable

• scissorEnable: boolean = false

Defined in

src/components/gui/uiComponents/UIPanel.ts:27

---

scissorCornerRadius

• scissorCornerRadius: number = 0

Defined in

src/components/gui/uiComponents/UIPanel.ts:28

---

scissorFadeOutSize

• scissorFadeOutSize: number = 0

Defined in

src/components/gui/uiComponents/UIPanel.ts:29

---

panelRatio

• panelRatio: number = 1

Defined in

src/components/gui/uiComponents/UIPanel.ts:35

---

isUIPanel

• Readonly isUIPanel: true

Defined in

src/components/gui/uiComponents/UIPanel.ts:36

---

isUIShadow

• Optional isUIShadow: boolean

Inherited from

UIImage.isUIShadow

Defined in

src/components/gui/uiComponents/UIRenderAble.ts:12

---

isShadowless

• Optional isShadowless: boolean

Inherited from

UIImage.isShadowless

Defined in

src/components/gui/uiComponents/UIRenderAble.ts:13

---

needUpdateShadow

• needUpdateShadow: boolean

Inherited from

UIImage.needUpdateShadow

Defined in

src/components/gui/uiComponents/UIRenderAble.ts:14

Accessors

eventDispatcher

• get eventDispatcher(): CEventDispatcher

Returns

CEventDispatcher

Inherited from

UIImage.eventDispatcher

Defined in

src/components/ComponentBase.ts:23

• set eventDispatcher(value): void

Parameters

Name	Type
value	CEventDispatcher

Returns

void

Inherited from

UIImage.eventDispatcher

Defined in

src/components/ComponentBase.ts:28

---

isStart

• get isStart(): boolean

Returns

boolean

Inherited from

UIImage.isStart

Defined in

src/components/ComponentBase.ts:40

---

transform

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns

Transform

Inherited from

UIImage.transform

Defined in

src/components/ComponentBase.ts:47

---

enable

• get enable(): boolean

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns

boolean

Inherited from

UIImage.enable

Defined in

src/components/ComponentBase.ts:68

• set enable(value): void

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

UIImage.enable

Defined in

src/components/ComponentBase.ts:54

---

uiTransform

• get uiTransform(): UITransform

Returns

UITransform

Inherited from

UIImage.uiTransform

Defined in

src/components/gui/uiComponents/UIComponentBase.ts:16

---

visible

• get visible(): boolean

Returns

boolean

Inherited from

UIImage.visible

Defined in

src/components/gui/uiComponents/UIComponentBase.ts:20

• set visible(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

UIImage.visible

Defined in

src/components/gui/uiComponents/UIComponentBase.ts:24

---

sprite

• get sprite(): GUISprite

Returns

GUISprite

Inherited from

UIImage.sprite

Defined in

src/components/gui/uiComponents/UIImage.ts:54

• set sprite(value): void

Parameters

Name	Type
value	GUISprite

Returns

void

Inherited from

UIImage.sprite

Defined in

src/components/gui/uiComponents/UIImage.ts:34

---

color

• get color(): Color

Returns

Color

Inherited from

UIImage.color

Defined in

src/components/gui/uiComponents/UIImage.ts:74

• set color(value): void

Parameters

Name	Type
value	Color

Returns

void

Inherited from

UIImage.color

Defined in

src/components/gui/uiComponents/UIImage.ts:78

---

imageType

• get imageType(): ImageType

Returns

ImageType

Inherited from

UIImage.imageType

Defined in

src/components/gui/uiComponents/UIImage.ts:85

• set imageType(value): void

Parameters

Name	Type
value	ImageType

Returns

void

Inherited from

UIImage.imageType

Defined in

src/components/gui/uiComponents/UIImage.ts:89

---

quadMaxCount

• get quadMaxCount(): number

Return How many Quads can a single GUIGeometry support at most

Returns

number

Defined in

src/components/gui/uiComponents/UIPanel.ts:92

---

renderer

• get renderer(): GUIRenderer

Returns

GUIRenderer

Defined in

src/components/gui/uiComponents/UIPanel.ts:96

---

billboard

• get billboard(): BillboardType

Returns

BillboardType

Defined in

src/components/gui/uiComponents/UIPanel.ts:114

• set billboard(type): void

Parameters

Name	Type
type	BillboardType

Returns

void

Defined in

src/components/gui/uiComponents/UIPanel.ts:100

---

cullMode

• get cullMode(): GPUCullMode

Returns

GPUCullMode

Defined in

src/components/gui/uiComponents/UIPanel.ts:128

• set cullMode(value): void

Parameters

Name	Type
value	GPUCullMode

Returns

void

Defined in

src/components/gui/uiComponents/UIPanel.ts:118

---

mainQuads

• get mainQuads(): GUIQuad[]

Returns

GUIQuad[]

Inherited from

UIImage.mainQuads

Defined in

src/components/gui/uiComponents/UIRenderAble.ts:44

Methods

stop

▸ stop(): void

Returns

void

Inherited from

UIImage.stop

Defined in

src/components/ComponentBase.ts:114

---

onEnable

▸ onEnable(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIImage.onEnable

Defined in

src/components/ComponentBase.ts:115

---

onDisable

▸ onDisable(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIImage.onDisable

Defined in

src/components/ComponentBase.ts:116

---

onLateUpdate

▸ onLateUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIImage.onLateUpdate

Defined in

src/components/ComponentBase.ts:118

---

onBeforeUpdate

▸ onBeforeUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIImage.onBeforeUpdate

Defined in

src/components/ComponentBase.ts:119

---

onCompute

▸ onCompute(view?, command?): any

Parameters

Name	Type
view?	View3D
command?	GPUCommandEncoder

Returns

any

Inherited from

UIImage.onCompute

Defined in

src/components/ComponentBase.ts:120

---

onGraphic

▸ onGraphic(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIImage.onGraphic

Defined in

src/components/ComponentBase.ts:121

---

onParentChange

▸ onParentChange(lastParent?, currentParent?): any

Parameters

Name	Type
lastParent?	Object3D
currentParent?	Object3D

Returns

any

Inherited from

UIImage.onParentChange

Defined in

src/components/ComponentBase.ts:122

---

onAddChild

▸ onAddChild(child): any

Parameters

Name	Type
child	Object3D

Returns

any

Inherited from

UIImage.onAddChild

Defined in

src/components/ComponentBase.ts:123

---

onRemoveChild

▸ onRemoveChild(child): any

Parameters

Name	Type
child	Object3D

Returns

any

Inherited from

UIImage.onRemoveChild

Defined in

src/components/ComponentBase.ts:124

---

beforeDestroy

▸ beforeDestroy(force?): void

before release this component, object refrences are not be set null now.

Parameters

Name	Type
force?	boolean

Returns

void

Inherited from

UIImage.beforeDestroy

Defined in

src/components/ComponentBase.ts:200

---

cloneTo

▸ cloneTo(obj): void

clone component data to target object3D

Parameters

Name	Type	Description
obj	Object3D	target object3D

Returns

void

Overrides

UIImage.cloneTo

Defined in

src/components/gui/uiComponents/UIPanel.ts:38

---

copyComponent

▸ copyComponent(from): this

Parameters

Name	Type
from	this

Returns

this

Overrides

UIImage.copyComponent

Defined in

src/components/gui/uiComponents/UIPanel.ts:43

---

init

▸ init(param?): void

Parameters

Name	Type
param?	any

Returns

void

Overrides

UIImage.init

Defined in

src/components/gui/uiComponents/UIPanel.ts:57

---

updateDrawCallSegment

▸ updateDrawCallSegment(index, indexStart, indexCount): void

Parameters

Name	Type
index	number
indexStart	number
indexCount	number

Returns

void

Defined in

src/components/gui/uiComponents/UIPanel.ts:64

---

onUpdate

▸ onUpdate(view?): void

Parameters

Name	Type
view?	View3D

Returns

void

Overrides

UIImage.onUpdate

Defined in

src/components/gui/uiComponents/UIPanel.ts:132

---

destroy

▸ destroy(): void

release this component

Returns

void

Inherited from

UIImage.destroy

Defined in

src/components/gui/uiComponents/UIRenderAble.ts:21

---

start

▸ start(): void

Returns

void

Inherited from

UIImage.start

Defined in

src/components/gui/uiComponents/UIRenderAble.ts:30

---

setShadowRenderer

▸ setShadowRenderer(value): void

Parameters

Name	Type
value	UIRenderAble

Returns

void

Inherited from

UIImage.setShadowRenderer

Defined in

src/components/gui/uiComponents/UIRenderAble.ts:48

---

setShadowSource

▸ setShadowSource(value): void

Parameters

Name	Type
value	UIRenderAble

Returns

void

Inherited from

UIImage.setShadowSource

Defined in

src/components/gui/uiComponents/UIRenderAble.ts:52

---

getShadowRender

▸ getShadowRender(): UIRenderAble

Returns

UIRenderAble

Inherited from

UIImage.getShadowRender

Defined in

src/components/gui/uiComponents/UIRenderAble.ts:56