TParams.h

//
// class TParams
//
// defines all the construction parameters for a terrain
//
// Copyright (c) 2001-2011 Virtual Terrain Project
// Free for all uses, see license.txt for details.
//

#ifndef TPARAMSH
#define TPARAMSH

#include "vtdata/MathTypes.h"
#include "vtdata/Content.h"


enum TextureEnum {
    TE_NONE,
    TE_SINGLE,
    TE_TILED,
    TE_DERIVED,
    TE_TILESET
};

enum LodMethodEnum {
    LM_ROETTGER,    
    LM_TOPOVISTA,   
    LM_MCNALLY,     
    LM_DEMETER,     
    LM_BRUTE        
};

// TParam Layer Types
#define TERR_LTYPE_STRUCTURE    "Structure"
#define TERR_LTYPE_ABSTRACT     "Abstract"
#define TERR_LTYPE_IMAGE        "Image"

// Class to encapsulate a scenarios parameters.

class ScenarioParams : public vtTagArray
{
public:
    ScenarioParams();

    // copy constructor and assignment operator
    ScenarioParams(const ScenarioParams& paramsSrc);
    ScenarioParams &operator = (const ScenarioParams &rhs);

    // override to catch active layers list
    void WriteOverridesToXML(FILE *fp) const;

    vtStringArray& GetActiveLayers() { return m_ActiveLayers; }

protected:
    vtStringArray m_ActiveLayers;
};

class TParams : public vtTagArray
{
public:
    TParams();

    // copy constructor and assignment operator
    TParams(const TParams& paramsSrc);
    TParams &operator = (const TParams &rhs);

    // File IO
    bool LoadFrom(const char *fname);
    bool LoadFromXML(const char *fname);

    // override to catch structure files
    void WriteOverridesToXML(FILE *fp) const;

    void SetLodMethod(LodMethodEnum method);
    LodMethodEnum GetLodMethod() const;

    void SetTextureEnum(TextureEnum tex);
    TextureEnum GetTextureEnum() const;

    // Convenience method
    void SetOverlay(const vtString &fname, int x, int y);
    bool GetOverlay(vtString &fname, int &x, int &y) const;

public:
    // this must be a public member (currently..)
    std::vector<vtTagArray> m_Layers;
    vtStringArray m_AnimPaths;
    std::vector<ScenarioParams> m_Scenarios;

private:
    void ConvertOldTimeValue();
};

// Visitor class for XML parsing of TParams files.

class TParamsVisitor : public TagVisitor
{
public:
    TParamsVisitor(TParams *pParams) : TagVisitor(pParams), m_pParams(pParams), m_bInLayer(false), m_bInScenario(false) {}
    void startElement(const char *name, const XMLAttributes &atts);
    void endElement (const char *name);

protected:
    TParams *m_pParams;
    vtTagArray m_layer;
    bool m_bViz;
    ScenarioParams m_Scenario;
    bool m_bInLayer;
    bool m_bInScenario;
};

#define STR_TPARAMS_FORMAT_NAME "Terrain_Parameters"

#define STR_NAME "Name"
#define STR_ELEVFILE "Elevation_Filename"
#define STR_VERTICALEXAG "Vertical_Exag"
#define STR_SUPPRESS "Suppress_Surface"

#define STR_MINHEIGHT "Min_Height"
#define STR_NAVSTYLE "Nav_Style"
#define STR_NAVSPEED "Nav_Speed"
#define STR_LOCFILE "Locations_File"
#define STR_INITLOCATION "Init_Location"
#define STR_HITHER "Hither_Distance"
#define STR_ACCEL "Accel"
#define STR_ALLOW_ROLL "Allow_Roll"

#define STR_SURFACE_TYPE "Surface_Type" // 0=grid, 1=TIN, 2=tiled grid
#define STR_LODMETHOD "LOD_Method"
#define STR_TRICOUNT "Tri_Count"
#define STR_TRISTRIPS "Tristrips"
#define STR_VERTCOUNT "Vert_Count"
#define STR_TILE_CACHE_SIZE "Tile_Cache_Size"   // in MB
#define STR_TILE_THREADING "Tile_Threading"

#define STR_TIMEON "Time_On"
#define STR_INITTIME "Init_Time"
#define STR_TIMESPEED "Time_Speed"

