iboundedobject.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_IBOUNDEDOBJECT_H
#define TOXIC_RENDERER_IBOUNDEDOBJECT_H

#include "common/math/aabb3.h"
#include "common/math/matrix4.h"
#include "common/math/point2.h"
#include "common/math/point3.h"
#include "common/math/vector3.h"
#include "globals.h"
#include "iobject.h"

#include <vector>

namespace toxic {

    class ISurfaceShader;
    class Scene;

    const sheep::Vector3 OBJECT_AABB_EXTENSION(1.0e-3);

    class IBoundedObject : public IObject {
    public:
        //! m is the object space to world space transformation matrix.
        //! The 'surface_shader' pointer may be null because some objects
        //! (like the Collection and Octree objects) don't need a shader.
        IBoundedObject(
            const sheep::Matrix4 &m,
            const ISurfaceShader *surface_shader = 0,
            IntersectionMask intersection_mask = INTERSECT_ALL_RAYS);

        virtual ~IBoundedObject() {}

        //! Returns the Axis Aligned Bounding Box of this object. The AABB is
        //! expressed in world space.
        virtual const sheep::AABB3 &GetAABB() const = 0;

        //! Computes the surface area of this object.
        virtual sheep::Real ComputeSurfaceArea() const = 0;

        //! Given a point in the unit square (the set of points in [0..1]^2),
        //! this method computes the corresponding surface point and normal
        //! (both are expressed in world space).
        virtual void EvaluateSurface(
            const sheep::Point2 &input,
            sheep::Point3 *point,
            sheep::Vector3 *geometric_normal
        ) const = 0;
    };

#include "iboundedobject.inl"

}

#endif  // !TOXIC_RENDERER_IBOUNDEDOBJECT_H

---