scene.h

Go to the documentation of this file.

/*
    toxic - A Global Illumination Renderer
    Copyright (C) 2003-2004 Francois Beaune
    Contact: http://toxicengine.sourceforge.net/

    This file is part of toxic.

    toxic is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    toxic 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with toxic; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef TOXIC_RENDERER_SCENE_H
#define TOXIC_RENDERER_SCENE_H

#include "common/math/point3.h"
#include "common/math/vector3.h"
#include "color3.h"
#include "globals.h"
#include "hit.h"
#include "iobject.h"
#include "ray.h"

#include <cassert>
#include <vector>

namespace toxic {

    class Context;
    class Hit;
    class ILight;

    //! The scene is view-independant.
    //! It must contains at least one object (the root object).
    class Scene {
    public:
        Scene();
        ~Scene();   //!< The scene deletes the root object when it is destructed.

        //! Background color. Default is black.
        void SetBackgroundColor(const Color3 &color);
        const Color3 &GetBackgroundColor() const;

        //! Sets an object as the root object. A scene *must* contains a root object.
        void SetRootObject(const IObject *object);
        const IObject *GetRootObject() const;

        //! Ambient illumination. Default is none.
        //!\todo Move ambient illumination to a class derived from ILight.
        void SetAmbientIllumination(const Color3 &ambient);
        const Color3 &GetAmbientIllumination() const;

        //! Light sources.
        void InsertLight(const ILight *light);
        int GetLightCount() const;
        const ILight *GetLight(int i) const;

        bool Trace(const Context &context, const Ray &ray, Hit *hit = 0) const;

        bool ArePointsMutuallyVisible(
            const Context &context,
            const sheep::Point3 &origin,            //!< World space.
            const sheep::Vector3 &origin_normal,    //!< World space.
            const sheep::Point3 &goal,              //!< World space.
            Ray::Type ray_type = Ray::VISIBILITY_RAY
        ) const;

    private:
        Color3 m_background_color;
        const IObject *m_root_object;
        Color3 m_ambient;
        std::vector<const ILight *> m_lights;
    };

#include "scene.inl"

}

#endif  // !TOXIC_RENDERER_SCENE_H

---