juce_Point.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE 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 General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_POINT_H_INCLUDED
#define JUCE_POINT_H_INCLUDED
 
 
//==============================================================================
template <typename ValueType>
class Point
{
public:
    Point() noexcept : x(), y() {}
 
    Point (const Point& other) noexcept : x (other.x), y (other.y)  {}
 
    Point (ValueType initialX, ValueType initialY) noexcept : x (initialX), y (initialY) {}
 
    //==============================================================================
    Point& operator= (const Point& other) noexcept                  { x = other.x; y = other.y; return *this; }
 
    inline bool operator== (Point other) const noexcept             { return x == other.x && y == other.y; }
    inline bool operator!= (Point other) const noexcept             { return x != other.x || y != other.y; }
 
    bool isOrigin() const noexcept                                  { return x == ValueType() && y == ValueType(); }
 
    inline bool isFinite() const noexcept                           { return juce_isfinite(x) && juce_isfinite(y); }
 
    inline ValueType getX() const noexcept                          { return x; }
 
    inline ValueType getY() const noexcept                          { return y; }
 
    inline void setX (ValueType newX) noexcept                      { x = newX; }
 
    inline void setY (ValueType newY) noexcept                      { y = newY; }
 
    Point withX (ValueType newX) const noexcept                     { return Point (newX, y); }
 
    Point withY (ValueType newY) const noexcept                     { return Point (x, newY); }
 
    void setXY (ValueType newX, ValueType newY) noexcept            { x = newX; y = newY; }
 
    void addXY (ValueType xToAdd, ValueType yToAdd) noexcept        { x += xToAdd; y += yToAdd; }
 
    //==============================================================================
    Point translated (ValueType deltaX, ValueType deltaY) const noexcept    { return Point (x + deltaX, y + deltaY); }
 
    Point operator+ (Point other) const noexcept                    { return Point (x + other.x, y + other.y); }
 
    Point& operator+= (Point other) noexcept                        { x += other.x; y += other.y; return *this; }
 
    Point operator- (Point other) const noexcept                    { return Point (x - other.x, y - other.y); }
 
    Point& operator-= (Point other) noexcept                        { x -= other.x; y -= other.y; return *this; }
 
    template <typename OtherType>
    Point operator* (Point<OtherType> other) const noexcept         { return Point ((ValueType) (x * other.x), (ValueType) (y * other.y)); }
 
    template <typename OtherType>
    Point& operator*= (Point<OtherType> other) noexcept             { *this = *this * other; return *this; }
 
    template <typename OtherType>
    Point operator/ (Point<OtherType> other) const noexcept         { return Point ((ValueType) (x / other.x), (ValueType) (y / other.y)); }
 
    template <typename OtherType>
    Point& operator/= (Point<OtherType> other) noexcept             { *this = *this / other; return *this; }
 
    template <typename FloatType>
    Point operator* (FloatType multiplier) const noexcept           { return Point ((ValueType) (x * multiplier), (ValueType) (y * multiplier)); }
 
    template <typename FloatType>
    Point operator/ (FloatType divisor) const noexcept              { return Point ((ValueType) (x / divisor), (ValueType) (y / divisor)); }
 
    template <typename FloatType>
    Point& operator*= (FloatType multiplier) noexcept               { x = (ValueType) (x * multiplier); y = (ValueType) (y * multiplier); return *this; }
 
    template <typename FloatType>
    Point& operator/= (FloatType divisor) noexcept                  { x = (ValueType) (x / divisor); y = (ValueType) (y / divisor); return *this; }
 
    Point operator-() const noexcept                                { return Point (-x, -y); }
 
    //==============================================================================
    typedef typename TypeHelpers::SmallestFloatType<ValueType>::type FloatType;
 
    //==============================================================================
    ValueType getDistanceFromOrigin() const noexcept                { return juce_hypot (x, y); }
 
    ValueType getDistanceFrom (Point other) const noexcept          { return juce_hypot (x - other.x, y - other.y); }
 
    FloatType getAngleToPoint (Point other) const noexcept
    {
        return static_cast<FloatType> (std::atan2 (static_cast<FloatType> (other.x - x),
                                                   static_cast<FloatType> (y - other.y)));
    }
 
    Point rotatedAboutOrigin (ValueType angleRadians) const noexcept
    {
        return Point (x * std::cos (angleRadians) - y * std::sin (angleRadians),
                      x * std::sin (angleRadians) + y * std::cos (angleRadians));
    }
 
    Point<FloatType> getPointOnCircumference (float radius, float angle) const noexcept
    {
        return Point<FloatType> (static_cast<FloatType> (x + radius * std::sin (angle)),
                                 static_cast<FloatType> (y - radius * std::cos (angle)));
    }
 
    Point<FloatType> getPointOnCircumference (float radiusX, float radiusY, float angle) const noexcept
    {
        return Point<FloatType> (static_cast<FloatType> (x + radiusX * std::sin (angle)),
                                 static_cast<FloatType> (y - radiusY * std::cos (angle)));
    }
 
    FloatType getDotProduct (Point other) const noexcept          { return x * other.x + y * other.y; }
 
    //==============================================================================
    void applyTransform (const AffineTransform& transform) noexcept     { transform.transformPoint (x, y); }
 
    Point transformedBy (const AffineTransform& transform) const noexcept
    {
        return Point (static_cast<ValueType> (transform.mat00 * x + transform.mat01 * y + transform.mat02),
                      static_cast<ValueType> (transform.mat10 * x + transform.mat11 * y + transform.mat12));
    }
 
    //==============================================================================
    Point<int> toInt() const noexcept                             { return Point<int> (static_cast<int> (x), static_cast<int> (y)); }
 
    Point<float> toFloat() const noexcept                         { return Point<float> (static_cast<float> (x), static_cast<float> (y)); }
 
    Point<double> toDouble() const noexcept                       { return Point<double> (static_cast<double> (x), static_cast<double> (y)); }
 
    Point<int> roundToInt() const noexcept                        { return Point<int> (juce::roundToInt (x), juce::roundToInt (y)); }
 
    String toString() const                                       { return String (x) + ", " + String (y); }
 
    //==============================================================================
    ValueType x; 
    ValueType y; 
};
 
 
#endif   // JUCE_POINT_H_INCLUDED