Class Size2

The Size2 implements a 2D size with a width and height. The class follows the 'copy-on-write' pattern, which means that every operation such as Size2.add or Size2.subtract returns a copy of the size2 with updates values. It also implies that the values of the size2 cannot be directly modified.

The concept of immutability improves sharing of objects as all types in TypeScript are assigned by identity, instead of by-value (e.g. a copy) as in other programming languages like C.

Index

Constructors

constructor

new Size2(width?: number, height?: number): Size2
Parameters
- Optionalwidth: number
- Optionalheight: number
Returns Size2

Inherited from Size2Generated.constructor

Properties

`Protected`_height

_height: number

`Protected`_width

_width: number

`Static` `Readonly`zero

zero: Immutable<Size2>

A Size2 with all components set to zero.

Accessors

height

get height(): number

The height.

Returns number

Inherited from Size2Generated.height
set height(value: number): void
Parameters
- value: number
Returns void

Inherited from Size2Generated.height

isZero

get isZero(): boolean

Determines if width and height are zero.

Returns boolean

width

get width(): number

The width.

Returns number

Inherited from Size2Generated.width
set width(value: number): void
Parameters
- value: number
Returns void

Inherited from Size2Generated.width

Methods

add

add(rhs: Immutable<Size2>): Size2
Returns a copy of the current Size2 added by the given one.
Parameters
- rhs: Immutable<Size2>
Returns Size2

assign

assign(other: Immutable<Size2>): Size2
Copies all properties defined by the prototype of Size2 from other to this instance.
Parameters
- other: Immutable<Size2>
Returns Size2

Inherited from Size2Generated.assign

clone

clone(): Size2

Clones this instance and returns a new Size2 with identical values.

Returns Size2

Inherited from Size2Generated.clone

divide

divide(rhs: Immutable<Size2>): Size2
Returns a copy of the current Size2 divided by another Size2.
Parameters
- rhs: Immutable<Size2>
Returns Size2

divideScalar

divideScalar(factor: number): Size2
Returns a copy of the current Size2 divided by a factor.
Parameters
- factor: number
Returns Size2

doAdd

doAdd(rhs: Immutable<Size2>): Size2
Adds another Size2 to this one and returns it.
Parameters
- rhs: Immutable<Size2>
Returns Size2

doClear

doClear(): Size2

Sets width and height to zero.

Returns Size2

doDivide

doDivide(rhs: Immutable<Size2>): Size2
Divides this Size2 by another Size2.
Parameters
- rhs: Immutable<Size2>
Returns Size2

doDivideScalar

doDivideScalar(factor: number): Size2
Divides this Size2 by a factor.
Parameters
- factor: number
Returns Size2

doMultiply

doMultiply(rhs: Immutable<Size2>): Size2
Performs component-wise multiplication with another Size2.
Parameters
- rhs: Immutable<Size2>
Returns Size2

doMultiplyScalar

doMultiplyScalar(factor: number): Size2
Multiplies the width and height with the given factor.
Parameters
- factor: number
Returns Size2

doSet

doSet(width: number, height: number): Size2
Sets the values.
Parameters
- width: number
- height: number
Returns Size2

doSubtract

doSubtract(rhs: Immutable<Size2>): Size2
Subtracts another Size2 from this one and returns it.
Parameters
- rhs: Immutable<Size2>
Returns Size2

isAlmostEqual

isAlmostEqual(rhs: Immutable<Size2>, epsilon?: number): boolean
Returns whether the provided Size2, given a error margin, has the same width and height values as this one.
Parameters
- rhs: Immutable<Size2>
  The other Size2 to compare with.
- Optionalepsilon: number
  Optional. Error margin within which the numbers should be considered equal.
Returns boolean
True if equal, false otherwise.

isEqual

isEqual(rhs: Immutable<Size2>): boolean
Returns whether the given Size2 contains the same width and height as this one.
Parameters
- rhs: Immutable<Size2>
Returns boolean

Overrides Size2Generated.isEqual

multiply

multiply(rhs: Immutable<Size2>): Size2
Returns a copy of the current Size2 multiplied by the given Size2.
Parameters
- rhs: Immutable<Size2>
Returns Size2

multiplyScalar

multiplyScalar(factor: number): Size2
Returns a copy of this Size2 multiplied by the factor.
Parameters
- factor: number
Returns Size2

subtract

subtract(rhs: Immutable<Size2>): Size2
Returns a copy of the current width and height subtracted by the given Size2.
Parameters
- rhs: Immutable<Size2>
Returns Size2

