 | PixelLight 0.9.11-R1 Copyright (C) 2002-2012 by The PixelLight Team Last modified Thu Feb 23 2012 14:08:52 |  | The content of this PixelLight
document is published under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported |
|
PixelLightAPI
.
|
00001 /*********************************************************\ 00002 * File: CamcorderLoaderPL.h * 00003 * 00004 * Copyright (C) 2002-2012 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 __PLENGINE_CAMCORDERLOADER_PL_H__ 00024 #define __PLENGINE_CAMCORDERLOADER_PL_H__ 00025 #pragma once 00026 00027 00028 //[-------------------------------------------------------] 00029 //[ Includes ] 00030 //[-------------------------------------------------------] 00031 #include "PLEngine/Tools/CamcorderLoader.h" 00032 00033 00034 //[-------------------------------------------------------] 00035 //[ Forward declarations ] 00036 //[-------------------------------------------------------] 00037 namespace PLCore { 00038 class XmlElement; 00039 } 00040 namespace PLEngine { 00041 class Camcorder; 00042 } 00043 00044 00045 //[-------------------------------------------------------] 00046 //[ Namespace ] 00047 //[-------------------------------------------------------] 00048 namespace PLEngine { 00049 00050 00051 //[-------------------------------------------------------] 00052 //[ Classes ] 00053 //[-------------------------------------------------------] 00054 /** 00055 * @brief 00056 * Camcorder loader implementation for the PixelLight camcorder XML file format 00057 */ 00058 class CamcorderLoaderPL : public CamcorderLoader { 00059 00060 00061 //[-------------------------------------------------------] 00062 //[ RTTI interface ] 00063 //[-------------------------------------------------------] 00064 pl_class(PL_RTTI_EXPORT, CamcorderLoaderPL, "PLEngine", PLEngine::CamcorderLoader, "Camcorder loader implementation for the PixelLight camcorder XML file format") 00065 // Properties 00066 pl_properties 00067 pl_property("Formats", "cam,CAM") 00068 pl_property("Load", "1") 00069 pl_property("Save", "1") 00070 pl_properties_end 00071 // Constructors 00072 pl_constructor_0(DefaultConstructor, "Default constructor", "") 00073 // Methods 00074 pl_method_2(Load, pl_ret_type(bool), Camcorder&, PLCore::File&, "Load method", "") 00075 pl_method_2(Save, pl_ret_type(bool), Camcorder&, PLCore::File&, "Save method", "") 00076 pl_class_end 00077 00078 00079 //[-------------------------------------------------------] 00080 //[ Public RTTI methods ] 00081 //[-------------------------------------------------------] 00082 public: 00083 PL_API bool Load(Camcorder &cCamcorder, PLCore::File &cFile); 00084 PL_API bool Save(Camcorder &cCamcorder, PLCore::File &cFile); 00085 00086 00087 //[-------------------------------------------------------] 00088 //[ Public functions ] 00089 //[-------------------------------------------------------] 00090 public: 00091 /** 00092 * @brief 00093 * Default constructor 00094 */ 00095 PL_API CamcorderLoaderPL(); 00096 00097 /** 00098 * @brief 00099 * Destructor 00100 */ 00101 PL_API virtual ~CamcorderLoaderPL(); 00102 00103 00104 //[-------------------------------------------------------] 00105 //[ Private functions ] 00106 //[-------------------------------------------------------] 00107 private: 00108 /** 00109 * @brief 00110 * Loader implementation for format version 1 00111 * 00112 * @param[in] cCamcorder 00113 * Camcorder to load into 00114 * @param[in] cCamcorderElement 00115 * Camcorder XML element to read the data from 00116 * @param[in] cFile 00117 * File to load from 00118 * 00119 * @return 00120 * 'true' if all went fine, else 'false' 00121 */ 00122 bool LoadV1(Camcorder &cCamcorder, const PLCore::XmlElement &cCamcorderElement, PLCore::File &cFile) const; 00123 00124 00125 }; 00126 00127 00128 //[-------------------------------------------------------] 00129 //[ Namespace ] 00130 //[-------------------------------------------------------] 00131 } // PLEngine 00132 00133 00134 #endif // __PLENGINE_CAMCORDERLOADER_PL_H__
|