Class Size

Two dimensional size type representing the width and height.

Hierarchy

ValueType
- Size

Index

Constructors

constructor

Properties

Accessors

x
y

Methods

Constructors

constructor

newSize(other: Size): Size
newSize(width?: undefined | number, height?: undefined | number): Size

- Defined in cocos/core/math/size.ts:69
en

Constructor a size from another one.

zh

构造与指定尺寸相等的尺寸。

Parameters
- other: Size
  
  Specified Size.
Returns Size
- Defined in cocos/core/math/size.ts:76
en

Constructor a size with specified values.

zh

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

Parameters
- Optional width: undefined | number
  
  width of the Size, default value is 0.
- Optional height: undefined | number
  
  height of the Size, default value is 0.
Returns Size

Properties

height

height: number

width

width: number

Static ONE

ONE: Readonly<Size> = Object.freeze(new Size(1, 1))

Static ZERO

ZERO: Readonly<Size> = Object.freeze(new Size(0, 0))

Accessors

x

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

- Defined in cocos/core/math/size.ts:63
Returns number
- Defined in cocos/core/math/size.ts:62
Parameters
- val: number
Returns void

y

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

- Defined in cocos/core/math/size.ts:65
Returns number
- Defined in cocos/core/math/size.ts:64
Parameters
- val: number
Returns void

Methods

clone

clone(): Size

Overrides ValueType.clone
- Defined in cocos/core/math/size.ts:101
clone the current Size.

Returns Size

equals

equals(other: Size): boolean

Overrides ValueType.equals
- Defined in cocos/core/math/size.ts:139
Check whether the current Size equals another one.

Parameters
- other: Size
  
  Specified Size
Returns boolean

Returns true' when both dimensions are equal in width and height; otherwise returns false'.

lerp

lerp(to: Size, ratio: number): this

- Defined in cocos/core/math/size.ts:150
Calculate the interpolation result between this size and another one with given ratio

Parameters
- to: Size
  
  Target Size.
- ratio: number
  
  The interpolation coefficient.The range is [0,1].
Returns this

set

set(other: Size): any
set(width?: undefined | number, height?: undefined | number): any

Overrides ValueType.set
- Defined in cocos/core/math/size.ts:111
Set values with another Size.

Parameters
- other: Size
  
  Specified Size.
Returns any

this
Overrides ValueType.set
- Defined in cocos/core/math/size.ts:120
Set the value of each component of the current Size.

Parameters
- Optional width: undefined | number
  
  Specified width
- Optional height: undefined | number
  
  Specified height
Returns any

this

toString

toString(): string

Overrides ValueType.toString
- Defined in cocos/core/math/size.ts:161
Return the information of the current size in string

Returns string

The information of the current size in string

Static lerp

lerp<Out>(out: Out, from: Out, to: Out, ratio: number): Out

- Defined in cocos/core/math/size.ts:55
Calculate the interpolation result between this size and another one with given ratio

Type parameters
- Out: ISizeLike
Parameters
- out: Out
  
  Output Size.
- from: Out
  
  Original Size.
- to: Out
  
  Target Size.
- ratio: number
  
  The interpolation coefficient.The range is [0,1].
Returns Out

A vector consisting of linear interpolation of the width and height of the current size to the width and height of the target size at a specified interpolation ratio, respectively.

Generated using TypeDoc