Skip to content
本页内容

Class: UIButton

组件用于在实体对象上附加功能。组件可以在每个帧接收更新事件。

Hierarchy

Properties

Accessors

Methods

Constructors

Properties

object3D

object3D: Object3D = null

此组件附加到的Object3D对象。

Inherited from

UIInteractive.object3D

Defined in

src/engine/components/ComponentBase.ts:14


serializeTag

Optional serializeTag: SerializeTag

Inherited from

UIInteractive.serializeTag

Defined in

src/engine/components/ComponentBase.ts:30

Accessors

transform

get transform(): Transform

附加到此 Object3D对象 的 Transform组件。

Returns

Transform

Inherited from

UIInteractive.transform

Defined in

src/engine/components/ComponentBase.ts:39


enable

get enable(): boolean

启用/禁用 组件。启用的组件可更新,禁用的组件不可更新。

Returns

boolean

Inherited from

UIInteractive.enable

Defined in

src/engine/components/ComponentBase.ts:62

set enable(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

UIInteractive.enable

Defined in

src/engine/components/ComponentBase.ts:43


mouseStyle

set mouseStyle(value): void

Parameters

NameType
valueUIInteractiveStyle

Returns

void

Overrides

UIInteractive.mouseStyle

Defined in

src/engine/gui/components/UIButton.ts:27


upTexture

get upTexture(): GUISubTexture

Returns

GUISubTexture

Defined in

src/engine/gui/components/UIButton.ts:32

set upTexture(value): void

Parameters

NameType
valueGUISubTexture

Returns

void

Defined in

src/engine/gui/components/UIButton.ts:36


overTexture

get overTexture(): GUISubTexture

Returns

GUISubTexture

Defined in

src/engine/gui/components/UIButton.ts:43

set overTexture(value): void

Parameters

NameType
valueGUISubTexture

Returns

void

Defined in

src/engine/gui/components/UIButton.ts:47


downTexture

get downTexture(): GUISubTexture

Returns

GUISubTexture

Defined in

src/engine/gui/components/UIButton.ts:61

set downTexture(value): void

Parameters

NameType
valueGUISubTexture

Returns

void

Defined in

src/engine/gui/components/UIButton.ts:54


disableTexture

get disableTexture(): GUISubTexture

Returns

GUISubTexture

Defined in

src/engine/gui/components/UIButton.ts:72

set disableTexture(value): void

Parameters

NameType
valueGUISubTexture

Returns

void

Defined in

src/engine/gui/components/UIButton.ts:65


uiTransform

get uiTransform(): UITransform

Returns

UITransform

Inherited from

UIInteractive.uiTransform

Defined in

src/engine/gui/components/UIComponentBase.ts:6


interactive

get interactive(): boolean

Returns

boolean

Inherited from

UIInteractive.interactive

Defined in

src/engine/gui/components/UIInteractive.ts:14

set interactive(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

UIInteractive.interactive

Defined in

src/engine/gui/components/UIInteractive.ts:10

Methods

onVisible

onVisible(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

UIInteractive.onVisible

Defined in

src/engine/components/ComponentBase.ts:66


onUpdate

onUpdate(call): void

添加更新函数。会在每帧更新时执行。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

UIInteractive.onUpdate

Defined in

src/engine/components/ComponentBase.ts:135


onLateUpdate

onLateUpdate(call): void

添加延迟更新函数。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

UIInteractive.onLateUpdate

Defined in

src/engine/components/ComponentBase.ts:148


onBeforeUpdate

onBeforeUpdate(call): void

添加帧更新前执行的函数。

Parameters

NameTypeDescription
callFunction回调函数

Returns

void

Inherited from

UIInteractive.onBeforeUpdate

Defined in

src/engine/components/ComponentBase.ts:161


serialization

serialization(assets): SerializeComponentBase

Parameters

NameType
assetsISerializeAssetsCollect

Returns

SerializeComponentBase

Inherited from

UIInteractive.serialization

Defined in

src/engine/components/ComponentBase.ts:170


unSerialization

unSerialization(componentData, data): void

Parameters

NameType
componentDataSerializeComponentBase
dataUnSerializeData

Returns

void

Inherited from

UIInteractive.unSerialization

Defined in

src/engine/components/ComponentBase.ts:175


cloneTo

cloneTo(obj): void

创建新的组件,复制当前组件的属性,并添加到目标对象上。

Parameters

NameTypeDescription
objObject3D源对象

Returns

void

Overrides

UIInteractive.cloneTo

Defined in

src/engine/gui/components/UIButton.ts:87


addQuad

addQuad(quad): void

Parameters

NameType
quadGUIQuad

Returns

void

Inherited from

UIInteractive.addQuad

Defined in

src/engine/gui/components/UIComponentBase.ts:28


clean

clean(): void

Returns

void

Inherited from

UIInteractive.clean

Defined in

src/engine/gui/components/UIComponentBase.ts:32


destroy

destroy(): void

移除组件时候调用

Returns

void

Inherited from

UIInteractive.destroy

Defined in

src/engine/gui/components/UIInteractive.ts:27


rayPick

rayPick(ray, screenPos, screenSize): Object

Parameters

NameType
rayRay
screenPosVector2
screenSizeVector2

Returns

Object

NameType
intersectboolean
intersectPoint?Vector3
distancenumber

Inherited from

UIInteractive.rayPick

Defined in

src/engine/gui/components/UIInteractive.ts:32

Constructors

constructor

new UIButton()

Inherited from

UIInteractive.constructor

Defined in

src/engine/gui/components/UIComponentBase.ts:10