PixelLightAPI  .
TerrainLoaderPL.h
Go to the documentation of this file.
00001 /*********************************************************\
00002  *  File: TerrainLoaderPL.h                              *
00003  *
00004  *  Copyright (C) 2002-2011 The PixelLight Team (http://www.pixellight.org/)
00005  *
00006  *  This file is part of PixelLight.
00007  *
00008  *  PixelLight is free software: you can redistribute it and/or modify
00009  *  it under the terms of the GNU Lesser General Public License as published by
00010  *  the Free Software Foundation, either version 3 of the License, or
00011  *  (at your option) any later version.
00012  *
00013  *  PixelLight is distributed in the hope that it will be useful,
00014  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00016  *  GNU Lesser General Public License for more details.
00017  *
00018  *  You should have received a copy of the GNU Lesser General Public License
00019  *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
00020 \*********************************************************/
00021 
00022 
00023 #ifndef __PLSCENE_SCENENODE_TERRAINLOADER_PL_H__
00024 #define __PLSCENE_SCENENODE_TERRAINLOADER_PL_H__
00025 #pragma once
00026 
00027 
00028 //[-------------------------------------------------------]
00029 //[ Includes                                              ]
00030 //[-------------------------------------------------------]
00031 #include "PLScene/Scene/SceneNodes/Terrain/TerrainLoader.h"
00032 
00033 
00034 //[-------------------------------------------------------]
00035 //[ Namespace                                             ]
00036 //[-------------------------------------------------------]
00037 namespace PLScene {
00038 
00039 
00040 //[-------------------------------------------------------]
00041 //[ Classes                                               ]
00042 //[-------------------------------------------------------]
00043 /**
00044 *  @brief
00045 *    Terrain loader implementation for the PixelLight terrain XML file format
00046 */
00047 class TerrainLoaderPL : public TerrainLoader {
00048 
00049 
00050     //[-------------------------------------------------------]
00051     //[ RTTI interface                                        ]
00052     //[-------------------------------------------------------]
00053     pl_class(PLS_RTTI_EXPORT, TerrainLoaderPL, "PLScene", PLScene::TerrainLoader, "Terrain loader implementation for the PixelLight terrain XML file format")
00054         // Properties
00055         pl_properties
00056             pl_property("Formats",  "terrain,TERRAIN")
00057             pl_property("Load",     "1")
00058             pl_property("Save",     "0")
00059         pl_properties_end
00060         // Methods
00061         pl_method_2(Load,   pl_ret_type(bool),  SNTerrain&, PLCore::File&,  "Load method",  "")
00062         pl_method_2(Save,   pl_ret_type(bool),  SNTerrain&, PLCore::File&,  "Save method",  "")
00063         // Constructors
00064         pl_constructor_0(DefaultConstructor,    "Default constructor",  "")
00065     pl_class_end
00066 
00067 
00068     //[-------------------------------------------------------]
00069     //[ Public RTTI methods                                   ]
00070     //[-------------------------------------------------------]
00071     public:
00072         PLS_API bool Load(SNTerrain &cSNTerrain, PLCore::File &cFile);
00073         PLS_API bool Save(SNTerrain &cSNTerrain, PLCore::File &cFile);
00074 
00075 
00076     //[-------------------------------------------------------]
00077     //[ Public functions                                      ]
00078     //[-------------------------------------------------------]
00079     public:
00080         /**
00081         *  @brief
00082         *    Default Constructor
00083         */
00084         PLS_API TerrainLoaderPL();
00085 
00086         /**
00087         *  @brief
00088         *    Destructor
00089         */
00090         PLS_API virtual ~TerrainLoaderPL();
00091 
00092 
00093     //[-------------------------------------------------------]
00094     //[ Private functions                                     ]
00095     //[-------------------------------------------------------]
00096     private:
00097         /**
00098         *  @brief
00099         *    Loader implementation for format version 1
00100         *
00101         *  @param[in] cSNTerrain
00102         *    Terrain to load into
00103         *  @param[in] cTerrainElement
00104         *    Terrain XML element to read the data from
00105         *
00106         *  @return
00107         *    'true' if all went fine, else 'false'
00108         */
00109         bool LoadV1(SNTerrain &cSNTerrain, const PLCore::XmlElement &cTerrainElement) const;
00110 
00111 
00112 };
00113 
00114 
00115 //[-------------------------------------------------------]
00116 //[ Namespace                                             ]
00117 //[-------------------------------------------------------]
00118 } // PLScene
00119 
00120 
00121 #endif // __PLSCENE_SCENENODE_TERRAINLOADER_PL_H__


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:04
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported