ray.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_RAY_H
#define TOXIC_RENDERER_RAY_H

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

#include <cassert>

namespace toxic {

    class Ray {
    public:
        // A ray can be expressed in world space or object space.

        // If you alter this enumeration, don't forget to update IObject::IntersectionMask
        // (in file iobject.h) accordingly.
        enum Type {
            VISIBILITY_RAY = 1,
            PRIMARY_RAY = 2,
            REFLECTED_RAY = 4,
            SHADOW_RAY = 8,
            PHOTON_RAY = 16,
            PRIMARY_FG_RAY = 32,
            SECONDARY_FG_RAY = 64,
            AUTOFOCUS_RAY = 128
        };

        sheep::Point3 m_origin; //!< World space or object space.
        sheep::Vector3 m_direction; //!< World space or object space.

        Ray(Type type);
        Ray(const Ray &r);
        Ray(Type type, const sheep::Point3 &origin, const sheep::Vector3 &direction);

        Type GetType() const;

        //! Returns an invalid ray id (useful for mailbox mechanisms).
        static int GetInvalidId();

        //! Returns id of this ray, which lies in range [0..infinity).
        int GetId() const;

        //! Assigns a new id to this ray.
        void NewId();

        //! t lies in the interval [0..infinity[. Warning! Be careful to take
        //! into account the fact that the ray direction may not be unit-length.
        sheep::Point3 GetPointAt(sheep::Real t) const;

    private:
        static int m_next_id;

        Type m_type;
        int m_id;
    };

#include "ray.inl"

}

#endif  // !TOXIC_RENDERER_RAY_H

---