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

annotate engine/core/model/structures/layer.i @ 378:64738befdf3b

bringing in the changes from the build_system_rework branch in preparation for the 0.3.0 release. This commit will require the Jan2010 devkit. Clients will also need to be modified to the new way to import fife.

author	vtchill@33b003aa-7bff-0310-803a-e67f0ece8222
date	Mon, 11 Jan 2010 23:34:52 +0000
parents	ab41334e8a57
children

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 "model/metamodel/modelcoords.i"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	28 %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	29 %include "util/structures/utilstructures.i"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	30 %include "util/base/utilbase.i"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	31
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	32 namespace FIFE {
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 class Map;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	35 class Selection;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	36 class Instance;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	37 class Object;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	38 class CellGrid;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	39
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	40 enum PathingStrategy {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	41 CELL_EDGES_ONLY,
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	42 CELL_EDGES_AND_DIAGONALS,
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	43 FREEFORM
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	44 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	45
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	46 %feature("director") LayerChangeListener;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	47 class LayerChangeListener {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	48 public:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	49 virtual ~LayerChangeListener() {};
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	50 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	51 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	52 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	53 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	54
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 class Layer : public ResourceClass {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	57 public:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	58 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	59 ~Layer();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	60
340 7e5717105212 * Added setId to Layer, Map, Object and Camera cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	61 const std::string& getId() const;
7e5717105212 * Added setId to Layer, Map, Object and Camera cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	62 void setId(const std::string& id);
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	63
340 7e5717105212 * Added setId to Layer, Map, Object and Camera cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	64 CellGrid* getCellGrid() const;
7e5717105212 * Added setId to Layer, Map, Object and Camera cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	65 void setCellGrid(CellGrid* grid);
0 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="");
91 e7b55b2b398f Corrected Layer::addInstance() to return appropriate bool. Added the function to layer.i for swig Sleek@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 46 diff changeset	71 bool addInstance(Instance* instance, const ExactModelCoordinate& p);
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	72 void deleteInstance(Instance* object);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	73
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	74 const std::vector<Instance*>& getInstances() const;
99 64e7fe3d4288 - added possibility to change instance ids spq@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 91 diff changeset	75 std::vector<Instance*> getInstances(const std::string& identifier);
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 112 diff changeset	76 std::vector<Instance*> getInstancesAt(Location& loc, bool use_exactcoordinates=false);
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	77 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	78
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	79 void setInstancesVisible(bool vis);
356 ab41334e8a57 Added or1andov's code with a few adjustments to fix instance transparencies fixed[t:378] prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 340 diff changeset	80 void setLayerTransparency(uint8_t transparency);
ab41334e8a57 Added or1andov's code with a few adjustments to fix instance transparencies fixed[t:378] prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 340 diff changeset	81 uint8_t getLayerTransparency();
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	82 bool cellContainsBlockingInstance(const ModelCoordinate& cellCoordinate);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	83 void toggleInstancesVisible();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	84 bool areInstancesVisible() const;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	85
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	86 void setPathingStrategy(PathingStrategy strategy);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	87 PathingStrategy getPathingStrategy();
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 void addChangeListener(LayerChangeListener* listener);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	90 void removeChangeListener(LayerChangeListener* listener);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	91 bool isChanged();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	92 std::vector<Instance*>& getChangedInstances();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	93 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	94 }

Mercurial > fife-parpg

annotate engine/core/model/structures/layer.i @ 378:64738befdf3b