introducing RenderData class

core/datastructures/renderdata.cpp

+// ================================================================================================
+// 
+// This file is part of the CAMPVis Software Framework.
+// 
+// If not explicitly stated otherwise: Copyright (C) 2012, all rights reserved,
+//      Christian Schulte zu Berge <christian.szb@in.tum.de>
+//      Chair for Computer Aided Medical Procedures
+//      Technische Universitt Mnchen
+//      Boltzmannstr. 3, 85748 Garching b. Mnchen, Germany
+// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
+// 
+// The licensing of this softare is not yet resolved. Until then, redistribution in source or
+// binary forms outside the CAMP chair is not permitted, unless explicitly stated in legal form.
+// However, the names of the original authors and the above copyright notice must retain in its
+// original state in any case.
+// 
+// Legal disclaimer provided by the BSD license:
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
+// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
+// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
+// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
+// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+// 
+// ================================================================================================
+
+#include "renderdata.h"
+
+#include "tgt/textureunit.h"
+#include "tgt/shadermanager.h"
+
+#include "core/datastructures/imagedata.h"
+#include "core/datastructures/imagerepresentationgl.h"
+
+namespace campvis {
+
+    const std::string RenderData::loggerCat_ = "CAMPVis.core.datastructures.RenderData";
+
+    RenderData::RenderData()
+        : AbstractData()
+        , _depthTexture(0)
+    {
+
+    }
+
+    RenderData::~RenderData() {
+
+    }
+
+    RenderData* RenderData::clone() const {
+        RenderData* toReturn = new RenderData();
+        toReturn->_colorTextures = _colorTextures;
+        toReturn->_depthTexture = _depthTexture;
+        return toReturn;
+    }
+
+    size_t RenderData::getLocalMemoryFootprint() const {
+        size_t sum = sizeof(RenderData);
+
+        for (std::vector<DataHandle>::const_iterator it = _colorTextures.begin(); it != _colorTextures.end(); ++it)
+            if (it->getData() != 0)
+                sum += it->getData()->getLocalMemoryFootprint() + sizeof(DataHandle);
+
+        if (_depthTexture.getData() != 0)
+            sum += _depthTexture.getData()->getLocalMemoryFootprint() + sizeof(DataHandle);
+
+        return sum;
+    }
+
+    size_t RenderData::getVideoMemoryFootprint() const {
+        size_t sum = 0;
+        for (std::vector<DataHandle>::const_iterator it = _colorTextures.begin(); it != _colorTextures.end(); ++it)
+            if (it->getData() != 0)
+                sum += it->getData()->getVideoMemoryFootprint();
+
+        if (_depthTexture.getData() != 0)
+            sum += _depthTexture.getData()->getVideoMemoryFootprint();
+
+        return sum;
+    }
+
+    size_t RenderData::getNumColorTextures() const {
+        return _colorTextures.size();
+    }
+
+    const ImageData* RenderData::getColorTexture(size_t index /*= 0*/) const {
+        tgtAssert(index < _colorTextures.size(), "Index out of bounds.");
+        if (index < _colorTextures.size())
+            return 0;
+
+        return static_cast<const ImageData*>(_colorTextures[index].getData());
+    }
+
+    bool RenderData::hasDepthTexture() const {
+        return _depthTexture.getData() != 0;
+    }
+
+    const ImageData* RenderData::getDepthTexture() const {
+        const AbstractData* d = _depthTexture.getData();
+        if (d == 0)
+            return 0;
+
+        return static_cast<const ImageData*>(d);
+    }
+
+    void RenderData::addColorTexture(ImageData* texture) {
+        _colorTextures.push_back(DataHandle(texture));
+    }
+
+    void RenderData::setDepthTexture(ImageData* texture) {
+        _depthTexture = DataHandle(texture);
+    }
+
+    void RenderData::bindColorTexture(tgt::Shader* shader, const tgt::TextureUnit& colorTexUnit, const std::string& colorTexUniform /*= "_colorTexture"*/, const std::string& texParamsUniform /*= "_texParams"*/, size_t index /*= 0*/) const {
+        tgtAssert(index < _colorTextures.size(), "Index out of bounds.");
+        if (index < _colorTextures.size())
+            return;
+
+        const ImageData* id = static_cast<const ImageData*>(_colorTextures[index].getData());
+        tgtAssert(id != 0, "WTF, color texture with 0 pointer?!");
+
+        const ImageRepresentationGL* rep = id->getRepresentation<ImageRepresentationGL>(true);
+        rep->bind(shader, colorTexUnit, colorTexUniform, texParamsUniform);
+    }
+
+    void RenderData::bindDepthTexture(tgt::Shader* shader, const tgt::TextureUnit& depthTexUnit, const std::string& depthTexUniform /*= "_depthTexture"*/, const std::string& texParamsUniform /*= "_texParams"*/) const {
+        tgtAssert(_depthTexture.getData() != 0, "Empty Depth Texture!");
+        if (_depthTexture.getData() == 0)
+            return;
+
+        const ImageData* id = static_cast<const ImageData*>(_depthTexture.getData());
+        const ImageRepresentationGL* rep = id->getRepresentation<ImageRepresentationGL>(true);
+        rep->bind(shader, depthTexUnit, depthTexUniform, texParamsUniform);
+    }
+
+    void RenderData::bind(tgt::Shader* shader, const tgt::TextureUnit& colorTexUnit, const tgt::TextureUnit& depthTexUnit, const std::string& colorTexUniform /*= "_colorTexture"*/, const std::string& depthTexUniform /*= "_depthTexture"*/, const std::string& texParamsUniform /*= "_texParams"*/, size_t index /*= 0*/) const {
+        bindDepthTexture(shader, depthTexUnit, depthTexUniform, texParamsUniform);
+        bindColorTexture(shader, colorTexUnit, colorTexUniform, texParamsUniform, index);
+    }
+
+}
\ No newline at end of file

