Rect

A Rect describes an axis-aligned rectangle by specifying the coordinates of its upper left and lower right corners. In Javascript they are represented by a 4-element array: [minX, minY, maxX, maxY]

The relationship between the minX, minY, maxX and maxY values can be set so that a rectangle is categorized as invalid, empty or infinite. This matters when passing such rectangles to Rect.transform(). There are convenience functions to obtain such rectangles: Rect.empty, Rect.invalid and Rect.infinite.

In TypeScript the Rect type is defined as follows:

type Rect = [number, number, number, number]

Constructors

class Rect()

This is an interface, not a concrete class!

Rects are not represented by a class; they are just plain arrays of four numbers.

Static properties

Rect.empty

A rectangle whose coordinates are such that it is categorized as empty.

Rect.invalid

A rectangle whose coordinates are such that it is categorized as invalid.

Rect.infinite

A rectangle whose coordinates are such that it is categorized as infinite.

Static methods

Rect.isEmpty(rect)

Returns whether the rectangle is empty or not.

Arguments:

  • rect (Rect) – Rectangle to evaluate.

Returns:

boolean

var isEmpty = mupdf.Rect.isEmpty([0, 0, 0, 0]) // true
var isEmpty = mupdf.Rect.isEmpty([0, 0, 100, 100]) // false
Rect.isValid(rect)

Returns whether the rectangle is valid or not.

Arguments:

  • rect (Rect) – Rectangle to evaluate.

Returns:

boolean

var isValid = mupdf.Rect.isValid([0, 0, 100, 100]) // true
var isValid = mupdf.Rect.isValid([0, 0, -100, 100]) // false
Rect.isInfinite(rect)

Returns whether the rectangle is infinite or not.

Arguments:

  • rect (Rect) – Rectangle to evaluate.

Returns:

boolean

var isInfinite = mupdf.Rect.isInfinite([0x80000000, 0x80000000, 0x7fffff80, 0x7fffff80]) //true
var isInfinite = mupdf.Rect.isInfinite([0, 0, 100, 100]) // false
Rect.transform(rect, matrix)

Transforms the supplied rectangle by the given transformation matrix.

Transforming an invalid, empty or infinite rectangle results in the supplied rectangle being returned without change.

Arguments:

  • rect (Rect) – Rectangle to transform.

  • matrix (Matrix) – Matrix describing transformation to perform.

Returns:

Rect

var m = mupdf.Rect.transform([0, 0, 100, 100], [1, 0.5, 1, 1, 1, 1])
Rect.isPointInside(rect, point)

Return whether the point is inside the rectangle.

:returns boolean

var inside = mupdf.Rect.isPointInside([0, 0, 100, 100], [50, 50])
Rect.rectFromQuad(quad)

Create a Rect that encompasses the entire quad.

Arguments:
Returns:

Rect