Class: UITextField ​

The textField component for gui

Hierarchy ​

• UIRenderAble

  ↳ UITextField

Constructors ​

• constructor

Properties ​

• object3D
• isDestroyed
• isUIShadow
• isShadowless
• needUpdateShadow

Accessors ​

• eventDispatcher
• isStart
• transform
• enable
• uiTransform
• visible
• mainQuads
• originSize
• font
• fontSize
• text
• color
• alignment
• lineSpacing

Methods ​

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

Constructors ​

constructor ​

• new UITextField()

Overrides ​

UIRenderAble.constructor

Defined in ​

src/components/gui/uiComponents/UITextField.ts:19

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 ​

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 ​

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 ​

Returns ​

void

Inherited from ​

UIRenderAble.visible

Defined in ​

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

mainQuads ​

• get mainQuads(): GUIQuad[]

Returns ​

GUIQuad[]

Inherited from ​

UIRenderAble.mainQuads

Defined in ​

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

originSize ​

• get originSize(): number

Returns ​

number

Defined in ​

src/components/gui/uiComponents/UITextField.ts:40

font ​

• get font(): string

Returns ​

string

Defined in ​

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

• set font(value): void

Parameters ​

Returns ​

void

Defined in ​

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

fontSize ​

• get fontSize(): number

Returns ​

number

Defined in ​

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

• set fontSize(value): void

Parameters ​

Returns ​

void

Defined in ​

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

text ​

• get text(): string

Returns ​

string

Defined in ​

src/components/gui/uiComponents/UITextField.ts:63

• set text(value): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/uiComponents/UITextField.ts:67

color ​

• get color(): Color

Returns ​

Color

Defined in ​

src/components/gui/uiComponents/UITextField.ts:117

• set color(value): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/uiComponents/UITextField.ts:121

alignment ​

• get alignment(): TextAnchor

Returns ​

TextAnchor

Defined in ​

src/components/gui/uiComponents/UITextField.ts:129

• set alignment(value): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/uiComponents/UITextField.ts:133

lineSpacing ​

• get lineSpacing(): number

Returns ​

number

Defined in ​

src/components/gui/uiComponents/UITextField.ts:140

• set lineSpacing(value): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/uiComponents/UITextField.ts:144

Methods ​

stop ​

▸ stop(): void

Returns ​

void

Inherited from ​

UIRenderAble.stop

Defined in ​

src/components/ComponentBase.ts:114

onEnable ​

▸ Optional onEnable(view?): any

Parameters ​

Returns ​

any

Inherited from ​

UIRenderAble.onEnable

Defined in ​

src/components/ComponentBase.ts:115

onDisable ​

▸ Optional onDisable(view?): any

Parameters ​

Returns ​

any

Inherited from ​

UIRenderAble.onDisable

Defined in ​

src/components/ComponentBase.ts:116

onUpdate ​

▸ Optional onUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

UIRenderAble.onUpdate

Defined in ​

src/components/ComponentBase.ts:117

onLateUpdate ​

▸ Optional onLateUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

UIRenderAble.onLateUpdate

Defined in ​

src/components/ComponentBase.ts:118

onBeforeUpdate ​

▸ Optional onBeforeUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

UIRenderAble.onBeforeUpdate

Defined in ​

src/components/ComponentBase.ts:119

onCompute ​

▸ Optional onCompute(view?, command?): any

Parameters ​

Returns ​

any

Inherited from ​

UIRenderAble.onCompute

Defined in ​

src/components/ComponentBase.ts:120

onGraphic ​

▸ Optional onGraphic(view?): any

Parameters ​

Returns ​

any

Inherited from ​

UIRenderAble.onGraphic

Defined in ​

src/components/ComponentBase.ts:121

onParentChange ​

▸ Optional onParentChange(lastParent?, currentParent?): any

Parameters ​

Returns ​

any

Inherited from ​

UIRenderAble.onParentChange

Defined in ​

src/components/ComponentBase.ts:122

beforeDestroy ​

▸ beforeDestroy(force?): void

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

Parameters ​

Returns ​

void

Inherited from ​

UIRenderAble.beforeDestroy

Defined in ​

src/components/ComponentBase.ts:198

init ​

▸ init(param?): void

Parameters ​

Returns ​

void

Inherited from ​

UIRenderAble.init

Defined in ​

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

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 ​

Returns ​

void

Inherited from ​

UIRenderAble.setShadowRenderer

Defined in ​

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

setShadowSource ​

▸ setShadowSource(value): void

Parameters ​

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

cloneTo ​

▸ cloneTo(obj): void

clone component data to target object3D

Parameters ​

Returns ​

void

Overrides ​

UIRenderAble.cloneTo

Defined in ​

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

copyComponent ​

▸ copyComponent(from): UITextField

Parameters ​

Returns ​

UITextField

Overrides ​

UIRenderAble.copyComponent

Defined in ​

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