CWorld.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 CWorldH
#define CWorldH
//------------------------------------------------------------------------------
#include "display/CCamera.h"
#include "graphics/CColor.h"
#include "graphics/CTriangleArray.h"
#include "graphics/CFog.h"
#include "materials/CTexture2d.h"
#include "world/CGenericObject.h"
//------------------------------------------------------------------------------
#include <vector>
//------------------------------------------------------------------------------

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

//------------------------------------------------------------------------------
class cGenericLight;
class cShadowMap;
//------------------------------------------------------------------------------
#define C_MAXIMUM_OPENGL_LIGHT_COUNT 8
//------------------------------------------------------------------------------

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

//==============================================================================
//==============================================================================
class cWorld : public cGenericObject
{
    friend class cGenericLight;

    //--------------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //--------------------------------------------------------------------------

public:

    cWorld();
    
    virtual ~cWorld();


    //--------------------------------------------------------------------------
    // PUBLIC METHODS - BACKGROUND PROPERTIES
    //--------------------------------------------------------------------------

public:

    void setBackgroundColor(const GLfloat a_red, 
                            const GLfloat a_green,
                            const GLfloat a_blue);

    void setBackgroundColor(const cColorf& a_color);

    cColorf getBackgroundColor() const { return (m_backgroundColor); }


    //-----------------------------------------------------------------------
    // PUBLIC METHODS - LIGHT SOURCES:
    //-----------------------------------------------------------------------

public:

    void enableLightSourceRendering(bool enable) { m_renderLightSources = enable; }

    virtual cGenericLight* getLightSource(int index);  


    //-----------------------------------------------------------------------
    // PUBLIC METHODS - COLLISION / INTERACTION:
    //-----------------------------------------------------------------------

public:

    virtual bool computeCollisionDetection(const cVector3d& a_segmentPointA,
                                           const cVector3d& a_segmentPointB,
                                           cCollisionRecorder& a_recorder,
                                           cCollisionSettings& a_settings);

    virtual void computeLocalInteraction(const cVector3d& a_toolPos,
                                         const cVector3d& a_toolVel,
                                         const unsigned int a_IDN);


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

public:

    void setUseShadowCasting(bool a_enabled) { m_useShadowCasting = a_enabled; }

    bool getUseShadowCastring() { return(m_useShadowCasting); }

    void setShadowIntensity(double a_intensity) { m_shadowIntensity = cClamp01(a_intensity); }

    // This method returns the shadow intensity.
    double getShadowIntensity() { return (m_shadowIntensity); }

    virtual bool updateShadowMaps(const bool a_mirrorX = false,
                                  const bool a_mirrorY = false);


    //--------------------------------------------------------------------------
    // PUBLIC MEMBERS:
    //--------------------------------------------------------------------------

public:

    cColorf m_backgroundColor;
    
    cFog* m_fog;

    std::vector<cGenericLight*> m_lights;

    std::list<cShadowMap*> m_shadowMaps;

    double m_worldModelView[16];


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

protected:

    virtual void render(cRenderOptions& a_options);


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

protected:

    bool addLightSource(cGenericLight* a_light);

    bool removeLightSource(cGenericLight* a_light);

    bool isShadowCastingSupported();


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS:
    //--------------------------------------------------------------------------

protected:

    bool m_renderLightSources; 

    double m_shadowIntensity;

    bool m_useShadowCasting;
};

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

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