ImageNode.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of FRAPPER
research.animationsinstitut.de
sourceforge.net/projects/frapper

Copyright (c) 2008-2009 Filmakademie Baden-Wuerttemberg, Institute of Animation 

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; version 2.1 of the License.

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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
-----------------------------------------------------------------------------
*/


#ifndef IMAGENODE_H
#define IMAGENODE_H

#include "FrapperPrerequisites.h"
#include "ViewNode.h"
#include <Ogre.h>

#if (OGRE_PLATFORM  == OGRE_PLATFORM_WIN32)
#include <windows.h>
#endif

namespace Frapper {

class FRAPPER_CORE_EXPORT ImageNode : public ViewNode
{

    Q_OBJECT

public: // static constants

    static const int NumberUnknown = -1;

public: // constructors and destructors

    ImageNode ( const QString &name, ParameterGroup *parameterRoot, bool cacheEnabled = true, const QString &outputImageName = "Image" );

    virtual ~ImageNode ();

public: // functions

    virtual Ogre::TexturePtr getImage ();

    bool isCached ( int index ) const;

    Ogre::Image * getCachedImage ( int index ) const;

    public slots: //

        void clearImageCache ();

protected: // functions

    void setNumberOfImagesToCache ( unsigned int numberOfImagesToCache );

    Ogre::Image * createImageFromTexture ( Ogre::TexturePtr texturePointer );

    void cacheImage ( int index, Ogre::Image *image );

    void setOutputImage ( Ogre::Image *image );

private: // functions

    void updateCacheStatus ();

protected: // data

    bool m_cacheEnabled;

    bool m_cacheInvalid;

    QString m_outputImageName;

    int m_numberOfImagesToCache;

    QMap<int, Ogre::Image *> m_imageCache;

};

} // end namespace Frapper

#endif