GUI::CoordConverter Class Reference

Utility class that helps in converting various types of co-ordinate between absolute screen positions and positions offset from the top-left corner of a given Window object. More...

List of all members.

Public Member Functions
float	windowToScreenX (Window window, UDim x)
	Convert a window co-ordinate value, specified as a UDim, to a screen relative pixel co-ordinate.
float	windowToScreenX (Window window, float x)
	Convert a window pixel co-ordinate value, specified as a float, to a screen pixel co-ordinate.
float	windowToScreenY (Window window, UDim y)
	Convert a window co-ordinate value, specified as a UDim, to a screen relative pixel co-ordinate.
float	windowToScreenY (Window window, float y)
	Convert a window pixel co-ordinate value, specified as a float, to a screen pixel co-ordinate.
Vector2	windowToScreen (Window window, UVector2 vec)
	Convert a window co-ordinate point, specified as a UVector2, to a screen relative pixel co-ordinate point.
Vector2	windowToScreen (Window window, Vector2 vec)
	Convert a window pixel co-ordinate point, specified as a Vector2, to a screen pixel co-ordinate point.
Rect	windowToScreen (Window window, URect rect)
	Convert a window area, specified as a URect, to a screen area.
Rect	windowToScreen (Window window, Rect rect)
	Convert a pixel window area, specified as a Rect, to a screen area.
float	screenToWindowX (Window window, UDim x)
	Convert a screen relative UDim co-ordinate value to a window co-ordinate value, specified in pixels.
float	screenToWindowX (Window window, float x)
	Convert a screen pixel co-ordinate value to a window co-ordinate value, specified in pixels.
float	screenToWindowY (Window window, UDim y)
	Convert a screen relative UDim co-ordinate value to a window co-ordinate value, specified in pixels.
float	screenToWindowY (Window window, float y)
	Convert a screen pixel co-ordinate value to a window co-ordinate value, specified in pixels.
Vector2	screenToWindow (Window window, UVector2 vec)
	Convert a screen relative UVector2 point to a window co-ordinate point, specified in pixels.
Vector2	screenToWindow (Window window, Vector2 vec)
	Convert a screen Vector2 pixel point to a window co-ordinate point, specified in pixels.
Rect	screenToWindow (Window window, URect rect)
	Convert a URect screen area to a window area, specified in pixels.
Rect	screenToWindow (Window window, Rect rect)
	Convert a Rect screen pixel area to a window area, specified in pixels.

---

Detailed Description

Utility class that helps in converting various types of co-ordinate between absolute screen positions and positions offset from the top-left corner of a given Window object.

---

Member Function Documentation

float GUI::CoordConverter::windowToScreenX	(	Window	window,
		UDim	x
	)

Convert a window co-ordinate value, specified as a UDim, to a screen relative pixel co-ordinate.

Parameters:

window	Window object to use as a base for the conversion.
x	UDim x co-ordinate value to be converted

Returns:

float value describing a pixel screen co-ordinate that is equivalent to window UDim co-ordinate x.

float GUI::CoordConverter::windowToScreenX	(	Window	window,
		float	x
	)

Convert a window pixel co-ordinate value, specified as a float, to a screen pixel co-ordinate.

Parameters:

window	Window object to use as a base for the conversion.
x	float x co-ordinate value to be converted.

Returns:

float value describing a pixel screen co-ordinate that is equivalent to window co-ordinate x.

float GUI::CoordConverter::windowToScreenY	(	Window	window,
		UDim	y
	)

Convert a window co-ordinate value, specified as a UDim, to a screen relative pixel co-ordinate.

Parameters:

window	Window object to use as a base for the conversion.
y	UDim y co-ordinate value to be converted

Returns:

float value describing a screen co-ordinate that is equivalent to window UDim co-ordinate y.

float GUI::CoordConverter::windowToScreenY	(	Window	window,
		float	y
	)

Convert a window pixel co-ordinate value, specified as a float, to a screen pixel co-ordinate.

Parameters:

window	Window object to use as a base for the conversion.
y	float y co-ordinate value to be converted.

Returns:

float value describing a screen co-ordinate that is equivalent to window co-ordinate y.

Vector2 GUI::CoordConverter::windowToScreen	(	Window	window,
		UVector2	vec
	)

Convert a window co-ordinate point, specified as a UVector2, to a screen relative pixel co-ordinate point.

