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 Gegl-0.3.d.ts:2845
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

boundingBox

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

- Defined in Gegl-0.3.d.ts:2744
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 Gegl-0.3.d.ts:2751
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 Gegl-0.3.d.ts:2759
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 Gegl-0.3.d.ts:2763
For debugging purposes, not stable API.

Returns void

dup

dup(): Gegl.Rectangle

- Defined in Gegl-0.3.d.ts:2767
Create a new copy of rectangle.

Returns Gegl.Rectangle

equal

equal(rectangle2: Gegl.Rectangle): boolean

- Defined in Gegl-0.3.d.ts:2774
Check if two #GeglRectangles are equal.

Returns TRUE if rectangle and rectangle2 are equal.

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

equalCoords

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

- Defined in Gegl-0.3.d.ts:2784
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 Gegl-0.3.d.ts:2796
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

isEmpty

isEmpty(): boolean

- Defined in Gegl-0.3.d.ts:2802
Check if a rectangle has zero area.

Returns TRUE if rectangle height and width are both zero.

Returns boolean

isInfinitePlane

isInfinitePlane(): boolean

- Defined in Gegl-0.3.d.ts:2807
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 Gegl-0.3.d.ts:2815
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

subtractBoundingBox

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

- Defined in Gegl-0.3.d.ts:2826
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 infinitePlane

infinitePlane(): Gegl.Rectangle

- Defined in Gegl-0.3.d.ts:2858
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 Gegl-0.3.d.ts:2854
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