/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: b2i64tuple.hxx,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/07 20:36:16 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef _BGFX_TUPLE_B2I64TUPLE_HXX
#define _BGFX_TUPLE_B2I64TUPLE_HXX

#ifndef _SAL_TYPES_H_
#include <sal/types.h>
#endif

#ifndef _BGFX_TUPLE_B2DTUPLE_HXX
#include <basegfx/tuple/b2dtuple.hxx>
#endif


namespace basegfx
{
	/** Base class for all Points/Vectors with two sal_Int64 values

		This class provides all methods common to Point
		avd Vector classes which are derived from here.

		@derive Use this class to implement Points or Vectors
		which are based on two sal_Int64 values
	*/
	class B2I64Tuple
	{
	protected:
		sal_Int64										mnX;
		sal_Int64										mnY;
							
	public:					
		/**	Create a 2D Tuple

        	The tuple is initialized to (0, 0)
		*/
		B2I64Tuple() 
		:	mnX(0), 
			mnY(0) 
		{}

		/**	Create a 2D Tuple

			@param fX
			This parameter is used to initialize the X-coordinate
			of the 2D Tuple.
			
			@param fY
			This parameter is used to initialize the Y-coordinate
			of the 2D Tuple.
		*/
		B2I64Tuple(sal_Int64 fX, sal_Int64 fY) 
		:	mnX( fX ), 
			mnY( fY ) 
		{}

		/**	Create a copy of a 2D Tuple

			@param rTup
			The 2D Tuple which will be copied.
		*/
		B2I64Tuple(const B2I64Tuple& rTup) 
		:	mnX( rTup.mnX ), 
			mnY( rTup.mnY ) 
		{}

		~B2I64Tuple() 
		{}

		/// Get X-Coordinate of 2D Tuple
		sal_Int64 getX() const
		{ 
			return mnX; 
		}

		/// Get Y-Coordinate of 2D Tuple
		sal_Int64 getY() const
		{ 
			return mnY; 
		}

		/// Set X-Coordinate of 2D Tuple
		void setX(sal_Int64 fX)
		{
			mnX = fX;
		}

		/// Set Y-Coordinate of 2D Tuple
		void setY(sal_Int64 fY)
		{
			mnY = fY;
		}

		/// Array-access to 2D Tuple
		const sal_Int64& operator[] (int nPos) const 
		{ 
			// Here, normally one if(...) should be used. In the assumption that
			// both sal_Int64 members can be accessed as an array a shortcut is used here.
			// if(0 == nPos) return mnX; return mnY;
			return *((&mnX) + nPos);
		}

		/// Array-access to 2D Tuple
		sal_Int64& operator[] (int nPos)
		{ 
			// Here, normally one if(...) should be used. In the assumption that
			// both sal_Int64 members can be accessed as an array a shortcut is used here.
			// if(0 == nPos) return mnX; return mnY;
			return *((&mnX) + nPos);
		}

		// operators
		//////////////////////////////////////////////////////////////////////

		B2I64Tuple& operator+=( const B2I64Tuple& rTup ) 
		{ 
			mnX += rTup.mnX;
			mnY += rTup.mnY; 
			return *this; 
		}

		B2I64Tuple& operator-=( const B2I64Tuple& rTup ) 
		{ 
			mnX -= rTup.mnX;
			mnY -= rTup.mnY; 
			return *this; 
		}

		B2I64Tuple& operator/=( const B2I64Tuple& rTup ) 
		{ 
			mnX /= rTup.mnX;
			mnY /= rTup.mnY; 
			return *this; 
		}

		B2I64Tuple& operator*=( const B2I64Tuple& rTup ) 
		{ 
			mnX *= rTup.mnX;
			mnY *= rTup.mnY; 
			return *this; 
		}

		B2I64Tuple& operator*=(sal_Int64 t) 
		{ 
			mnX *= t; 
			mnY *= t; 
			return *this; 
		}

		B2I64Tuple& operator/=(sal_Int64 t) 
		{ 
			mnX /= t; 
			mnY /= t; 
			return *this; 
		}

		B2I64Tuple operator-(void) const 
		{	
			return B2I64Tuple(-mnX, -mnY); 
		}
		
		bool equalZero() const { return mnX == 0 && mnY == 0; }

		bool operator==( const B2I64Tuple& rTup ) const 
		{ 
			return rTup.mnX == mnX && rTup.mnY == mnY;
		}

		bool operator!=( const B2I64Tuple& rTup ) const 
		{ 
			return !(*this == rTup);
		}
		
