Magic_Game/src/kiwano/render/Brush.h

// Copyright (c) 2016-2018 Kiwano - Nomango
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#pragma once
#include <kiwano/core/ObjectBase.h>
#include <kiwano/render/dx/D2DDeviceResources.h>

namespace kiwano
{
	class RenderContext;
	class Renderer;

	KGE_DECLARE_SMART_PTR(Brush);

	/**
	* \addtogroup Render
	* @{
	*/

	/// \~chinese
	/// @brief <20><><EFBFBD><EFBFBD>ת<EFBFBD><D7AA><EFBFBD><EFBFBD>
	struct GradientStop
	{
		float offset;	///< ƫ<>ƾ<EFBFBD><C6BE><EFBFBD>
		Color color;	///< <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ɫ

		GradientStop();

		GradientStop(float offset, Color color);
	};

	/// \~chinese
	/// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ģʽ
	/// @details <20><>ģʽ<C4A3><CABD><EFBFBD><EFBFBD>ָ<EFBFBD><D6B8><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>λ<EFBFBD><CEBB><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>IJ<EFBFBD><C4B2><EFBFBD>
	enum class GradientExtendMode
	{
		Clamp,	///< <20><>ģʽ<C4A3><CABD><EFBFBD>ظ<EFBFBD><D8B8><EFBFBD><EFBFBD>Ʊ߽<C6B1><DFBD><EFBFBD>ɫ
		Wrap,	///< <20><><EFBFBD><EFBFBD>ģʽ<C4A3><CABD><EFBFBD>ظ<EFBFBD><D8B8><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
		Mirror	///< <20><><EFBFBD><EFBFBD>ģʽ<C4A3><CABD><EFBFBD><EFBFBD>ת<EFBFBD><D7AA><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
	};

	/// \~chinese
	/// @brief <20><><EFBFBD>Խ<EFBFBD><D4BD><EFBFBD><EFBFBD><EFBFBD>ʽ
	struct LinearGradientStyle
	{
		Point begin;					///< <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʼ<EFBFBD><CABC>
		Point end;						///< <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ֹ<EFBFBD><D6B9>
		Vector<GradientStop> stops;		///< <20><><EFBFBD><EFBFBD>ת<EFBFBD><D7AA><EFBFBD>㼯<EFBFBD><E3BCAF>
		GradientExtendMode extend_mode;	///< <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ģʽ

		LinearGradientStyle(Point const& begin, Point const& end, Vector<GradientStop> const& stops, GradientExtendMode extend_mode = GradientExtendMode::Clamp);
	};

	/// \~chinese
	/// @brief <20><><EFBFBD>򽥱<EFBFBD><F2BDA5B1><EFBFBD>ʽ
	struct RadialGradientStyle
	{
		Point center;					///< <20><><EFBFBD>򽥱<EFBFBD>Բ<EFBFBD><D4B2>
		Vec2 offset;					///< <20><><EFBFBD>򽥱<EFBFBD>ƫ<EFBFBD><C6AB>
		Vec2 radius;					///< <20><><EFBFBD>򽥱<EFBFBD><F2BDA5B1>뾶
		Vector<GradientStop> stops;		///< <20><><EFBFBD><EFBFBD>ת<EFBFBD><D7AA><EFBFBD>㼯<EFBFBD><E3BCAF>
		GradientExtendMode extend_mode;	///< <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ģʽ

		RadialGradientStyle(Point const& center, Vec2 const& offset, Vec2 const& radius, Vector<GradientStop> const& stops, GradientExtendMode extend_mode = GradientExtendMode::Clamp);
	};

	/**
	* \~chinese
	* @brief <EFBFBD><EFBFBD>ˢ
	*/
	class KGE_API Brush
		: public virtual ObjectBase
	{
		friend class RenderContext;
		friend class Renderer;

	public:
		/// \~chinese
		/// @brief <20><><EFBFBD><EFBFBD>Ĭ<EFBFBD>ϻ<EFBFBD>ˢ
		Brush();

		/// \~chinese
		/// @brief <20>Ƿ<EFBFBD><C7B7><EFBFBD>Ч
		bool IsValid() const;

		/// \~chinese
		/// @brief <20><><EFBFBD>ô<EFBFBD>ɫ<EFBFBD><C9AB>ˢ<EFBFBD><CBA2>ɫ
		void SetColor(Color const& color);

		/// \~chinese
		/// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Խ<EFBFBD><D4BD><EFBFBD><EFBFBD><EFBFBD>ʽ
		void SetStyle(LinearGradientStyle const& style);

		/// \~chinese
		/// @brief <20><><EFBFBD>þ<EFBFBD><C3BE>򽥱<EFBFBD><F2BDA5B1><EFBFBD>ʽ
		void SetStyle(RadialGradientStyle const& style);

	public:
		/// \~chinese
		/// @brief <20><>ˢ<EFBFBD><CBA2><EFBFBD><EFBFBD>
		enum class Type
		{
			Unknown,
			SolidColor,			///< <20><>ɫ<EFBFBD><C9AB><EFBFBD>仭ˢ
			LinearGradient,		///< <20><><EFBFBD>Խ<EFBFBD><D4BD>仭ˢ
			RadialGradient		///< <20><><EFBFBD>򽥱仭ˢ
		};

		/// \~chinese
		/// @brief <20><>ȡ<EFBFBD><C8A1>ˢ<EFBFBD><CBA2><EFBFBD><EFBFBD>
		Type GetType() const;

	private:
		/// \~chinese
		/// @brief <20><>ȡ͸<C8A1><CDB8><EFBFBD><EFBFBD>
		float GetOpacity() const;

		/// \~chinese
		/// @brief <20><><EFBFBD><EFBFBD>͸<EFBFBD><CDB8><EFBFBD><EFBFBD>
		void SetOpacity(float opacity);

		void SetBrush(ComPtr<ID2D1Brush> brush, Type type);

		ComPtr<ID2D1Brush> GetBrush() const;

	private:
		Type type_;
		float opacity_;
		ComPtr<ID2D1Brush> raw_;
	};

	/** @} */

	inline Brush::Type			Brush::GetType() const		{ return type_; }

	inline ComPtr<ID2D1Brush>	Brush::GetBrush() const		{ return raw_; }

}