isurfacesampler.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_ISURFACESAMPLER_H
#define TOXIC_RENDERER_ISURFACESAMPLER_H

#include "common/math/point2.h"
#include "common/math/real.h"
#include "globals.h"

#include <vector>

namespace toxic {

    class Context;

    //! A surface sampler implements a sampling strategy and
    //! holds a vector of samples which can be refreshed by
    //! calling the GenerateNewSamples() method.
    class ISurfaceSampler {
    public:
        typedef std::vector<sheep::Point2> SampleVector;

        SampleVector m_samples;

        ISurfaceSampler(int size);
        virtual ~ISurfaceSampler() {}

        int GetSampleCount() const;
        sheep::Real GetInvSampleCount() const;

        //! Generates a fresh sample vector.
        virtual void GenerateNewSamples(const Context &context) = 0;

    protected:
        int m_size;                 //!< Sample count.
        sheep::Real m_inv_size;     //!< Reciprocal of the sample count.
    };

#include "isurfacesampler.inl"

}

#endif  // !TOXIC_RENDERER_ISURFACESAMPLER_H

---