Class: UIImage

A GUI component to display image/sprite/video

Hierarchy

• UIRenderAble

  ↳ UIImage

  ↳↳ UIPanel

Constructors

• constructor

Properties

• object3D
• isDestroyed
• isUIShadow
• isShadowless
• needUpdateShadow

Accessors

• eventDispatcher
• isStart
• transform
• enable
• uiTransform
• visible
• sprite
• color
• imageType
• mainQuads

Methods

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

Constructors

constructor

• new UIImage(): UIImage

Returns

UIImage

Inherited from

UIRenderAble.constructor

Properties

object3D

• object3D: Object3D = null

owner object3D

Inherited from

UIRenderAble.object3D

Defined in

src/components/ComponentBase.ts:17

---

isDestroyed

• Optional isDestroyed: boolean

Inherited from

UIRenderAble.isDestroyed

Defined in

src/components/ComponentBase.ts:38

---

isUIShadow

• Optional isUIShadow: boolean

Inherited from

UIRenderAble.isUIShadow

Defined in

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

---

isShadowless

• Optional isShadowless: boolean

Inherited from

UIRenderAble.isShadowless

Defined in

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

---

needUpdateShadow

• needUpdateShadow: boolean

Inherited from

UIRenderAble.needUpdateShadow

Defined in

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

Accessors

eventDispatcher

• get eventDispatcher(): CEventDispatcher

Returns

CEventDispatcher

Inherited from

UIRenderAble.eventDispatcher

Defined in

src/components/ComponentBase.ts:23

• set eventDispatcher(value): void

Parameters

Name	Type
value	CEventDispatcher

Returns

void

Inherited from

UIRenderAble.eventDispatcher

Defined in

src/components/ComponentBase.ts:28

---

isStart

• get isStart(): boolean

Returns

boolean

Inherited from

UIRenderAble.isStart

Defined in

src/components/ComponentBase.ts:40

---

transform

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns

Transform

Inherited from

UIRenderAble.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

UIRenderAble.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

UIRenderAble.enable

Defined in

src/components/ComponentBase.ts:54

---

uiTransform

• get uiTransform(): UITransform

Returns

UITransform

Inherited from

UIRenderAble.uiTransform

Defined in

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

---

visible

• get visible(): boolean

Returns

boolean

Inherited from

UIRenderAble.visible

Defined in

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

• set visible(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

UIRenderAble.visible

Defined in

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

---

sprite

• get sprite(): GUISprite

Returns

GUISprite

Defined in

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

• set sprite(value): void

Parameters

Name	Type
value	GUISprite

Returns

void

Defined in

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

---

color

• get color(): Color

Returns

Color

Defined in

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

• set color(value): void

Parameters

Name	Type
value	Color

Returns

void

Defined in

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

---

imageType

• get imageType(): ImageType

Returns

ImageType

Defined in

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

• set imageType(value): void

Parameters

Name	Type
value	ImageType

Returns

void

Defined in

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

---

mainQuads

• get mainQuads(): GUIQuad[]

Returns

GUIQuad[]

Inherited from

UIRenderAble.mainQuads

Defined in

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

Methods

stop

▸ stop(): void

Returns

void

Inherited from

UIRenderAble.stop

Defined in

src/components/ComponentBase.ts:114

---

onEnable

▸ onEnable(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIRenderAble.onEnable

Defined in

src/components/ComponentBase.ts:115

---

onDisable

▸ onDisable(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIRenderAble.onDisable

Defined in

src/components/ComponentBase.ts:116

---

onUpdate

▸ onUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIRenderAble.onUpdate

Defined in

src/components/ComponentBase.ts:117

---

onLateUpdate

▸ onLateUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIRenderAble.onLateUpdate

Defined in

src/components/ComponentBase.ts:118

---

onBeforeUpdate

▸ onBeforeUpdate(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIRenderAble.onBeforeUpdate

Defined in

src/components/ComponentBase.ts:119

---

onCompute

▸ onCompute(view?, command?): any

Parameters

Name	Type
view?	View3D
command?	GPUCommandEncoder

Returns

any

Inherited from

UIRenderAble.onCompute

Defined in

src/components/ComponentBase.ts:120

---

onGraphic

▸ onGraphic(view?): any

Parameters

Name	Type
view?	View3D

Returns

any

Inherited from

UIRenderAble.onGraphic

Defined in

src/components/ComponentBase.ts:121

---

onParentChange

▸ onParentChange(lastParent?, currentParent?): any

Parameters

Name	Type
lastParent?	Object3D
currentParent?	Object3D

Returns

any

Inherited from

UIRenderAble.onParentChange

Defined in

src/components/ComponentBase.ts:122

---

onAddChild

▸ onAddChild(child): any

Parameters

Name	Type
child	Object3D

Returns

any

Inherited from

UIRenderAble.onAddChild

Defined in

src/components/ComponentBase.ts:123

---

onRemoveChild

▸ onRemoveChild(child): any

Parameters

Name	Type
child	Object3D

Returns

any

Inherited from

UIRenderAble.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

UIRenderAble.beforeDestroy

Defined in

src/components/ComponentBase.ts:200

---

init

▸ init(param?): void

Parameters

Name	Type
param?	any

Returns

void

Overrides

UIRenderAble.init

Defined in

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

---

cloneTo

▸ cloneTo(obj): void

clone component data to target object3D

Parameters

Name	Type	Description
obj	Object3D	target object3D

Returns

void

Overrides

UIRenderAble.cloneTo

Defined in

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

---

copyComponent

▸ copyComponent(from): this

Parameters

Name	Type
from	this

Returns

this

Overrides

UIRenderAble.copyComponent

Defined in

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

---

destroy

▸ destroy(): void

release this component

Returns

void

Inherited from

UIRenderAble.destroy

Defined in

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

---

start

▸ start(): void

Returns

void

Inherited from

UIRenderAble.start

Defined in

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

---

setShadowRenderer

▸ setShadowRenderer(value): void

Parameters

Name	Type
value	UIRenderAble

Returns

void

Inherited from

UIRenderAble.setShadowRenderer

Defined in

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

---

setShadowSource

▸ setShadowSource(value): void

Parameters

Name	Type
value	UIRenderAble

Returns

void

Inherited from

UIRenderAble.setShadowSource

Defined in

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

---

getShadowRender

▸ getShadowRender(): UIRenderAble

Returns

UIRenderAble

Inherited from

UIRenderAble.getShadowRender

Defined in

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