BansheeEngine/Source/BansheeEditor/Include/BsSceneGrid.h

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

#include "BsEditorPrerequisites.h"
#include "BsVector2I.h"
#include "BsColor.h"
#include "BsMaterial.h"

namespace BansheeEngine
{
	/** @cond INTERNAL */
	/** @addtogroup Scene-Editor
	 *  @{
	 */

	class SceneGridCore;

	/** Determines how is the scene grid drawn. */
	enum class GridMode
	{
		Perspective, /**< Grid is drawn in XZ plane, at Y = 0. */
		OrthoX, /**< Grid is drawn in YZ plane, always visible along positive X. */
		OrthoY, /**< Grid is drawn in XZ plane, always visible along positive Y. */
		OrthoZ, /**< Grid is drawn in XY plane, always visible along positive Z. */
		OrthoNegX, /**< Grid is drawn in YZ plane, always visible along negative X. */
		OrthoNegY, /**< Grid is drawn in XZ plane, always visible along negative Y. */
		OrthoNegZ /**< Grid is drawn in XY plane, always visible along negative Z. */
	};

	/**	Handles rendering of the grid in the scene view. */
	class BS_ED_EXPORT SceneGrid
	{
	public:
		SceneGrid(const CameraPtr& camera);
		~SceneGrid();

		/**	Sets the total width/height of the grid in XZ plane. */
		void setSize(UINT32 size);
		
		/**	Sets the spacing between grid lines. */
		void setSpacing(float spacing);

		/** Determines in what position and orientation is the grid drawn. */
		void setMode(GridMode mode);

		/** Changes the active editor settings. Grid properties will be updated internally when editor settings change. */
		void setSettings(const EditorSettingsPtr& settings);

		/** Called once per frame. */
		void _update();
	private:
		/** Updates internal grid parameters from the attached settings object. */
		void updateFromEditorSettings();

		/**	Rebuilds the scene grid mesh. Call this whenever grid parameters change. */
		void updateGridMesh();

		/**
		 * Initializes the core thread portion of the scene grid renderer.
		 *
		 * @param[in]	material	Material used for drawing the grid.
		 * @param[in]	camera		Camera to render the scene grid to.
		 */
		void initializeCore(const SPtr<CameraCore>& camera, const SPtr<MaterialCore>& material);

		/** Destroys the core thread portion of the draw manager. */
		void destroyCore(SceneGridCore* core);

		float mSpacing = 1.0f;
		UINT32 mSize = 256;
		GridMode mMode = GridMode::Perspective;
		bool mCoreDirty;

		EditorSettingsPtr mSettings;
		UINT32 mSettingsHash = 0;

		HMesh mGridMesh;
		VertexDataDescPtr mVertexDesc;
		std::atomic<SceneGridCore*> mCore;
	};

	/** Handles scene grid rendering on the core thread. */
	class SceneGridCore
	{
	public:
		SceneGridCore() { }
		~SceneGridCore();

	private:
		friend class SceneGrid;

		/**
		 * Initializes the object. Must be called right after construction and before any use.
		 *
		 * @param[in]	material	Material used for drawing the grid.
		 * @param[in]	camera		Camera to render the scene grid to.
		 */
		void initialize(const SPtr<CameraCore>& camera, const SPtr<MaterialCore>& material);

		/**
		 * Updates the grid mesh to render.
		 * 			
		 * @param[in]	mesh			Grid mesh to render.
		 * @param[in]	spacing			Spacing between the grid lines.
		 * @param[in]	fadeGrid		Determines should the grid fade out at larger distances.
		 * @param[in]	gridPlaneNormal	Normal to the plane to render the grid on. Must be one of the basis vectors
		 *								(can't be arbitrary).						
		 */
		void updateData(const SPtr<MeshCore>& mesh, float spacing, bool fadeGrid, const Vector3& gridPlaneNormal);

		/**	Callback triggered by the renderer, actually draws the grid mesh. */
		void render();

		SPtr<CameraCore> mCamera;
		SPtr<MeshCore> mGridMesh;
		SPtr<MaterialCore> mGridMaterial;
		float mSpacing = 1.0f;
		bool mFadeGrid = true;
		Vector3 mGridPlaneNormal;

		MaterialParamMat4Core mViewProjParam;
		MaterialParamVec4Core mWorldCameraPosParam;
		MaterialParamColorCore mGridColorParam;
		MaterialParamFloatCore mGridSpacingParam;
		MaterialParamFloatCore mGridBorderWidthParam;
		MaterialParamFloatCore mGridFadeOutStartParam;
		MaterialParamFloatCore mGridFadeOutEndParam;
		MaterialParamVec3Core mGridPlaneNormalParam;

		static const Color GRID_LINE_COLOR;
		static const float LINE_WIDTH;
		static const float LINE_BORDER_WIDTH;
		static const float FADE_OUT_START;
		static const float FADE_OUT_END;
	};

	/** @} */
	/** @endcond */
}