VRS - The Virtual Rendering System

version 3.3

sky.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2002 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  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 2.1 of the License, or (at
 * your option) any later version. This library  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 this library; if
 * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: sky.h 4633 2005-01-03 01:43:11Z klimetschek $
// $Date: 2005-01-03 02:43:11 +0100 (Mon, 03 Jan 2005) $
// $Revision: 4633 $
// $State$
// $Author: klimetschek $
//
// $Log$
// Revision 1.18  2005/01/03 01:43:08  klimetschek
// - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
// - removed vrs.vcproj
// minor things:
// - added all glutexamples to vrs4glut.sln
// - fixed some problems in glutexamples
// - removed all project references from all VS projects (using solution wide project dependencies instead)
//
// Revision 1.17  2004/11/05 13:58:09  basch
// Class comment changed (Doxygen style)
//
// Revision 1.16  2004/03/12 16:28:39  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.15  2004/01/19 11:43:57  baumann
// serialization mechanism improved
//
// Revision 1.14  2003/11/07 14:19:24  kirsch
// removed leading underscore from include guards
//
// Revision 1.13  2003/07/23 17:04:49  baumann
// code cleanup (especially untabified)
//
// Revision 1.12  2002/10/27 10:13:26  skirsch
// added trubidity and tessellation error setting
//
// Revision 1.11  2002/10/07 07:57:49  skirsch
// added sun direction support to the constructor
//
// Revision 1.10  2002/10/02 13:31:05  skirsch
// changed comment on the calcRealSkyColors method
//
// Revision 1.9  2002/09/30 13:34:40  skirsch
// changed the default behavior of the sky
//
// Revision 1.8  2002/09/25 17:54:35  skirsch
// moved the colorModified activation to the modified call
// fixed a bug with the serialization
//
// Revision 1.7  2002/09/25 08:29:13  skirsch
// changed the default position of the sun
// fixed a bug with opengl culling
// added structures to supply sky specific color
//
// Revision 1.6  2002/09/20 09:37:48  skirsch
// added sun position calculation
//
// Revision 1.5  2002/09/17 08:05:26  skirsch
// changed the default colors
//
// Revision 1.4  2002/09/13 14:17:32  kirsch
// member variables were initialized in wrong order
//
// Revision 1.3  2002/09/10 12:34:32  skirsch
// added declarations for sun position and sky color calculation
//
// Revision 1.2  2002/09/10 10:06:14  baumann
// code cleanup
// persistency added
//
// Revision 1.1  2002/09/06 11:29:28  skirsch
// initial version
//

#ifndef VRS_SKY_H_
#define VRS_SKY_H_

#include <vrs/color.h>
#include <vrs/shape.h>
#include <vrs/cache.h>
#include <vrs/polygonset.h>

namespace VRS {

class VRS_CORE_API Sky : public Shape {

public:
    Sky(bool calcRealSkyColor = false,
        const Color& skyColor = Color(0.3, 0.3, 0.9), const Color& fogColor = Color(1.0, 1.0, 1.0),
        double colorDiff = 0.005,
        bool sunOnOff = true, const Vector& sunDirection = Vector(0.0, 1.0, 0.0),
        double turbitdity = 3.0);

    Sky(unsigned int day, unsigned short hour, unsigned short minute, unsigned short second, double latitude,
        bool calcRealSkyColor = false,
        const Color& skyColor = Color(0.3, 0.3, 0.9), const Color& fogColor = Color(1.0, 1.0, 1.0),
        double colorDiff = 0.005,
        bool sunOnOff = true,
        double turbitdity = 3.0);

    virtual ~Sky();

    void setSun(bool onOff);
    bool getSun() const;
    void setSunDirection(const Vector& sunDirection);

    const Vector& getSunDirection() const;

    void setCalcRealSkyColor(bool calcRealSkyColor);

    bool getCalcRealSkyColor() const;
    void setSkyColor(const Color& skyColor);
    const Color& getSkyColor() const;
    void setFogColor(const Color& fogColor);
    const Color& getFogColor() const;

    void setTurbidity(double trubidity);

    double getTurbidity() const;

    void calculateSunDirection(unsigned int day = 173, unsigned short hour = 12, unsigned short minute = 0,
        unsigned short second = 0, double latitude = 52.0);

    void setTessellationError(double colorDiff);

    void setTessellationForStaticSky();

    void setTessellationForDynamicSky();

    double getTessellationError() const;

    virtual void modified();

    Bounds boundingBox() const;

    bool getUpdateTessellation() const;
    void setUpdateTessellation(bool updateTessellation);
    Cache* getTessellation() const;
    void setTessellation(PolygonSet* tessellation);

    VRS_TYPEINFO(Sky, Shape);
    VRS_SERIALIZABLE(Sky);

private:
    bool calcRealSkyColor_;
    Color skyColor_;
    Color fogColor_;
    double colorDiff_;

    bool sun_;
    Vector sunDirection_;

    double turbidity_;

    //non persitent
    bool updateTessellation_;
    SO<Cache> tessellation_;
};

inline bool Sky::getSun() const { return sun_; }
inline const Vector& Sky::getSunDirection() const { return sunDirection_; }

inline bool Sky::getCalcRealSkyColor() const { return calcRealSkyColor_; }
inline const Color& Sky::getSkyColor() const { return skyColor_; }
inline const Color& Sky::getFogColor() const {  return fogColor_; }

inline double Sky::getTurbidity() const { return turbidity_; }

inline double Sky::getTessellationError() const { return colorDiff_; }

inline Bounds Sky::boundingBox() const { return Bounds(); }

} // namespace VRS

#endif // VRS_SKY_H_

---

Generated on Thu May 24 06:00:15 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact