iphotontracer.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_IPHOTONTRACER_H
#define TOXIC_RENDERER_IPHOTONTRACER_H

#include "common/misc/progressmonitor.h"
#include "globals.h"

namespace toxic {

    class Color3;
    class Context;
    class ILight;
    class PhotonMap;
    class Ray;
    class Scene;

    class IPhotonTracer {
    public:
        virtual ~IPhotonTracer() {}

        //! 'nphotons' is the number of photons to trace for the whole scene
        //! (it is then divided amongst all lights).
        virtual void BuildPhotonMap(
            const Context &context,
            PhotonMap *photonmap,
            const Scene *scene,
            int photon_count,
            sheep::ProgressMonitor *progmon = 0
        ) const;

    protected:
        virtual void emit_photons(
            const Context &context,
            PhotonMap *photonmap,
            const Scene *scene,
            const ILight *light,
            int photon_count,
            sheep::ProgressMonitor *progmon
        ) const;

        virtual void trace_photon(
            const Context &context,
            PhotonMap *photonmap,
            const Scene *scene,
            Ray ray,
            Color3 power
        ) const = 0;
    };

#include "iphotontracer.inl"

}

#endif  // !TOXIC_RENDERER_IPHOTONTRACER_H

---