juce_Grid.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  Grid  final
{
public:
    //==============================================================================
    struct Px  final
    {
        explicit Px (float p) : pixels (static_cast<long double>(p)) { /*sta (p >= 0.0f);*/ }
        explicit Px (int p)   : pixels (static_cast<long double>(p)) { /*sta (p >= 0.0f);*/ }
        explicit constexpr Px (long double p)        : pixels (p) {}
        explicit constexpr Px (unsigned long long p) : pixels (static_cast<long double>(p)) {}
 
        long double pixels;
    };

    struct Fr  final
    {
        explicit Fr (int f) : fraction (static_cast<unsigned long long> (f)) {}
        explicit constexpr Fr (unsigned long long p) : fraction (p) {}
 
        unsigned long long fraction;
    };
 
    //==============================================================================
    struct TrackInfo  final
    {
        TrackInfo() noexcept;
 
        TrackInfo (Px sizeInPixels) noexcept;
        TrackInfo (Fr fractionOfFreeSpace) noexcept;
 
        TrackInfo (Px sizeInPixels, const String& endLineNameToUse) noexcept;
        TrackInfo (Fr fractionOfFreeSpace, const String& endLineNameToUse) noexcept;
 
        TrackInfo (const String& startLineNameToUse, Px sizeInPixels) noexcept;
        TrackInfo (const String& startLineNameToUse, Fr fractionOfFreeSpace) noexcept;
 
        TrackInfo (const String& startLineNameToUse, Px sizeInPixels, const String& endLineNameToUse) noexcept;
        TrackInfo (const String& startLineNameToUse, Fr fractionOfFreeSpace, const String& endLineNameToUse) noexcept;
 
        bool isAuto() const noexcept { return hasKeyword; }
        bool isFractional() const noexcept { return isFraction; }
        bool isPixels() const noexcept { return ! isFraction; }
        const String& getStartLineName() const noexcept { return startLineName; }
        const String& getEndLineName() const noexcept { return endLineName; }

        float getSize() const noexcept { return size; }
 
    private:
        friend class Grid;
        float getAbsoluteSize (float relativeFractionalUnit) const;
 
        float size = 0; // Either a fraction or an absolute size in pixels
        bool isFraction = false;
        bool hasKeyword = false;
 
        String startLineName, endLineName;
    };
 
    //==============================================================================
    enum class JustifyItems : int
    {
        start = 0,                
        end,                      
        center,                   
        stretch                   
    };

    enum class AlignItems : int
    {
        start = 0,                
        end,                      
        center,                   
        stretch                   
    };

    enum class JustifyContent
    {
        start,                    
        end,                      
        center,                   
        stretch,                  
        spaceAround,              
        spaceBetween,             
        spaceEvenly               
    };

    enum class AlignContent
    {
        start,                    
        end,                      
        center,                   
        stretch,                  
        spaceAround,              
        spaceBetween,             
        spaceEvenly               
    };

    enum class AutoFlow
    {
        row,                      
        column,                   
        rowDense,                 
        columnDense               
    };
 
 
    //==============================================================================
    Grid() = default;

    ~Grid() noexcept = default;
 
    //==============================================================================
    JustifyItems   justifyItems   = JustifyItems::stretch;

    AlignItems     alignItems     = AlignItems::stretch;

    JustifyContent justifyContent = JustifyContent::stretch;

    AlignContent   alignContent   = AlignContent::stretch;

    AutoFlow       autoFlow       = AutoFlow::row;
 
 
    //==============================================================================
    Array<TrackInfo> templateColumns;

    Array<TrackInfo> templateRows;

    StringArray templateAreas;

    TrackInfo autoRows;

    TrackInfo autoColumns;

    Px columnGap { 0 };
    Px rowGap { 0 };

    void setGap (Px sizeInPixels) noexcept          { rowGap = columnGap = sizeInPixels; }
 
    //==============================================================================
    Array<GridItem> items;
 
    //==============================================================================
    void performLayout (Rectangle<int>);
 
    //==============================================================================
    int getNumberOfColumns() const noexcept         { return templateColumns.size(); }
    int getNumberOfRows() const noexcept            { return templateRows.size(); }
 
private:
    //==============================================================================
    struct SizeCalculation;
    struct PlacementHelpers;
    struct AutoPlacement;
    struct BoxAlignment;
};
 
constexpr Grid::Px operator"" _px (long double px)          { return Grid::Px { px }; }
constexpr Grid::Px operator"" _px (unsigned long long px)   { return Grid::Px { px }; }
constexpr Grid::Fr operator"" _fr (unsigned long long fr)   { return Grid::Fr { fr }; }
 
} // namespace juce