SkyLight.h

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

Copyright (c) 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__SKYLIGHT_H
#define CAELUM__SKYLIGHT_H

#include "CameraBoundElement.h"

namespace Caelum
{
    class CAELUM_EXPORT BaseSkyLight : public CameraBoundElement
    {
    protected:
        Ogre::Light *mMainLight;

        Ogre::SceneNode *mNode;

        float mRadius;

        Ogre::Vector3 mDirection;
        
        Ogre::ColourValue mBodyColour;

        Ogre::ColourValue mLightColour;

        Ogre::ColourValue mDiffuseMultiplier;

        Ogre::ColourValue mSpecularMultiplier;

        Ogre::ColourValue mAmbientMultiplier;

        bool mAutoDisableLight;

        Ogre::Real mAutoDisableThreshold;

        bool mForceDisableLight;

    public:
        BaseSkyLight (
                Ogre::SceneManager *sceneMgr,
                Ogre::SceneNode *caelumRootNode);

        virtual ~BaseSkyLight () = 0;

        virtual void update (
                const Ogre::Vector3& direction,
                const Ogre::ColourValue &lightColour,
                const Ogre::ColourValue &bodyColour);

        const Ogre::Vector3 getLightDirection () const;

        virtual void setLightDirection (const Ogre::Vector3 &dir);

        const Ogre::ColourValue getBodyColour () const;

        virtual void setBodyColour (const Ogre::ColourValue &colour);

        const Ogre::ColourValue getLightColour () const;

        virtual void setLightColour (const Ogre::ColourValue &colour);

        void setDiffuseMultiplier (const Ogre::ColourValue &diffuse);

        const Ogre::ColourValue getDiffuseMultiplier () const;

        void setSpecularMultiplier (const Ogre::ColourValue &specular);

        const Ogre::ColourValue getSpecularMultiplier () const;

        void setAmbientMultiplier (const Ogre::ColourValue &ambient);

        const Ogre::ColourValue getAmbientMultiplier () const;

        Ogre::Light* getMainLight() const;

        inline bool getAutoDisable() const { return mAutoDisableLight; }

        inline void setAutoDisable(bool value) { mAutoDisableLight = value; }

        inline Ogre::Real getAutoDisableThreshold() const { return mAutoDisableThreshold; }

        inline void setAutoDisableThreshold(Ogre::Real value) { mAutoDisableThreshold = value; }

        static const Ogre::Real DEFAULT_AUTO_DISABLE_THRESHOLD;

        inline void setForceDisable(bool value) { mForceDisableLight = value; } 
        inline bool getForceDisable() const { return mForceDisableLight; }

        virtual void setQueryFlags (uint flags) = 0;
        virtual uint getQueryFlags () const = 0;
        virtual void setVisibilityFlags (uint flags) = 0;
        virtual uint getVisibilityFlags () const = 0;

    protected:
        virtual void setFarRadius (Ogre::Real radius);
        
        void setMainLightColour(const Ogre::ColourValue &colour);

        bool shouldEnableLight(const Ogre::ColourValue &colour);
    };
}

#endif // CAELUM__SKYLIGHT_H