xyz.cpp

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 ***
 */



#include "prim_common.h"
#include "xyz.h"

namespace lass
{
namespace prim
{

/** intializes iterator to @a x axis.
 */
XYZ::XYZ():
    value_(0)
{
}



/** initializes iterator to an axis by character: 'x', 'y' or 'z'.
 */
XYZ::XYZ(char iAxis)
{
    reset(iAxis);
}



/** initializes iterator to an axis by number.
 *  ..., -1 == @a z, 0 == @a x, 1 == @a y, 2 == @a z, 3 == @a x, ...
 */
XYZ::XYZ(int iValue):
    value_(iValue)
{
}



/** initializes iterator to an axis by character: "x", "y" or "z".
 */
XYZ::XYZ(const std::string& iAxis)
{
    if (iAxis.length() != 1)
    {
        LASS_THROW("Invalid parameter iAxis '" << iAxis << "'.  It must be a single character.");
    }
    reset(iAxis[0]);
}



/** return axis by character: "x", "y" or "z".
 */
const char XYZ::axis() const
{
    LASS_ASSERT(value_ >= 0 && value_ < 3);
    const char axes[] = { 'x', 'y', 'z' };
    return axes[value_];
}



XYZ& XYZ::operator++()
{
    LASS_ASSERT(value_ >= 0 && value_ < dimension);
    ++value_;
    return *this;
}



XYZ& XYZ::operator--()
{
    LASS_ASSERT(value_ >= 0 && value_ < dimension);
    --value_;
    return *this;
}



XYZ XYZ::operator++(int)
{
    XYZ result(*this);
    ++*this;
    return result;
}



XYZ XYZ::operator--(int)
{
    XYZ result(*this);
    --*this;
    return result;
}



XYZ& XYZ::operator+=(int iOffset)
{
    value_ += iOffset;
    return *this;
}



XYZ& XYZ::operator-=(int iOffset)
{
    value_ -= iOffset;
    return *this;
}




// --- protected -----------------------------------------------------------------------------------



// --- private -------------------------------------------------------------------------------------

inline void XYZ::reset(char iAxis)
{
    switch (iAxis)
    {
    case 0:
    case 'x':
    case 'X':
        value_ = 0;
        break;

    case 1:
    case 'y':
    case 'Y':
        value_ = 1;
        break;

    case 2:
    case 'z':
    case 'Z':
        value_ = 2;
        break;

    default:
        LASS_THROW("Invalid parameter iAxis '" << iAxis
            << "'.  Try 'x', 'X', 'y', 'Y', 'z' or 'Z'.");
    }
}



// --- free ----------------------------------------------------------------------------------------

/** @relates lass::prim::XYZ
 */
bool operator==(const XYZ& iA, const XYZ& iB)
{
    return iA.value_ == iB.value_;
}



/** @relates lass::prim::XYZ
 */
bool operator==(const XYZ& iA, char iB)
{
    return iA.axis() == iB;
}



/** @relates lass::prim::XYZ
 */
bool operator==(char iA, const XYZ& iB)
{
    return iA == iB.axis();
}



/** @relates lass::prim::XYZ
 */
bool operator==(const XYZ& iA, const std::string& iB)
{
    return std::string(1, iA.axis()) == iB;
}



/** @relates lass::prim::XYZ
 */
bool operator==(const std::string& iA, const XYZ& iB)
{
    return iA == std::string(1, iB.axis());
}




/** @relates lass::prim::XYZ
 */
bool operator!=(const XYZ& iA, const XYZ& iB)
{
    return !(iA == iB);
}




/** @relates lass::prim::XYZ
 */
bool operator!=(const XYZ& iA, char iB)
{
    return !(iA == iB);
}




/** @relates lass::prim::XYZ
 */
bool operator!=(char iA, const XYZ& iB)
{
    return !(iA == iB);
}




/** @relates lass::prim::XYZ
 */
bool operator!=(const XYZ& iA, const std::string& iB)
{
    return !(iA == iB);
}




/** @relates lass::prim::XYZ
 */
bool operator!=(const std::string& iA, const XYZ& iB)
{
    return !(iA == iB);
}



/** @relates lass::prim::XYZ
 */
XYZ operator+(const XYZ& iA, int iOffset)
{
    XYZ result(iA);
    result += iOffset;
    return result;
}



/** @relates lass::prim::XYZ
 */
XYZ operator-(const XYZ& iA, int iOffset)
{
    XYZ result(iA);
    result -= iOffset;
    return result;
}



}

}

// EOF