Changeset 8232 for code/trunk/src/modules/designtools/ScreenshotManager.h

Timestamp:

Apr 11, 2011, 7:37:00 PM (13 years ago)

Author:

dafrick

Message:

Extending and reorganizing ScreenshotManager and SkyboxGenerator.
The SkyboxGenerator now takes HD screenshots, thus the size of the faces generated by the SkyboxGenerator can now be specified freely (through a config value).

File:

• code/trunk/src/modules/designtools/ScreenshotManager.h (modified) (4 diffs)

code/trunk/src/modules/designtools/ScreenshotManager.h

@@ -1 @@
-/* COPYRIGHT: this code comes from http://www.ogre3d.org/wiki/index.php/High_resolution_screenshots */
+/*
+ *   ORXONOX - the hottest 3D action shooter ever to exist
+ *                    > www.orxonox.net <
+ *
+ *
+ *   License notice:
+ *
+ *   This program 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.
+ *
+ *   This program 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 this program; if not, write to the Free Software
+ *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ *   Author:
+ *      This code comes from http://www.ogre3d.org/tikiwiki/High+resolution+screenshots which is Public Domain.
+ *   Co-authors:
+ *      Oli Scheuss
+ *      Damian 'Mozork' Frick
+ *
+ */
+
+/**
+   @file ScreenshotManager.h
+   @brief Definition of the ScreenshotManager class.
+   @ingroup Designtools
+*/
 
 #ifndef __ScreenshotManager_h__
@@ -5 +38 @@
 
 #include "DesignToolsPrereqs.h"
-
-#include <string>
-#include <cstring>
-#include <cstdlib>
 
 #include <OgrePrerequisites.h>
@@ -22 +51 @@
     /**
     @brief
-        Class encapsulates Screenshot functionality and provides a method for making multi grid screenshots.
+        Class encapsulates screenshot functionality and provides a method for making multi grid (i.e. HD) screenshots.
+        
+        
+    @author
+        This code comes from http://www.ogre3d.org/tikiwiki/High+resolution+screenshots which is Public Domain.
+    @author
+        Oli Scheuss
+    @author
+        Damian 'Mozork' Frick
+    @ingroup Designtools
     */
     class ScreenshotManager : public OrxonoxClass, public Singleton<ScreenshotManager>
@@ -31 +69 @@
             ScreenshotManager();
             virtual ~ScreenshotManager();
+            void setConfigValues(void); // Sets some config values.
 
-            void makeScreenshot() const; //!< Creates a screenshot with the given camera.
+            void makeScreenshot(); // Make a screenshot.
+            Ogre::Image* getScreenshot(); // Creates a screenshot and returns it.
+            Ogre::Image* getScreenshot(Ogre::Camera* camera); // Creates a screenshot with the given camera and returns it.
 
             /**
-            @brief Creates a screenshot with a given size.
-            @param size Size is factor by which the current screen size is scaled.
+            @brief Creates a screenshot.
             */
-            static void makeScreenshot_s(unsigned int size)
-                { getInstance().setGridSize(size); getInstance().makeScreenshot(); }
+            static void makeScreenshot_s()
+                { ScreenshotManager::getInstance().makeScreenshot(); }
 
-            void setGridSize(unsigned int size); //!< Set the size of the grid.
+            void setGridSize(unsigned int size); // Set the size of the grid.
+            /**
+            @brief Get the current grid size.
+            @return Returns the size of the grid.
+            */
+            inline unsigned int getGridSize(void)
+                { return this->gridSize_; }
+            
+        protected:
+            void update(void); // Update internal parameters.
+            
+            static ScreenshotManager* singletonPtr_s;
 
-        protected:
-            static std::string getTimestamp();
+            std::string fileExtension_; //!< The image extension used to save the screenshot.
+            unsigned int gridSize_; //!< The magnification factor.  A 2 will create a 2x2 grid, doubling the size of the screenshot.  A 3 will create a 3x3 grid, tripling the size of the screenshot.
+            unsigned int windowWidth_, windowHeight_; //!< The width and height of the window.
+            bool disableOverlays_; //!< Whether overlays should be disabled.
 
-            std::string mFileExtension_;
-            unsigned int mGridSize_; //!< The magnification factor.  A 2 will create a 2x2 grid, doubling the size of the screenshot.  A 3 will create a 3x3 grid, tripling the size of the screenshot.
-            unsigned int mWindowWidth_, mWindowHeight_;
-            bool mDisableOverlays_;
-            //! temp texture with current screensize
-            Ogre::TexturePtr mTempTex_;
-            Ogre::RenderTexture* mRT_;
-            Ogre::HardwarePixelBufferSharedPtr mBuffer_;
-            //! PixelBox for a large Screenshot, if grid size is > 1
-            Ogre::PixelBox  mFinalPicturePB_;
-            uint8_t* data_;
+            Ogre::TexturePtr tempTexture_; //!< Temporary texture with current screen size.
+            Ogre::RenderTexture* renderTarget_; //!< Render target for the temporary texture.
+            Ogre::HardwarePixelBufferSharedPtr buffer_; //!< Buffer for the temporary texture.
+            
+            Ogre::PixelBox finalPicturePB_; //!< PixelBox for large screenshots, contains the screenshot for gridSize_ > 1.
+            uint8_t* data_; //!< Data pointer for the PixelBox.
 
-            static ScreenshotManager* singletonPtr_s;
     };