fractorium/Source/Fractorium/PaletteEditor/GradientArrow.h

/****************************************************************************/
// This file is part of the gradLib library originally made by Stian Broen
//
// For more free libraries, please visit <http://broentech.no>
//
// gradLib is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this library.  If not, see <http://www.gnu.org/licenses/>
/****************************************************************************/

#pragma once

#include "FractoriumPch.h"

/// <summary>
/// Class for drawing the small arrows below the gradient in the palette editor.
/// The drawing is accomplished via a QPolygon object.
/// </summary>
class GradientArrow
{
public:
	/// <summary>
	/// Default constructor which sets up the size of the arrow.
	/// </summary>
	explicit GradientArrow()
	{
		QPolygon area;
		area << QPoint(5, 5) << QPoint(10, 0) << QPoint(15, 5) << QPoint(15, 15) << QPoint(5, 15) << QPoint(5, 5);
		Area(area);
	}

	/// <summary>
	/// Constructor which takes the color and focus state of the arrow.
	/// </summary>
	/// <param name="col">The color of the arrow</param>
	/// <param name="focus">Whether the arrow is focused</param>
	explicit GradientArrow(QColor col, bool focus)
		: GradientArrow()
	{
		m_Color = col;
		m_Focus = focus;
	}

	/// <summary>
	/// Copy constructor to copy another GradientArrow.
	/// </summary>
	/// <param name="other">The GradientArrow object to copy</param>
	GradientArrow(const GradientArrow& other)
		: m_Focus(other.Focus()),
		  m_Area(other.Area()),
		  m_Color(other.Color())
	{
	}

	/// <summary>
	/// Getters and setters.
	/// </summary>
	inline bool Focus() const { return m_Focus; }
	inline void Focus(bool val) { m_Focus = val; }
	inline const QPolygon Area() const { return m_Area; }
	inline void Area(const QPolygon& val) {m_Area = val; }
	inline const QColor Color() const { return m_Color; }
	inline void Color(const QColor& val) { m_Color = val; }

private:
	bool m_Focus;
	QPolygon m_Area;
	QColor m_Color;
};

/// <summary>
/// Thin derivation to handle drawing arrows at the top of the gradient area to
/// represent the color indices of each xform.
/// </summary>
class TopArrow : public GradientArrow
{
public:
	/// <summary>
	/// Default constructor which is only present so this class can be used with containers.
	/// This should never be used by a caller.
	/// </summary>
	TopArrow()
		: TopArrow(10, 0)
	{
	}

	/// <summary>
	/// Constructor which takes the width used to draw the arrow and the xform index
	/// this arrow represents.
	/// </summary>
	/// <param name="width">The width used to draw the arrow</param>
	/// <param name="index">The xform index this arrow represents</param>
	TopArrow(int width, size_t index)
	{
		QPolygon area;
		constexpr int center = 10;
		const auto mid = width / 2;
		const auto left = center - mid;
		const auto right = center + mid;
		area << QPoint(left, 0) << QPoint(right, 0) << QPoint(right, 10) << QPoint(center, 15) << QPoint(left, 10) << QPoint(left, 0);
		Area(area);
		m_Index = index;
		m_Width = width;
		m_Text = QString::number(index + 1);
	}

	/// <summary>
	/// Getters.
	/// </summary>
	int Width() { return m_Width; }
	size_t Index() { return m_Index; }
	QString Text() { return m_Text; }

private:
	int m_Width;
	size_t m_Index;
	QString m_Text;
};