Magic_Game/Kiwano/2d/Node.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 "include-forwards.h"
#include "Transform.hpp"
#include "ActionManager.h"
#include "../base/TimerManager.h"
#include "../base/EventDispatcher.h"

namespace kiwano
{
	class Application;

	// 节点
	class KGE_API Node
		: public virtual Object
		, public TimerManager
		, public ActionManager
		, public EventDispatcher
		, public IntrusiveListItem<NodePtr>
	{
		friend class Application;
		friend class Transition;
		friend class IntrusiveList<NodePtr>;

		using Children = IntrusiveList<NodePtr>;
		using UpdateCallback = Closure<void(Duration)>;

	public:
		Node();

		// 更新节点
		virtual void OnUpdate(Duration dt) { KGE_NOT_USED(dt); }

		// 渲染节点
		virtual void OnRender() {}

		// 获取显示状态
		bool IsVisible()				const	{ return visible_; }

		// 获取响应状态
		bool IsResponsible()			const	{ return responsible_; }

		// 获取名称的 Hash 值
		size_t GetHashName()			const	{ return hash_name_; }

		// 获取 Z 轴顺序
		int GetZOrder()					const	{ return z_order_; }

		// 获取坐标
		Point GetPosition()				const	{ return transform_.position; }

		// 获取 x 坐标
		float GetPositionX()			const	{ return transform_.position.x; }

		// 获取 y 坐标
		float GetPositionY()			const	{ return transform_.position.y; }

		// 获取横向缩放比例
		Point GetScale()				const	{ return transform_.scale; }

		// 获取横向缩放比例
		float GetScaleX()				const	{ return transform_.scale.x; }

		// 获取纵向缩放比例
		float GetScaleY()				const	{ return transform_.scale.y; }

		// 获取错切角度
		Point GetSkew()					const { return transform_.skew; }

		// 获取横向错切角度
		float GetSkewX()				const	{ return transform_.skew.x; }

		// 获取纵向错切角度
		float GetSkewY()				const	{ return transform_.skew.y; }

		// 获取旋转角度
		float GetRotation()				const	{ return transform_.rotation; }

		// 获取宽度
		float GetWidth()				const	{ return size_.x; }

		// 获取高度
		float GetHeight()				const	{ return size_.y; }

		// 获取大小
		Size GetSize()					const	{ return size_; }

		// 获取缩放后的宽度
		float GetScaledWidth()			const	{ return size_.x * transform_.scale.x; }

		// 获取缩放后的高度
		float GetScaledHeight()			const	{ return size_.y * transform_.scale.y; }

		// 获取缩放后的大小
		Size GetScaledSize()			const	{ return Size{ GetScaledWidth(), GetScaledHeight() }; }

		// 获取锚点
		Point GetAnchor()				const	{ return anchor_; }

		// 获取 x 方向锚点
		float GetAnchorX()				const	{ return anchor_.x; }

		// 获取 y 方向锚点
		float GetAnchorY()				const	{ return anchor_.y; }

		// 获取透明度
		float GetOpacity()				const	{ return opacity_; }

		// 获取变换
		Transform GetTransform()		const	{ return transform_; }

		// 获取边框
		Rect GetBounds() const;

		// 获取外切包围盒
		Rect GetBoundingBox() const;

		// 获取二维变换矩阵
		Matrix const& GetTransformMatrix()  const;

		// 获取二维变换的逆矩阵
		Matrix const& GetTransformInverseMatrix()  const;

		// 获取父节点
		inline Node* GetParent() const { return parent_; }

		// 获取所在场景
		inline Scene* GetScene() const { return scene_; }

		// 设置是否显示
		void SetVisible(
			bool val
		);

		// 设置名称
		void SetName(
			String const& name
		);

		// 设置横坐标
		void SetPositionX(
			float x
		);

		// 设置纵坐标
		void SetPositionY(
			float y
		);

		// 设置坐标
		void SetPosition(
			const Point & point
		);

		// 设置坐标
		void SetPosition(
			float x,
			float y
		);

		// 移动
		void Move(
			float x,
			float y
		);

		// 移动
		void Move(
			const Point & vector
		);

		// 设置横向缩放比例
		// 默认为 1.0
		void SetScaleX(
			float scale_x
		);

		// 设置纵向缩放比例
		// 默认为 1.0
		void SetScaleY(
			float scale_y
		);

		// 设置缩放比例
		// 默认为 (1.0, 1.0)
		void SetScale(
			float scale_x,
			float scale_y
		);

		// 设置缩放比例
		// 默认为 (1.0, 1.0)
		void SetScale(
			Point const& scale
		);

		// 设置缩放比例
		// 默认为 1.0
		void SetScale(
			float scale
		);

		// 设置横向错切角度
		// 默认为 0
		void SetSkewX(
			float skew_x
		);

		// 设置纵向错切角度
		// 默认为 0
		void SetSkewY(
			float skew_y
		);

		// 设置错切角度
		// 默认为 (0, 0)
		void SetSkew(
			float skew_x,
			float skew_y
		);

		// 设置错切角度
		// 默认为 (0, 0)
		void SetSkew(
			Point const& skew
		);

		// 设置旋转角度
		// 默认为 0
		void SetRotation(
			float rotation
		);

		// 设置锚点的横向位置
		// 默认为 0, 范围 [0, 1]
		void SetAnchorX(
			float anchor_x
		);

		// 设置锚点的纵向位置
		// 默认为 0, 范围 [0, 1]
		void SetAnchorY(
			float anchor_y
		);

		// 设置锚点位置
		// 默认为 (0, 0), 范围 [0, 1]
		void SetAnchor(
			float anchor_x,
			float anchor_y
		);

		// 设置锚点位置
		// 默认为 (0, 0), 范围 [0, 1]
		void SetAnchor(
			Point const& anchor
		);

		// 修改宽度
		void SetWidth(
			float width
		);

		// 修改高度
		void SetHeight(
			float height
		);

		// 修改大小
		void SetSize(
			float width,
			float height
		);

		// 修改大小
		void SetSize(
			const Size & size
		);

		void SetTransform(
			Transform const& transform
		);

		// 设置透明度
		// 默认为 1.0, 范围 [0, 1]
		void SetOpacity(
			float opacity
		);

		// 设置 Z 轴顺序
		// 默认为 0
		void SetZOrder(
			int zorder
		);

		// 是否可响应 (鼠标 Hover | Out | Click 消息)
		// 默认为 false
		void SetResponsible(
			bool enable
		);

		// 判断点是否在节点内
		bool ContainsPoint(
			const Point& point
		)  const;

		// 添加子节点
		void AddChild(
			NodePtr child
		);

		// 添加多个子节点
		void AddChildren(
			Array<NodePtr> const& children
		);

		// 获取所有名称相同的子节点
		Array<NodePtr> GetChildren(
			String const& name
		) const;

		// 获取名称相同的子节点
		NodePtr GetChild(
			String const& name
		) const;

		// 获取全部子节点
		Children const& GetChildren() const;

		// 移除子节点
		void RemoveChild(
			NodePtr child
		);

		// 移除子节点
		void RemoveChild(
			Node* child
		);

		// 移除所有名称相同的子节点
		void RemoveChildren(
			String const& child_name
		);

		// 移除所有节点
		void RemoveAllChildren();

		// 从父节点移除
		void RemoveFromParent();

		// 暂停节点更新
		inline void PauseUpdating()									{ update_pausing_ = true; }

		// 继续节点更新
		inline void ResumeUpdating()								{ update_pausing_ = false; }

		// 节点更新是否暂停
		inline bool IsUpdatePausing() const							{ return update_pausing_; }

		// 设置更新时的回调函数
		inline void SetCallbackOnUpdate(UpdateCallback const& cb)	{ cb_update_ = cb; }

		// 获取更新时的回调函数
		inline UpdateCallback const& GetCallbackOnUpdate()			{ return cb_update_; }

		// 设置默认锚点
		static void SetDefaultAnchor(
			float anchor_x,
			float anchor_y
		);

	public:
		// 事件分发
		void Dispatch(Event& evt) override;

	protected:
		virtual void PrepareRender() {}

		virtual void Update(Duration dt);

		void Render();

		void UpdateTransform() const;

		void UpdateOpacity();

		void SetScene(Scene* scene);

		void Reorder();

	protected:
		bool			visible_;
		bool			hover_;
		bool			pressed_;
		bool			responsible_;
		bool			update_pausing_;
		int				z_order_;
		float			opacity_;
		float			display_opacity_;
		size_t			hash_name_;
		Transform		transform_;
		Point			anchor_;
		Size			size_;
		Node*			parent_;
		Scene*			scene_;
		Children		children_;
		UpdateCallback	cb_update_;

		mutable bool	dirty_transform_;
		mutable bool	dirty_transform_inverse_;
		mutable Matrix	transform_matrix_;
		mutable Matrix	transform_matrix_inverse_;
	};


	// 可视化节点
	class KGE_API VisualNode
		: public Node
	{
	public:
		virtual void PrepareRender() override;
	};

}