		B2I64Tuple& operator=( const B2I64Tuple& rTup ) 
		{ 
			mnX = rTup.mnX;
			mnY = rTup.mnY; 
			return *this; 
		}

		static const B2I64Tuple& getEmptyTuple();
	};

	// external operators
	//////////////////////////////////////////////////////////////////////////

	inline B2I64Tuple minimum(const B2I64Tuple& rTupA, const B2I64Tuple& rTupB) 
	{ 
		B2I64Tuple aMin(
			(rTupB.getX() < rTupA.getX()) ? rTupB.getX() : rTupA.getX(),
			(rTupB.getY() < rTupA.getY()) ? rTupB.getY() : rTupA.getY()); 
		return aMin;
	}

	inline B2I64Tuple maximum(const B2I64Tuple& rTupA, const B2I64Tuple& rTupB) 
	{ 
		B2I64Tuple aMax(
			(rTupB.getX() > rTupA.getX()) ? rTupB.getX() : rTupA.getX(),
			(rTupB.getY() > rTupA.getY()) ? rTupB.getY() : rTupA.getY()); 
		return aMax;
	}

	inline B2I64Tuple absolute(const B2I64Tuple& rTup) 
	{ 
		B2I64Tuple aAbs(
			(0 > rTup.getX()) ? -rTup.getX() : rTup.getX(),
			(0 > rTup.getY()) ? -rTup.getY() : rTup.getY()); 
		return aAbs;
	}

	inline B2DTuple interpolate(const B2I64Tuple& rOld1, const B2I64Tuple& rOld2, double t) 
	{ 
		B2DTuple aInt(
			((rOld2.getX() - rOld1.getX()) * t) + rOld1.getX(),
			((rOld2.getY() - rOld1.getY()) * t) + rOld1.getY()); 
		return aInt;
	}

	inline B2DTuple average(const B2I64Tuple& rOld1, const B2I64Tuple& rOld2) 
	{ 
		B2DTuple aAvg(
			(rOld1.getX() + rOld2.getX()) * 0.5,
			(rOld1.getY() + rOld2.getY()) * 0.5); 
		return aAvg;
	}
	
	inline B2DTuple average(const B2I64Tuple& rOld1, const B2I64Tuple& rOld2, const B2I64Tuple& rOld3)
	{ 
		B2DTuple aAvg(
			(rOld1.getX() + rOld2.getX() + rOld3.getX()) * (1.0 / 3.0),
			(rOld1.getY() + rOld2.getY() + rOld3.getY()) * (1.0 / 3.0)); 
		return aAvg;
	}

	inline B2I64Tuple operator+(const B2I64Tuple& rTupA, const B2I64Tuple& rTupB)
	{ 
		B2I64Tuple aSum(rTupA); 
		aSum += rTupB; 
		return aSum; 
	}

	inline B2I64Tuple operator-(const B2I64Tuple& rTupA, const B2I64Tuple& rTupB)
	{ 
		B2I64Tuple aSub(rTupA); 
		aSub -= rTupB; 
		return aSub; 
	}

	inline B2I64Tuple operator/(const B2I64Tuple& rTupA, const B2I64Tuple& rTupB)
	{ 
		B2I64Tuple aDiv(rTupA); 
		aDiv /= rTupB; 
		return aDiv; 
	}

	inline B2I64Tuple operator*(const B2I64Tuple& rTupA, const B2I64Tuple& rTupB)
	{ 
		B2I64Tuple aMul(rTupA); 
		aMul *= rTupB; 
		return aMul; 
	}

	inline B2I64Tuple operator*(const B2I64Tuple& rTup, sal_Int64 t)
	{ 
		B2I64Tuple aNew(rTup); 
		aNew *= t; 
		return aNew; 
	}

	inline B2I64Tuple operator*(sal_Int64 t, const B2I64Tuple& rTup)
	{ 
		B2I64Tuple aNew(rTup); 
		aNew *= t; 
		return aNew; 
	}

	inline B2I64Tuple operator/(const B2I64Tuple& rTup, sal_Int64 t)
	{ 
		B2I64Tuple aNew(rTup); 
		aNew /= t; 
		return aNew; 
	}

	inline B2I64Tuple operator/(sal_Int64 t, const B2I64Tuple& rTup)
	{
		B2I64Tuple aNew(t, t); 
		B2I64Tuple aTmp(rTup); 
		aNew /= aTmp; 
		return aNew; 
	}
} // end of namespace basegfx

#endif /* _BGFX_TUPLE_B2I64TUPLE_HXX */
