OpenWalnut  1.4.0
WGEProjectFileIO.h
00001 //---------------------------------------------------------------------------
00002 //
00003 // Project: OpenWalnut ( http://www.openwalnut.org )
00004 //
00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
00006 // For more information see http://www.openwalnut.org/copying
00007 //
00008 // This file is part of OpenWalnut.
00009 //
00010 // OpenWalnut is free software: you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as published by
00012 // the Free Software Foundation, either version 3 of the License, or
00013 // (at your option) any later version.
00014 //
00015 // OpenWalnut is distributed in the hope that it will be useful,
00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018 // GNU Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public License
00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
00022 //
00023 //---------------------------------------------------------------------------
00024 
00025 #ifndef WGEPROJECTFILEIO_H
00026 #define WGEPROJECTFILEIO_H
00027 
00028 #include <string>
00029 #include <map>
00030 
00031 #include <osg/Matrixd>
00032 
00033 #include "../common/WProjectFileIO.h"
00034 
00035 class WProjectFile;
00036 
00037 /**
00038  * IO class for writing the graphics engine state to a project file. Currently it only writes the camera settings for the main view with the
00039  * WGEZoomTrackbalManipulator.
00040  */
00041 class WGEProjectFileIO: public WProjectFileIO
00042 {
00043 public:
00044     /**
00045      * Default constructor.
00046      */
00047     WGEProjectFileIO();
00048 
00049     /**
00050      * Destructor.
00051      */
00052     virtual ~WGEProjectFileIO();
00053 
00054     /**
00055      * This method parses the specified line and interprets it. It gets called line by line by WProjectFile.
00056      *
00057      * \param line the current line as string
00058      * \param lineNumber the current line number. Useful for error/warning/debugging output.
00059      *
00060      * \return true if the line could be parsed.
00061      */
00062     virtual bool parse( std::string line, unsigned int lineNumber );
00063 
00064     /**
00065      * Called whenever the end of the project file has been reached. This is useful if your specific parser class wants to do some post
00066      * processing after parsing line by line.
00067      */
00068     virtual void done();
00069 
00070     /**
00071      * Saves the state to the specified stream.
00072      *
00073      * \param output the stream to print the state to.
00074      */
00075     virtual void save( std::ostream& output );   // NOLINT
00076 
00077     /**
00078      * Create a clone of the IO. This is especially useful for custom parsers registered at \ref WProjectFile::registerParser. Implement this
00079      * function.
00080      *
00081      * \param project the project file using this parser instance.
00082      *
00083      * \return Cloned instance.
00084      */
00085     virtual SPtr clone( WProjectFile* project ) const;
00086 
00087 protected:
00088     /**
00089      * All Cameras parsed.
00090      */
00091     typedef std::map< unsigned int, std::string > CameraList;
00092 
00093     /**
00094      * Camera map.
00095      */
00096     CameraList m_cameras;
00097 
00098     /**
00099      * All view's manipulator matrices.
00100      */
00101     std::map< unsigned int, osg::Matrixd > m_manipulatorMatrices;
00102 
00103     /**
00104      * The home position eye point.
00105      */
00106     std::map< unsigned int, osg::Vec3d > m_homeEyeVectors;
00107 
00108     /**
00109      * The home position center point.
00110      */
00111     std::map< unsigned int, osg::Vec3d > m_homeCenterVectors;
00112 
00113     /**
00114      * The home position up vector.
00115      */
00116     std::map< unsigned int, osg::Vec3d > m_homeUpVectors;
00117 
00118 private:
00119 };
00120 
00121 #endif  // WGEPROJECTFILEIO_H
00122