fife-parpg: engine/core/model/structures/layer.i annotate

annotate engine/core/model/structures/layer.i @ 46:90005975cdbb

* Final LGPL switch step by adjusting the file headers * Remaining issues (just slightly related to the unittest switch): * No working unittest solution for msvc2005 yet * Unittests not working with mingw + scons either though this seems hard to impossible to fix without an expert in this field * sample_unit_test.cpp would need to get modified for unittest++; it still contains the old boost unittest code

author	mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date	Sun, 13 Jul 2008 11:05:12 +0000
parents	4a0efb7baf70
children	e7b55b2b398f

rev	line source
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	1 /***************************************************************************
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	2 * Copyright (C) 2005-2008 by the FIFE team *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	3 * http://www.fifengine.de *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	4 * This file is part of FIFE. *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	5 * *
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. *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	10 * *
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, *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
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. *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	15 * *
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 *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	18 * Free Software Foundation, Inc., *
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 *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	20 ***************************************************************************/
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	21
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	22 %module fife
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	23 %{
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	24 #include "model/structures/layer.h"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	25 %}
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	26
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	27 %include "std_vector.i"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	28
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	29 %include "model/metamodel/modelcoords.i"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	30 %include "model/metamodel/grids/cellgrids.i"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	31 %include "util/structures/utilstructures.i"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	32 %include "util/base/utilbase.i"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	33
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	34 namespace FIFE {
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 class Map;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	37 class Selection;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	38 class Instance;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	39 class Object;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	40 class CellGrid;
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 enum PathingStrategy {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	43 CELL_EDGES_ONLY,
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	44 CELL_EDGES_AND_DIAGONALS,
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	45 FREEFORM
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	46 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	47
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	48 %feature("director") LayerChangeListener;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	49 class LayerChangeListener {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	50 public:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	51 virtual ~LayerChangeListener() {};
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	52 virtual void onLayerChanged(Layer* layer, std::vector<Instance*>& changedInstances) = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	53 virtual void onInstanceCreate(Layer* layer, Instance* instance) = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	54 virtual void onInstanceDelete(Layer* layer, Instance* instance) = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	55 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	56
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	57
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	58 class Layer : public ResourceClass {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	59 public:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	60 Layer(const std::string& identifier, Map* map, CellGrid* geometry);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	61 ~Layer();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	62
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	63 const std::string& getId();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	64
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	65 CellGrid* getCellGrid() const { return m_grid; }
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	66
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	67 Map* getMap();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	68 bool hasInstances() const;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	69 Instance* createInstance(Object* object, const ModelCoordinate& p, const std::string& id="");
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	70 Instance* createInstance(Object* object, const ExactModelCoordinate& p, const std::string& id="");
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	71 void deleteInstance(Instance* object);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	72
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	73 const std::vector<Instance*>& getInstances() const;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	74 Instance* getInstance(const std::string& id);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	75
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	76 void setInstancesVisible(bool vis);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	77 bool cellContainsBlockingInstance(const ModelCoordinate& cellCoordinate);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	78 void toggleInstancesVisible();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	79 bool areInstancesVisible() const;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	80
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	81 void setPathingStrategy(PathingStrategy strategy);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	82 PathingStrategy getPathingStrategy();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	83
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	84 void addChangeListener(LayerChangeListener* listener);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	85 void removeChangeListener(LayerChangeListener* listener);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	86 bool isChanged();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	87 std::vector<Instance*>& getChangedInstances();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	88 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	89 }

Mercurial > fife-parpg

annotate engine/core/model/structures/layer.i @ 46:90005975cdbb