basis.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_BASIS_H
#define TOXIC_RENDERER_BASIS_H

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

namespace toxic {

    class Basis {
    public:
        //! m is the local space to world space transformation matrix.
        Basis(const sheep::Matrix4 &m);

        //! Vector v is expressed in local space, returned vector is expressed in world space.
        sheep::Vector3 TransformToWorld(const sheep::Vector3 &v) const;

        //! Point p is expressed in local space, returned point is expressed in world space.
        sheep::Point3 TransformToWorld(const sheep::Point3 &v) const;

        //! Vector v is expressed in world space, returned vector is expressed in local space.
        sheep::Vector3 TransformToLocal(const sheep::Vector3 &v) const;

        //! Point p is expressed in world space, returned point is expressed in local space.
        sheep::Point3 TransformToLocal(const sheep::Point3 &v) const;

        //! Ray r is expressed in local space, returned ray is expressed in world space.
        //! Direction vector of the returned ray MAY NOT be unit-length.
        Ray TransformToWorld(const Ray &r) const;

        //! Ray r is expressed in world space, returned ray is expressed in local space.
        //! Direction vector of the returned ray MAY NOT be unit-length.
        Ray TransformToLocal(const Ray &r) const;

        //! Normal n is expressed in local space, returned normal is expressed in world space.
        //! The returned vector IS unit-length.
        sheep::Vector3 TransformNormalToWorld(const sheep::Vector3 &n) const;

        //! Normal n is expressed in world space, returned normal is expressed in local space.
        //! The returned vector IS unit-length.
        sheep::Vector3 TransformNormalToLocal(const sheep::Vector3 &n) const;

    protected:  //!< Objects may want to directly access to the matrices.
        sheep::Matrix4 m_m;         //!< Local space to world space vector transformation matrix.
        sheep::Matrix4 m_inv_m;     //!< World space to local space vector transformation matrix.
        sheep::Matrix4 m_tr_inv_m;  //!< Local space to world space normal transformation matrix.
        sheep::Matrix4 m_tr_m;      //!< World space to local space normal transformation matrix.
    };

#include "basis.inl"

}

#endif  // !TOXIC_RENDERER_BASIS_H

---