1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
|
/***********************************************************************
* fpoint.h - Point with an x and y coordinate *
* *
* This file is part of the FINAL CUT widget toolkit *
* *
* Copyright 2014-2023 Markus Gans *
* *
* FINAL CUT is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License as *
* published by the Free Software Foundation; either version 3 of *
* the License, or (at your option) any later version. *
* *
* FINAL CUT 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 program. If not, see *
* <http://www.gnu.org/licenses/>. *
***********************************************************************/
/* Standalone class
* ════════════════
*
* ▕▔▔▔▔▔▔▔▔▏
* ▕ FPoint ▏
* ▕▁▁▁▁▁▁▁▁▏
*/
#ifndef FPOINT_H
#define FPOINT_H
#if !defined (USE_FINAL_H) && !defined (COMPILE_FINAL_CUT)
#error "Only <final/final.h> can be included directly."
#endif
#include <iostream>
#include <utility>
#include "final/util/fstring.h"
namespace finalcut
{
//----------------------------------------------------------------------
// class FPoint
//----------------------------------------------------------------------
class FPoint
{
public:
// Constructors
FPoint () noexcept = default;
FPoint (int, int) noexcept;
// Overloaded operators
auto operator += (const FPoint&) -> FPoint&;
auto operator -= (const FPoint&) -> FPoint&;
// Accessors
auto getClassName() const -> FString;
auto getX() const noexcept -> int;
auto getY() const noexcept -> int;
void setX (int) noexcept;
void setY (int) noexcept;
void setPoint (const FPoint&) noexcept;
void setPoint (int, int) noexcept;
// Inquiry
auto isOrigin() const noexcept -> bool;
// Point references
auto x_ref() & noexcept -> int&;
auto y_ref() & noexcept -> int&;
// Methods
void move (int, int) noexcept;
void move (const FPoint&) noexcept;
private:
// Data members
int xpos{0};
int ypos{0};
// Friend operator functions
friend auto operator == (const FPoint&, const FPoint&) -> bool;
friend auto operator != (const FPoint&, const FPoint&) -> bool;
friend auto operator + (const FPoint&, const FPoint&) -> FPoint;
friend auto operator - (const FPoint&, const FPoint&) -> FPoint;
friend auto operator - (const FPoint&) -> FPoint;
friend auto operator << (std::ostream&, const FPoint&) -> std::ostream&;
friend auto operator >> (std::istream&, FPoint&) -> std::istream&;
};
// FPoint inline functions
//----------------------------------------------------------------------
inline FPoint::FPoint (int x, int y) noexcept
: xpos{x}
, ypos{y}
{ }
//----------------------------------------------------------------------
inline auto FPoint::getClassName() const -> FString
{ return "FPoint"; }
//----------------------------------------------------------------------
inline auto FPoint::getX() const noexcept -> int
{ return xpos; }
//----------------------------------------------------------------------
inline auto FPoint::getY() const noexcept -> int
{ return ypos; }
//----------------------------------------------------------------------
inline void FPoint::setX (int x) noexcept
{ xpos = x; }
//----------------------------------------------------------------------
inline void FPoint::setY (int y) noexcept
{ ypos = y; }
//----------------------------------------------------------------------
inline void FPoint::setPoint (const FPoint& p) noexcept
{ setPoint(p.xpos, p.ypos); }
//----------------------------------------------------------------------
inline void FPoint::setPoint (int x, int y) noexcept
{
xpos = x;
ypos = y;
}
//----------------------------------------------------------------------
inline auto FPoint::isOrigin() const noexcept -> bool
{ return xpos == 0 && ypos == 0; }
//----------------------------------------------------------------------
inline auto FPoint::x_ref() & noexcept -> int&
{ return xpos; }
//----------------------------------------------------------------------
inline auto FPoint::y_ref() & noexcept -> int&
{ return ypos; }
//----------------------------------------------------------------------
inline void FPoint::move (int dx, int dy) noexcept
{
xpos += dx;
ypos += dy;
}
//----------------------------------------------------------------------
inline void FPoint::move (const FPoint& d) noexcept
{
xpos += d.getX();
ypos += d.getY();
}
// FPoint non-member operators
//----------------------------------------------------------------------
inline auto operator == (const FPoint& p1, const FPoint& p2) -> bool
{ return p1.xpos == p2.xpos && p1.ypos == p2.ypos; }
//----------------------------------------------------------------------
inline auto operator != (const FPoint& p1, const FPoint& p2) -> bool
{ return p1.xpos != p2.xpos || p1.ypos != p2.ypos; }
//----------------------------------------------------------------------
inline auto operator + (const FPoint& p1, const FPoint& p2) -> FPoint
{ return {p1.xpos + p2.xpos, p1.ypos + p2.ypos}; }
//----------------------------------------------------------------------
inline auto operator - (const FPoint& p1, const FPoint& p2) -> FPoint
{ return {p1.xpos - p2.xpos, p1.ypos - p2.ypos}; }
//----------------------------------------------------------------------
inline auto operator - (const FPoint& p) -> FPoint
{ return {-p.xpos, -p.ypos}; }
} // namespace finalcut
#endif // FPOINT_H
|