Difference between revisions of "Recti"

Latest revision as of 17:27, 1 December 2016

A Recti is a 2D integer rectangle, usually in pixel coordinates.

Name	Description
empty	True if right=left and bottom=top (read-only)
left	Left edge
top	Top edge
right	Right edge
bottom	Bottom edge
width	Rectangle width (right - left)
height	Rectangle height (bottom - top)
size	The size as a tuple of (width, height)
valid	True if the rectangle is valid (right>left, bottom>top) (read-only)

Name	Description
Recti(left, top, right, bottom)	The default constructor
Recti(left, top, width, height)	Use arguments names to specify which constructor to use.
clip(other)	Returns a new Recti with this clipped to other
union(other)	Returns a new Recti with the union of the two
intersect(other)	Returns a new Recti with the intersection of the two

Name	Description
and	The intersecton
or	The union

@@ Line 27: / Line 27: @@
 |height
 |Rectangle height (bottom - top)
+|-
+|size
+|The size as a tuple of (width, height)
 |-
 |valid
@@ Line 37: / Line 40: @@
 ! scope="col" | Name
 ! scope="col" class="unsortable" | Description
+|-
+|Recti(left, top, right, bottom)
+|The default constructor
 |-
 |Recti(left, top, width, height)
-|Constructs a new Rectangle
+|Use arguments names to specify which constructor to use.
 |-
 |clip(other)
 |Returns a new Recti with this clipped to other
 |-
-|moveTo(x, y)
+|union(other)
-|Moves the top left corner of the rectangle to x, y
+|Returns a new Recti with the union of the two
 |-
-|set(x, y, width, height)
+|intersect(other)
-|Sets the rectangle position and size
+|Returns a new Recti with the intersection of the two
+|-
+|}
+=== Operators ===
+{| class="wikitable"
+! scope="col" | Name
+! scope="col" class="unsortable" | Description
 |-
-|setSize(width, height)
+|and
-|Resizes the rectangle to the new width and height
+|The intersecton
 |-
-|translate(dx, dy)
+|or
-|Translates the rectangle by dx and dy
+|The union
 |-
-|translated(dx, dy)
-|Returns a new Rect translated by dx and dy
 |}