BppPositionIndicator.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 BPPPOSITIONINDICATOR_HPP
#define BPPPOSITIONINDICATOR_HPP

#include <duds/ui/graphics/BppImage.hpp>
#include <boost/exception/info.hpp>

namespace duds { namespace ui { namespace graphics {

struct BppPositionIndicatorError : virtual std::exception, virtual boost::exception { };

struct BppPositionIndicatorMarkerSizeError : BppPositionIndicatorError { };

struct BppPositionIndicatorDimensionTooSmall : BppPositionIndicatorError { };

struct BppPositionIndicatorRangeTooSmall : BppPositionIndicatorError { };

typedef boost::error_info<struct Info_IndicatorMinimumSize, std::uint16_t>
    PositionMarkMinimumSize;

typedef boost::error_info<struct Info_IndicatorRange, std::uint16_t>
    IndicatorRange;

class BppPositionIndicator {
    ImageLocation ipos;
    ImageDimensions idim;
    std::uint16_t rng;
    std::uint16_t minSize = 4;
    bool bstate = false;
    int position(int pos, int len) const;
public:
    BppPositionIndicator() = default;
    BppPositionIndicator(
        std::uint16_t minMarkerSize,
        bool backgroundState = false
    ) : minSize(minMarkerSize), bstate(backgroundState) { }
    BppPositionIndicator(
        const ImageLocation &indicatorPos,
        const ImageDimensions &indicatorDim,
        std::uint16_t minMarkerSize = 4,
        bool backgroundState = false
    );
    const ImageLocation &position() const {
        return ipos;
    }
    void position(const ImageLocation &pos) {
        ipos = pos;
    }
    const ImageDimensions &dimensions() const {
        return idim;
    }
    void dimensions(const ImageDimensions &dim);
    std::uint16_t minMarkerSize() const {
        return minSize;
    }
    void minMarkerSize(std::uint16_t size);
    bool backgroundState() const {
        return bstate;
    }
    void backgroundState(bool s) {
        bstate = s;
    }
    bool markerState() const {
        return !bstate;
    }
    void markerState(bool s) {
        bstate = !s;
    }
    std::uint16_t range() const {
        return rng + 1;
    }
    void range(std::uint16_t r);
    std::uint16_t maxPosition() const {
        return rng;
    }
    void maxPosition(std::uint16_t p) {
        rng = p;
    }
    bool horizontal() const {
        return idim.w > idim.h;
    }
    bool vertical() const {
        return idim.h >= idim.w;
    }
    void render(BppImage *dest, int start, int end = 0);
    void render(const BppImageSptr &dest, int start, int end = 0) {
        render(dest.get(), start, end);
    }
};

} } }

#endif        //  #ifndef BPPPOSITIONINDICATOR_HPP