ring.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_RING_H
#define TOXIC_RENDERER_RING_H

#include "common/math/aabb3.h"
#include "common/math/matrix4.h"
#include "common/math/point2.h"
#include "common/math/point3.h"
#include "common/math/real.h"
#include "common/math/vector3.h"
#include "color3.h"
#include "globals.h"
#include "iarealight.h"

namespace toxic {

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

    class Ring : public IAreaLight {
    public:
        // The ring has unit outer radius, custom inner radius and unit height (ring base
        // is at y=-0.5, ring top is at y=+0.5). The ring is centered at the origin and
        // its axis is directed along Y. Surface normal is pointing outward (it goes away
        // from the ring surface).

        //! m is the object space to world space transformation matrix.
        Ring(
            const sheep::Matrix4 &m,
            const ISurfaceShader *surface_shader,
            sheep::Real inner_radius,   //!< The inner radius of the ring, in [0..1).
            IntersectionMask intersection_mask = INTERSECT_ALL_RAYS);

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

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

        //! 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;

        //! 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;

    private:
        sheep::Real m_inner_radius2;        //!< Square of the ring's inner radius.
        sheep::Point3 m_center;             //!< Center of the object, expressed in world space.
        sheep::Vector3 m_ex, m_ey, m_ez;    //!< Basis vectors, expressed in world space.
        sheep::AABB3 m_aabb;                //!< Bounding box of the object, expressed in world space.
    };

#include "ring.inl"

}

#endif  // !TOXIC_RENDERER_RING_H

---