blob: 38e724a1bd19f69738da73aa01e99d70846f820c [file] [log] [blame]
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef _BGFX_TUPLE_B3DTUPLE_HXX
#define _BGFX_TUPLE_B3DTUPLE_HXX
#include <sal/types.h>
#include <basegfx/numeric/ftools.hxx>
#undef min
#undef max
#include <algorithm>
namespace basegfx
{
// predeclarations
class B3ITuple;
/** Base class for all Points/Vectors with three double 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 three double values
*/
class B3DTuple
{
protected:
double mfX;
double mfY;
double mfZ;
public:
/** Create a 3D Tuple
The tuple is initialized to (0.0, 0.0, 0.0)
*/
B3DTuple()
: mfX(0.0),
mfY(0.0),
mfZ(0.0)
{}
/** Create a 3D Tuple
@param fX
This parameter is used to initialize the X-coordinate
of the 3D Tuple.
@param fY
This parameter is used to initialize the Y-coordinate
of the 3D Tuple.
@param fZ
This parameter is used to initialize the Z-coordinate
of the 3D Tuple.
*/
B3DTuple(double fX, double fY, double fZ)
: mfX(fX),
mfY(fY),
mfZ(fZ)
{}
/** Create a copy of a 3D Tuple
@param rTup
The 3D Tuple which will be copied.
*/
B3DTuple(const B3DTuple& rTup)
: mfX( rTup.mfX ),
mfY( rTup.mfY ),
mfZ( rTup.mfZ )
{}
/** Create a copy of a 3D integer Tuple
@param rTup
The 3D Tuple which will be copied.
*/
explicit B3DTuple(const B3ITuple& rTup);
~B3DTuple()
{}
/// get X-Coordinate of 3D Tuple
double getX() const
{
return mfX;
}
/// get Y-Coordinate of 3D Tuple
double getY() const
{
return mfY;
}
/// get Z-Coordinate of 3D Tuple
double getZ() const
{
return mfZ;
}
/// set X-Coordinate of 3D Tuple
void setX(double fX)
{
mfX = fX;
}
/// set Y-Coordinate of 3D Tuple
void setY(double fY)
{
mfY = fY;
}
/// set Z-Coordinate of 3D Tuple
void setZ(double fZ)
{
mfZ = fZ;
}
/// Array-access to 3D Tuple
const double& operator[] (int nPos) const
{
// Here, normally two if(...)'s should be used. In the assumption that
// both double members can be accessed as an array a shortcut is used here.
// if(0 == nPos) return mfX; if(1 == nPos) return mfY; return mfZ;
return *((&mfX) + nPos);
}
/// Array-access to 3D Tuple
double& operator[] (int nPos)
{
// Here, normally two if(...)'s should be used. In the assumption that
// both double members can be accessed as an array a shortcut is used here.
// if(0 == nPos) return mfX; if(1 == nPos) return mfY; return mfZ;
return *((&mfX) + nPos);
}
// comparators with tolerance
//////////////////////////////////////////////////////////////////////
bool equalZero() const
{
return (this == &getEmptyTuple() ||
(::basegfx::fTools::equalZero(mfX)
&& ::basegfx::fTools::equalZero(mfY)
&& ::basegfx::fTools::equalZero(mfZ)));
}
bool equalZero(const double& rfSmallValue) const
{
return (this == &getEmptyTuple() ||
(::basegfx::fTools::equalZero(mfX, rfSmallValue)
&& ::basegfx::fTools::equalZero(mfY, rfSmallValue)
&& ::basegfx::fTools::equalZero(mfZ, rfSmallValue)));
}
bool equal(const B3DTuple& rTup) const
{
return (
this == &rTup ||
(::basegfx::fTools::equal(mfX, rTup.mfX) &&
::basegfx::fTools::equal(mfY, rTup.mfY) &&
::basegfx::fTools::equal(mfZ, rTup.mfZ)));
}
bool equal(const B3DTuple& rTup, const double& rfSmallValue) const
{
return (
this == &rTup ||
(::basegfx::fTools::equal(mfX, rTup.mfX, rfSmallValue) &&
::basegfx::fTools::equal(mfY, rTup.mfY, rfSmallValue) &&
::basegfx::fTools::equal(mfZ, rTup.mfZ, rfSmallValue)));
}
// operators
//////////////////////////////////////////////////////////////////////
B3DTuple& operator+=( const B3DTuple& rTup )
{
mfX += rTup.mfX;
mfY += rTup.mfY;
mfZ += rTup.mfZ;
return *this;
}
B3DTuple& operator-=( const B3DTuple& rTup )
{
mfX -= rTup.mfX;
mfY -= rTup.mfY;
mfZ -= rTup.mfZ;
return *this;
}
B3DTuple& operator/=( const B3DTuple& rTup )
{
mfX /= rTup.mfX;
mfY /= rTup.mfY;
mfZ /= rTup.mfZ;
return *this;
}
B3DTuple& operator*=( const B3DTuple& rTup )
{
mfX *= rTup.mfX;
mfY *= rTup.mfY;
mfZ *= rTup.mfZ;
return *this;
}
B3DTuple& operator*=(double t)
{
mfX *= t;
mfY *= t;
mfZ *= t;
return *this;
}
B3DTuple& operator/=(double t)
{
const double fVal(1.0 / t);
mfX *= fVal;
mfY *= fVal;
mfZ *= fVal;
return *this;
}
B3DTuple operator-(void) const
{
return B3DTuple(-mfX, -mfY, -mfZ);
}
bool operator==( const B3DTuple& rTup ) const
{
return mfX == rTup.mfX && mfY == rTup.mfY && mfZ == rTup.mfZ;
}
bool operator!=( const B3DTuple& rTup ) const
{
return mfX != rTup.mfX || mfY != rTup.mfY || mfZ != rTup.mfZ;
}
B3DTuple& operator=( const B3DTuple& rTup )
{
mfX = rTup.mfX;
mfY = rTup.mfY;
mfZ = rTup.mfZ;
return *this;
}
void correctValues(const double fCompareValue = 0.0)
{
if(0.0 == fCompareValue)
{
if(::basegfx::fTools::equalZero(mfX))
{
mfX = 0.0;
}
if(::basegfx::fTools::equalZero(mfY))
{
mfY = 0.0;
}
if(::basegfx::fTools::equalZero(mfZ))
{
mfZ = 0.0;
}
}
else
{
if(::basegfx::fTools::equal(mfX, fCompareValue))
{
mfX = fCompareValue;
}
if(::basegfx::fTools::equal(mfY, fCompareValue))
{
mfY = fCompareValue;
}
if(::basegfx::fTools::equal(mfZ, fCompareValue))
{
mfZ = fCompareValue;
}
}
}
static const B3DTuple& getEmptyTuple();
};
// external operators
//////////////////////////////////////////////////////////////////////////
inline B3DTuple minimum(const B3DTuple& rTupA, const B3DTuple& rTupB)
{
return B3DTuple(
std::min(rTupB.getX(), rTupA.getX()),
std::min(rTupB.getY(), rTupA.getY()),
std::min(rTupB.getZ(), rTupA.getZ()));
}
inline B3DTuple maximum(const B3DTuple& rTupA, const B3DTuple& rTupB)
{
return B3DTuple(
std::max(rTupB.getX(), rTupA.getX()),
std::max(rTupB.getY(), rTupA.getY()),
std::max(rTupB.getZ(), rTupA.getZ()));
}
inline B3DTuple absolute(const B3DTuple& rTup)
{
B3DTuple aAbs(
fabs(rTup.getX()),
fabs(rTup.getY()),
fabs(rTup.getZ()));
return aAbs;
}
inline B3DTuple interpolate(const B3DTuple& rOld1, const B3DTuple& rOld2, double t)
{
if(rOld1 == rOld2)
{
return rOld1;
}
else if(0.0 >= t)
{
return rOld1;
}
else if(1.0 <= t)
{
return rOld2;
}
else
{
return B3DTuple(
((rOld2.getX() - rOld1.getX()) * t) + rOld1.getX(),
((rOld2.getY() - rOld1.getY()) * t) + rOld1.getY(),
((rOld2.getZ() - rOld1.getZ()) * t) + rOld1.getZ());
}
}
inline B3DTuple average(const B3DTuple& rOld1, const B3DTuple& rOld2)
{
return B3DTuple(
rOld1.getX() == rOld2.getX() ? rOld1.getX() : (rOld1.getX() + rOld2.getX()) * 0.5,
rOld1.getY() == rOld2.getY() ? rOld1.getY() : (rOld1.getY() + rOld2.getY()) * 0.5,
rOld1.getZ() == rOld2.getZ() ? rOld1.getZ() : (rOld1.getZ() + rOld2.getZ()) * 0.5);
}
inline B3DTuple average(const B3DTuple& rOld1, const B3DTuple& rOld2, const B3DTuple& rOld3)
{
return B3DTuple(
(rOld1.getX() == rOld2.getX() && rOld2.getX() == rOld3.getX()) ? rOld1.getX() : (rOld1.getX() + rOld2.getX() + rOld3.getX()) * (1.0 / 3.0),
(rOld1.getY() == rOld2.getY() && rOld2.getY() == rOld3.getY()) ? rOld1.getY() : (rOld1.getY() + rOld2.getY() + rOld3.getY()) * (1.0 / 3.0),
(rOld1.getZ() == rOld2.getZ() && rOld2.getZ() == rOld3.getZ()) ? rOld1.getZ() : (rOld1.getZ() + rOld2.getZ() + rOld3.getZ()) * (1.0 / 3.0));
}
inline B3DTuple operator+(const B3DTuple& rTupA, const B3DTuple& rTupB)
{
B3DTuple aSum(rTupA);
aSum += rTupB;
return aSum;
}
inline B3DTuple operator-(const B3DTuple& rTupA, const B3DTuple& rTupB)
{
B3DTuple aSub(rTupA);
aSub -= rTupB;
return aSub;
}
inline B3DTuple operator/(const B3DTuple& rTupA, const B3DTuple& rTupB)
{
B3DTuple aDiv(rTupA);
aDiv /= rTupB;
return aDiv;
}
inline B3DTuple operator*(const B3DTuple& rTupA, const B3DTuple& rTupB)
{
B3DTuple aMul(rTupA);
aMul *= rTupB;
return aMul;
}
inline B3DTuple operator*(const B3DTuple& rTup, double t)
{
B3DTuple aNew(rTup);
aNew *= t;
return aNew;
}
inline B3DTuple operator*(double t, const B3DTuple& rTup)
{
B3DTuple aNew(rTup);
aNew *= t;
return aNew;
}
inline B3DTuple operator/(const B3DTuple& rTup, double t)
{
B3DTuple aNew(rTup);
aNew /= t;
return aNew;
}
inline B3DTuple operator/(double t, const B3DTuple& rTup)
{
B3DTuple aNew(rTup);
aNew /= t;
return aNew;
}
/** Round double to nearest integer for 3D tuple
@return the nearest integer for this tuple
*/
B3ITuple fround(const B3DTuple& rTup);
} // end of namespace basegfx
#endif /* _BGFX_TUPLE_B3DTUPLE_HXX */