toString

toString(): string

Returns a string representation of an object.

Returns string

withWidthAndHeight

withWidthAndHeight(width: number, height: number): Size2
Creates a new Size2 with the given width and height.
Parameters
- width: number
- height: number
Returns Size2

`Static`add

add(lhs: Immutable<Size2>, rhs: Immutable<Size2>): Size2
Adds two Size2 together.
Parameters
- lhs: Immutable<Size2>
- rhs: Immutable<Size2>
Returns Size2

`Static`divide

divide(lhs: Immutable<Size2>, rhs: Immutable<Size2>): Size2
Divides the first Size2 by the second.
Parameters
- lhs: Immutable<Size2>
- rhs: Immutable<Size2>
Returns Size2

`Static`divideScalar

divideScalar(lhs: Immutable<Size2>, factor: number): Size2
Divides the given Size2 by a factor.
Parameters
- lhs: Immutable<Size2>
- factor: number
Returns Size2

`Static`isAlmostEqual

isAlmostEqual(
    lhs: Immutable<Size2>,
    rhs: Immutable<Size2>,
    epsilon?: number,
): boolean
Compares two Size2 with an error margin.
Parameters
- lhs: Immutable<Size2>
  First size2 to compare.
- rhs: Immutable<Size2>
  Second size2 to compare.
- Optionalepsilon: number
  Optional. Error margin within which the numbers should be considered equal.
Returns boolean
True if equal, false otherwise.

`Static`isEqual

isEqual(lhs: Immutable<Size2>, rhs: Immutable<Size2>): boolean
Returns whether width and height from both sizes contains the same values.
Parameters
- lhs: Immutable<Size2>
- rhs: Immutable<Size2>
Returns boolean

Overrides Size2Generated.isEqual

`Static`max

max(lhs: Immutable<Size2>, rhs: Immutable<Size2>): Size2
Returns a new Size2 with the maximum width and maximum height from both Size2.
Parameters
- lhs: Immutable<Size2>
  First Size2.
- rhs: Immutable<Size2>
  Second Size2.
Returns Size2
Size2 with the maximum width and maximum height from both Size2.

`Static`min

min(lhs: Immutable<Size2>, rhs: Immutable<Size2>): Size2
Returns a new Size2 with the minimum width and minimum height from both Size2.
Parameters
- lhs: Immutable<Size2>
  First Size2.
- rhs: Immutable<Size2>
  Second Size2.
Returns Size2
Size2 with the minimum width and minimum height from both Size2.

`Static`multiply

multiply(lhs: Immutable<Size2>, rhs: Immutable<Size2>): Size2
Multiplies both Size2.
Parameters
- lhs: Immutable<Size2>
- rhs: Immutable<Size2>
Returns Size2

`Static`multiplyScalar

multiplyScalar(lhs: Immutable<Size2>, factor: number): Size2
Multiply the Size2 by the scalar.
Parameters
- lhs: Immutable<Size2>
- factor: number
Returns Size2

`Static`subtract

subtract(lhs: Immutable<Size2>, rhs: Immutable<Size2>): Size2
Subtract both Size2.
Parameters
- lhs: Immutable<Size2>
- rhs: Immutable<Size2>
Returns Size2

Class Size2

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Size2

Properties

Protected_height

Protected_width

Static Readonlyzero

Accessors

height

Returns number

Parameters

Returns void

isZero

Returns boolean

width

Returns number

Parameters

Returns void

Methods

add

Parameters

Returns Size2

assign

Parameters

Returns Size2

clone

Returns Size2

divide

Parameters

Returns Size2

divideScalar

Parameters

Returns Size2

doAdd

Parameters

Returns Size2

doClear

Returns Size2

doDivide

Parameters

Returns Size2

doDivideScalar

Parameters

Returns Size2

doMultiply

Parameters

Returns Size2

doMultiplyScalar

Parameters

Returns Size2

doSet

Parameters

Returns Size2

doSubtract

Parameters

Returns Size2

isAlmostEqual

Parameters

Returns boolean

isEqual

Parameters

Returns boolean

multiply

Parameters

Returns Size2

multiplyScalar

Parameters

Returns Size2

subtract

Parameters

Returns Size2

toString

Returns string

`Protected`_height

`Protected`_width

`Static` `Readonly`zero

`Static`add

`Static`divide

`Static`divideScalar

`Static`isAlmostEqual

`Static`isEqual

`Static`max

`Static`min

`Static`multiply

`Static`multiplyScalar

`Static`subtract