OLight.h

Go to the documentation of this file.

//========================================================================
// Copyright (c) 2003-2011 Anael Seghezzi <www.maratis3d.com>
// Copyright (c) 2014-2015 Yannick Pflanzer <www.neo-engine.de>
//
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented; you must not
//    claim that you wrote the original software. If you use this software
//    in a product, an acknowledgment in the product documentation would
//    be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such, and must not
//    be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source
//    distribution.
//
//========================================================================


#ifndef __OLIGHT_H
#define __OLIGHT_H

namespace Neo
{

// light types
enum LIGHT_TYPES
{
    LIGHT_POINT = 0,
    LIGHT_SPOT,
    LIGHT_DIRECTIONAL
};

class NEO_ENGINE_EXPORT OLight : public Object3d
{
public:

    // constructor / destructor
    OLight(void);
    ~OLight(void);

    // copy constructor
    OLight(const OLight & light);

private:

    // lightType
    LIGHT_TYPES m_lightType;
    
    // radius
    float m_radius;

    // color
    float m_intensity;
    Vector3 m_color;
    
    // spot
    float m_spotAngle;
    float m_spotExponent;
    
    // shadow
    bool m_shadow;
    float m_shadowBias;
    float m_shadowBlur;
    unsigned int m_shadowQuality;

public:

    // type
    virtual int getType(void){ return OBJECT3D_LIGHT; }

    inline void setLightType(LIGHT_TYPES lightType) { m_lightType = lightType; }
    
    inline LIGHT_TYPES getLightType(void) { return m_lightType; }

    inline void castShadow(bool shadow) { m_shadow = shadow; }

    inline void setShadowQuality(unsigned int shadowQuality)
    {
        m_shadowQuality = shadowQuality;
    }

    inline void setShadowBias(float shadowBias) { m_shadowBias = shadowBias; }

    inline void setShadowBlur(float shadowBlur) { m_shadowBlur = shadowBlur; }

    inline bool isCastingShadow(void) { return m_shadow; }

    inline unsigned int getShadowQuality(void) { return m_shadowQuality; }
    
    inline float getShadowBias(void) { return m_shadowBias; }
    
    inline float getShadowBlur(void) { return m_shadowBlur; }

    inline void setRadius(float radius) { m_radius = radius; }
    
    inline float getRadius(void) { return m_radius; }

    inline void setIntensity(float intensity) { m_intensity = intensity; }
    
    inline void setColor(const Vector3 &color) { m_color = color; }
    
    inline float getIntensity(void) { return m_intensity; }
    
    inline Vector3 getColor(void) const { return m_color; }
    
    inline Vector3 getFinalColor(void) const { return m_color * m_intensity; }

    inline void setSpotAngle(float angle)
    {
        m_spotAngle = CLAMP(angle, 0.0f, 180.0f);
    }

    inline void setSpotExponent(float exponent)
    {
        m_spotExponent = CLAMP(exponent, 0.0f, 1.0f);
    }

    inline float getSpotAngle(void) { return m_spotAngle; }
    
    inline float getSpotExponent(void) { return m_spotExponent; }

    // visibility
    virtual void updateVisibility(OCamera *camera);
};
}
#endif