forked from 0ad/0ad
112 lines
3.3 KiB
C++
112 lines
3.3 KiB
C++
/* Copyright (C) 2009 Wildfire Games.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/*
|
|
///////////////////////////////////////////////
|
|
CTerrainProperties
|
|
|
|
Basically represents a set of terrain attributes loaded from XML. These
|
|
objects are organized in an inheritance tree, determined at load time.
|
|
|
|
*/
|
|
|
|
#ifndef INCLUDED_TERRAINPROPERTIES
|
|
#define INCLUDED_TERRAINPROPERTIES
|
|
|
|
#include "ps/CStr.h"
|
|
#include <boost/shared_ptr.hpp>
|
|
|
|
class CTerrainGroup;
|
|
class XMBElement;
|
|
class CXeromyces;
|
|
class CTerrainProperties;
|
|
class HEntity;
|
|
|
|
typedef shared_ptr<CTerrainProperties> CTerrainPropertiesPtr;
|
|
|
|
struct STerrainPassability
|
|
{
|
|
explicit STerrainPassability(bool passable=true):
|
|
m_Type(), m_Passable(passable), m_SpeedFactor(passable?1.0:0.0)
|
|
{}
|
|
|
|
CStr m_Type;
|
|
bool m_Passable;
|
|
double m_SpeedFactor;
|
|
// TODO Effects
|
|
};
|
|
|
|
class CTerrainProperties
|
|
{
|
|
public:
|
|
typedef std::vector<CTerrainGroup *> GroupVector;
|
|
|
|
private:
|
|
CTerrainPropertiesPtr m_pParent;
|
|
|
|
// BGRA color of topmost mipmap level, for coloring minimap, or a color
|
|
// manually specified in the Terrain XML (or by any parent)
|
|
// ..Valid is true if the base color is specified in this terrain XML
|
|
// No caching here, since ideally, a saved XML file of an object should
|
|
// produce be equivalent to the source file
|
|
u32 m_BaseColor;
|
|
bool m_HasBaseColor;
|
|
|
|
STerrainPassability m_DefaultPassability;
|
|
|
|
// All terrain type groups we're a member of
|
|
GroupVector m_Groups;
|
|
|
|
// Passability definitions
|
|
std::vector<STerrainPassability> m_Passabilities;
|
|
|
|
void ReadPassability(bool passable, XMBElement node, CXeromyces *pFile, const char *path);
|
|
void LoadXml(XMBElement node, CXeromyces *pFile, const char *path);
|
|
|
|
public:
|
|
CTerrainProperties(CTerrainPropertiesPtr parent);
|
|
|
|
// Create a new object and load the XML file specified. Returns NULL upon
|
|
// failure
|
|
// The parent pointer may be NULL, for the "root" terrainproperties object.
|
|
static CTerrainPropertiesPtr FromXML(const CTerrainPropertiesPtr& parent, const char* path);
|
|
|
|
// Save the object to an XML file. Implement when needed! ;-)
|
|
// bool WriteXML(const CStr& path);
|
|
|
|
inline CTerrainPropertiesPtr GetParent() const
|
|
{ return m_pParent; }
|
|
|
|
// Return true if this property object or any of its parents has a basecolor
|
|
// override (mmap attribute in the XML file)
|
|
bool HasBaseColor();
|
|
// Return the minimap color specified in this property object or in any of
|
|
// its parents. If no minimap color is specified, return garbage.
|
|
// Use HasBaseColor() to see if the value is valid.
|
|
// The color value is in BGRA format
|
|
u32 GetBaseColor();
|
|
|
|
double GetSpeedFactor(HEntity entity);
|
|
bool IsPassable(HEntity entity);
|
|
const STerrainPassability &GetPassability(HEntity entity);
|
|
|
|
const GroupVector &GetGroups() const
|
|
{ return m_Groups; }
|
|
};
|
|
|
|
#endif
|