Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UIWidget

Hierarchy

Index

Constructors

constructor

  • new UIWidget(entity: Entity2D): UIWidget

Properties

Readonly entity

entity: Entity2D

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

Static Execute

Execute: Readonly<typeof Execute> = ...

更新运算的时机的枚举值,对应不同的组件生命周期。

static
memberof

UIWidget

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

  • Align: number
  • Layout: number
  • Low: number
  • Physics: number
  • Render: number
  • Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

    • (...args: any[]): any
    • Parameters

      • Rest ...args: any[]

      Returns any

Accessors

active

  • get active(): boolean
  • set active(value: boolean): void
  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

activeInHierarchy

  • get activeInHierarchy(): boolean
  • 在场景树中是否active

    readonly
    memberof

    Component

    Returns boolean

bottomAnchor

  • get bottomAnchor(): number
  • set bottomAnchor(val: number): void
  • 默认值为undefined,下目标内容包围盒的锚点,作为下方向对齐起点位置(取值范围(0-1))

    memberof

    UIWidget

    Returns number

  • 默认值为undefined,下目标内容包围盒的锚点,作为下方向对齐起点位置(取值范围(0-1))

    Parameters

    • val: number

    Returns void

bottomAnchorTarget

  • Transform2D类型,默认值为undefined,下方向对齐目标。

    memberof

    UIWidget

    Returns Transform2D

  • Transform2D类型,默认值为undefined,下方向对齐目标。

    Parameters

    Returns void

bottomOffset

  • get bottomOffset(): number
  • set bottomOffset(val: number): void
  • 默认值为0,根据下方向目标Anchor对齐运算后,再叠加的偏移量

    memberof

    UIWidget

    Returns number

  • 默认值为0,根据下方向目标Anchor对齐运算后,再叠加的偏移量

    Parameters

    • val: number

    Returns void

execute

  • get execute(): Execute
  • set execute(val: Execute): void
  • Execute类型,组件属性或目标关联属性发生变化后,具体进行更新运算的时机。

    memberof

    UIWidget

    Returns Execute

  • Execute类型,组件属性或目标关联属性发生变化后,具体进行更新运算的时机。

    Parameters

    • val: Execute

    Returns void

leftAnchor

  • get leftAnchor(): number
  • set leftAnchor(val: number): void
  • 默认值为undefined,左目标内容包围盒的锚点,作为左方向对齐起点位置(取值范围(0-1))

    memberof

    UIWidget

    Returns number

  • 默认值为undefined,左目标内容包围盒的锚点,作为左方向对齐起点位置(取值范围(0-1))

    Parameters

    • val: number

    Returns void

leftAnchorTarget

  • Transform2D类型,默认值为undefined,左方向对齐目标。

    memberof

    UIWidget

    Returns Transform2D

  • Transform2D类型,默认值为undefined,左方向对齐目标。

    Parameters

    Returns void

leftOffset

  • get leftOffset(): number
  • set leftOffset(val: number): void
  • 默认值为0,根据左方向目标Anchor对齐运算后,再叠加的偏移量

    memberof

    UIWidget

    Returns number

  • 默认值为0,根据左方向目标Anchor对齐运算后,再叠加的偏移量

    Parameters

    • val: number

    Returns void

rightAnchor

  • get rightAnchor(): number
  • set rightAnchor(val: number): void
  • 默认值为undefined,右目标内容包围盒的锚点,作为右方向对齐起点位置(取值范围(0-1))

    memberof

    UIWidget

    Returns number

  • 默认值为undefined,右目标内容包围盒的锚点,作为右方向对齐起点位置(取值范围(0-1))

    Parameters

    • val: number

    Returns void

rightAnchorTarget

  • Transform2D类型,默认值为undefined,右方向对齐目标。

    memberof

    UIWidget

    Returns Transform2D

  • Transform2D类型,默认值为undefined,右方向对齐目标。

    Parameters

    Returns void

rightOffset

  • get rightOffset(): number
  • set rightOffset(val: number): void
  • 默认值为0,根据右方向目标Anchor对齐运算后,再叠加的偏移量

    memberof

    UIWidget

    Returns number

  • 默认值为0,根据右方向目标Anchor对齐运算后,再叠加的偏移量

    Parameters

    • val: number

    Returns void

topAnchor

  • get topAnchor(): number
  • set topAnchor(val: number): void
  • 默认值为undefined,上目标内容包围盒的锚点,作为上方向对齐起点位置(取值范围(0-1))

    memberof

    UIWidget

    Returns number

  • 默认值为undefined,上目标内容包围盒的锚点,作为上方向对齐起点位置(取值范围(0-1))

    Parameters

    • val: number

    Returns void

topAnchorTarget

  • Transform2D类型,默认值为undefined,上方向对齐目标。

    memberof

    UIWidget

    Returns Transform2D

  • Transform2D类型,默认值为undefined,上方向对齐目标。

    Parameters

    Returns void

topOffset

  • get topOffset(): number
  • set topOffset(val: number): void
  • 默认值为0,根据上方向目标Anchor对齐运算后,再叠加的偏移量

    memberof

    UIWidget

    Returns number

  • 默认值为0,根据上方向目标Anchor对齐运算后,再叠加的偏移量

    Parameters

    • val: number

    Returns void

Methods

destroy

  • destroy(): void
  • Returns void

getTypeName

  • getTypeName(): string

isDetached

  • isDetached(): boolean
  • Returns boolean

resetProperties

  • resetProperties(): void

Generated using TypeDoc