PriorityGridLayout.hpp

Go to the documentation of this file.

/*
 * This file is part of the DUDS project. It is subject to the BSD-style
 * license terms in the LICENSE file found in the top-level directory of this
 * distribution and at https://github.com/jjackowski/duds/blob/master/LICENSE.
 * No part of DUDS, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 *
 * Copyright (C) 2020  Jeff Jackowski
 */
#ifndef PRIORITYGRIDLAYOUT_HPP
#define PRIORITYGRIDLAYOUT_HPP

#include <duds/ui/graphics/GridLayoutConfig.hpp>
#include <duds/ui/graphics/Panel.hpp>

namespace duds { namespace ui { namespace graphics {

class PriorityGridLayout {
    struct PanelStatus {
        PanelSptr panel;
        GridLayoutConfig config;
        ImageDimensions dim;
        ImageLocation loc;
        int sizeStep;
        bool hidden;
        const GridSizeStep &currentStep() const {
            return config.sizes[sizeStep];
        }
        GridLayoutConfig::Flags flags() const {
            return config.flags | config.sizes[sizeStep].flags;
        }
        PanelStatus() = default;
        PanelStatus(const PanelSptr &pspt, const GridLayoutConfig &conf);
        PanelStatus(const PanelSptr &pspt, GridLayoutConfig &&conf);
    };
    typedef std::map<unsigned int, PanelStatus>  GridConfig;
    GridConfig configs;
    struct RowData {
        typedef std::pair<unsigned int, PanelStatus*>  KeyPanel;
        std::vector<KeyPanel> panels;
        ImageDimensions used = ImageDimensions(0, 0);
        int widthExpand = 0;
        bool heightExpand = false;
        bool minCols(int mc) noexcept;
        KeyPanel &operator [] (int c);
    };
    typedef std::vector<RowData> RowVec;
    std::vector<std::int16_t> rowMaxHeight;
    ImageLocation offset = { 0, 0 };
    ImageDimensions fill;
    static bool minRows(RowVec &rv, int ms);
    static unsigned int panelAt(RowVec &rv, const GridLocation &gl) noexcept;
public:
    void renderOffset(const ImageLocation &off) {
        offset = off;
    }
    const ImageLocation &renderOffset() const {
        return offset;
    }
    void renderFill(const ImageDimensions &dim) {
        fill = dim;
    }
    const ImageDimensions &renderFill() const {
        return fill;
    }
    void maxRowHeight(int row, std::int16_t height);
    std::int16_t maxRowHeight(int row) const;
    bool add(
        const PanelSptr &panel,
        const GridLayoutConfig &config,
        unsigned int pri
    );
    bool add(
        const PanelSptr &panel,
        const GridSizeStep &config,
        unsigned int pri
    );
    unsigned int add(const PanelSptr &panel, const GridLayoutConfig &config);
    unsigned int add(const PanelSptr &panel, const GridSizeStep &config);
    void addOrReplace(
        const PanelSptr &panel,
        const GridLayoutConfig &config,
        unsigned int pri
    );
    void addOrReplace(
        const PanelSptr &panel,
        const GridSizeStep &config,
        unsigned int pri
    );
    void remove(unsigned int pri);
    void remove(const PanelSptr &panel);
    GridLayoutConfig &panelConfig(unsigned int pri);
    const GridLayoutConfig &panelConfig(unsigned int pri) const;
    int layout();
    void render(BppImage *dest);
    void render(BppImage &dest) {
        render(&dest);
    }
    void render(const BppImageSptr &dest) {
        render(dest.get());
    }
    ImageDimensions layoutDimensions(unsigned int pri) const;
    ImageLocation layoutLocation(unsigned int pri) const;
    bool layoutPosition(
        ImageDimensions &dim,
        ImageLocation &loc,
        unsigned int pri
    ) const;
};

} } }

#endif        //  #ifndef PRIORITYGRIDLAYOUT_HPP