hit.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_HIT_H
#define TOXIC_RENDERER_HIT_H

#include "common/math/point3.h"
#include "common/math/real.h"
#include "common/math/vector3.h"
#include "globals.h"
#include "iobject.h"
#include "ray.h"

namespace toxic {

    class IObject;

    class Hit {
    public:
        //! Hit object.
        const IObject *m_object;

        //! Intersection point in ray space, expressed in world space.
        sheep::Real m_abscissa;

        //! Geometric normal vector at intersection point, expressed in object space.
        //! Not necessarily unit-length.
        sheep::Vector3 m_geometric_normal;

        //! Shading normal vector at intersection point, expressed in object space.
        //! Not necessarily unit-length.
        sheep::Vector3 m_shading_normal;

        //! Planar texture coordinates, expressed in object space.
        sheep::Real m_u, m_v;

        //! 'ray' must be expressed in world space.
        //! Any of 'point', 'geometric_normal' and 'shading_normal' can be set to 0
        //! in order to disable computation of the corresponding feature.
        //! 'point', 'geometric_normal' and 'shading_normal' are expressed in world space.
        void ExtractIntersection(
            const Ray &ray,                     //!< World space.
            sheep::Point3 *point,               //!< World space.
            sheep::Vector3 *geometric_normal,   //!< World space.
            sheep::Vector3 *shading_normal      //!< World space.
        ) const;
    };

#include "hit.inl"

}

#endif  // !TOXIC_RENDERER_HIT_H

---