Mtk-18 ▶ Mtk ▶ Rectangle

constructor

• new Rectangle(
      properties?: Partial<
          { height: number; width: number; x: number; y: number },
      >,
  ): Mtk.Rectangle

  Parameters

  • Optionalproperties: Partial<{ height: number; width: number; x: number; y: number }>

  Returns Mtk.Rectangle

height

width

x

y

Static$gtype

area

• area(): number

  Returns number

  The area of the rectangle

contains_point

• contains_point(x: number, y: number): boolean

  Parameters

  • x: number

    X coordinate of the point

  • y: number

    Y coordinate of the point

  Returns boolean

  Whether the rectangle contains the point

contains_pointf

• contains_pointf(x: number, y: number): boolean

  Parameters

  • x: number

    X coordinate of the point

  • y: number

    Y coordinate of the point

  Returns boolean

  Whether the rectangle contains the point

contains_rect

• contains_rect(inner_rect: Mtk.Rectangle): boolean

  Parameters

  • inner_rect: Mtk.Rectangle

    The inner rectangle

  Returns boolean

  Whether the outer rectangle contains the inner one

copy

• copy(): Mtk.Rectangle

  Returns Mtk.Rectangle

could_fit_rect

• could_fit_rect(inner_rect: Mtk.Rectangle): boolean

  Parameters

  • inner_rect: Mtk.Rectangle

    The inner rectangle

  Returns boolean

  Whether the inner rectangle could fit inside the outer one

crop_and_scale

• crop_and_scale(
      src_rect: Graphene.Rect,
      dst_width: number,
      dst_height: number,
      dest: Mtk.Rectangle,
  ): void

  Parameters

  • src_rect: Graphene.Rect
  • dst_width: number
  • dst_height: number
  • dest: Mtk.Rectangle

  Returns void

equal

• equal(src2: Mtk.Rectangle): boolean

  Compares the two rectangles

  Parameters

  • src2: Mtk.Rectangle

    The second rectangle

  Returns boolean

  Whether the two rectangles are equal

free

• free(): void

  Returns void

horiz_overlap

• horiz_overlap(rect2: Mtk.Rectangle): boolean

  Similar to Rectangle.overlap but ignores the vertical location.

  Parameters

  • rect2: Mtk.Rectangle

    The second rectangle

  Returns boolean

  Whether the two rectangles overlap horizontally

intersect

• intersect(src2: Mtk.Rectangle): [boolean, Mtk.Rectangle]

  Find the intersection between the two rectangles

  Parameters

  • src2: Mtk.Rectangle

    another Mtk.Rectangle

  Returns [boolean, Mtk.Rectangle]

  TRUE is some intersection exists and is not degenerate, FALSE otherwise.

is_adjacent_to

• is_adjacent_to(other: Mtk.Rectangle): boolean

  Parameters

  • other: Mtk.Rectangle

  Returns boolean

is_empty

• is_empty(): boolean

  Returns boolean

overlap

• overlap(rect2: Mtk.Rectangle): boolean

  Similar to Rectangle.intersect but doesn't provide the location of the intersection.

  Parameters

  • rect2: Mtk.Rectangle

    The second rectangle

  Returns boolean

  Whether the two rectangles overlap

scale_double

• scale_double(
      scale: number,
      rounding_strategy: RoundingStrategy,
      dest: Mtk.Rectangle,
  ): void

  Parameters

  • scale: number
  • rounding_strategy: RoundingStrategy
  • dest: Mtk.Rectangle

  Returns void

to_graphene_rect

• to_graphene_rect(): Graphene.Rect

  Returns Graphene.Rect

  Return a graphene_rect_t created from rect

transform

• transform(
      transform: MonitorTransform,
      width: number,
      height: number,
      dest: Mtk.Rectangle,
  ): void

  This function transforms the values in rect in order to compensate for transform applied to a MetaMonitor, making them match the viewport. Note that compensating implies that for a clockwise rotation of the MetaMonitor an anti-clockwise rotation has to be applied to rect.

  Parameters

  • transform: MonitorTransform

    the Mtk.MonitorTransform

  • width: number

    the width of the target space

  • height: number

    the height of the target space

  • dest: Mtk.Rectangle

    the transformed Mtk.Rectangle

  Returns void

union

• union(rect2: Mtk.Rectangle): Mtk.Rectangle

  Computes the union of the two rectangles

  Parameters

  • rect2: Mtk.Rectangle

    another Mtk.Rectangle

  Returns Mtk.Rectangle

vert_overlap

• vert_overlap(rect2: Mtk.Rectangle): boolean

  Similar to Rectangle.overlap but ignores the horizontal location.

  Parameters

  • rect2: Mtk.Rectangle

    The second rectangle

  Returns boolean

  Whether the two rectangles overlap vertically

Staticfrom_graphene_rect

• from_graphene_rect(
      rect: Graphene.Rect,
      rounding_strategy: RoundingStrategy,
  ): Mtk.Rectangle

  Parameters

  • rect: Graphene.Rect

    A rectangle

  • rounding_strategy: RoundingStrategy

    The rounding strategy

  Returns Mtk.Rectangle

Staticnew

• new(x: number, y: number, width: number, height: number): Mtk.Rectangle

  Parameters

  • x: number
  • y: number
  • width: number
  • height: number

  Returns Mtk.Rectangle

Staticnew_empty

• new_empty(): Mtk.Rectangle

  Returns Mtk.Rectangle