plane.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_PLANE_H
#define TOXIC_RENDERER_PLANE_H

#include "common/math/matrix4.h"
#include "globals.h"
#include "iobject.h"

namespace toxic {

    class Context;
    class Hit;
    class ISurfaceShader;
    class Ray;
    class Scene;

    class Plane : public IObject {
    public:
        // The plane coincides with the XZ plane (it contains the basis vectors X and Z).
        // Surface normal is pointing toward Y+ (it goes away from the plane toward increasing Y).

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

        //! This method returns true if the ray intersect the object, or false otherwise.
        //! If 'hit' is not null, intersection data are reported through the 'hit' parameter
        //! (only if an intersection has been found; if no intersection has been found, the
        //! 'hit' parameter is left unchanged). The ray is expressed in world space.
        virtual bool Intersect(
            const Context &context,
            const Ray &ray,
            Hit *hit = 0
        ) const;
    };

#include "plane.inl"

}

#endif  // !TOXIC_RENDERER_PLANE_H

---