Class Rectangle

Hierarchy

Rectangle

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in @types/Gjs/Gegl-0.3.d.ts:2715
Creates a new rectangle set with the values from x, y, width and height.

Parameters
- x: number
  
  upper left x coordinate
- y: number
  
  upper left y coordinate
- width: number
  
  width in pixels.
- height: number
  
  height in pixels.
Returns Gegl.Rectangle

Properties

height

height: number

width

width: number

x

x: number

y

y: number

Static name

name: string

Methods

bounding_box

bounding_box(source1: Gegl.Rectangle, source2: Gegl.Rectangle): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:2614
Computes the bounding box of the rectangles source1 and source2 and stores the resulting bounding box in destination.

destination may point to the same object as source1 or source2.

Parameters
- source1: Gegl.Rectangle
  
  a #GeglRectangle
- source2: Gegl.Rectangle
  
  a #GeglRectangle
Returns void

contains

contains(child: Gegl.Rectangle): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:2621
Checks if the #GeglRectangle child is fully contained within parent.

Returns TRUE if the child is fully contained in parent.

Parameters
- child: Gegl.Rectangle
  
  a #GeglRectangle
Returns boolean

copy

copy(source: Gegl.Rectangle): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:2629
Copies the rectangle information stored in source over the information in destination.

destination may point to the same object as source.

Parameters
- source: Gegl.Rectangle
  
  a #GeglRectangle
Returns void

dump

dump(): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:2633
For debugging purposes, not stable API.

Returns void

dup

dup(): Gegl.Rectangle

- Defined in @types/Gjs/Gegl-0.3.d.ts:2637
Create a new copy of rectangle.

Returns Gegl.Rectangle

equal

equal(rectangle2: Gegl.Rectangle): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:2644
Check if two #GeglRectangles are equal.

Returns TRUE if rectangle and rectangle2 are equal.

Parameters
- rectangle2: Gegl.Rectangle
  
  a #GeglRectangle
Returns boolean

equal_coords

equal_coords(x: number, y: number, width: number, height: number): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:2654
Check if a rectangle is equal to a set of parameters.

Returns TRUE if rectangle and x,``y width x height are equal.

Parameters
- x: number
  
  X coordinate
- y: number
  
  Y coordinate
- width: number
  
  width of rectangle
- height: number
  
  height of rectangle
Returns boolean

intersect

intersect(src1: Gegl.Rectangle, src2: Gegl.Rectangle): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:2666
Calculates the intersection of two rectangles. If the rectangles do not intersect, dest's width and height are set to 0 and its x and y values are undefined.

dest may point to the same object as src1 or src2.

Returns TRUE if the rectangles intersect.

Parameters
- src1: Gegl.Rectangle
  
  a #GeglRectangle
- src2: Gegl.Rectangle
  
  a #GeglRectangle
Returns boolean

is_empty

is_empty(): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:2672
Check if a rectangle has zero area.

Returns TRUE if rectangle height and width are both zero.

Returns boolean

is_infinite_plane

is_infinite_plane(): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:2677
Returns TRUE if the GeglRectangle represents an infininte plane, FALSE otherwise.

Returns boolean

set

set(x: number, y: number, width: number, height: number): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:2685
Sets the x, y, width and height on rectangle.

Parameters
- x: number
  
  upper left x coordinate
- y: number
  
  upper left y coordinate
- width: number
  
  width in pixels.
- height: number
  
  height in pixels.
Returns void

subtract_bounding_box

subtract_bounding_box(minuend: Gegl.Rectangle, subtrahend: Gegl.Rectangle): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:2696
Computes the bounding box of the area formed by subtracting subtrahend from minuend, and stores the result in destination.

destination may point to the same object as minuend or subtrahend.

Returns TRUE if the result is not empty.

Parameters
- minuend: Gegl.Rectangle
  
  a #GeglRectangle
- subtrahend: Gegl.Rectangle
  
  a #GeglRectangle
Returns boolean

Static infinite_plane

infinite_plane(): Gegl.Rectangle

- Defined in @types/Gjs/Gegl-0.3.d.ts:2728
Returns a GeglRectangle that represents an infininte plane.

Returns Gegl.Rectangle

Static new

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

- Defined in @types/Gjs/Gegl-0.3.d.ts:2724
Creates a new rectangle set with the values from x, y, width and height.

Parameters
- x: number
  
  upper left x coordinate
- y: number
  
  upper left y coordinate
- width: number
  
  width in pixels.
- height: number
  
  height in pixels.
Returns Gegl.Rectangle