ray3.h

Go to the documentation of this file.

/****************************************************************************
* VCGLib                                                            o o     *
* Visual and Computer Graphics Library                            o     o   *
*                                                                _   O  _   *
* Copyright(C) 2004                                                \/)\/    *
* Visual Computing Lab                                            /\/|      *
* ISTI - Italian National Research Council                           |      *
*                                                                    \      *
* All rights reserved.                                                      *
*                                                                           *
* This program 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.                                       *
*                                                                           *
* This program 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 (http://www.gnu.org/licenses/gpl.txt)          *
* for more details.                                                         *
*                                                                           *
****************************************************************************/
/****************************************************************************
  History

$Log: not supported by cvs2svn $
Revision 1.4  2004/03/11 11:47:20  tarini
minor updates, corrections, added documentations, etc.


Revision 1.3  2004/03/10 15:27:18  tarini
first version

****************************************************************************/



#ifndef __VCGLIB_RAY3
#define __VCGLIB_RAY3

#include <vcg/space/point3.h>

namespace vcg {

template <class RayScalarType, bool NORM=false>
class Ray3
{
public: 

        typedef RayScalarType ScalarType;

        typedef Point3<RayScalarType> PointType;

        typedef Ray3<RayScalarType,NORM> RayType;

private:

        PointType _ori;

        PointType _dir;

public:



  inline const PointType &Origin() const { return _ori; } 
  inline PointType &Origin() { return _ori; } 
  inline const PointType &Direction() const { return _dir; } 
        inline void SetOrigin( const PointType & ori )
        {       _ori=ori; }
        inline void SetDirection( const PointType & dir)
        {       _dir=dir; if (NORM) _dir.Normalize();  }
        inline void Set( const PointType & ori, const PointType & dir )
        {       SetOrigin(ori); SetDirection(dir); }



        Ray3() {};
        Ray3(const PointType &ori, const PointType &dir) {SetOrigin(ori); SetDirection(dir);};

        inline bool operator == ( RayType const & p ) const
        {       return _ori==p._ori && _dir==p._dir; }
        inline bool operator != ( RayType const & p ) const
        {       return _ori!=p._ori || _dir!=p._dir; }
        inline ScalarType Projection( const  PointType &p ) const
        { if (NORM) return ScalarType((p-_ori).dot(_dir));
                else      return ScalarType((p-_ori).dot(_dir)/_dir.SquaredNorm());
        }
        static bool IsNormalized() {return NORM;};
        inline PointType P( const ScalarType t ) const
        { return _ori + _dir * t; }
        inline Ray3<ScalarType,true> &Normalize()
        { if (!NORM) _dir.Normalize(); return *((Ray3<ScalarType,true>*)this);}
        static Ray3<ScalarType,true> &Normalize(RayType &p)
        { p.Normalize(); return *((Ray3<ScalarType,true>*)(&p));}
        template <class Q, bool K>
        inline void Import( const Ray3<Q,K> & b )
        { _ori.Import( b.Origin() );    _dir.Import( b.Direction() ); 
          if ((NORM) && (!K)) _dir.Normalize(); 
                //printf("(=)%c->%c ",(!NORM)?'N':'n', NORM?'N':'n');
        }
        template <class Q, bool K>
        static RayType Construct( const Ray3<Q,K> & b )
        { RayType res; res.Import(b);  return res;
        }       
        PointType ClosestPoint(const PointType & p) const{
        return P(Projection(p));
        }
        inline void Flip(){
                _dir=-_dir;
        };


        inline Ray3<ScalarType,false> operator + ( RayType const & p) const
        {return Ray3<ScalarType,false> ( _ori+p.Origin(), _dir+p.Direction() );}
        inline Ray3<ScalarType,false> operator - ( RayType const & p) const
        {return Ray3<ScalarType,false> ( _ori-p.Origin(), _dir-p.Direction() );}
        inline Ray3<ScalarType,false> operator * ( const ScalarType s ) const
        {return Ray3<ScalarType,false> ( _ori*s, _dir*s );}
        inline Ray3<ScalarType,false> operator / ( const ScalarType s ) const
        {ScalarType s0=((ScalarType)1.0)/s; return RayType( _ori*s0, _dir*s0 );}




        Ray3(const Ray3<ScalarType,!NORM > &r) 
        { Import(r); };
        inline RayType & operator = ( Ray3<ScalarType,!NORM> const &r) 
        { Import(r); return *this; };

}; // end class definition

typedef Ray3<short>  Ray3s;
typedef Ray3<int>    Ray3i;
typedef Ray3<float>  Ray3f;
typedef Ray3<double> Ray3d;

typedef Ray3<short ,true> Ray3sN;
typedef Ray3<int   ,true> Ray3iN;
typedef Ray3<float ,true> Ray3fN;
typedef Ray3<double,true> Ray3dN;

template <class ScalarType, bool NORM> 
Point3<ScalarType> ClosestPoint( Ray3<ScalarType,NORM> r, const Point3<ScalarType> & p) 
{
        ScalarType t = r.Projection(p); 
        if (t<0) return r.Origin();
        return r.P(t); 
}

} // end namespace
#endif