ScummVM API documentation
area.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 // Based on Phantasma code by Thomas Harte (2013),
23 // available at https://github.com/TomHarte/Phantasma/ (MIT)
24 
25 #ifndef FREESCAPE_AREA_H
26 #define FREESCAPE_AREA_H
27 
28 #include "math/ray.h"
29 #include "math/vector3d.h"
30 
31 #include "freescape/language/instruction.h"
32 #include "freescape/objects/object.h"
33 #include "freescape/objects/group.h"
34 
35 
36 namespace Freescape {
37 
38 typedef Common::HashMap<uint16, Object *> ObjectMap;
39 typedef Common::Array<Object *> ObjectArray;
40 class Area {
41 public:
42  Area(uint16 areaID, uint16 areaFlags, ObjectMap *objectsByID, ObjectMap *entrancesByID, bool isCastle);
43  virtual ~Area();
44 
45  Common::String _name;
46  Object *objectWithID(uint16 objectID);
47  Object *entranceWithID(uint16 objectID);
48  Common::List<int> getEntranceIds();
49 
50  void changeObjectID(uint16 objectID, uint16 newObjectID);
51  ObjectArray getSensors();
52  uint16 getAreaID();
53  Common::Array<Object *> &getSortedObjects() { return _sortedObjects; }
54  uint16 getAreaFlags();
55  uint8 getScale();
56  void remapColor(int index, int color);
57  void unremapColor(int index);
58  void draw(Renderer *gfx, uint32 animationTicks, Math::Vector3d camera, Math::Vector3d direction, bool insideWait);
59  void drawGroup(Renderer *gfx, Group *group, bool runAnimation);
60  void show();
61 
62  Object *checkCollisionRay(const Math::Ray &ray, int raySize);
63  bool checkInSight(const Math::Ray &ray, float maxDistance);
64  Math::Vector3d separateFromWall(const Math::Vector3d &position);
65  ObjectArray checkCollisions(const Math::AABB &boundingBox);
66  bool checkIfPlayerWasCrushed(const Math::AABB &boundingBox);
67  Math::Vector3d resolveCollisions(Math::Vector3d const &lastPosition, Math::Vector3d const &newPosition, int playerHeight);
68  void addObjectFromArea(int16 id, Area *global);
69  void addGroupFromArea(int16 id, Area *global);
70  void addObject(Object *obj);
71  void addFloor();
72  void addStructure(Area *global);
73  void removeObject(int16 id);
74  void resetArea();
75  void resetAreaGroups();
76  bool isOutside();
77  bool hasActiveGroups();
78 
79  Common::Array<Common::String> _conditionSources;
81 
82  // Serialization
83  void saveObjects(Common::WriteStream *stream);
84  void loadObjects(Common::SeekableReadStream *stream, Area *global);
85 
86  // Driller specific
87  Common::Point _gasPocketPosition;
88  uint32 _gasPocketRadius;
89 
90  // Castle Master specific
91  bool _isCastle;
92 
93  uint8 _scale;
94  uint8 _skyColor;
95  uint8 _groundColor;
96  uint8 _usualBackgroundColor;
97  uint8 _underFireBackgroundColor;
98  uint8 _inkColor;
99  uint8 _paperColor;
100  uint8 _extraColor[4];
101  ColorReMap _colorRemaps;
102 
103  uint32 _lastTick;
104 
105 private:
106  Math::Vector3d _lastCameraPosition;
107  ObjectArray _sortedObjects;
108 
109  uint16 _areaID;
110  uint16 _areaFlags;
111  ObjectMap *_objectsByID;
112  ObjectMap *_entrancesByID;
113  ObjectArray _drawableObjects;
114  ObjectMap _addedObjects;
115  Object *objectWithIDFromMap(ObjectMap *map, uint16 objectID);
116 };
117 
118 } // End of namespace Freescape
119 
120 #endif // FREESCAPE_AREA_H
Definition: group.h:40
Definition: str.h:59
Definition: stream.h:77
Definition: area.h:36
Definition: area.h:40
Definition: stream.h:745
Definition: gfx.h:63
Definition: rect.h:144
Definition: object.h:56