iarealight.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_IAREALIGHT_H
#define TOXIC_RENDERER_IAREALIGHT_H

#include "common/math/matrix4.h"
#include "common/math/point3.h"
#include "common/math/real.h"
#include "common/math/vector3.h"
#include "color3.h"
#include "globals.h"
#include "iboundedobject.h"
#include "ilight.h"
#include "isurfacesampler.h"

namespace toxic {

    class Context;
    class ISurfaceShader;
    class Scene;

    class IAreaLight : public IBoundedObject, public ILight {
    public:
        //! m is the object space to world space transformation matrix.
        IAreaLight(
            const sheep::Matrix4 &m,
            const ISurfaceShader *surface_shader,
            IntersectionMask intersection_mask = INTERSECT_ALL_RAYS
        );

        virtual ~IAreaLight() {}

        //! This method must be called only once, after the object is completely
        //! configured, and before it is used for the first time.
        virtual void Finalize(const Context &context);

        //! Returns the emission power of this object, expressed in W.
        virtual const Color3 &GetPower() const;

        virtual Ray GeneratePhotonRay(const Context &context) const;

        //! Computes irradiance due to this light source. The point and the surface normal
        //! are both expressed in world space.
        virtual void ComputeIrradiance(
            const Context &context,
            const Scene *scene,
            const sheep::Point3 &point,
            const sheep::Vector3 &geometric_normal,
            const sheep::Vector3 &shading_normal,
            const ISurfaceSampler::SampleVector &input,
            IrradianceSampleVector *output
        ) const;

    protected:
        sheep::Real m_surface_area; //!< Cached value of the surface area of this object, expressed in m^2.
        Color3 m_power;             //!< Emission power of this object, expressed in W.
    };

#include "iarealight.inl"

}

#endif  // !TOXIC_RENDERER_IAREALIGHT_H

---