📐 Geometry

Geometry is a static class that provides information about widgets positions and sizes.

---

This is a static class. Access brush methods with . instead of :

It's not possible to spawn new instances.

---

🦠 Functions

AbsoluteToLocal

Translates absolute coordinates into local coordinates.

— Returns Vector2D.

local ret = Geometry.AbsoluteToLocal(Widget, AbsoluteCoordinate)

Type	Parameter	Description
BaseWidget	Widget
Vector2D	AbsoluteCoordinate

LocalToAbsolute

Translates local coordinates into absolute coordinates.

— Returns Vector2D.

local ret = Geometry.LocalToAbsolute(Widget, LocalCoordinate)

Type	Parameter	Description
BaseWidget	Widget
Vector2D	LocalCoordinate

LocalToViewport

Translates local coordinate of the geometry provided into local viewport coordinates.

— Returns Vector2D (pixel position).

— Returns Vector2D (viewport position).

local ret, ret2 = Geometry.LocalToViewport(Widget)

Type	Parameter	Description
BaseWidget	Widget
Vector2D	LocalCoordinate

IsUnderLocation

Absolute coordinates could be either desktop or window space depending on what space the root of the widget hierarchy is in.

— Returns boolean.

local ret = Geometry.IsUnderLocation(Widget, AbsoluteCoordinate)

Type	Parameter	Description
BaseWidget	Widget
Vector2D	AbsoluteCoordinate

ScreenToLocal

Translates a screen position in pixels into the local space of a widget with the given geometry.

If IncludeWindowPosition is true, then this method will also remove the game window's position (useful when in windowed mode).

— Returns boolean.

local ret = Geometry.ScreenToLocal(Widget, ScreenPosition, IncludeWindowPosition)

Type	Parameter	Description
BaseWidget	Widget
Vector2D	ScreenPosition
boolean	IncludeWindowPosition

GetLocalTopLeft

Returns the local top/left of the geometry in local coordinates.

— Returns Vector2D.

local ret = Geometry.GetLocalTopLeft(Widget)

Type	Parameter	Description
BaseWidget	Widget

GetLocalSize

Returns the size of the geometry in local space.

— Returns Vector2D.

local ret = Geometry.GetLocalSize(Widget)

Type	Parameter	Description
BaseWidget	Widget

GetAbsoluteSize

Returns the size of the geometry in absolute space.

— Returns Vector2D.

local ret = Geometry.GetLocalSize(Widget)

Type	Parameter	Description
BaseWidget	Widget