Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
ui.h
1/*
2** Copyright 2007-2024, RTE (https://www.rte-france.com)
3** See AUTHORS.txt
4** SPDX-License-Identifier: MPL-2.0
5** This file is part of Antares-Simulator,
6** Adequacy and Performance assessment for interconnected energy networks.
7**
8** Antares_Simulator is free software: you can redistribute it and/or modify
9** it under the terms of the Mozilla Public Licence 2.0 as published by
10** the Mozilla Foundation, either version 2 of the License, or
11** (at your option) any later version.
12**
13** Antares_Simulator is distributed in the hope that it will be useful,
14** but WITHOUT ANY WARRANTY; without even the implied warranty of
15** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16** Mozilla Public Licence 2.0 for more details.
17**
18** You should have received a copy of the Mozilla Public Licence 2.0
19** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
20*/
21#ifndef __ANTARES_LIBS_STUDY_UI_H__
22#define __ANTARES_LIBS_STUDY_UI_H__
23
24#include <map>
25
26#include <yuni/yuni.h>
27#include <yuni/core/string.h>
28
29namespace Antares
30{
31namespace Data
32{
36class AreaUI final
37{
38public:
40 AreaUI();
41
44 {
46 }
47
51 void reset();
52
56 bool loadFromFile(const AnyString& filename);
57
64 bool saveToFile(const AnyString& filename, bool force = false) const;
65
69 bool modified() const;
70
74 void markAsModified();
75
76 void rebuildCache();
77
78public:
80 int x;
81 std::map<size_t, int> layerX;
83 int y;
84 std::map<size_t, int> layerY;
85
87 int color[3];
88 std::map<size_t, int[3]> layerColor;
89
91 // \see UIRuntimeInfo::reload()
92 Yuni::CString<12, false> cacheColorHSV;
93
95 std::vector<size_t> mapLayersVisibilityList;
96
97private:
99 mutable bool pModified;
100
101}; // class AreaUI
102
103} // namespace Data
104} // namespace Antares
105
106#endif // __ANTARES_LIBS_STUDY_UI_H__
Information about the Area for the UI.
Definition ui.h:37
~AreaUI()
Default constructor.
Definition ui.h:43
bool loadFromFile(const AnyString &filename)
Load settings from an INI file.
Definition ui.cpp:214
int y
The Y-Coordinate.
Definition ui.h:83
int x
The X-Coordinate.
Definition ui.h:80
void reset()
(Re)Initialize all properties
Definition ui.cpp:197
std::vector< size_t > mapLayersVisibilityList
The list of layers this Node will appear on.
Definition ui.h:95
bool modified() const
Get if the structure has been modified.
Definition ui.cpp:366
int color[3]
Color of the area (RGB)
Definition ui.h:87
void markAsModified()
Mark the structure as modified.
Definition ui.cpp:371
bool saveToFile(const AnyString &filename, bool force=false) const
Save the settings into a file.
Definition ui.cpp:313
Yuni::CString< 12, false > cacheColorHSV
HSV color model (only computed from the interface)
Definition ui.h:92
AreaUI()
Default constructor.
Definition ui.cpp:185