iedf.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_IEDF_H
#define TOXIC_RENDERER_IEDF_H

#include "common/math/real.h"
#include "common/math/vector3.h"
#include "common/misc/iclonable.h"
#include "globals.h"
#include "surfacebasis.h"

#include <cassert>

namespace toxic {

    class Context;

    class IEDF : public sheep::IClonable<IEDF> {
    public:
        virtual ~IEDF() {}

        //! Evaluates the function. The emission direction is expressed in local space.
        virtual sheep::Real Evaluate(
            const Context &context,
            const sheep::Vector3 &direction
        ) const = 0;

        //! Samples the function in order to obtain an emission direction. The
        //! probability with which the direction has been chosen is also computed.
        //! The emission direction is expressed in local space.
        virtual void Sample(
            const Context &context,
            sheep::Vector3 *direction,
            sheep::Real *prob
        ) const = 0;

        //! Utility function.
        sheep::Real GetEmittedRadiance(
            const Context &context,
            const sheep::Vector3 &normal,   //!< On the light source, expressed in world space or object space.
            const sheep::Vector3 &direction //!< Away from the light source, expressed in same space as the normal.
        ) const;
    };

#include "iedf.inl"

}

#endif  // !TOXIC_RENDERER_IEDF_H

---