office-gobmx/include/basegfx/point/b2dpoint.hxx
Thomas Arnhold 29c0fdc645 fixincludeguards.sh: include/{basegfx,basic}
Change-Id: Id18d3f4b4ed763b2ec9e718d66c3c3b9968fcac2
2013-10-23 23:22:31 +02:00

150 lines
4.3 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef INCLUDED_BASEGFX_POINT_B2DPOINT_HXX
#define INCLUDED_BASEGFX_POINT_B2DPOINT_HXX
#include <ostream>
#include <basegfx/tuple/b2dtuple.hxx>
#include <basegfx/point/b2ipoint.hxx>
#include <basegfx/basegfxdllapi.h>
namespace basegfx
{
// predeclaration
class B2DHomMatrix;
/** Base Point class with two double values
This class derives all operators and common handling for
a 2D data class from B2DTuple. All necessary extensions
which are special for points will be added here.
@see B2DTuple
*/
class SAL_WARN_UNUSED B2DPoint : public ::basegfx::B2DTuple
{
public:
/** Create a 2D Point
The point is initialized to (0.0, 0.0)
*/
B2DPoint()
: B2DTuple()
{}
/** Create a 2D Point
@param fX
This parameter is used to initialize the X-coordinate
of the 2D Point.
@param fY
This parameter is used to initialize the Y-coordinate
of the 2D Point.
*/
B2DPoint(double fX, double fY)
: B2DTuple(fX, fY)
{}
/** Create a copy of a 2D Point
@param rPoint
The 2D Point which will be copied.
*/
B2DPoint(const B2DPoint& rPoint)
: B2DTuple(rPoint)
{}
/** Create a copy of a 2D Point
@param rPoint
The 2D Point which will be copied.
*/
explicit B2DPoint(const ::basegfx::B2IPoint& rPoint)
: B2DTuple(rPoint)
{}
/** constructor with tuple to allow copy-constructing
from B2DTuple-based classes
*/
B2DPoint(const ::basegfx::B2DTuple& rTuple)
: B2DTuple(rTuple)
{}
~B2DPoint()
{}
/** *=operator to allow usage from B2DPoint, too
*/
B2DPoint& operator*=( const B2DPoint& rPnt )
{
mfX *= rPnt.mfX;
mfY *= rPnt.mfY;
return *this;
}
/** *=operator to allow usage from B2DPoint, too
*/
B2DPoint& operator*=(double t)
{
mfX *= t;
mfY *= t;
return *this;
}
/** assignment operator to allow assigning the results
of B2DTuple calculations
*/
BASEGFX_DLLPUBLIC B2DPoint& operator=( const ::basegfx::B2DTuple& rPoint );
/** Transform point by given transformation matrix.
The translational components of the matrix are, in
contrast to B2DVector, applied.
*/
BASEGFX_DLLPUBLIC B2DPoint& operator*=( const ::basegfx::B2DHomMatrix& rMat );
static const B2DPoint& getEmptyPoint()
{
return (const B2DPoint&) ::basegfx::B2DTuple::getEmptyTuple();
}
};
// external operators
/** Transform B2DPoint by given transformation matrix.
Since this is a Point, translational components of the
matrix are used.
*/
BASEGFX_DLLPUBLIC B2DPoint operator*( const B2DHomMatrix& rMat, const B2DPoint& rPoint );
} // end of namespace basegfx
template< typename charT, typename traits >
inline std::basic_ostream<charT, traits> & operator <<(
std::basic_ostream<charT, traits> & stream, const basegfx::B2DPoint& point )
{
return stream << "(" << point.getX() << "," << point.getY() << ")";
}
#endif // INCLUDED_BASEGFX_POINT_B2DPOINT_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */