ParamsLegendProperties.cc 7.21 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
/*
 * ParamsLegendProperties.cc
 *
 *  Created on: 18 sep. 2014
 *      Author: AKKA
 */

#include "ParamsLegendProperties.hh"

#include <cstring>

namespace plot
{


LegendLineProperties::LegendLineProperties(void) : _symbolProperties(),
			_lineProperties(), _text("None"), _textColor()
{
}

LegendLineProperties::~LegendLineProperties(void)
{
}

/*
 * @brief Get symbol
 */
const SymbolProperties& LegendLineProperties::getSymbolProperties(void) const
{
	return _symbolProperties;
}

/*
 * @brief Set symbol
 */
void LegendLineProperties::setSymbolProperties(const SymbolProperties& symbolProperties)
{
	_symbolProperties = symbolProperties;
}

/*
 * @brief Get line
 */
const LineProperties& LegendLineProperties::getLineProperties(void) const
{
	return _lineProperties;
}

/*
 * @brief Set line
 */
void LegendLineProperties::setLineProperties(const LineProperties& lineProperties)
{
	_lineProperties = lineProperties;
}

/*
 * @brief Get text
 */
const char *LegendLineProperties::getText(void) const
{
	return _text.c_str();
}

/*
 * @brief Set text
 */
void LegendLineProperties::setText(const char *text)
{
	_text = text;
}

/*
 * @brief Set default color
 */
void LegendLineProperties::setDefaultTextColor(const Color &textColor)
{
	_textColor = textColor;
}

/*
 * @brief Get color to use for text
 */
Color LegendLineProperties::getTextColor(bool autoTextColor)
{
	if (!autoTextColor)
		//use default color
		return _textColor;
	if (isLineVisible())
		//use line color
		return _lineProperties.getColor();
	if (isSymbolsVisible())
		//use symbol color
		return _symbolProperties.getColor();
	//else use default color
	return _textColor;
}

/*
 * @brief Line visibility
 */
bool LegendLineProperties::isLineVisible(void)
{
	return (_lineProperties.getType() == LineType::LINE);
}

/*
 * @brief Symbol visibility
 */
bool LegendLineProperties::isSymbolsVisible(void)
{
	return (_symbolProperties.getType() != SymbolType::NO);
}




ParamsLegendProperties::ParamsLegendProperties(void) :
		_isOnlyText(false),
		_defaultTextColor(Color(0,0,0)),
		_isBorderVisible(true), _borderColor(Color(0,0,0)),
		_isVisible(false), _position(ParamsLegendPosition::POS_INSIDE),
		_font("sans-serif", 12), _leftOffset(0.0), _drawn(false), _isParamInfoVisible(true),
		_isIntervalInfoVisible(false),
		_intervalInfoType(ParamsLegendProperties::IntervalInfoType::INDEX)
{

}

ParamsLegendProperties::~ParamsLegendProperties(void)
{
	reset();
}

/*
 * @brief Reset legend for a next plot
 */
void ParamsLegendProperties::reset(void)
{
	_lines.clear();
	_colors.clear();
	_drawn = false;
}

/*
 * @brief Add a serie to the legend
 */
void ParamsLegendProperties::addSerie(SeriesProperties &serie,
		const char *text, Color lineColor, Color symbolColor)
{
	LegendLineProperties lineProp;

	SymbolProperties symbol = serie.getSymbolProperties();
	symbol.setColor(symbolColor);
	lineProp.setSymbolProperties(symbol);

	LineProperties line = serie.getLineProperties();
	line.setColor(lineColor);
	lineProp.setLineProperties(line);

	lineProp.setText(text);

	lineProp.setDefaultTextColor(_defaultTextColor);

	_lines.push_back(lineProp);
}

/*
 * @brief Get color index from a color
 * Create a list of used color
 */
int ParamsLegendProperties::getColorIndex(plstream *pls, Color color)
{
	int r, g, b;

	if (color._colorIndex != -1)
		pls->gcol0(color._colorIndex, r, g,	b);
	else
	{
		r = color._red;
		g = color._green;
		b = color._blue;
	}

	int index = 0;
	for (auto col : _colors)
	{
		if ((col._red == r) &&
			(col._green == g) &&
			(col._blue == b))
			return index;
		++index;
	}

	Color newCol(r,g,b);
	_colors.push_back(newCol);

	return index;
}

/*
 * @brief Set only text option
 */
void ParamsLegendProperties::setOnlyText(bool onlyText)
{
	_isOnlyText = onlyText;
}

/*
 * @brief Get only text option
 */
bool ParamsLegendProperties::isOnlyText(void)
{
	return _isOnlyText;
}

/*
 * @brief Set font
 */
void ParamsLegendProperties::setFont(Font font)
{
	_font = font;
}

/*
 * @brief Get font
 */
Font& ParamsLegendProperties::getFont(void)
{
	return _font;
}

/*
 * @brief Set default text color
 */
void ParamsLegendProperties::setDefaultTextColor(const Color& color)
{
	_defaultTextColor = color;

	for (auto lineProp : _lines)
	{
		lineProp.setDefaultTextColor(_defaultTextColor);
	}
}

/*
 * @brief Set border color
 */
void ParamsLegendProperties::setBorderColor(const Color& color)
{
	_borderColor = color;
}

/*
 * @brief Get border color
 */
Color ParamsLegendProperties::getBorderColor(void)
{
	return _borderColor;
}

/*
 * @brief Set visibility of border
 */
void ParamsLegendProperties::setIsBorderVisible(bool boderVisible)
{
	_isBorderVisible = boderVisible;
}

/*
 * @brief Get visibility of border
 */
bool ParamsLegendProperties::isBorderVisible(void)
{
	return _isBorderVisible;
}

/*
 * @brief Get visibility of legend
 */
bool ParamsLegendProperties::isVisible(void)
{
	return _isVisible;
}

/*
 * @brief Set visibility of the legend
 */
void ParamsLegendProperties::setIsVisible(bool isVisible)
{
	_isVisible = isVisible;
}

/*
 * @brief Get position
 */
ParamsLegendPosition ParamsLegendProperties::getPosition(void)
{
	return _position;
}

/*
 * @brief Set position
 */
void ParamsLegendProperties::setPosition(ParamsLegendPosition position)
{
	_position = position;
}

/*
 * @brief Get left offset
 */
double ParamsLegendProperties::getLeftOffset(void)
{
	return _leftOffset;
}

/*
 * @brief Set left offset
 */
void ParamsLegendProperties::setLeftOffset(double offset)
{
	_leftOffset = offset;
}

/*
 * @brief Estimate the width of the legend
 */
double ParamsLegendProperties::getEstimateWidth(double charSize)
{
	int maxNbChar = 0;
	for (auto line : _lines)
	{
		maxNbChar = std::max(maxNbChar,(int)strlen(line.getText()));
	}

	double width = charSize * (LEGEND_TEXT_OFFSET+maxNbChar);
	if (!_isOnlyText)
		width += LEGEND_LINE_SYM_WIDTH;
	//else
	//	width += charSize * LEGEND_TEXT_OFFSET;

	return width;
}

/*
 * @brief Get list of legend lines
 */
const std::list<LegendLineProperties>& ParamsLegendProperties::getLegendLines(void) const
{
	return _lines;
}

/*
 * @brief Get list of color used by the legend
 */
const std::vector<Color>& ParamsLegendProperties::getColorsMap(void) const
{
	return _colors;
}

/*
 * @brief To know if the legend is already drawn
 */
bool ParamsLegendProperties::isDrawn(void)
{
	return _drawn;
}

/*
 * @brief Set if legend is drawn
 */
void ParamsLegendProperties::setDrawn(bool drawn)
{
	_drawn = drawn;
}

/*
 * @brief Set param info visibility
 */
void ParamsLegendProperties::setParamInfoVisible(bool isVisible)
{
	_isParamInfoVisible = isVisible;
}

/*
 * @brief Get param info visibility
 */
bool ParamsLegendProperties::isParamInfoVisible(void)
{
	return _isParamInfoVisible;
}

/*
 * @brief Set interval info visibility
 */
void ParamsLegendProperties::setIntervalInfoVisible(bool isVisible)
{
	_isIntervalInfoVisible = isVisible;
}

/*
 * @brief Get interval info visibility
 */
bool ParamsLegendProperties::isIntervalInfoVisible(void)
{
	return _isIntervalInfoVisible;
}

/*
 * @brief Set interval info type
 */
void ParamsLegendProperties::setIntervalInfoType(IntervalInfoType type)
{
	_intervalInfoType = type;
}

/*
 * @brief Get interval info type
 */
ParamsLegendProperties::IntervalInfoType ParamsLegendProperties::getIntervalInfoType(void)
{
	return _intervalInfoType;
}

} /* namespace plot */