CEGUI::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...

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

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

Vector2 CEGUI::CoordConverter::screenToWindow ( const Window &  window, const UVector2 &  vec  )

static

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.

References CEGUI::System::getSingleton().

Referenced by CEGUI::MultiLineEditbox::getTextIndexFromPosition(), CEGUI::Titlebar::onMouseButtonDown(), CEGUI::Thumb::onMouseButtonDown(), CEGUI::DragContainer::onMouseButtonDown(), CEGUI::ListHeaderSegment::onMouseButtonDown(), CEGUI::FrameWindow::onMouseButtonDown(), CEGUI::Listbox::onMouseButtonDown(), CEGUI::Tree::onMouseButtonDown(), CEGUI::MultiColumnList::onMouseButtonDown(), CEGUI::Titlebar::onMouseMove(), CEGUI::ComboDropList::onMouseMove(), CEGUI::Thumb::onMouseMove(), CEGUI::DragContainer::onMouseMove(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::FrameWindow::onMouseMove(), CEGUI::Listbox::onMouseMove(), and CEGUI::Tree::onMouseMove().

Vector2 CEGUI::CoordConverter::screenToWindow ( const Window &  window, const Vector2 &  vec  )

static

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 CEGUI::CoordConverter::screenToWindow ( const Window &  window, const URect &  rect  )

static

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.

References CEGUI::System::getRenderer(), CEGUI::System::getSingleton(), CEGUI::Renderer::getSize(), and CEGUI::Rect::offset().

Rect CEGUI::CoordConverter::screenToWindow ( const Window &  window, const Rect &  rect  )

static

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.

References CEGUI::Rect::offset().

float CEGUI::CoordConverter::screenToWindowX ( const Window &  window, const UDim &  x  )

static

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.

References CEGUI::System::getSingleton().

Referenced by CEGUI::FalagardEditbox::getTextIndexFromPosition().

float CEGUI::CoordConverter::screenToWindowX ( const Window &  window, const float  x  )

static

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 CEGUI::CoordConverter::screenToWindowY ( const Window &  window, const UDim &  y  )

static

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.

References CEGUI::System::getSingleton().

float CEGUI::CoordConverter::screenToWindowY ( const Window &  window, const float  y  )

static

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 CEGUI::CoordConverter::windowToScreen ( const Window &  window, const UVector2 &  vec  )

static

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.

References CEGUI::Window::getPixelSize().

Referenced by CEGUI::ClippedContainer::getUnclippedInnerRect_impl(), and CEGUI::Window::getUnclippedPixelRect().

Vector2 CEGUI::CoordConverter::windowToScreen ( const Window &  window, const Vector2 &  vec  )

static

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 CEGUI::CoordConverter::windowToScreen ( const Window &  window, const URect &  rect  )

static

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

Parameters

rect	URect object describing the area to be converted

Returns

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

References CEGUI::Window::getPixelSize(), and CEGUI::Rect::offset().

Rect CEGUI::CoordConverter::windowToScreen ( const Window &  window, const Rect &  rect  )

static

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.

References CEGUI::Rect::offset().

float CEGUI::CoordConverter::windowToScreenX ( const Window &  window, const UDim &  x  )

static

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.

References CEGUI::Window::getPixelSize().

float CEGUI::CoordConverter::windowToScreenX ( const Window &  window, const float  x  )

static

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 CEGUI::CoordConverter::windowToScreenY ( const Window &  window, const UDim &  y  )

static

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.

References CEGUI::Window::getPixelSize().

float CEGUI::CoordConverter::windowToScreenY ( const Window &  window, const float  y  )

static

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.