/usr/include/CEGUI/CEGUICoordConverter.h is in libcegui-mk2-dev 0.7.6-3.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 | /***********************************************************************
filename: CEGUICoordConverter.h
created: Sun Sep 18 2005
author: Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUICoordConverter_h_
#define _CEGUICoordConverter_h_
#include "CEGUIUDim.h"
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
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.
*/
class CEGUIEXPORT CoordConverter
{
public:
/*!
\brief
Convert a window co-ordinate value, specified as a UDim, to a screen
relative pixel co-ordinate.
\param window
Window object to use as a base for the conversion.
\param x
UDim x co-ordinate value to be converted
\return
float value describing a pixel screen co-ordinate that is equivalent to
window UDim co-ordinate \a x.
*/
static float windowToScreenX(const Window& window, const UDim& x);
/*!
\brief
Convert a window pixel co-ordinate value, specified as a float, to a
screen pixel co-ordinate.
\param window
Window object to use as a base for the conversion.
\param x
float x co-ordinate value to be converted.
\return
float value describing a pixel screen co-ordinate that is equivalent to
window co-ordinate \a x.
*/
static float windowToScreenX(const Window& window, const float x);
/*!
\brief
Convert a window co-ordinate value, specified as a UDim, to a screen
relative pixel co-ordinate.
\param window
Window object to use as a base for the conversion.
\param y
UDim y co-ordinate value to be converted
\return
float value describing a screen co-ordinate that is equivalent to
window UDim co-ordinate \a y.
*/
static float windowToScreenY(const Window& window, const UDim& y);
/*!
\brief
Convert a window pixel co-ordinate value, specified as a float, to a
screen pixel co-ordinate.
\param window
Window object to use as a base for the conversion.
\param y
float y co-ordinate value to be converted.
\return
float value describing a screen co-ordinate that is equivalent to
window co-ordinate \a y.
*/
static float windowToScreenY(const Window& window, const float y);
/*!
\brief
Convert a window co-ordinate point, specified as a UVector2, to a
screen relative pixel co-ordinate point.
\param window
Window object to use as a base for the conversion.
\param vec
UVector2 object describing the point to be converted
\return
Vector2 object describing a screen co-ordinate position that is
equivalent to window based UVector2 \a vec.
*/
static Vector2 windowToScreen(const Window& window, const UVector2& vec);
/*!
\brief
Convert a window pixel co-ordinate point, specified as a Vector2, to a
screen pixel co-ordinate point.
\param window
Window object to use as a base for the conversion.
\param vec
Vector2 object describing the point to be converted.
\return
Vector2 object describing a screen co-ordinate position that is
equivalent to window based Vector2 \a vec.
*/
static Vector2 windowToScreen(const Window& window, const Vector2& vec);
/*!
\brief
Convert a window area, specified as a URect, to a screen area.
\param rect
URect object describing the area to be converted
\return
Rect object describing a screen area that is equivalent to window
area \a rect.
*/
static Rect windowToScreen(const Window& window, const URect& rect);
/*!
\brief
Convert a pixel window area, specified as a Rect, to a screen area.
\param window
Window object to use as a base for the conversion.
\param rect
Rect object describing the area to be converted.
\return
Rect object describing a screen area that is equivalent to window
area \a rect.
*/
static Rect windowToScreen(const Window& window, const Rect& rect);
/*!
\brief
Convert a screen relative UDim co-ordinate value to a window co-ordinate
value, specified in pixels.
\param window
Window object to use as a target for the conversion.
\param x
UDim x co-ordinate value to be converted
\return
float value describing a window co-ordinate value that is equivalent to
screen UDim co-ordinate \a x.
*/
static float screenToWindowX(const Window& window, const UDim& x);
/*!
\brief
Convert a screen pixel co-ordinate value to a window co-ordinate
value, specified in pixels.
\param window
Window object to use as a target for the conversion.
\param x
float x co-ordinate value to be converted.
\return
float value describing a window co-ordinate value that is equivalent to
screen co-ordinate \a x.
*/
static float screenToWindowX(const Window& window, const float x);
/*!
\brief
Convert a screen relative UDim co-ordinate value to a window co-ordinate
value, specified in pixels.
\param window
Window object to use as a target for the conversion.
\param y
UDim y co-ordinate value to be converted
\return
float value describing a window co-ordinate value that is equivalent to
screen UDim co-ordinate \a y.
*/
static float screenToWindowY(const Window& window, const UDim& y);
/*!
\brief
Convert a screen pixel co-ordinate value to a window co-ordinate
value, specified in pixels.
\param window
Window object to use as a target for the conversion.
\param y
UDim y co-ordinate value to be converted.
\return
float value describing a window co-ordinate value that is equivalent to
screen co-ordinate \a y.
*/
static float screenToWindowY(const Window& window, const float y);
/*!
\brief
Convert a screen relative UVector2 point to a window co-ordinate point,
specified in pixels.
\param window
Window object to use as a target for the conversion.
\param vec
UVector2 object describing the point to be converted
\return
Vector2 object describing a window co-ordinate point that is equivalent
to screen based UVector2 point \a vec.
*/
static Vector2 screenToWindow(const Window& window, const UVector2& vec);
/*!
\brief
Convert a screen Vector2 pixel point to a window co-ordinate point,
specified in pixels.
\param window
Window object to use as a target for the conversion.
\param vec
Vector2 object describing the point to be converted.
\return
Vector2 object describing a window co-ordinate point that is equivalent
to screen based Vector2 point \a vec.
*/
static Vector2 screenToWindow(const Window& window, const Vector2& vec);
/*!
\brief
Convert a URect screen area to a window area, specified in pixels.
\param window
Window object to use as a target for the conversion.
\param rect
URect object describing the area to be converted
\return
Rect object describing a window area that is equivalent to URect screen
area \a rect.
*/
static Rect screenToWindow(const Window& window, const URect& rect);
/*!
\brief
Convert a Rect screen pixel area to a window area, specified in pixels.
\param window
Window object to use as a target for the conversion.
\param rect
Rect object describing the area to be converted.
\return
Rect object describing a window area that is equivalent to Rect screen
area \a rect.
*/
static Rect screenToWindow(const Window& window, const Rect& rect);
private:
/*!
\brief
Return the base X co-ordinate of the given Window object.
\param window
Window object to return base position for.
\return
float value indicating the base on-screen pixel location of the window
on the x axis (i.e. The screen co-ord of the window's left edge).
*/
static float getBaseXValue(const Window& window);
/*!
\brief
Return the base Y co-ordinate of the given Window object.
\param window
Window object to return base position for.
\return
float value indicating the base on-screen pixel location of the window
on the y axis (i.e. The screen co-ord of the window's top edge).
*/
static float getBaseYValue(const Window& window);
/*!
\brief
Return the base position of the given Window object.
\param window
Window object to return base position for.
\return
Vector2 value indicating the base on-screen pixel location of the window
object. (i.e. The screen co-ord of the window's top-left corner).
*/
static Vector2 getBaseValue(const Window& window);
};
} // End of CEGUI namespace section
#endif // end of guard _CEGUICoordConverter_h_
|