docs » hs.geometry

Creates a copy of an hs.geometry object

• geom - an hs.geometry object to copy

• a newly created copy of the hs.geometry object

Creates a new hs.geometry object

• ... - see the module description at the top

• a newly created hs.geometry object

Convenience function for creating a point object

• x - A number containing the horizontal co-ordinate of the point
• y - A number containing the vertical co-ordinate of the point

• An hs.geometry point object

Convenience function for creating a rect-table

• x - A number containing the horizontal co-ordinate of the top-left point of the rect
• y - A number containing the vertical co-ordinate of the top-left point of the rect
• w - A number containing the width of the rect
• h - A number containing the height of the rect

• An hs.geometry rect object

Convenience function for creating a size object

• w - A number containing a width
• h - A number containing a height

• An hs.geometry size object

A number representing the area of this rect or size; changing it will scale the rect/size - see hs.geometry:scale()

A number representing the aspect ratio of this rect or size; changing it will reshape the rect/size, keeping its area and center constant

Alias for x2y2

A point representing the geometric center of this rect or the midpoint of this vector2; changing it will move the rect/vector accordingly

The height of this rect or size; changing it will keep the rect's x,y corner constant

A number representing the length of the diagonal of this rect, or the length of this vector2; changing it will scale the rect/vector - see hs.geometry:scale()

The "X,Y/WxH" string for this hs.geometry object (reduced precision); useful e.g. for logging

The {x=X,y=Y,w=W,h=H} table for this hs.geometry object; useful e.g. for serialization/deserialization

Alias for xy

The width of this rect or size; changing it will keep the rect's x,y corner constant

The size component for this hs.geometry object; setting this to a new size will keep the rect's x,y corner constant

The x coordinate for this point or rect's corner; changing it will move the rect but keep the same width and height

Alias for x

The x coordinate for the second corner of this rect; changing it will affect the rect's width

The point denoting the other corner of this hs.geometry object; setting this to a new point will change the rect's width and height

The point component for this hs.geometry object; setting this to a new point will move the rect but keep the same width and height

The y coordinate for this point or rect's corner; changing it will move the rect but keep the same width and height

Alias for y

The y coordinate for the second corner of this rect; changing it will affect the rect's height

Returns the angle between the positive x axis and this vector2

• None

• a number representing the angle in radians

Returns the angle between the positive x axis and the vector connecting this point or rect's center to another point or rect's center

• point - an hs.geometry object, or a table or string or parameter list to construct one; if a rect, uses the rect's center

• a number representing the angle in radians

Finds the distance between this point or rect's center and another point or rect's center

• point - an hs.geometry object, or a table or string or parameter list to construct one; if a rect, uses the rect's center

• a number indicating the distance

Checks if two geometry objects are equal

• other - another hs.geometry object, or a table or string or parameter list to construct one

• true if this hs.geometry object perfectly overlaps other, false otherwise

Ensure this rect is fully inside bounds, by scaling it down if it's larger (preserving its aspect ratio) and moving it if necessary

• bounds - an hs.geometry rect object, or a table or string or parameter list to construct one, indicating the rect that must fully contain this rect

• this hs.geometry object for method chaining

Truncates all coordinates in this object to integers

• None

• this hs.geometry point for method chaining

Converts a unit rect within a given frame into a rect

• frame - an hs.geometry rect (with w and h >0)

• An hs.geometry rect object

Checks if this hs.geometry object lies fully inside a given rect

• rect - an hs.geometry rect, or a table or string or parameter list to construct one

• true if this point/rect lies fully inside the given rect, false otherwise

Returns the intersection rect between this rect and another rect

• rect - an hs.geometry rect, or a table or string or parameter list to construct one

• a new hs.geometry rect

• If the two rects don't intersect, the result rect will be a "projection" of the second rect onto this rect's closest edge or corner along the x or y axis; the w and/or h fields in the result rect will be 0.

Moves this point/rect

• point - an hs.geometry object, or a table or string or parameter list to construct one, indicating the x and y displacement to apply

• this hs.geometry object for method chaining

Normalizes this vector2

• None

• this hs.geometry point for method chaining

Rotates a point around another point N times

• aroundpoint - an hs.geometry point to rotate this point around
• ntimes - the number of times to rotate, defaults to 1

• A new hs.geometry point containing the location of the rotated point

Scales this vector2/size, or this rect keeping its center constant

• size - an hs.geometry object, or a table or string or parameter list to construct one, indicating the factors for scaling this rect's width and height; if a number, the rect will be scaled by the same factor in both axes

• this hs.geometry object for method chaining

Converts a rect into its unit rect within a given frame

• frame - an hs.geometry rect (with w and h >0)

• An hs.geometry unit rect object

• The resulting unit rect is always clipped within frame's bounds (via hs.geometry:intersect()); if frame does not encompass this rect no error will be thrown, but the resulting unit rect won't be a direct match with this rect (i.e. calling :fromUnitRect(frame) on it will return a different rect)

Returns the type of an hs.geometry object

• None

• a string describing the type of this hs.geometry object, i.e. 'point', 'size', 'rect' or 'unitrect'; nil if not a valid object

Returns the smallest rect that encloses both this rect and another rect

• rect - an hs.geometry rect, or a table or string or parameter list to construct one

• a new hs.geometry rect

Returns the vector2 from this point or rect's center to another point or rect's center

• point - an hs.geometry object, or a table or string or parameter list to construct one; if a rect, uses the rect's center

• an hs.geometry point