Class Size

isEmpty

• get isEmpty(): boolean

  Returns true if either of the width or height are less than or equal to zero.

  Returns boolean

isNull

• get isNull(): boolean

  Returns true if both width and height values are zero.

  Returns boolean

fuzzyIsNull

• get fuzzyIsNull(): boolean

  Returns true if both width and height values are equal to zero to within 4 decimal places of precision.

  Returns boolean

constructor

• new Size(widthOrSize?: number | SizeType | Size, height?: number): Size

  Parameters

  • OptionalwidthOrSize: number | SizeType | Size
  • Optionalheight: number

  Returns Size

clone

• clone(): Size

  Returns a new Size instance with values copied from this one.

  Returns Size

set

• set(widthOrSize?: number | SizeType, height?: number): this

  Set the width and height properties. The widthOrSize parameter can be any object containing 'width' and 'height' properties, or a numeric value for the 'width' value. In the latter case, if a height parameter is passed, it is assigned to the 'height' value; otherwise the widthOrSize parameter is used for both 'width' and 'height'.

  Parameters

  • widthOrSize: number | SizeType = 0
  • Optionalheight: number

  Returns this

equals

• equals(widthOrSize: number | SizeType, height?: number): boolean

  Returns true if this size equals the widthOrSize SizeType or width & height values.

  Parameters

  • widthOrSize: number | SizeType
  • Optionalheight: number

  Returns boolean

fuzzyEquals

• fuzzyEquals(other: SizeType, epsilon?: number): boolean

  Returns true is this size equals the given SizeType to within epsilon decimal places of precision.

  Parameters

  • other: SizeType
  • epsilon: number = 0.0001

  Returns boolean

plus_eq

• plus_eq(widthOrSize: number | SizeType | PointType, height?: number): this

  Adds value(s) to current coordinates. Modifies the current value of this instance and returns itself

  Parameters

  • widthOrSize: number | SizeType | PointType
  • Optionalheight: number

  Returns this

plus

• plus(widthOrSize: number | SizeType | PointType, height?: number): Size

  Adds value(s) to current coordinates and returns a new Vect2d object.

  Parameters

  • widthOrSize: number | SizeType | PointType
  • Optionalheight: number

  Returns Size

times_eq

• times_eq(widthOrSize: number | SizeType | PointType, height?: number): this

  Multiplies current coordinates by value(s). Modifies the current value of this instance and returns itself

  Parameters

  • widthOrSize: number | SizeType | PointType
  • Optionalheight: number

  Returns this

times

• times(widthOrSize: number | SizeType | PointType, height?: number): Size

  Multiplies current coordinates by value(s) and returns a new Vect2d object.

  Parameters

  • widthOrSize: number | SizeType | PointType
  • Optionalheight: number

  Returns Size

toString

• toString(): void

  Returns a string representation of an object.

  Returns void

Staticadd

• add(
      size: Size,
      widthOrSize: number | SizeType | PointType,
      height?: number,
  ): Size

  Adds value(s) to size and returns new instance, does not modify input value.

  Parameters

  • size: Size
  • widthOrSize: number | SizeType | PointType
  • Optionalheight: number

  Returns Size

Staticmultiply

• multiply(
      size: Size,
      widthOrSize: number | SizeType | PointType,
      height?: number,
  ): Size

  Multiplies size coordinates by value(s) and returns new instance, does not modify input value,

  Parameters

  • size: Size
  • widthOrSize: number | SizeType | PointType
  • Optionalheight: number

  Returns Size

Staticnew

• new(widthOrSize?: number | SizeType, height?: number): SizeType

  Returns a new SizeType object with width and height set from number value(s) or another SizeType object.

  Parameters

  • widthOrSize: number | SizeType = 0
  • Optionalheight: number

  Returns SizeType

Staticset

• set(sz: SizeType, widthOrSize?: number | SizeType, height?: number): SizeType

  Sets the width and height values of a SizeType object. The widthOrSize parameter can be any object containing 'width' and 'height' properties, or a numeric value for the 'width' value. In the latter case, if a height parameter is passed, it is assigned to the 'height' value; otherwise the widthOrSize parameter is used for both 'width' and 'height'.

  Parameters

  • sz: SizeType
  • widthOrSize: number | SizeType = 0
  • Optionalheight: number

  Returns SizeType

StaticisEmpty

• isEmpty(sz: SizeType): boolean

  Returns true if either of the width or height are less than or equal to zero.

  Parameters

  • sz: SizeType

  Returns boolean

StaticisNull

• isNull(sz: SizeType): boolean

  Returns true if both width and height of sz are zero.

  Parameters

  • sz: SizeType

  Returns boolean

StaticfuzzyIsNull

• fuzzyIsNull(sz: SizeType, epsilon?: number): boolean

  Returns true if both width and height of sz are within epsilon delta of zero.

  Parameters

  • sz: SizeType
  • epsilon: number = 0.0001

  Returns boolean

Staticequals

• equals(sz: SizeType, widthOrSize: number | SizeType, height?: number): boolean

  Returns true if sz SizeType equals the widthOrSize SizeType or width & height values.

  Parameters

  • sz: SizeType
  • widthOrSize: number | SizeType
  • Optionalheight: number

  Returns boolean

StaticfuzzyEquals

• fuzzyEquals(sz: SizeType, other: SizeType, epsilon?: number): boolean

  Returns true is this SizeType equals the given SizeType to within epsilon decimal places of precision.

  Parameters

  • sz: SizeType
  • other: SizeType
  • epsilon: number = 0.0001

  Returns boolean

Staticplus_eq

• plus_eq(
      sz: SizeType,
      widthOrSize: number | SizeType | PointType,
      height?: number,
  ): SizeType

  Adds value(s) to sz and returns it. Modifies input value.

  Parameters

  • sz: SizeType
  • widthOrSize: number | SizeType | PointType
  • Optionalheight: number

  Returns SizeType

Staticplus

• plus(
      sz: SizeType,
      widthOrSize: number | SizeType | PointType,
      height?: number,
  ): SizeType

  Adds value(s) to sz and returns new instance, does not modify input value.

  Parameters

  • sz: SizeType
  • widthOrSize: number | SizeType | PointType
  • Optionalheight: number

  Returns SizeType

Statictimes_eq

• times_eq(
      sz: SizeType,
      widthOrSize: number | SizeType | PointType,
      height?: number,
  ): SizeType

  Multiplies sz coordinates by value(s) and returns it. Modifies input value.

  Parameters

  • sz: SizeType
  • widthOrSize: number | SizeType | PointType
  • Optionalheight: number

  Returns SizeType

Statictimes

• times(
      sz: SizeType,
      widthOrSize: number | SizeType | PointType,
      height?: number,
  ): SizeType

  Multiplies sz coordinates by value(s) and returns new instance, does not modify input value,

  Parameters

  • sz: SizeType
  • widthOrSize: number | SizeType | PointType
  • Optionalheight: number

  Returns SizeType

StatictoString

• toString(sz: SizeType, name?: string): string

  Parameters

  • sz: SizeType
  • name: string = "Size"

  Returns string

width

height