juce_BorderSize.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_BORDERSIZE_H_INCLUDED
#define JUCE_BORDERSIZE_H_INCLUDED
 
 
//==============================================================================
template <typename ValueType>
class BorderSize
{
public:
    //==============================================================================
    BorderSize() noexcept
        : top(), left(), bottom(), right()
    {
    }
 
    BorderSize (const BorderSize& other) noexcept
        : top (other.top), left (other.left), bottom (other.bottom), right (other.right)
    {
    }
 
    BorderSize (ValueType topGap, ValueType leftGap, ValueType bottomGap, ValueType rightGap) noexcept
        : top (topGap), left (leftGap), bottom (bottomGap), right (rightGap)
    {
    }
 
    explicit BorderSize (ValueType allGaps) noexcept
        : top (allGaps), left (allGaps), bottom (allGaps), right (allGaps)
    {
    }
 
    //==============================================================================
    ValueType getTop() const noexcept                   { return top; }
 
    ValueType getLeft() const noexcept                  { return left; }
 
    ValueType getBottom() const noexcept                { return bottom; }
 
    ValueType getRight() const noexcept                 { return right; }
 
    ValueType getTopAndBottom() const noexcept          { return top + bottom; }
 
    ValueType getLeftAndRight() const noexcept          { return left + right; }
 
    bool isEmpty() const noexcept                       { return left + right + top + bottom == ValueType(); }
 
    //==============================================================================
    void setTop (ValueType newTopGap) noexcept          { top = newTopGap; }
 
    void setLeft (ValueType newLeftGap) noexcept        { left = newLeftGap; }
 
    void setBottom (ValueType newBottomGap) noexcept    { bottom = newBottomGap; }
 
    void setRight (ValueType newRightGap) noexcept      { right = newRightGap; }
 
    //==============================================================================
    Rectangle<ValueType> subtractedFrom (const Rectangle<ValueType>& original) const noexcept
    {
        return Rectangle<ValueType> (original.getX() + left,
                                     original.getY() + top,
                                     original.getWidth() - (left + right),
                                     original.getHeight() - (top + bottom));
    }
 
    void subtractFrom (Rectangle<ValueType>& rectangle) const noexcept
    {
        rectangle = subtractedFrom (rectangle);
    }
 
    Rectangle<ValueType> addedTo (const Rectangle<ValueType>& original) const noexcept
    {
        return Rectangle<ValueType> (original.getX() - left,
                                     original.getY() - top,
                                     original.getWidth() + (left + right),
                                     original.getHeight() + (top + bottom));
    }
 
 
    void addTo (Rectangle<ValueType>& rectangle) const noexcept
    {
        rectangle = addedTo (rectangle);
    }
 
    //==============================================================================
    bool operator== (const BorderSize& other) const noexcept
    {
        return top == other.top && left == other.left && bottom == other.bottom && right == other.right;
    }
 
    bool operator!= (const BorderSize& other) const noexcept
    {
        return ! operator== (other);
    }
 
private:
    //==============================================================================
    ValueType top, left, bottom, right;
};
 
 
#endif   // JUCE_BORDERSIZE_H_INCLUDED