MRPythonUiInteraction.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <optional>
#include <string>
#include <utility>
#include <vector>
 
namespace MR::PythonViewer
{

enum class UiEntryType
{
    button,
    group,
    valueInt,
    valueUint,
    valueReal,
    valueString,
};
 
struct UiEntry
{
    std::string name;
    UiEntryType type = UiEntryType::button;
    std::string status;
};
 
struct UiValueInt
{
    std::int64_t value = 0;
    std::int64_t min = 0;
    std::int64_t max = 0;
};
 
struct UiValueUint
{
    std::uint64_t value = 0;
    std::uint64_t min = 0;
    std::uint64_t max = 0;
};
 
struct UiValueReal
{
    double value = 0;
    double min = 0;
    double max = 0;
};
 
struct UiValueString
{
    std::string value;
    std::optional<std::vector<std::string>> allowed;
};


[[nodiscard]] std::vector<UiEntry> _uiListEntries( const std::vector<std::string>& path );

[[nodiscard]] std::vector<std::pair<std::vector<std::string>, UiEntry>> _uiListAllEntries( const std::vector<std::string>& rootPath );

void uiPressButton( const std::vector<std::string>& path );

[[nodiscard]] UiValueInt uiReadValueInt( const std::vector<std::string>& path );

[[nodiscard]] UiValueUint uiReadValueUint( const std::vector<std::string>& path );

[[nodiscard]] UiValueReal uiReadValueReal( const std::vector<std::string>& path );

[[nodiscard]] UiValueString uiReadValueString( const std::vector<std::string>& path );

void uiWriteValue( const std::vector<std::string>& path, std::int64_t value );

void uiWriteValue( const std::vector<std::string>& path, std::uint64_t value );

void uiWriteValue( const std::vector<std::string>& path, double value );

void uiWriteValue( const std::vector<std::string>& path, const std::string& value );
 
}