CSpotLight.h

Go to the documentation of this file.

//==============================================================================
/*
    Software License Agreement (BSD License)
    Copyright (c) 2003-2016, CHAI3D.
    (www.chai3d.org)

    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
    copyright notice, this list of conditions and the following
    disclaimer in the documentation and/or other materials provided
    with the distribution.

    * Neither the name of CHAI3D nor the names of its contributors may
    be used to endorse or promote products derived from this software
    without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE. 

    \author    <http://www.chai3d.org>
    \author    Francois Conti
    \version   3.2.0 $Rev: 2159 $
*/
//==============================================================================

//------------------------------------------------------------------------------
#ifndef CSpotLightH
#define CSpotLightH
//------------------------------------------------------------------------------
#include "lighting/CPositionalLight.h"
#include "lighting/CDirectionalLight.h"
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
namespace chai3d {
//------------------------------------------------------------------------------

//==============================================================================
//==============================================================================

//==============================================================================
//==============================================================================
class cSpotLight : public cPositionalLight, public cDirectionalLight
{
    //--------------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //--------------------------------------------------------------------------

public:

    cSpotLight(cWorld* a_world);
    
    virtual ~cSpotLight();


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - SHADOW CASTING:
    //--------------------------------------------------------------------------

public:

    bool updateShadowMap(const double a_mirrorH = 1.0, 
        const double a_mirrorV = 1.0);

    void setShadowMapProperties(const double& a_nearClippingPlane,
        const double& a_farClippingPlane);

    void setShadowMapEnabled(const bool a_enabled);

    bool getShadowMapEnabled() const;


    //--------------------------------------------------------------------------
    // PUBLIC MEMBERS - SHADOW CASTING:
    //--------------------------------------------------------------------------

public:

    cShadowMap* m_shadowMap;


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - LIGHTING PROPERTIES:
    //--------------------------------------------------------------------------

public:

    void setSpotExponent(const GLfloat& a_value) { m_spotExponent = cClamp(a_value, 0.0f, 100.0f); }

    GLfloat getSpotExponent() const { return (m_spotExponent); }
    
    void setCutOffAngleDeg(const GLfloat& a_angleDeg);

    GLfloat getCutOffAngleDeg() const { return (m_cutOffAngleDeg); }


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - DISPLAY MODEL:
    //--------------------------------------------------------------------------

public:

    void setDisplaySettings(const double& a_sourceRadius = 0.02, 
        const double& a_coneLength = 1.0, 
        const bool a_displayEnabled = true);


    //--------------------------------------------------------------------------
    // PUBLIC MEMBERS - DISPLAY MODEL:
    //--------------------------------------------------------------------------

public:

    cColorf m_displayConeColor;


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS - LIGHTING PROPERTIES
    //--------------------------------------------------------------------------

protected:

    GLfloat m_spotExponent;
    
    GLfloat m_cutOffAngleDeg;


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS - SHADOW CASTING
    //--------------------------------------------------------------------------

protected:

    double m_shadowNearClippingPlane;

    double m_shadowFarClippingPlane;


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS - DISPLAY MODEL:
    //--------------------------------------------------------------------------

protected:

    double m_displayConeLength;


    //--------------------------------------------------------------------------
    // PROTECTED VIRTUAL METHODS:
    //--------------------------------------------------------------------------

protected:

    virtual void renderLightSource(cRenderOptions& a_options);

    virtual void render(cRenderOptions& a_options);
};

//------------------------------------------------------------------------------
} // namespace chai3d
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
#endif
//------------------------------------------------------------------------------