BansheeEngine/Source/EditorCore/GUI/BsGUICurvesField.h

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2018 Marko Pintera ([email protected]). All rights reserved. **********************//
#pragma once

#include "BsEditorPrerequisites.h"
#include "GUI/BsGUIFieldBase.h"
#include "Animation/BsAnimationCurve.h"

namespace bs
{
	class GUICurves;

	/** @addtogroup GUI-Editor
	 *  @{
	 */

	/**
	 * A composite GUI object representing an editor field. Editor fields are a combination of a label and an input field.
	 * Label is optional. This specific implementation displays an animation curve or a range between two animation curves.
	 */
	class BS_ED_EXPORT BS_SCRIPT_EXPORT(ed:true,m:GUIEditor) GUICurvesField final : public TGUIField<GUICurvesField>
	{
	public:
		/** Returns type name of the GUI element used for finding GUI element styles. */
		static const String& getGUITypeName();

		/** Style type name for the internal curve field. */
		static const String& getCurveStyleType();

		GUICurvesField(const PrivatelyConstruct& dummy, const GUIContent& labelContent, UINT32 labelWidth,
			const String& style, const GUIDimensions& dimensions, bool withLabel);

		/** Sets an animation curve to display on the field. */
		BS_SCRIPT_EXPORT() 
		void setCurve(const TAnimationCurve<float>& curve);

		/** Sets a set of animation curves and displays the difference (range) between them. */
		BS_SCRIPT_EXPORT()
		void setCurveRange(const TAnimationCurve<float>& curveA, const TAnimationCurve<float>& curveB);

		/** 
		 * Returns the curve represented by the field. If the field represents a curve range this returns the minimal
		 * curve of that range.
		 */
		BS_SCRIPT_EXPORT(pr:getter,n:Curve)
		const TAnimationCurve<float>& getCurve() const;

		/** 
		 * Returns the minimal curve represented by the field containing a curve range. Returns the only available
		 * curve if the field doesn't represent a range.
		 */
		BS_SCRIPT_EXPORT(pr:getter,n:MinCurve)
		const TAnimationCurve<float>& getMinCurve() const;

		/** 
		 * Returns the maximal curve represented by the field containing a curve range. Returns the only available
		 * curve if the field doesn't represent a range.
		 */
		BS_SCRIPT_EXPORT(pr:getter,n:MaxCurve)
		const TAnimationCurve<float>& getMaxCurve() const;

		/** @copydoc GUIElement::setTint */
		void setTint(const Color& color) override;

		BS_SCRIPT_EXPORT(in:true) 
		Event<void()> onClicked; /**< Triggered when the user clicks on the GUI element. */

		/** @name Internal 
		 *  @{
		 */

		/** @copydoc GUIElement::_getOptimalSize */
		Vector2I _getOptimalSize() const override;

		/** @} */

	protected:
		/** @copydoc GUIElement::styleUpdated */
		void styleUpdated() override;

		/**	Triggered when the child color input field is clicked on. */
		void clicked();

		UINT32 mLabelWidth = 100;
		GUILabel* mLabel = nullptr;
		GUICurves* mCurves = nullptr;
	};

	/** @} */
}