package geoml

  1. Overview
  2. Docs

Module RectangleSource

This module provides the basic operations over rectangles

Sourcetype t = private Point.t * float * float

rectangle type

Sourceval make : Point.t -> float -> float -> t

make p w h, returns a rectangle where p is the bottom-left corner of the rectangle, w its width and h its height

Sourceval of_diagonal : Point.t -> Point.t -> t

of_diagonal p1 p2, builds the rectangle where p1p2 is its diagonal (the bounding rectangle of the two points)

Sourceval scale_x : t -> float -> t
Sourceval scale_y : t -> float -> t
Sourceval scale : t -> float -> t

scale on both axis

Sourceval bottom_left : t -> Point.t
Sourceval bottom_right : t -> Point.t
Sourceval top_right : t -> Point.t
Sourceval top_left : t -> Point.t
Sourceval translate : float -> float -> t -> t
Sourceval reflection : Point.t -> t -> t
Sourceval contains : t -> Point.t -> bool
Sourceval area : t -> float
Sourceval perimeter : t -> float
Sourceval proj_x : t -> float * float
Sourceval proj_y : t -> float * float
Sourceval intersects : t -> t -> bool

determines whether or not two rectangles intersect

Sourceval intersect_line : t -> Line.t -> Point.t list

returns the intersection points of a rectangle and a line. returns if they don't intersect.

Sourceval segments : t -> Segment.t list

returns a list of length 4 containing the segments of the rectangle

Sourceval is_square : t -> bool

tests if the sides of the rectangle have same length

Sourceval encompass : t -> Point.t -> t

given a rectangle and point, returns the smallest rectangle that contains the point and the rectangle given as parameters

Sourceval bounding : Point.t list -> t

given a list of point, returns the smallest rectangle that contains all the points of the list

Sourceval centroid : t -> Point.t

returns the gravity center of a rectangle

Sourceval random_point : Random.State.t -> t -> Point.t

returns a randomly and uniformly chosen point of the rectangle

Sourceval print : Format.formatter -> t -> unit

printer