#define STR_TEXTURE "Texture"   // 0=none, 1=single, 3=derived, 4=tileset
//#define STR_TILESIZE "Tile_Size"              // obsolete
#define STR_TEXTUREFILE "Texture_Filename"
//#define STR_TEXTUREBASE "Base_Texture"        // obsolete
//#define STR_TEXTURE4BY4 "Texture_4by4"        // obsolete
//#define STR_TEXTUREFORMAT "Texture_Format"    // 0=bmp, 1=jpg; obsolete
#define STR_TEXTURE_GRADUAL "Texture_Gradual"
#define STR_TEXURE_LOD_FACTOR "Texture_LOD_Factor"
#define STR_MIPMAP "MIP_Map"
#define STR_REQUEST16BIT "Request_16_Bit"
#define STR_PRELIGHT "Pre-Light"
#define STR_PRELIGHTFACTOR "PreLight_Factor"
#define STR_CAST_SHADOWS "Cast_Shadows"
#define STR_COLOR_MAP "Color_Map"
#define STR_TEXTURE_RETAIN "Texture_Retain"

#define STR_DETAILTEXTURE "Detail_Texture"
#define STR_DTEXTURE_NAME "DTexture_Name"
#define STR_DTEXTURE_SCALE "DTexture_Scale"
#define STR_DTEXTURE_DISTANCE "DTexture_Distance"

#define STR_ROADS "Roads"
#define STR_ROADFILE "Road_File"
#define STR_HWY "Highway"
#define STR_PAVED "Paved"
#define STR_DIRT "Dirt"
#define STR_ROADHEIGHT "Road_Height"
#define STR_ROADDISTANCE "Road_Distance"
#define STR_TEXROADS "Road_Texture"
#define STR_ROADCULTURE "Road_Culture"

#define STR_TREES "Trees"
#define STR_TREEFILE "Tree_File"
#define STR_VEGDISTANCE "Tree_Distance"

#define STR_FOG "Fog"
#define STR_FOGDISTANCE "Fog_Distance"
#define STR_FOGCOLOR "Fog_Color"

#define STR_CONTENT_FILE "Content_File"

#define STR_STRUCTFILE   "Structure_File"   // Obsolete, use layers now
#define STR_STRUCTDIST   "Structure_Distance"
#define STR_STRUCT_SHADOWS "Structure_Shadows"
#define STR_SHADOW_REZ  "Shadow_Resolution"
#define STR_SHADOW_DARKNESS "Shadow_Darkness"

#define STR_SHADOWS_DEFAULT_ON "Shadows_Default_On"
#define STR_SHADOWS_EVERY_FRAME "Shadows_Every_Frame"
#define STR_LIMIT_SHADOW_AREA   "Limit_Shadow_Area"
#define STR_SHADOW_RADIUS   "Shadow_Radius"

#define STR_STRUCTURE_PAGING        "PagingStructures"
#define STR_STRUCTURE_PAGING_MAX    "PagingStructureMax"
#define STR_STRUCTURE_PAGING_DIST   "PagingStructureDist"

#define STR_TOWERS "Trans_Towers"
#define STR_TOWERFILE "Tower_File"

#define STR_VEHICLES "Vehicles"
#define STR_VEHICLESIZE "Vehicle_Size"
#define STR_VEHICLESPEED "Vehicle_Speed"

#define STR_SKY "Sky"
#define STR_SKYTEXTURE "Sky_Texture"
#define STR_OCEANPLANE "Ocean_Plane"
#define STR_OCEANPLANELEVEL "Ocean_Plane_Level"
#define STR_WATER "Water"
#define STR_WATERFILE "Water_File"
#define STR_DEPRESSOCEAN "Depress_Ocean"
#define STR_DEPRESSOCEANLEVEL "Depress_Ocean_Level"
#define STR_HORIZON "Horizon"
#define STR_BGCOLOR "Background_Color"

#define STR_ROUTEENABLE "Route_Enable"  // not used yet
#define STR_ROUTEFILE "Route_File"      // not used yet

#define STR_DIST_TOOL_HEIGHT "Distance_Tool_Height"
#define STR_HUD_OVERLAY "HUD_Overlay"
#define STR_OVERVIEW "HUD_Overview"
#define STR_COMPASS "HUD_Compass"

#define STR_INIT_SCENARIO "Init_Scenario"
#define STR_SCENARIO_NAME "Scenario_Name"

#define STR_ALLOW_GRID_SCULPTING "Allow_Sculpting"
    // Group terrain

#endif  // TPARAMSH