Blame view

src/ParamOutputImpl/Plot/Panel.cc 10.4 KB
fbe3c2bb   Benjamin Renard   First commit
1
2
3
4
5
6
7
8
9
10
11
12
/*
 * Panel.cc
 *
 *  Created on: 28 oct. 2013
 *      Author: CS
 */

#include "Panel.hh"
#include "DefaultPlotConfiguration.hh"
#include "ColormapManager.hh"
#include "Label.hh"
#include "PlotLogger.hh"
f6eaec4e   Benjamin Renard   Optimize plot ele...
13
#include "PlPlotUtil.hh"
fbe3c2bb   Benjamin Renard   First commit
14
15
16
17


namespace plot {

85bb5117   Benjamin Renard   Give the possibil...
18
19
//Auto id set to a negative number to preserve id defined in request
int Panel::PANEL_COUNTER = -1;
fbe3c2bb   Benjamin Renard   First commit
20
21

Panel::Panel() :
85bb5117   Benjamin Renard   Give the possibil...
22
		_id(--PANEL_COUNTER),
fbe3c2bb   Benjamin Renard   First commit
23
		_resolution(0),
fbe3c2bb   Benjamin Renard   First commit
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
		_updateTitleOnNextInterval(false),
		_bounds(Bounds()),
		_backgroundColor(Color()),
		_titleAlign(PlotCommon::Align::CENTER),
		_titlePosition(PlotCommon::Position::POS_TOP),
		_drawn(false),
		_page(),
		_preferedWidth(-1),
		_preferedHeight(-1),
		_leftMargin(-1),
		_rightMargin(-1),
		_topMargin(-1),
		_bottomMargin(-1),
		_paramsLegendProperties(),
		_textLegendPropertiesList(),
f6eaec4e   Benjamin Renard   Optimize plot ele...
39
40
		_font(Font("", 0)),
		_title(Font("", 0))
fbe3c2bb   Benjamin Renard   First commit
41
42
43
44
{
}

Panel::Panel(DefaultPlotConfiguration& defaults) :
85bb5117   Benjamin Renard   Give the possibil...
45
		_id(--PANEL_COUNTER),
fbe3c2bb   Benjamin Renard   First commit
46
		_resolution(defaults._defaultPanel._resolution),
fbe3c2bb   Benjamin Renard   First commit
47
48
49
50
51
52
53
54
55
56
57
58
59
60
		_updateTitleOnNextInterval(false),
		_bounds(Bounds()),
		_backgroundColor(defaults._defaultPanel._backgroundColor),
		_titleAlign(defaults._defaultPanel._titleAlign),
		_titlePosition(defaults._defaultPanel._titlePosition),
		_drawn(false),
		_page(),
		_preferedWidth(defaults._defaultPanel._preferedWidth),
		_preferedHeight(defaults._defaultPanel._preferedHeight),
		_leftMargin(defaults._defaultPanel._leftMargin),
		_rightMargin(defaults._defaultPanel._rightMargin),
		_topMargin(defaults._defaultPanel._topMargin),
		_bottomMargin(defaults._defaultPanel._bottomMargin),
		_textLegendPropertiesList(defaults._defaultPanel._textLegendPropertiesList),
f6eaec4e   Benjamin Renard   Optimize plot ele...
61
62
		_font(defaults._defaultPanel.getFont()),
		_title(defaults._defaultPanel.getFont())
fbe3c2bb   Benjamin Renard   First commit
63
64
65
66
{
}

Panel::Panel(Page* page) :
85bb5117   Benjamin Renard   Give the possibil...
67
		_id(--PANEL_COUNTER),
fbe3c2bb   Benjamin Renard   First commit
68
		_resolution(DefaultPlotConfiguration::getInstance()._defaultPanel._resolution),
fbe3c2bb   Benjamin Renard   First commit
69
70
71
72
73
74
75
76
77
78
79
80
81
82
		_updateTitleOnNextInterval(false),
		_bounds(Bounds()),
		_backgroundColor(DefaultPlotConfiguration::getInstance()._defaultPanel._backgroundColor),
		_titleAlign(DefaultPlotConfiguration::getInstance()._defaultPanel._titleAlign),
		_titlePosition(DefaultPlotConfiguration::getInstance()._defaultPanel._titlePosition),
		_drawn(false),
		_page(page),
		_preferedWidth(DefaultPlotConfiguration::getInstance()._defaultPanel._preferedWidth),
		_preferedHeight(DefaultPlotConfiguration::getInstance()._defaultPanel._preferedHeight),
		_leftMargin(DefaultPlotConfiguration::getInstance()._defaultPanel._leftMargin),
		_rightMargin(DefaultPlotConfiguration::getInstance()._defaultPanel._rightMargin),
		_topMargin(DefaultPlotConfiguration::getInstance()._defaultPanel._topMargin),
		_bottomMargin(DefaultPlotConfiguration::getInstance()._defaultPanel._bottomMargin),
		_textLegendPropertiesList(DefaultPlotConfiguration::getInstance()._defaultPanel._textLegendPropertiesList),
f6eaec4e   Benjamin Renard   Optimize plot ele...
83
84
85
86
87
88
		_font(Font(
					DefaultPlotConfiguration::getInstance()._defaultPanel.getFont()._name.empty() ?
							page->getFont()._name : DefaultPlotConfiguration::getInstance()._defaultPanel.getFont()._name,
					DefaultPlotConfiguration::getInstance()._defaultPanel.getFont()._size != 0 ?
							DefaultPlotConfiguration::getInstance()._defaultPanel.getFont()._size : page->getFont()._size)),
		_title(_font)
fbe3c2bb   Benjamin Renard   First commit
89
90
91
92
93
94
95
{
}

Panel::~Panel() {

}

f6eaec4e   Benjamin Renard   Optimize plot ele...
96
97
98
99
100
101
102
103
Font Panel::getTitleFont() {
	Font titleFont(_title.getFont());
	if (titleFont._name == "")
		titleFont._name = _font._name;
	if (titleFont._size == 0)
		titleFont._size = _font._size;
	return titleFont;
}
fbe3c2bb   Benjamin Renard   First commit
104

f6eaec4e   Benjamin Renard   Optimize plot ele...
105
106
107
108
void Panel::reserveSpaceForTitle(double& topSpace, double& bottomSpace, double& titleHeight) {
	LabelRowInfo titleRows(Label::getRowNumber(_title));
	if (titleRows->empty())
		return;
fbe3c2bb   Benjamin Renard   First commit
109

f6eaec4e   Benjamin Renard   Optimize plot ele...
110
	CharSize lCharSizeTitle;
fbe3c2bb   Benjamin Renard   First commit
111

f6eaec4e   Benjamin Renard   Optimize plot ele...
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
	Font titleFont(getTitleFont());
	PlPlotUtil::setPlFont(titleFont, &_title._style);
	lCharSizeTitle = PlPlotUtil::getCharacterSizeInPlPage(_page);

	titleHeight = (titleRows->size() + PlPlotUtil::LINE_SPACE_TITLE * (titleRows->size() + 1)) * lCharSizeTitle.second;

	switch (_titlePosition)
	{
		case PlotCommon::Position::POS_TOP :
			topSpace += titleHeight;
			break;
		case PlotCommon::Position::POS_BOTTOM :
			bottomSpace += titleHeight;
			break;
		default :
			//Not possible - Nothing to do
			;
	}
}

void Panel::drawTitle(std::shared_ptr<plstream>& pls) {
	LabelRowInfo titleRows(Label::getRowNumber(_title));
	if (titleRows->empty())
fbe3c2bb   Benjamin Renard   First commit
135
136
		return;

f6eaec4e   Benjamin Renard   Optimize plot ele...
137
138
	if ((_titlePosition != PlotCommon::Position::POS_TOP) && (_titlePosition != PlotCommon::Position::POS_BOTTOM))
		return;
fbe3c2bb   Benjamin Renard   First commit
139

f6eaec4e   Benjamin Renard   Optimize plot ele...
140
141
	// Compute panel coordinate in the page
	Bounds lBounds = getBoundsInPlPage();
2d40f7de   Benjamin Renard   Fix bug with pane...
142
143
144

	Color lInitialColor = changeColor(pls, _title._color, _page->_mode);

f6eaec4e   Benjamin Renard   Optimize plot ele...
145
146
	Font titleFont(getTitleFont());
	PlPlotUtil::setPlFont(titleFont, &_title._style);
fbe3c2bb   Benjamin Renard   First commit
147

f6eaec4e   Benjamin Renard   Optimize plot ele...
148
149
150
	// Specify viewport for the panel
	pls->vpor(lBounds._x, lBounds._x + lBounds._width,
			  lBounds._y, lBounds._y + lBounds._height);
fbe3c2bb   Benjamin Renard   First commit
151

f6eaec4e   Benjamin Renard   Optimize plot ele...
152
	float lRowDisp = -0.5 - PlPlotUtil::LINE_SPACE_TITLE;
fbe3c2bb   Benjamin Renard   First commit
153

fbe3c2bb   Benjamin Renard   First commit
154
	// Draw each line of title
f6eaec4e   Benjamin Renard   Optimize plot ele...
155
156
157
158
159
160
161
162
	for (auto row : *(titleRows.get())) {
		pls->mtex(
				getPlSide(_titlePosition).c_str(),
				lRowDisp,
				getPlPos(_titleAlign),
				getPlJust(_titleAlign),
				row.c_str()
				);
fbe3c2bb   Benjamin Renard   First commit
163
164

		// 1 is for full character and then let space between two line.
f6eaec4e   Benjamin Renard   Optimize plot ele...
165
		lRowDisp -= (1 + PlPlotUtil::LINE_SPACE_TITLE);
fbe3c2bb   Benjamin Renard   First commit
166
167
	}

2d40f7de   Benjamin Renard   Fix bug with pane...
168
169
	// Restore initial color.
	restoreColor(pls, lInitialColor, _page->_mode);
f6eaec4e   Benjamin Renard   Optimize plot ele...
170
171
172
173
174
175
176
177
178
179
180
181
182
}


void Panel::draw(std::shared_ptr<plstream>& pls) {
	if (_drawn)
		//panel is already drawn => no draw background and title
		return;

	// Draw background
	fillBackground(pls);

	// write title with dedicated position and align
	drawTitle(pls);
2d40f7de   Benjamin Renard   Fix bug with pane...
183

fbe3c2bb   Benjamin Renard   First commit
184
185
186
	_drawn = true;
}

8499fbdd   Benjamin Renard   Context file gene...
187
188
189
/**
 * @brief Write panel context
 */
f6eaec4e   Benjamin Renard   Optimize plot ele...
190
191
void Panel::writeContext(std::shared_ptr<plstream>& /*pls*/, ContextFileWriter& writer) {
	Bounds lBounds = getBoundsInPlPage();
85bb5117   Benjamin Renard   Give the possibil...
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
	writer.addAttribute("id", std::to_string(_id).c_str());
	if (_page->_orientation == PlotCommon::Orientation::PORTRAIT)
	{
		writer.addAttribute("x", std::to_string(lBounds._y*std::get<0>(_page->getSize())).c_str());
		writer.addAttribute("y", std::to_string(lBounds._x*std::get<1>(_page->getSize())).c_str());
		writer.addAttribute("width", std::to_string(lBounds._height*std::get<0>(_page->getSize())).c_str());
		writer.addAttribute("height", std::to_string(lBounds._width*std::get<1>(_page->getSize())).c_str());
	}
	else
	{
		writer.addAttribute("x", std::to_string(lBounds._x*std::get<0>(_page->getSize())).c_str());
		writer.addAttribute("y", std::to_string(lBounds._y*std::get<1>(_page->getSize())).c_str());
		writer.addAttribute("width", std::to_string(lBounds._width*std::get<0>(_page->getSize())).c_str());
		writer.addAttribute("height", std::to_string(lBounds._height*std::get<1>(_page->getSize())).c_str());
	}
8499fbdd   Benjamin Renard   Context file gene...
207

8499fbdd   Benjamin Renard   Context file gene...
208
209
}

f6eaec4e   Benjamin Renard   Optimize plot ele...
210
void Panel::fillBackground(std::shared_ptr<plstream>& pls) {
fbe3c2bb   Benjamin Renard   First commit
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
	// If color map index is not equal to 0, need to change cmap0.
	if (_backgroundColor._colorMapIndex != -1) {
		std::string lFilePath = ColormapManager::getInstance().get(_page->_mode,
				_backgroundColor._colorMapIndex);
		pls->spal0(lFilePath.c_str());
	}

	PLINT lInitialRed = -1, lInitialGreen = -1, lInitialBlue = -1;
	// if color index is equal to 0 choose the first color in cmap 0
	if (_backgroundColor._colorIndex != -1) {
		pls->col0(_backgroundColor._colorIndex);
	} else if (_backgroundColor._red != -1 && _backgroundColor._green != -1
			&& _backgroundColor._blue != -1) {
		// Store initial color in first index.
		pls->gcol0(0, lInitialRed, lInitialGreen, lInitialBlue);
		pls->scol0(0, _backgroundColor._red, _backgroundColor._green,
				_backgroundColor._blue);
		pls->col0(0);
	} else {
		// chose first color in cmap0.
		pls->col0(0);
	}

f6eaec4e   Benjamin Renard   Optimize plot ele...
234
235
236
237
238
239
240
241
242
243
	// Compute panel coordinate in the page
	Bounds lBounds = getBoundsInPlPage();

	// Specify viewport for the panel
	pls->vpor(lBounds._x, lBounds._x + lBounds._width,
			  lBounds._y, lBounds._y + lBounds._height);

	// Set window size.
	pls->wind(0, 1, 0, 1);

fbe3c2bb   Benjamin Renard   First commit
244
	// Fill background.
f6eaec4e   Benjamin Renard   Optimize plot ele...
245
246
	PLFLT px[] = { 0, 0, 1, 1 };
	PLFLT py[] = { 0, 1, 1, 0 };
fbe3c2bb   Benjamin Renard   First commit
247
248
249
250
251
252
253
254
255
256
257
	pls->fill(4, px, py);

	// Restore initial color in first index.
	if (lInitialRed != -1 && lInitialGreen != -1 && lInitialBlue != -1) {
		pls->scol0(0, lInitialRed, lInitialGreen, lInitialBlue);
	} else if (_backgroundColor._colorMapIndex != -1) {
		// Restore default cmap0 (default colormap for cmap0 is the first index).
		std::string lFilePath = ColormapManager::getInstance().get(_page->_mode,
				0);
		pls->spal0(lFilePath.c_str());
	}
f6eaec4e   Benjamin Renard   Optimize plot ele...
258
259

	pls->col0(0);
fbe3c2bb   Benjamin Renard   First commit
260
261
}

b96aa975   Benjamin Renard   Draw border aroun...
262
263
void Panel::drawEmptyPanel(std::shared_ptr<plstream>& pls)
{
f6eaec4e   Benjamin Renard   Optimize plot ele...
264
	Bounds lBounds = getBoundsInPlPage();
b96aa975   Benjamin Renard   Draw border aroun...
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284

	// Specify viewport for the panel
	pls->vpor(lBounds._x, lBounds._x + lBounds._width,
			  lBounds._y, lBounds._y + lBounds._height);

	// Set window size.
	pls->wind(0, 1, 0, 1);


	pls->col0(0);

	//Draw panel border
	PLFLT xBorder[5] = {0,0,1,1,0};
	PLFLT yBorder[5] = {0,1,1,0,0};

	pls->lsty(static_cast<int>(getPlLineStyle(LineStyle::LONG_SPACED_DOT)));
	pls->width(1);
	pls->line(5,xBorder,yBorder);

	//Draw text
f6eaec4e   Benjamin Renard   Optimize plot ele...
285
	PlPlotUtil::setPlFont(_font);
85bb5117   Benjamin Renard   Give the possibil...
286
287
288
289
	std::string emptyText = "Empty panel (Id : ";
	emptyText += std::to_string(_id);
	emptyText += ")";
	pls->ptex (0.5, 0.5, 0.5, 0, 0.5, emptyText.c_str());
b96aa975   Benjamin Renard   Draw border aroun...
290
291
292
293
294
295

	// Set window size.
	pls->wind(lBounds._x, lBounds._x + lBounds._width,
			  lBounds._y, lBounds._y + lBounds._height);
}

f6eaec4e   Benjamin Renard   Optimize plot ele...
296
297
298
299
Bounds Panel::getBoundsInPlPage() {
	Bounds drawableBounds;
	//Drawable bounds in PlPlot page
	_page->getDrawableBoundsInPlPage(drawableBounds);
fbe3c2bb   Benjamin Renard   First commit
300

f6eaec4e   Benjamin Renard   Optimize plot ele...
301
302
303
304
305
306
	//Panel bounds is relative to the drawable bounds => rewrite it relative to the PlPlot page
	Bounds panelBounds;
	panelBounds._x = drawableBounds._x + drawableBounds._width * _bounds._x;
	panelBounds._y = drawableBounds._y + drawableBounds._height * _bounds._y;
	panelBounds._width = drawableBounds._width * _bounds._width;
	panelBounds._height = drawableBounds._height * _bounds._height;
fbe3c2bb   Benjamin Renard   First commit
307

f6eaec4e   Benjamin Renard   Optimize plot ele...
308
	return panelBounds;
fbe3c2bb   Benjamin Renard   First commit
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
}

std::ostream& operator <<(std::ostream& out, Bounds& bounds) {
	out << "[BOUNDS]" << std::endl;
	out << "bounds.x=" << bounds._x << std::endl;
	out << "bounds.y=" << bounds._y << std::endl;
	out << "bounds.width=" << bounds._width << std::endl;
	out << "bounds.height=" << bounds._height << std::endl;

	return out;
}

std::ostream& operator <<(std::ostream& out, Panel& panel) {
	out << "[PANEL]" << std::endl;
	out << "panel.resolution=" << panel._resolution << std::endl;
f6eaec4e   Benjamin Renard   Optimize plot ele...
324
	out << "panel.title=" << panel.getTitle()->_text << std::endl;
fbe3c2bb   Benjamin Renard   First commit
325
326
	out << "panel.title.align=" << panel._titleAlign << std::endl;
	out << "panel.title.position=" << panel._titlePosition << std::endl;
f6eaec4e   Benjamin Renard   Optimize plot ele...
327
	out << panel._bounds << panel._backgroundColor << panel.getFont();
fbe3c2bb   Benjamin Renard   First commit
328
329
330
331
332
333
334
335
	for (auto axe : panel._axes) {
		if (axe.second != nullptr)
			axe.second.get()->dump(out);
	}
	return out;
}

} /* namespace plot */