ImageStarfield.h

/*
This file is part of Caelum.
See http://www.ogre3d.org/wiki/index.php/Caelum 

Copyright (c) 2006-2008 Caelum team. See Contributors.txt for details.

Caelum 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, either version 3 of the License, or
(at your option) any later version.

Caelum 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 Caelum. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef CAELUM__IMAGE_STARFIELD_H
#define CAELUM__IMAGE_STARFIELD_H

#include "CaelumPrerequisites.h"
#include "CameraBoundElement.h"
#include "PrivatePtr.h"

namespace Caelum
{
    class CAELUM_EXPORT ImageStarfield : public CameraBoundElement
    {
    protected:
        PrivateSceneNodePtr mNode;

        PrivateMaterialPtr mStarfieldMaterial;

        PrivateEntityPtr mEntity;

        static const Ogre::String STARFIELD_DOME_NAME;

        static const Ogre::String STARFIELD_MATERIAL_NAME;

        Ogre::Degree mInclination;

    public:
        static const String DEFAULT_TEXTURE_NAME;

        ImageStarfield (
                Ogre::SceneManager *sceneMgr,
                Ogre::SceneNode *caelumRootNode,
                const Ogre::String &textureName = DEFAULT_TEXTURE_NAME);

        virtual ~ImageStarfield ();

        void setInclination (Ogre::Degree inc);

        void update (const float time);

        void setTexture (const Ogre::String &mapName);

    public:
        virtual void notifyCameraChanged (Ogre::Camera *cam);

    protected:
        virtual void setFarRadius (Ogre::Real radius);

    public:
        void setQueryFlags (uint flags) { mEntity->setQueryFlags (flags); }
        uint getQueryFlags () const { return mEntity->getQueryFlags (); }
        void setVisibilityFlags (uint flags) { mEntity->setVisibilityFlags (flags); }
        uint getVisibilityFlags () const { return mEntity->getVisibilityFlags (); }
    };
}

#endif // CAELUM__IMAGE_STARFIELD_H