DynamicRenderable.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_DYNAMICRENDERABLE_H_
#define _MIRA_DYNAMICRENDERABLE_H_

#include <visualization/GuiVisualizationExports.h>

#ifndef Q_MOC_RUN
#include <OGRE/OgreSimpleRenderable.h>
#endif

#include <utils/EnumToFlags.h>

namespace mira {


class MIRA_GUI_VISUALIZATION_EXPORT DynamicRenderable : public Ogre::SimpleRenderable
{
public:
    DynamicRenderable();
    virtual ~DynamicRenderable();

    void initialize(Ogre::RenderOperation::OperationType operationType,
            const Ogre::VertexDeclaration& vertexDecl, bool useIndices);

    void setOperationType(Ogre::RenderOperation::OperationType operationType);

    void enableIndexBuffer(bool enable=true);


    enum Flags
    {
        NONE = 0,
        INDEX_BUFFER_32BIT = 1,  
    };
    MIRA_ENUM_TO_FLAGS_INCLASS(Flags);

    void prepareBuffers(size_t vertexCount, size_t indexCount=0,
                        Flags flags = NONE,
                        Ogre::HardwareBuffer::Usage usage=Ogre::HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY);

    void updateVertexCount(size_t vertexCount);

    Ogre::HardwareVertexBufferSharedPtr getVertexBuffer(unsigned short index = 0);

    Ogre::HardwareIndexBufferSharedPtr getIndexBuffer();


public:

    virtual Ogre::Real getBoundingRadius(void) const;
    virtual Ogre::Real getSquaredViewDepth(const Ogre::Camera* cam) const;

#if OGRE_VERSION < 0x11000
    // workaround for buggy implementation not respecting mRenderQueuePriority,
    // fixed in OGRE 1.10
public:

    virtual void _updateRenderQueue(Ogre::RenderQueue* queue) {
        queue->addRenderable( this, mRenderQueueID, mRenderQueuePriority);
    }
#endif

protected:
    size_t mVertexBufferCapacity;
    size_t mIndexBufferCapacity;
};


}

#endif