point_2dh.inl

Go to the documentation of this file.

/** @file
 *  @author Bram de Greve (bramz@users.sourceforge.net)
 *  @author Tom De Muer (tomdemuer@users.sourceforge.net)
 *
 *  *** BEGIN LICENSE INFORMATION ***
 *  
 *  The contents of this file are subject to the Common Public Attribution License 
 *  Version 1.0 (the "License"); you may not use this file except in compliance with 
 *  the License. You may obtain a copy of the License at 
 *  http://lass.sourceforge.net/cpal-license. The License is based on the 
 *  Mozilla Public License Version 1.1 but Sections 14 and 15 have been added to cover 
 *  use of software over a computer network and provide for limited attribution for 
 *  the Original Developer. In addition, Exhibit A has been modified to be consistent 
 *  with Exhibit B.
 *  
 *  Software distributed under the License is distributed on an "AS IS" basis, WITHOUT 
 *  WARRANTY OF ANY KIND, either express or implied. See the License for the specific 
 *  language governing rights and limitations under the License.
 *  
 *  The Original Code is LASS - Library of Assembled Shared Sources.
 *  
 *  The Initial Developer of the Original Code is Bram de Greve and Tom De Muer.
 *  The Original Developer is the Initial Developer.
 *  
 *  All portions of the code written by the Initial Developer are:
 *  Copyright (C) 2004-2007 the Initial Developer.
 *  All Rights Reserved.
 *  
 *  Contributor(s):
 *
 *  Alternatively, the contents of this file may be used under the terms of the 
 *  GNU General Public License Version 2 or later (the GPL), in which case the 
 *  provisions of GPL are applicable instead of those above.  If you wish to allow use
 *  of your version of this file only under the terms of the GPL and not to allow 
 *  others to use your version of this file under the CPAL, indicate your decision by 
 *  deleting the provisions above and replace them with the notice and other 
 *  provisions required by the GPL License. If you do not delete the provisions above,
 *  a recipient may use your version of this file under either the CPAL or the GPL.
 *  
 *  *** END LICENSE INFORMATION ***
 */

#ifndef LASS_GUARDIAN_OF_INCLUSION_PRIM_POINT_2DH_INL
#define LASS_GUARDIAN_OF_INCLUSION_PRIM_POINT_2DH_INL

#include "point_2dh.h"

