| 1 |
/*************************************************************************** |
| 2 |
* Copyright (C) 2005-2019 by the FIFE team * |
| 3 |
* http://www.fifengine.net * |
| 4 |
* This file is part of FIFE. * |
| 5 |
* * |
| 6 |
* FIFE is free software; you can redistribute it and/or * |
| 7 |
* modify it under the terms of the GNU Lesser General Public * |
| 8 |
* License as published by the Free Software Foundation; either * |
| 9 |
* version 2.1 of the License, or (at your option) any later version. * |
| 10 |
* * |
| 11 |
* This library is distributed in the hope that it will be useful, * |
| 12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of * |
| 13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * |
| 14 |
* Lesser General Public License for more details. * |
| 15 |
* * |
| 16 |
* You should have received a copy of the GNU Lesser General Public * |
| 17 |
* License along with this library; if not, write to the * |
| 18 |
* Free Software Foundation, Inc., * |
| 19 |
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * |
| 20 |
***************************************************************************/ |
| 21 |
|
| 22 |
#ifndef FIFE_ANGLES_H |
| 23 |
#define FIFE_ANGLES_H |
| 24 |
|
| 25 |
// Standard C++ library includes |
| 26 |
#include <map> |
| 27 |
|
| 28 |
// 3rd party library includes |
| 29 |
|
| 30 |
// FIFE includes |
| 31 |
// These includes are split up in two parts, separated by one empty line |
| 32 |
// First block: files included from the FIFE root src directory |
| 33 |
// Second block: files included from the same folder |
| 34 |
#include "model/structures/location.h" |
| 35 |
|
| 36 |
namespace FIFE { |
| 37 |
typedef std::map<uint32_t, int32_t> type_angle2id; |
| 38 |
|
| 39 |
/** Returns id for given angle from angle2id map |
| 40 |
* in case there are no elements in the map, negative value is returned |
| 41 |
*/ |
| 42 |
int32_t getIndexByAngle(int32_t angle, const type_angle2id& angle2id, int32_t& closestMatchingAngle); |
| 43 |
|
| 44 |
/** Gets angle of vector defined by given locations |
| 45 |
* @return angle in polar coordinates between the line |
| 46 |
* defined by the two locations and the horizontal axis (East <-> West) |
| 47 |
*/ |
| 48 |
int32_t getAngleBetween(const Location& loc1, const Location& loc2); |
| 49 |
|
| 50 |
/** Gets facing location defined by given angle and location |
| 51 |
* @return facing location |
| 52 |
*/ |
| 53 |
Location getFacing(const Location& loc, const int32_t angle); |
| 54 |
|
| 55 |
/** Gets angle of vector defined by given map coordinates |
| 56 |
* @return angle in polar coordinates between the line |
| 57 |
* defined by the two map coordinates and the horizontal axis (East <-> West) |
| 58 |
*/ |
| 59 |
int32_t getAngleBetween(const ExactModelCoordinate& emc1, const ExactModelCoordinate& emc2); |
| 60 |
|
| 61 |
/** Gets facing map coordinate defined by given angle and map coordinate |
| 62 |
* @return facing map coordinate |
| 63 |
*/ |
| 64 |
ExactModelCoordinate getFacing(const ExactModelCoordinate& emc, const int32_t angle); |
| 65 |
} |
| 66 |
|
| 67 |
#endif |