Parameters:

window	Window object to use as a base for the conversion.
vec	UVector2 object describing the point to be converted

Returns:

Vector2 object describing a screen co-ordinate position that is equivalent to window based UVector2 vec.

Vector2 GUI::CoordConverter::windowToScreen	(	Window	window,
		Vector2	vec
	)

Convert a window pixel co-ordinate point, specified as a Vector2, to a screen pixel co-ordinate point.

Parameters:

window	Window object to use as a base for the conversion.
vec	Vector2 object describing the point to be converted.

Returns:

Vector2 object describing a screen co-ordinate position that is equivalent to window based Vector2 vec.

Rect GUI::CoordConverter::windowToScreen	(	Window	window,
		URect	rect
	)

Convert a window area, specified as a URect, to a screen area.

Parameters:

window	Window object to use as a base for the conversion.
rect	URect object describing the area to be converted

Returns:

Rect object describing a screen area that is equivalent to window area rect.

Rect GUI::CoordConverter::windowToScreen	(	Window	window,
		Rect	rect
	)

Convert a pixel window area, specified as a Rect, to a screen area.

Parameters:

window	Window object to use as a base for the conversion.
rect	Rect object describing the area to be converted.

Returns:

Rect object describing a screen area that is equivalent to window area rect.

float GUI::CoordConverter::screenToWindowX	(	Window	window,
		UDim	x
	)

Convert a screen relative UDim co-ordinate value to a window co-ordinate value, specified in pixels.

Parameters:

window	Window object to use as a target for the conversion.
x	UDim x co-ordinate value to be converted

Returns:

float value describing a window co-ordinate value that is equivalent to screen UDim co-ordinate x.

float GUI::CoordConverter::screenToWindowX	(	Window	window,
		float	x
	)

Convert a screen pixel co-ordinate value to a window co-ordinate value, specified in pixels.

Parameters:

window	Window object to use as a target for the conversion.
x	float x co-ordinate value to be converted.

Returns:

float value describing a window co-ordinate value that is equivalent to screen co-ordinate x.

float GUI::CoordConverter::screenToWindowY	(	Window	window,
		UDim	y
	)

Convert a screen relative UDim co-ordinate value to a window co-ordinate value, specified in pixels.

Parameters:

window	Window object to use as a target for the conversion.
y	UDim y co-ordinate value to be converted

Returns:

float value describing a window co-ordinate value that is equivalent to screen UDim co-ordinate y.

float GUI::CoordConverter::screenToWindowY	(	Window	window,
		float	y
	)

Convert a screen pixel co-ordinate value to a window co-ordinate value, specified in pixels.

Parameters:

window	Window object to use as a target for the conversion.
y	UDim y co-ordinate value to be converted.

Returns:

float value describing a window co-ordinate value that is equivalent to screen co-ordinate y.

Vector2 GUI::CoordConverter::screenToWindow	(	Window	window,
		UVector2	vec
	)

Convert a screen relative UVector2 point to a window co-ordinate point, specified in pixels.

Parameters:

window	Window object to use as a target for the conversion.
vec	UVector2 object describing the point to be converted

Returns:

Vector2 object describing a window co-ordinate point that is equivalent to screen based UVector2 point vec.

Vector2 GUI::CoordConverter::screenToWindow	(	Window	window,
		Vector2	vec
	)

Convert a screen Vector2 pixel point to a window co-ordinate point, specified in pixels.

Parameters:

window	Window object to use as a target for the conversion.
vec	Vector2 object describing the point to be converted.

Returns:

Vector2 object describing a window co-ordinate point that is equivalent to screen based Vector2 point vec.

Rect GUI::CoordConverter::screenToWindow	(	Window	window,
		URect	rect
	)

Convert a URect screen area to a window area, specified in pixels.

Parameters:

window	Window object to use as a target for the conversion.
rect	URect object describing the area to be converted

Returns:

Rect object describing a window area that is equivalent to URect screen area rect.

Rect GUI::CoordConverter::screenToWindow	(	Window	window,
		Rect	rect
	)

Convert a Rect screen pixel area to a window area, specified in pixels.

Parameters:

window	Window object to use as a target for the conversion.
rect	Rect object describing the area to be converted.

Returns:

Rect object describing a window area that is equivalent to Rect screen area rect.