Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UIGraphic

Hierarchy

  • Renderable2D
    • UIGraphic

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    Returns UIGraphic

Properties

Readonly entity

entity: Entity2D

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

Static BlendMode

BlendMode: Readonly<typeof BlendMode> = ...

二维渲染叠加混合方式

static
memberof

Renderable2D

Static BlendType

BlendType: Readonly<typeof BlendType> = ...

继承混合颜色的方式

static
memberof

Renderable2D

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

Static Shape

Shape: typeof Shape = ...

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

alpha

  • get alpha(): number
  • set alpha(val: number): void

  • Returns number

  • Parameters

    • val: number

    Returns void

angle

  • get angle(): number
  • set angle(val: number): void

  • 圆的角度，仅Circle模式下有效

    memberof

    UIGraphic

    Returns number

  • 圆的角度，仅Circle模式下有效

    Parameters

    • val: number

    Returns void

blendMode

  • get blendMode(): BlendMode
  • set blendMode(val: BlendMode): void

  • 当前渲染元素的混合方式

    Returns BlendMode

  • 当前渲染元素的混合方式

    overload
    memberof

    Renderable2D

    Parameters

    • val: BlendMode

    Returns void

color

  • 渲染组件本身的颜色，用于与渲染元素进行颜色混合

    Returns Color

  • 渲染组件本身的颜色，用于与渲染元素进行颜色混合

    memberof

    Renderable2D

    Parameters

    Returns void

colorBlendType

  • 渲染组件继承父渲染组件颜色，颜色混合的方式

    Returns BlendType

  • 渲染组件继承父渲染组件颜色，颜色混合的方式

    overload
    memberof

    Renderable2D

    Parameters

    Returns void

cullingMask

  • get cullingMask(): number
  • set cullingMask(val: number): void

  • Returns number

  • deprecated

    Parameters

    • val: number

    Returns void

isMask

  • get isMask(): boolean

  • Returns boolean

material

  • 当前渲染元素的混合方式

    Returns Material

  • 当前渲染元素的混合方式

    overload
    memberof

    Renderable2D

    Parameters

    Returns void

radius

  • get radius(): number
  • set radius(val: number): void

  • 半径，仅Circle模式下有效

    memberof

    UIGraphic

    Returns number

  • 半径，仅Circle模式下有效

    Parameters

    • val: number

    Returns void

section

  • get section(): number
  • set section(val: number): void

  • 圆的分段数，仅Circle模式下有效

    memberof

    UIGraphic

    Returns number

  • 圆的分段数，仅Circle模式下有效

    Parameters

    • val: number

    Returns void

shape

  • get shape(): Shape
  • set shape(val: Shape): void

  • UIGraphic的图像类型

    memberof

    UIGraphic

    Returns Shape

  • UIGraphic的图像类型

    Parameters

    • val: Shape

    Returns void

visible

  • get visible(): boolean
  • set visible(val: boolean): void

  • 渲染组件是否具体渲染

    Returns boolean

  • 渲染组件是否具体渲染

    overload
    memberof

    Renderable2D

    Parameters

    • val: boolean

    Returns void

zOrder

  • get zOrder(): number
  • set zOrder(val: number): void

  • 渲染组件在同级的渲染顺序

    Returns number

  • 渲染组件在同级的渲染顺序

    overload
    memberof

    Renderable2D

    Parameters

    • val: number

    Returns void

Methods

destroy

  • destroy(): void

  • Returns void

getMaterialAtIndex

  • getMaterialAtIndex(index?: number): FakeMaterial

  • Parameters

    • index: number = 0

    Returns FakeMaterial

getMaterialCount

  • getMaterialCount(): number

  • Returns number

getTypeName

  • getTypeName(): string

  • Returns string

isDetached

  • isDetached(): boolean

  • Returns boolean

resetProperties

  • resetProperties(): void

  • Returns void

setMaterialDirty

  • setMaterialDirty(): void

  • 对外暴露的，将渲染元素对应RenderDraw的材质信息置脏

    Returns void

setVertexDirty

  • setVertexDirty(): void

  • 对外暴露的，将渲染元素对应RenderDraw的顶点数据置脏逻辑

    Returns void

Generated using TypeDoc