SO3ScreenshotManager.cpp

Go to the documentation of this file.

 
#include "SO3Renderer/SO3ScreenshotManager.h"
#include "SO3Renderer/SO3Root.h"
#include "SO3Renderer/SO3Window.h"
#include "SO3SceneGraph/SO3Camera.h"
#include "SO3Utils/SO3ConversionTools.h"
#include "SO3SceneGraph/SO3Scene.h"
 
#include "OgreMemoryAllocatorConfig.h"
 
namespace SO3
{
  SScreenshotManager::SScreenshotManager()
  {
    // Forbiden constructor (private).
  }
 
  SScreenshotManager::SScreenshotManager(SViewPort* viewport, unsigned int width, unsigned int height, bool withOverlays, bool transparentBackground)
  {
    mViewport = viewport;
    mDestWidth = width;
    mDestHeight = height;
    mEnableOverlays = withOverlays;
    mTransparentBackground = transparentBackground;
 
    mWindowWidth = mViewport->GetWidthPixels();
    mWindowHeight = mViewport->GetHeightPixels();
    mWidthGridSize = (((float)width / (float)mWindowWidth) > (width / mWindowWidth)) ? (width / mWindowWidth) + 1 : (width / mWindowWidth);
    mHeightGridSize = (((float)height / (float)mWindowHeight) > (height / mWindowHeight)) ? (height / mWindowHeight) + 1 : (height / mWindowHeight);
 
    //temp texture with current screensize
    Ogre::PixelFormat pformat = (mTransparentBackground) ? Ogre::PF_B8G8R8A8 : Ogre::PF_B8G8R8;
    mTempTex = Ogre::TextureManager::getSingleton().createManual(mViewport->GetCamera()->GetName() + "/ScreenShotTex", SO3_INTERNAL_RESOURCE_GROUP, Ogre::TEX_TYPE_2D, mWindowWidth, mWindowHeight, 0, pformat, Ogre::TU_RENDERTARGET, 0, false, 4);
 
    mRT = mTempTex->getBuffer()->getRenderTarget();
    mBuffer = mTempTex->getBuffer();
 
    mData = new uint8[(mWindowWidth * mWidthGridSize) * (mWindowHeight * mHeightGridSize) * Ogre::PixelUtil::getNumElemBytes(mRT->suggestPixelFormat())];
    mFinalPicturePB = Ogre::PixelBox(mWindowWidth * mWidthGridSize, mWindowHeight * mHeightGridSize, 1, mRT->suggestPixelFormat(), mData);
  }
 
  SScreenshotManager::~SScreenshotManager()
  {
    if (mData)
      delete[] mData;
 
    if (mTempTex)
    {
      Ogre::TextureManager::getSingleton().remove(mTempTex->getHandle());
      mTempTex.reset();
    }
  }
 
