juce_RectanglePlacement.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  RectanglePlacement
{
public:
    //==============================================================================
    inline RectanglePlacement (int placementFlags) noexcept  : flags (placementFlags) {}

    inline RectanglePlacement() = default;

    RectanglePlacement (const RectanglePlacement&) = default;

    RectanglePlacement& operator= (const RectanglePlacement&) = default;
 
    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 { centred };
};
 
} // namespace juce