Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Size

二维尺寸。

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • newSize(other: Size): Size
  • newSize(width?: undefined | number, height?: undefined | number): Size
  • 构造与指定尺寸相等的尺寸。

    Parameters

    • other: Size

      相比较的尺寸。

    Returns Size

  • 构造具有指定宽度和高度的尺寸。

    Parameters

    • Optional width: undefined | number
    • Optional height: undefined | number

    Returns Size

Properties

height

height: number

高度。

width

width: number

宽度。

Accessors

x

  • get x(): number
  • set x(val: number): void
  • Returns number

  • Parameters

    • val: number

    Returns void

y

  • get y(): number
  • set y(val: number): void
  • Returns number

  • Parameters

    • val: number

    Returns void

Static ZERO

  • 创建宽和高都为 0 的尺寸并返回。

    Returns Size

Methods

clone

  • 克隆当前尺寸。

    Returns Size

equals

  • equals(other: Size): boolean
  • 判断当前尺寸是否与指定尺寸的相等。

    Parameters

    • other: Size

      相比较的尺寸。

    Returns boolean

    两尺寸的宽和高都分别相等时返回 true;否则返回 false

lerp

  • lerp(to: Size, ratio: number): this
  • 根据指定的插值比率,从当前尺寸到目标尺寸之间做插值。

    Parameters

    • to: Size

      目标尺寸。

    • ratio: number

      插值比率,范围为 [0,1]。

    Returns this

set

  • set(other: Size): any
  • set(width?: undefined | number, height?: undefined | number): any
  • 设置当前尺寸的具体参数。

    Parameters

    • other: Size

      相比较的尺寸。

    Returns any

    this

  • 设置当前尺寸的具体参数。

    Parameters

    • Optional width: undefined | number

      要设置的 width 值

    • Optional height: undefined | number

      要设置的 height 值

    Returns any

    this

toString

  • toString(): string
  • 返回当前尺寸的字符串表示。

    Returns string

    当前尺寸的字符串表示。

Static lerp

  • lerp<Out>(out: Out, from: Out, to: Out, ratio: number): Out
  • 根据指定的插值比率,从当前尺寸到目标尺寸之间做插值。

    Type parameters

    Parameters

    • out: Out

      本方法将插值结果赋值给此参数

    • from: Out

      起始尺寸。

    • to: Out

      目标尺寸。

    • ratio: number

      插值比率,范围为 [0,1]。

    Returns Out

    当前尺寸的宽和高到目标尺寸的宽和高分别按指定插值比率进行线性插值构成的向量。

Generated using TypeDoc