MRPalette.h

Go to the documentation of this file.

#pragma once
 
#include "MRViewerFwd.h"
#include "MRMesh/MRVector4.h"
#include "MRMesh/MRMeshTexture.h"
#include "MRMesh/MRColor.h"
#include "MRMesh/MRExpected.h"
#include "MRViewer/MRImGui.h"
#include <algorithm>
#include <filesystem>
 
namespace Json{ class Value; }
 
namespace MR
{
 
class Palette
{
public:
    MRVIEWER_API static const std::vector<Color> DefaultColors;
    [[nodiscard]] static const std::vector<Color> & BlueGreenRedColors() { return DefaultColors; }
 
    [[nodiscard]] MRVIEWER_API static const std::vector<Color> & GreenRedColors();
 
    MRVIEWER_API Palette( const std::vector<Color>& colors );
    MRVIEWER_API void setBaseColors( const std::vector<Color>& colors );
    MRVIEWER_API void setRangeMinMax( float min, float max );
    MRVIEWER_API void setRangeMinMaxNegPos( float minNeg, float maxNeg, float minPos, float maxPos );
 
    // set number of different colors for discrete palette
    MRVIEWER_API void setDiscretizationNumber( int discretization );
    // set palette type (linear / discrete)
    MRVIEWER_API void setFilterType( FilterType type );
 
    MRVIEWER_API void draw( const std::string& windowName, const ImVec2& pose, const ImVec2& size, bool onlyTopHalf = false );
 
    // structure for label
    struct MRVIEWER_CLASS Label
    {
        float value = 0.f; // label position according normal scale (from Min to Max)
        std::string text; // label text
 
        Label() = default;
        MRVIEWER_API Label( float val, std::string text );
    };
    // reset labels to standard view
    MRVIEWER_API void resetLabels();
    // set labels manually
    MRVIEWER_API void setCustomLabels( const std::vector<Label>& labels );
    // set labels visible
    MRVIEWER_API void setLabelsVisible( bool visible );
 
 
    // Setup palette data from JsonValue
    // @return return true if loading successful
    MRVIEWER_API bool loadFromJson( const Json::Value& root );
    // Serialize this palette data to JsonValue
    MRVIEWER_API void saveCurrentToJson( Json::Value& root ) const;
 
 
    MRVIEWER_API Color getColor( float relativeValue ) const;
    Color getInvalidColor() const { return Color::gray(); }
 
    MRVIEWER_API VertColors getVertColors( const VertScalars& values, const VertBitSet& region, const VertBitSet* valids ) const;
 
    const MeshTexture& getTexture() const { return texture_; };
 
    // get relative position in [0,1], where 0 is for minimum and 1 is for maximum
    MRVIEWER_API float getRelativePos( float val ) const;
 
    UVCoord getUVcoord( float val, bool valid = true ) const
    {
        return {
            ( texEnd_ - texStart_ ) * getRelativePos( val ) + texStart_,
            valid ? 0.25f : 0.75f
        };
    }
 
    MRVIEWER_API VertUVCoords getUVcoords( const VertScalars & values, const VertBitSet & region, const VertPredicate & valids = {} ) const;
    MRVIEWER_API VertUVCoords getUVcoords( const VertScalars & values, const VertBitSet & region, const VertBitSet * valids ) const;
 
    // base parameters of palette
    struct Parameters
    {
        std::vector<float> ranges = { 0.f, 1.f }; // range limits for palette
        std::vector<Color> baseColors; // palette base colors (need for calculate real colors according discretization)
        int discretization = 7; // number of different colors for discrete palette
    };
 
    [[nodiscard]] const Parameters& getParameters() const { return parameters_; }
 
    [[nodiscard]] float getRangeMin() const { return parameters_.ranges.front(); }
 
    [[nodiscard]] float getRangeMax() const { return parameters_.ranges.back(); }
 
    [[nodiscard]] float getRangeSq() const { return std::max( sqr( getRangeMin() ), sqr( getRangeMax() ) ); }
 
    // returns formated string for this value of palette
    MRVIEWER_API std::string getStringValue( float value );
    // returns maximal label count
    MRVIEWER_API int getMaxLabelCount();
    // sets maximal label count
    MRVIEWER_API void setMaxLabelCount( int val );
 
private:
    void setRangeLimits_( const std::vector<float>& ranges );
 
    void updateDiscretizatedColors_();
    Color getBaseColor_( float val );
 
 
    // fill labels with equal distance between
    void setUniformLabels_();
    // first label is equal to min value, last - to the max val
    // don't use with MinMaxNegPos mode
    void setZeroCentredLabels_();
 
    void updateCustomLabels_();
 
    void sortLabels_();
 
    std::vector<Label> customLabels_;
    std::vector<Label> labels_;
    bool showLabels_ = false;
 
    // stores OpenGL textures. Change useDiscrete_ to switch between them
    MeshTexture texture_;
 
    // texture positions of min and max values
    float texStart_ = 0, texEnd_ = 1;
 
    Parameters parameters_;
 
    bool isWindowOpen_ = false;
 
    bool useCustomLabels_ = false;
 
    int maxLabelCount_ = 0;
 
    float prevMaxLabelWidth_ = 0.0f;
 
    static void resizeCallback_( ImGuiSizeCallbackData* data );
};
 
class PalettePresets
{
public:
    MRVIEWER_API static const std::vector<std::string>& getPresetNames();
    MRVIEWER_API static bool loadPreset( const std::string& name, Palette& palette );
    MRVIEWER_API static Expected<void> savePreset( const std::string& name, const Palette& palette );
    MRVIEWER_API static std::filesystem::path getPalettePresetsFolder();
private:
    PalettePresets();
    ~PalettePresets() = default;
 
    std::vector<std::string> names_;
    
    void update_();
 
    static PalettePresets& instance_();
};
 
}