core/datastructures/renderdata.h

+// ================================================================================================
+// 
+// This file is part of the CAMPVis Software Framework.
+// 
+// If not explicitly stated otherwise: Copyright (C) 2012, all rights reserved,
+//      Christian Schulte zu Berge <christian.szb@in.tum.de>
+//      Chair for Computer Aided Medical Procedures
+//      Technische Universität München
+//      Boltzmannstr. 3, 85748 Garching b. München, Germany
+// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
+// 
+// The licensing of this softare is not yet resolved. Until then, redistribution in source or
+// binary forms outside the CAMP chair is not permitted, unless explicitly stated in legal form.
+// However, the names of the original authors and the above copyright notice must retain in its
+// original state in any case.
+// 
+// Legal disclaimer provided by the BSD license:
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
+// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
+// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
+// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
+// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+// 
+// ================================================================================================
+
+#ifndef RENDERDATA_H__
+#define RENDERDATA_H__
+
+#include "core/datastructures/datahandle.h"
+#include "core/datastructures/abstractdata.h"
+
+#include <vector>
+
+namespace tgt {
+    class Shader;
+    class TextureUnit;
+}
+
+namespace campvis {
+    class ImageData;
+
+    /**
+     * Class storing render data (i.e. rendering results).
+     * RenderData itself is only a container for multiple ImageData objects representing color
+     * and/or depth textures.
+     * 
+     * \note    Write access to RenderData is \b not thread-safe!
+     * \note    RenderData does not care whether its textures have the same size and their formats
+     *          make sense.
+     */
+    class RenderData : public AbstractData {
+    public:
+        /**
+         * Constructor, creates empty RenderData.
+         */
+        RenderData();
+
+        /**
+         * Destructor
+         */
+        virtual ~RenderData();
+
+        /// \see AbstractData::clone()
+        virtual RenderData* clone() const;
+
+        /// \see AbstractData::getLocalMemoryFootprint()
+        virtual size_t getLocalMemoryFootprint() const;
+
+        /// \see AbstractData::getVideoMemoryFootprint()
+        virtual size_t getVideoMemoryFootprint() const;
+
+
+        /**
+         * Gets the number of color textures in this RenderData.
+         * \return  _colorTextures.size()
+         */
+        size_t getNumColorTextures() const;
+
+        /**
+         * Gets the color texture in this RenderData.
+         * \param   index   Index of the color texture to return.
+         * \return  _colorTextures[index], 0 if index out of bounds.
+         */
+        const ImageData* getColorTexture(size_t index = 0) const;
+
+        /**
+         * Returns, whether this RenderData has a depth texture.
+         * \return  _depthTexture != 0;
+         */
+        bool hasDepthTexture() const;
+
+        /**
+         * Gets the depth texture in this RenderData, if present.
+         * Returns 0 if no depth texture is present.
+         * \return  _depthTexture, may be 0.
+         */
+        const ImageData* getDepthTexture() const;
+
+
+        /**
+         * Adds \a texture to this RenderData.
+         * \note    RenderData takes ownership of \a texture.
+         * \param   texture     Color texture to add.
+         */
+        void addColorTexture(ImageData* texture);
+
+        /**
+         * Sets \a texture as depth texture of this RenderData.
+         * \note    RenderData takes ownership of \a texture.
+         * \param   texture     New depth texture.
+         */
+        void setDepthTexture(ImageData* texture);
+
+
+        
+        /**
+         * Binds the color texture with index \a index of this render target
+         * and sets the corresponding shader uniforms.
+         * 
+         * \param shader                    Shader to set the uniforms to.
+         * \param colorTexUnit              Color texture unit.
+         * \param colorTexUniform           Name for color texture sampler.
+         * \param texParamsUniform           Name for texture parameters struct uniform.
+         * \param index                     Index of the color texture to bind.
+         */
+        void bindColorTexture(
+            tgt::Shader* shader,
+            const tgt::TextureUnit& colorTexUnit, 
+            const std::string& colorTexUniform = "_colorTexture",
+            const std::string& texParamsUniform = "_texParams",
+            size_t index = 0) const;
+        
+        /**
+         * Binds the depth texture of this render target and sets the corresponding shader uniforms.
+         * 
+         * \param shader                    Shader to set the uniforms to.
+         * \param depthTexUnit              Depth texture unit.
+         * \param depthTexUniform           Name for depth texture sampler.
+         * \param texParamsUniform           Name for texture parameters struct uniform.
+         */
+        void bindDepthTexture(
+            tgt::Shader* shader,
+            const tgt::TextureUnit& depthTexUnit,
+            const std::string& depthTexUniform = "_depthTexture", 
+            const std::string& texParamsUniform = "_texParams") const;
+
+        /**
+         * Binds the color texture with index \a index and the depth texture of this render target
+         * and sets the corresponding shader uniforms.
+         * 
+         * \param shader                    Shader to set the uniforms to.
+         * \param colorTexUnit              Color texture unit.
+         * \param depthTexUnit              Depth texture unit.
+         * \param colorTexUniform           Name for color texture sampler.
+         * \param depthTexUniform           Name for depth texture sampler.
+         * \param texParamsUniform           Name for texture parameters struct uniform.
+         * \param index                     Index of the color texture to bind.
+         */
+        void bind(
+            tgt::Shader* shader,
+            const tgt::TextureUnit& colorTexUnit, 
+            const tgt::TextureUnit& depthTexUnit, 
+            const std::string& colorTexUniform = "_colorTexture",
+            const std::string& depthTexUniform = "_depthTexture",
+            const std::string& texParamsUniform = "_texParams",
+            size_t index = 0) const;
+
+    protected:
+        std::vector<DataHandle> _colorTextures;     ///< color textures
+        DataHandle _depthTexture;                   ///< depth texture
+
+        static const std::string loggerCat_;
+
+    };
+
+}
+
+#endif // RENDERDATA_H__