/usr/include/flatzebra/RCouple.h is in libflatzebra-dev 0.1.6-4.
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 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 | /* $Id: RCouple.h,v 1.6 2012/07/06 04:28:45 sarrazip Exp $
RCouple.h - Class representing a couple of integers.
flatzebra - Generic 2D Game Engine library
Copyright (C) 1999-2012 Pierre Sarrazin <http://sarrazip.com/>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef _H_RCouple
#define _H_RCouple
#include <flatzebra/Couple.h>
#include <assert.h>
#include <math.h>
namespace flatzebra {
class RCouple
/* Class representing a RCouple of floating point numbers.
*/
{
public:
double x, y;
/* The components.
*/
RCouple();
/* Builds a RCouple with ZERO values for the components.
*/
RCouple(double a, double b);
/* Initiliazes a RCouple with x equal to a and y equal to b.
*/
RCouple(const RCouple &c);
/* Copies the components of the RCouple 'c' into the current RCouple.
*/
RCouple(const Couple &c);
/* Converts the integer couple 'c' into the current floating
point RCouple.
*/
RCouple &operator = (const RCouple &c);
/* Replaces the components of the current RCouple by those of 'c'.
*/
RCouple &operator = (const Couple &c);
/* Replaces the components of the current RCouple by a conversion
of the integer couple 'c' into a floating point couple.
*/
~RCouple();
/* Does nothing.
*/
RCouple &zero();
/* Assign zero to both components.
Returns a reference to this object.
Was void until version 0.1.
*/
bool isZero() const;
/* Returns true iff both components are zero.
*/
bool isNonZero() const;
/* Returns true iff one or both components differ from zero.
*/
double squaredLength() const;
/* Returns the square of the length of the vector represented by the RCouple.
*/
double length() const;
/* Returns the length of the vector represented by the RCouple.
*/
RCouple normalize() const;
/* Returns a vector with the same direction as this one, but of length 1.
If this vector is the origin, the origin is returned.
*/
RCouple setLength(double newLength) const;
/* Returns a vector with the same direction as this one, but of the
specified length.
If this vector is the origin, the origin is returned.
*/
Couple round() const;
/* Returns an integer couple created from the rounded values of
this floating point couple.
*/
Couple floor() const;
/* Returns an integer couple created from the floored values of
this floating point couple.
*/
Couple ceil() const;
/* Returns an integer couple created from the ceiled values of
this floating point couple.
*/
RCouple &operator += (const RCouple &c);
RCouple &operator -= (const RCouple &c);
RCouple &operator *= (double n);
RCouple &operator /= (double n);
/* Return the current object as modified.
*/
friend RCouple operator + (const RCouple &c1, const RCouple &c2);
friend RCouple operator - (const RCouple &c1, const RCouple &c2);
friend RCouple operator * (const RCouple &c1, double n);
friend RCouple operator * (double n, const RCouple &c1);
friend RCouple operator / (const RCouple &c1, double n);
friend bool operator == (const RCouple &c1, const RCouple &c2);
friend bool operator != (const RCouple &c1, const RCouple &c2);
static bool rectangleCollision(const RCouple &pos1,
const RCouple &rect1,
const RCouple &pos2,
const RCouple &size2);
/* Indicates if the two specified rectangles collide.
They collide if they have an intersection that has a non-zero surface.
pos1 and pos2 must be the upper-left coordinates of the rectangles.
*/
double dotProduct(const RCouple &c) const;
/* Returns the scalar product of this couple with the given one.
*/
RCouple project(const RCouple &c) const;
/* Returns the projection of vector 'c' on this vector.
This vector must not be zero. (See isZero() and isNonZero().)
*/
RCouple getClosestPointOnSegment(const RCouple &segStart,
const RCouple &segEnd) const;
/* Returns the point on the given segment that is closest to this point.
segStart and segEnd give the end points of the segment, and must not
be equal.
If the projection of *this on the segment lies "before" segStart,
then segStart is returned; if the projection lies "after" segEnd,
then segEnd is returned.
*/
bool isOnSegment(const RCouple &segStart,
const RCouple &segEnd) const;
/* Return true if this point lies on the given segment.
segStart and segEnd give the end points of the segment, and must not
be equal.
*/
static const double tolerance;
/* Tolerance used in floating point comparisons when determining
if two values are "extremely" close.
*/
bool safeEqual(const RCouple &c) const;
/* Indicates if this vector is "extremely" close to 'c'.
*/
static bool safeEqual(double a, double b);
/* Indicates if the two numbers are "extremely" close.
*/
static bool safeLower(double a, double b);
/* Indicates if the two numbers are a < b and not "extremely" close.
*/
static bool safeLowerOrEqual(double a, double b);
/* Indicates if a < b or the two numbers are "extremely" close.
*/
static bool safeGreater(double a, double b);
/* Indicates if the two numbers are a > b and not "extremely" close.
*/
static bool safeGreaterOrEqual(double a, double b);
/* Indicates if a > b or the two numbers are "extremely" close.
*/
};
//
// IMPLEMENTATION (inline functions)
//
inline RCouple::RCouple()
: x(0), y(0)
{
}
inline RCouple::RCouple(double a, double b)
: x(a), y(b)
{
}
inline RCouple::RCouple(const RCouple &c)
: x(c.x), y(c.y)
{
}
inline RCouple::RCouple(const Couple &c)
: x(c.x), y(c.y)
{
}
inline RCouple &RCouple::operator = (const RCouple &c)
{
x = c.x;
y = c.y;
return *this;
}
inline RCouple &RCouple::operator = (const Couple &c)
{
x = c.x;
y = c.y;
return *this;
}
inline RCouple::~RCouple()
{
}
inline RCouple &RCouple::zero()
{
x = y = 0;
return *this;
}
inline bool RCouple::isZero() const
{
return (x == 0 && y == 0);
}
inline bool RCouple::isNonZero() const
{
return (x != 0 || y != 0);
}
inline RCouple &RCouple::operator += (const RCouple &c)
{
x += c.x;
y += c.y;
return *this;
}
inline RCouple &RCouple::operator -= (const RCouple &c)
{
x -= c.x;
y -= c.y;
return *this;
}
inline RCouple &RCouple::operator *= (double n)
{
x *= n;
y *= n;
return *this;
}
inline RCouple &RCouple::operator /= (double n)
{
x /= n;
y /= n;
return *this;
}
inline RCouple operator + (const RCouple &c1, const RCouple &c2)
{
RCouple c(c1);
return c += c2;
}
inline RCouple operator - (const RCouple &c1, const RCouple &c2)
{
RCouple c(c1);
return c -= c2;
}
inline RCouple operator * (const RCouple &c1, double n)
{
RCouple c(c1);
return c *= n;
}
inline RCouple operator * (double n, const RCouple &c1)
{
RCouple c(c1);
return c *= n;
}
inline RCouple operator / (const RCouple &c1, double n)
{
RCouple c(c1);
return c /= n;
}
inline bool operator == (const RCouple &c1, const RCouple &c2)
{
return (c1.x == c2.x && c1.y == c2.y);
}
inline bool operator != (const RCouple &c1, const RCouple &c2)
{
return !(c1 == c2);
}
inline double RCouple::squaredLength() const
{
return x * x + y * y;
}
inline double RCouple::length() const
{
return hypot(x, y);
}
inline RCouple RCouple::normalize() const
{
if (isZero())
return RCouple();
return *this / length();
}
inline RCouple RCouple::setLength(double newLength) const
{
if (isZero())
return RCouple();
return *this / length() * newLength;
}
inline Couple RCouple::round() const
{
return Couple(
int(x >= 0 ? (x + 0.5) : (x - 0.5)),
int(y >= 0 ? (y + 0.5) : (y - 0.5)));
}
inline Couple RCouple::floor() const
{
return Couple(static_cast<int>(::floor(x)), static_cast<int>(::floor(y)));
}
inline Couple RCouple::ceil() const
{
return Couple(static_cast<int>(::ceil(x)), static_cast<int>(::ceil(y)));
}
inline double RCouple::dotProduct(const RCouple &c) const
{
return x * c.x + y * c.y;
}
inline RCouple RCouple::project(const RCouple &c) const
{
assert(isNonZero());
return (dotProduct(c) / dotProduct(*this)) * *this;
}
inline bool RCouple::safeEqual(const RCouple &c) const
{
return fabs(x - c.x) < tolerance && fabs(y - c.y) < tolerance;
}
inline bool RCouple::safeEqual(double a, double b)
{
return fabs(a - b) < tolerance;
}
inline bool RCouple::safeLower(double a, double b)
{
return !safeEqual(a, b) && a < b;
}
inline bool RCouple::safeLowerOrEqual(double a, double b)
{
return safeEqual(a, b) || a < b;
}
inline bool RCouple::safeGreater(double a, double b)
{
return !safeEqual(a, b) && a > b;
}
inline bool RCouple::safeGreaterOrEqual(double a, double b)
{
return safeEqual(a, b) || a > b;
}
} // namespace flatzebra
#endif /* _H_RCouple */
|