  void SScreenshotManager::MakeScreenshot(std::string filename)
  {
    SWindow* cwindow = mViewport->GetParentWindow();
    StereoManager::StereoMode stereoMode = cwindow->GetStereoMode();
    if (stereoMode != StereoManager::SO3_NONE_STEREO)
      cwindow->SetStereoMode(StereoManager::SO3_NONE_STEREO);
 
    //Remove all viewports, so the added Viewport(camera) ist the only
    Ogre::Camera* camera = mViewport->GetCamera()->GetOgreCameraPointer();
    mRT->removeAllViewports();
    mRT->addViewport(camera);
 
    Ogre::Vector2 foffset = camera->getFrustumOffset();
    Ogre::Real lodBias = camera->getLodBias();
    bool bmatrix = camera->isCustomProjectionMatrixEnabled();
    Ogre::Matrix4 cmatrix = camera->getProjectionMatrix();
    bool autoRatio = camera->getAutoAspectRatio();
    float prevRatio = camera->getAspectRatio();
    camera->setAspectRatio((float)mDestWidth / (float)mDestHeight);
    camera->setFrustumOffset(Ogre::Vector2(0.0f, 0.0f));
    camera->setLodBias(10.0f);
    camera->setCustomProjectionMatrix(false);
 
    //set the viewport settings
    Ogre::Viewport *vp = mRT->getViewport(0);
    vp->setClearEveryFrame(true);
 
    Ogre::ColourValue bgcolor = (mTransparentBackground) ? Ogre::ColourValue(1.0f, 1.0f, 1.0f, 0.0f) : mViewport->GetOgreViewPortPointer()->getBackgroundColour();
    vp->setBackgroundColour(bgcolor);
    vp->setOverlaysEnabled(mEnableOverlays);
    vp->setMaterialScheme(mViewport->GetMaterialScheme());
 
    if (mWidthGridSize <= 1 && mHeightGridSize <= 1)
    {
      // Simple case where the contents of the screen are taken directly
      // Also used when an invalid value is passed within gridSize (zero or negative grid size)
      mRT->update();
 
      Ogre::PixelBox pb(mWindowWidth, mWindowHeight, 1, mRT->suggestPixelFormat());
      pb.data = new uint8[pb.getConsecutiveSize()];
      mRT->copyContentsToMemory(pb, pb);
 
      Ogre::PixelBox sizedImage = Ogre::PixelBox(mDestWidth, mDestHeight, 1, mRT->suggestPixelFormat());
      sizedImage.data = new uint8[sizedImage.getConsecutiveSize()];
      Ogre::Image::scale(pb, sizedImage);
 
      Ogre::Image finalImage;
      finalImage.loadDynamicImage(static_cast<unsigned char*>(sizedImage.data), sizedImage.getWidth(), sizedImage.getHeight(), mRT->suggestPixelFormat());
 
      //write the file on the Harddisk
      finalImage.save(filename);
      delete[] pb.data;
      delete[] sizedImage.data;
    }
    else
    {
      // do not repeat overlays
      vp->setOverlaysEnabled(false);
 
      // set the original Frustum extents
      Ogre::RealRect originalFrustum = camera->getFrustumExtents();
 
      // compute the Stepsize for the drid
      Ogre::Real frustumGridStepHorizontal = (originalFrustum.right * 2) / mWidthGridSize;
      Ogre::Real frustumGridStepVertical = (originalFrustum.top * 2) / mHeightGridSize;
 
      // process each grid
      Ogre::Real frustumLeft, frustumRight, frustumTop, frustumBottom;
 
      for (unsigned int y = 0; y < mHeightGridSize; y++)
      {
        for (unsigned int x = 0; x < mWidthGridSize; x++)
        {
          // compute the new frustum extents
          frustumLeft = originalFrustum.left + frustumGridStepHorizontal * x;
          frustumRight = frustumLeft + frustumGridStepHorizontal;
          frustumTop = originalFrustum.top - frustumGridStepVertical * y;
          frustumBottom = frustumTop - frustumGridStepVertical;
 
          // set the frustum extents value to the camera
          camera->setFrustumExtents(frustumLeft, frustumRight, frustumTop, frustumBottom);
 
          // ignore time duration between frames
          SRoot::getSingletonPtr()->GetOgreRootPointer()->clearEventTimes();
          mRT->update();//render
 
          //define the current 
          Ogre::Box subBox = Ogre::Box(x * mWindowWidth, y * mWindowHeight, x * mWindowWidth + mWindowWidth, y * mWindowHeight + mWindowHeight);
 
          //copy the content from the temp buffer into the final picture PixelBox 
          //Place the tempBuffer content at the right position
          mBuffer->blitToMemory(mFinalPicturePB.getSubVolume(subBox));
        }
      }
 
      // set frustum extents to previous settings
      camera->resetFrustumExtents();
 
      //insert the PixelBox data into the Image Object
      Ogre::PixelBox sizedImage = Ogre::PixelBox(mDestWidth, mDestHeight, 1, mRT->suggestPixelFormat());
      sizedImage.data = new uint8[sizedImage.getConsecutiveSize()];
      Ogre::Image::scale(mFinalPicturePB, sizedImage);
 
      Ogre::Image finalImage;
      finalImage.loadDynamicImage(static_cast<unsigned char*>(sizedImage.data), sizedImage.getWidth(), sizedImage.getHeight(), mRT->suggestPixelFormat());
      // Save the Final image to a file
      finalImage.save(filename);
      delete[] sizedImage.data;
    }
 
    //restore auto ratio
    camera->setAutoAspectRatio(autoRatio);
    camera->setAspectRatio(prevRatio);
    camera->setFrustumOffset(foffset);
    camera->setLodBias(lodBias);
    camera->setCustomProjectionMatrix(bmatrix, cmatrix);
 
    // reset time since last frame to pause the scene
    SRoot::getSingletonPtr()->GetOgreRootPointer()->clearEventTimes();
 
    if (stereoMode != StereoManager::SO3_NONE_STEREO)
      cwindow->SetStereoMode(stereoMode);
  }
 
}