namespace lass
{
namespace prim
{

template <typename T> inline
Point2DH<T>::Point2DH():
    x(TNumTraits::zero),
    y(TNumTraits::zero),
    z(TNumTraits::zero)
{
    LASS_ASSERT(isZero());
}



template<typename T> inline
Point2DH<T>::Point2DH(TParam iX, TParam iY, TParam iZ):
    x(iX),
    y(iY),
    z(iZ)
{
}



template<typename T> inline
Point2DH<T>::Point2DH(const TPoint& iAffinePoint):
    x(iAffinePoint.x),
    y(iAffinePoint.y),
    z(TNumTraits::one)
{
}



template<typename T> inline
Point2DH<T>::Point2DH(const TVector& iPositionVector):
    x(iPositionVector.x),
    y(iPositionVector.y),
    z(iPositionVector.z)
{
}



template <typename T> inline
const typename Point2DH<T>::TVector
Point2DH<T>::position() const
{
    return TVector(x, y, z);
}



template<typename T> inline
typename Point2DH<T>::TConstReference
Point2DH<T>::operator[](size_t iIndex) const
{
    LASS_ASSERT(iIndex < dimension);
    return *(&x + iIndex);
}



template<typename T> inline
typename Point2DH<T>::TReference
Point2DH<T>::operator[](size_t iIndex)
{
    LASS_ASSERT(iIndex < dimension);
    return *(&x + iIndex);
}



/** Wrap index around range.
 */
template<typename T> inline
typename Point2DH<T>::TConstReference
Point2DH<T>::at(signed iIndex) const
{
    return *(&x + num::mod(iIndex, dimension));
}



/** Wrap index around range.
 */
template<typename T> inline
typename Point2DH<T>::TReference
Point2DH<T>::at(signed iIndex)
{
    return *(&x + num::mod(iIndex, dimension));
}



/** A weird way to get back the same object
 */
template<typename T> inline
const Point2DH<T>& Point2DH<T>::operator+() const
{
    return *this;
}



template<typename T>
const Point2DH<T> Point2DH<T>::operator-() const
{
    return Poin2DH(-x, -y, -z);
}



template<typename T>
Point2DH<T>& Point2DH<T>::operator+=(const Point2DH<T>& iB)
{
    x += iB.x;
    y += iB.y;
    z += iB.z;
    return *this;
}



template<typename T>
Point2DH<T>& Point2DH<T>::operator-=(const Point2DH<T>& iB)
{
    x -= iB.x;
    y -= iB.y;
    z -= iB.z;
    return *this;
}



template<typename T>
Point2DH<T>& Point2DH<T>::operator*=(TParam iB)
{
    x *= iB;
    y *= iB;
    z *= iB;
    return *this;
}



template<typename T>
Point2DH<T>& Point2DH<T>::operator/=(TParam iB)
{
    const TValue invB = TNumTraits::one / iB;
    x *= invB;
    y *= invB;
    z *= invB;
    return *this;
}



/** Return true if point is origin (0, 0, z).
 *  z may be 0 but doesn't has to be.
 */
template<typename T>
const bool Point2DH<T>::isZero() const
{
    return x == TNumTraits::zero && y == TNumTraits::zero;
}



/** Return true if at least one of the components is NaN
 */
template<typename T> inline
const bool Point2DH<T>::isNaN() const
{
    return num::isNaN(x) || num::isNaN(y) || num::isNaN(z);
}



/** Return true if point is at infinite distance of origin.  test if z == 0.
 */
template<typename T>
const bool Point2DH<T>::isInfinite() const
{
    return z == TNumTraits::zero;
}



/** Return true if point is valid.  test if point != (0, 0, 0)
 */
template<typename T>
const bool Point2DH<T>::isValid() const
{
    return x != TNumTraits::zero || y != TNumTraits::zero || z != TNumTraits::zero;
}



/** Return weight of point.  weight = z.
 */
template<typename T> inline
const typename Point2DH<T>::TValue Point2DH<T>::weight() const
{
    return z;
}



/** Return rescaled version of point with weight = 1.
 *  Does not influence original poitn.
 */
template<typename T> inline
const Point2D<T> Point2DH<T>::affine() const
{
    Point2DH<T> result(*this);
    result.homogenize();
    return Point2D<T>(result.x, result.y);
}



/** Rescale point so that weight is 1.
 */
template<typename T>
void Point2DH<T>::homogenize()
{
    const TValue invZ = TNumTraits::one / z;
    x *= invZ;
    y *= invZ;
    z = TNumTraits::one;
}



// --- FREE FUNCTIONS ---------------------------------------------------------------------------

/** @relates lass::prim::Point2DH
 */
template<typename T>
bool operator==(const Point2DH<T>& iA, const Point2DH<T>& iB)
{
    return iA.x == iB.x && iA.y == iB.y && iA.z == iB.z;
}



/** @relates lass::prim::Point2DH
 */
template<typename T> inline
bool operator!=(const Point2DH<T>& iA, const Point2DH<T>& iB)
{
    return !(iA == iB);
}



/** @relates lass::prim::Point2DH
 */
template<typename T> inline
Point2DH<T> operator+(const Point2DH<T>& iA, const Point2DH<T>& iB)
{
    Point2DH<T> result(iA);
    result += iB;
    return result;
}



/** @relates lass::prim::Point2DH
 */
template<typename T> inline
Point2DH<T> operator+(const Point2DH<T>& iA, const Point2D<T>& iB)
{
    Point2DH<T> result(iA);
    result += iB;
    return result;
}



/** @relates lass::prim::Point2DH
 */
template<typename T> inline
Point2DH<T> operator+(const Point2D<T>& iA, const Point2DH<T>& iB)
{
    Point2DH<T> result(iA);
    result += iB;
    return result;
}



/** @relates lass::prim::Point2DH
 */
template<typename T> inline
Point2DH<T> operator+(const Point2D<T>& iA, const Point2D<T>& iB)
{
    Point2DH<T> result(iA);
    result += iB;
    return result;
}



/** @relates lass::prim::Point2DH
 */
template<typename T> inline
Point2DH<T> operator-(const Point2DH<T>& iA, const Point2DH<T>& iB)
{
    Point2DH<T> result(iA.position());
    result -= iB;
    return result;
}



/** @relates lass::prim::Point2DH
 */
template<typename T> inline
Point2DH<T> operator*(const Point2DH<T>& iA, typename Point2DH<T>::TParam iB)
{
    Point2DH<T> result(iA);
    result *= iB;
    return result;
}



/** @relates lass::prim::Point2DH
 */
template<typename T> inline
Point2DH<T> operator/(const Point2DH<T>& iA, typename Point2DH<T>::TParam iB)
{
    Point2DH<T> result(iA);
    result /= iB;
    return result;
}



/** @relates lass::prim::Point2DH
 */
template<typename T> inline
Point2DH<T> operator*(typename Point2DH<T>::TParam iA, const Point2DH<T>& iB)
{
    Point2DH<T> result(iB);
    result *= iA;
    return result;
}



/** @relates lass::prim::Point2DH
 */
template<typename T>
std::ostream& operator<<(std::ostream& ioOStream, const Point2DH<T>& iB)
{
    LASS_ENFORCE_STREAM(ioOStream) << iB.position();
    return ioOStream;
}



/** @relates lass::prim::Point2DH
 */
template<typename T>
io::XmlOStream& operator<<(io::XmlOStream& oOStream, const Point2DH<T>& iB)
{
    LASS_ENFORCE_STREAM(oOStream)
        << "<Point2DH>" << iB.x << " " << iB.y << " " << iB.z << "</Point2DH>\n";
    return oOStream;
}



/** @relates lass::prim::Point2DH
 */
template<typename T>
std::istream& operator>>(std::istream& ioIStream, Point2DH<T>& oB)
{
    Vector3D<T> temp;
    LASS_ENFORCE(ioIStream) >> temp;
    oB = Point2DH<T>(temp);
    return ioIStream;
}



}

}

#endif

// --- END OF FILE ------------------------------------------------------------------------------