juce_RectanglePlacement.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_RECTANGLEPLACEMENT_H_INCLUDED
#define JUCE_RECTANGLEPLACEMENT_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  RectanglePlacement
{
public:
    //==============================================================================
    inline RectanglePlacement (int placementFlags) noexcept  : flags (placementFlags) {}
 
    inline RectanglePlacement() noexcept                     : flags (centred) {}
 
    RectanglePlacement (const RectanglePlacement&) noexcept;
 
    RectanglePlacement& operator= (const RectanglePlacement&) noexcept;
 
    bool operator== (const RectanglePlacement&) const noexcept;
    bool operator!= (const RectanglePlacement&) const noexcept;
 
    //==============================================================================
    enum Flags
    {
        //==============================================================================
        xLeft                                   = 1,
 
        xRight                                  = 2,
 
        xMid                                    = 4,
 
        //==============================================================================
        yTop                                    = 8,
 
        yBottom                                 = 16,
 
        yMid                                    = 32,
 
        //==============================================================================
        stretchToFit                            = 64,
 
        //==============================================================================
        fillDestination                         = 128,
 
        onlyReduceInSize                        = 256,
 
        onlyIncreaseInSize                      = 512,
 
        doNotResize                             = (onlyIncreaseInSize | onlyReduceInSize),
 
        //==============================================================================
        centred                                 = 4 + 32
    };
 
    //==============================================================================
    inline int getFlags() const noexcept                            { return flags; }
 
    inline bool testFlags (int flagsToTest) const noexcept          { return (flags & flagsToTest) != 0; }
 
 
    //==============================================================================
    void applyTo (double& sourceX,
                  double& sourceY,
                  double& sourceW,
                  double& sourceH,
                  double destinationX,
                  double destinationY,
                  double destinationW,
                  double destinationH) const noexcept;
 
    template <typename ValueType>
    Rectangle<ValueType> appliedTo (const Rectangle<ValueType>& source,
                                    const Rectangle<ValueType>& destination) const noexcept
    {
        double x = source.getX(), y = source.getY(), w = source.getWidth(), h = source.getHeight();
        applyTo (x, y, w, h, static_cast <double> (destination.getX()), static_cast <double> (destination.getY()),
                 static_cast <double> (destination.getWidth()), static_cast <double> (destination.getHeight()));
        return Rectangle<ValueType> (static_cast <ValueType> (x), static_cast <ValueType> (y),
                                     static_cast <ValueType> (w), static_cast <ValueType> (h));
    }
 
    AffineTransform getTransformToFit (const Rectangle<float>& source,
                                       const Rectangle<float>& destination) const noexcept;
 
 
private:
    //==============================================================================
    int flags;
};
 
#endif   // JUCE_RECTANGLEPLACEMENT_H_INCLUDED