fife-parpg: engine/core/util/math/angles.h annotate

annotate engine/core/util/math/angles.h @ 697:ecaa4d98f05f tip

Abstracted the GUI code and refactored the GUIChan-specific code into its own module. * Most of the GUIChan code has been refactored into its own gui/guichan module. However, references to the GuiFont class still persist in the Engine and GuiManager code and these will need further refactoring. * GuiManager is now an abstract base class which specific implementations (e.g. GUIChan) should subclass. * The GUIChan GUI code is now a concrete implementation of GuiManager, most of which is in the new GuiChanGuiManager class. * The GUI code in the Console class has been refactored out of the Console and into the GUIChan module as its own GuiChanConsoleWidget class. The rest of the Console class related to executing commands was left largely unchanged. * Existing client code may need to downcast the GuiManager pointer received from FIFE::Engine::getGuiManager() to GuiChanGuiManager, since not all functionality is represented in the GuiManager abstract base class. Python client code can use the new GuiChanGuiManager.castTo static method for this purpose.

author	M. George Hansen <technopolitica@gmail.com>
date	Sat, 18 Jun 2011 00:28:40 -1000
parents	07b1cf8e92b5
children

rev	line source
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	1 /***************************************************************************
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	2 * Copyright (C) 2005-2008 by the FIFE team *
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	3 * http://www.fifengine.de *
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	4 * This file is part of FIFE. *
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	5 * *
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	6 * FIFE is free software; you can redistribute it and/or *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	7 * modify it under the terms of the GNU Lesser General Public *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	8 * License as published by the Free Software Foundation; either *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	9 * version 2.1 of the License, or (at your option) any later version. *
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	10 * *
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	11 * This library is distributed in the hope that it will be useful, *
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	14 * Lesser General Public License for more details. *
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	15 * *
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	16 * You should have received a copy of the GNU Lesser General Public *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	17 * License along with this library; if not, write to the *
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	18 * Free Software Foundation, Inc., *
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	20 ***************************************************************************/
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	21
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	22 #ifndef FIFE_ANGLES_H
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	23 #define FIFE_ANGLES_H
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	24
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	25 // Standard C++ library includes
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	26 #include <map>
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	27
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	28 // 3rd party library includes
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	29
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	30 // FIFE includes
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	31 // These includes are split up in two parts, separated by one empty line
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	32 // First block: files included from the FIFE root src directory
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	33 // Second block: files included from the same folder
407 f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	34 #include "model/structures/location.h"
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	35
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	36 namespace FIFE {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	37 typedef std::map<unsigned int, int> type_angle2id;
407 f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	38
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	39 /** Returns id for given angle from angle2id map
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	40 * in case there are no elements in the map, negative value is returned
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	41 */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	42 int getIndexByAngle(int angle, const type_angle2id& angle2id, int& closestMatchingAngle);
407 f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	43
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	44 /** Gets angle of vector defined by given locations
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	45 * @return angle in polar coordinates between the line
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	46 * defined by the two locations and the horizontal axis (East <-> West)
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	47 */
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	48 inline int getAngleBetween(const Location& loc1, const Location& loc2) {
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	49 ExactModelCoordinate c1 = loc1.getMapCoordinates();
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	50 ExactModelCoordinate c2 = loc2.getMapCoordinates();
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	51
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	52 double dy = (c2.y - c1.y);
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	53 double dx = (c2.x - c1.x);
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	54
646 07b1cf8e92b5 * Major improvements to fife_math.h and added corresponding Python bindings. Users now have access to FIFE's internal math functions. These functions are recommended to be used by all clients if required. Note: this may cause some problems with certain compilers. I hope this wont have to be reverted. TODO: remove the static constant globals somehow. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 621 diff changeset	55 int angle = static_cast<int>(Mathd::ATan2(-dy,dx)*(180.0/Mathd::pi()));
407 f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	56
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	57 return angle;
f27880d4c08c Moved getAngleBetween() form Camera to angles.h and updated it to not use the camera angle in it's calculation. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	58 }
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	59 }
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	60
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	61 #endif

Mercurial > fife-parpg

annotate engine/core/util/math/angles.h @ 697:ecaa4d98f05f tip