BansheeEngine/Source/BansheeCore/Renderer/BsCamera.h

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

#include "BsCorePrerequisites.h"
#include "Reflection/BsIReflectable.h"
#include "Math/BsMatrix4.h"
#include "Math/BsVector3.h"
#include "Math/BsVector2.h"
#include "Math/BsVector2I.h"
#include "Math/BsAABox.h"
#include "Math/BsQuaternion.h"
#include "Math/BsRay.h"
#include "CoreThread/BsCoreObject.h"
#include "Math/BsConvexVolume.h"
#include "Renderer/BsRenderSettings.h"

namespace bs 
{
	/** @addtogroup Renderer-Internal
	 *  @{
	 */

	/**	Signals which portion of a Camera is dirty. */
	enum class CameraDirtyFlag
	{
		Transform = 1<<0,
		Everything = 1<<1,
		RenderSettings = 1<<2
	};

	/** @} */
	/** @addtogroup Implementation
	 *  @{
	 */

	/**
	 * Camera determines how is world geometry projected onto a 2D surface. You may position and orient it in space, set
	 * options like aspect ratio and field or view and it outputs view and projection matrices required for rendering.
	 *
	 * @note	This class contains funcionality common to both core and non-core versions of the camera.
	 */
	class BS_CORE_EXPORT CameraBase
	{
	public:
		virtual ~CameraBase() { }

		/**
		 * Determines the camera horizontal field of view. This determines how wide the camera viewing angle is along the
		 * horizontal axis. Vertical FOV is calculated from the horizontal FOV and the aspect ratio.
		 */
		virtual void setHorzFOV(const Radian& fovy);

		/** @copydoc setHorzFOV() */
		virtual const Radian& getHorzFOV() const;

		/**
		 * Determines the distance from the frustum to the near clipping plane. Anything closer than the near clipping plane will
		 * not be rendered. Decreasing this value decreases depth buffer precision.
		 */
		virtual void setNearClipDistance(float nearDist);

		/** @copydoc setNearClipDistance() */
		virtual float getNearClipDistance() const;

		/**
		 * Determines the distance from the frustum to the far clipping plane. Anything farther than the far clipping plane will
		 * not be rendered. Increasing this value decreases depth buffer precision.
		 */
		virtual void setFarClipDistance(float farDist);

		/** @copydoc setFarClipDistance() */
		virtual float getFarClipDistance() const;

		/**	Determines the current viewport aspect ratio (width / height). */
		virtual void setAspectRatio(float ratio);

		/** @copydoc setAspectRatio() */
		virtual float getAspectRatio() const;

		/**	Sets camera world space position. */
		virtual void setPosition(const Vector3& position);

		/**	Retrieves camera world space position. */
		virtual Vector3 getPosition() const { return mPosition; }

		/**	Sets should the camera be rendered to or not. */
		void setIsActive(bool active) { mIsActive = active; _markCoreDirty(); }
		
		/**	Gets whether the camera be rendered to or not. */
		bool getIsActive() const { return mIsActive; }

		/**
		 * Gets the Z (forward) axis of the object, in world space.
		 *
		 * @return	Forward axis of the object.
		 */
		Vector3 getForward() const { return getRotation().rotate(-Vector3::UNIT_Z); }

		/**	Sets camera world space rotation. */
		virtual void setRotation(const Quaternion& rotation);

		/**	Retrieves camera world space rotation. */
		virtual Quaternion getRotation() const { return mRotation; }

		/** Manually set the extents of the frustum that will be used when calculating the projection matrix. This will
		 * prevents extents for being automatically calculated from aspect and near plane so it is up to the caller to keep
		 * these values accurate.
		 *
		 * @param[in] left		The position where the left clip plane intersect the near clip plane, in view space.
		 * @param[in] right		The position where the right clip plane intersect the near clip plane, in view space.
		 * @param[in] top		The position where the top clip plane intersect the near clip plane, in view space.
		 * @param[in] bottom	The position where the bottom clip plane intersect the near clip plane, in view space.
		*/
		virtual void setFrustumExtents(float left, float right, float top, float bottom);

		/** 
		 * Resets frustum extents so they are automatically derived from other values. This is only relevant if you have
		 * previously set custom extents.
		 */
		virtual void resetFrustumExtents(); 

		/** Returns the extents of the frustum in view space at the near plane. */
		virtual void getFrustumExtents(float& outleft, float& outright, float& outtop, float& outbottom) const;

		/** 
		 * Returns the standard projection matrix that determines how are 3D points projected to two dimensions. The layout
		 * of this matrix depends on currently used render system.
		 *
		 * @note	
		 * You should use this matrix when sending the matrix to the render system to make sure everything works 
		 * consistently when other render systems are used.
		 */
		virtual const Matrix4& getProjectionMatrixRS() const;

		/** Returns the inverse of the render-system specific projection matrix. See getProjectionMatrixRS(). */
		virtual const Matrix4& getProjectionMatrixRSInv() const;

		/** 
		 * Returns the standard projection matrix that determines how are 3D points projected to two dimensions. Returned
		 * matrix is standard following right-hand rules and depth range of [-1, 1]. In case you need a render-system specific
		 * projection matrix call getProjectionMatrixRS().
		 */
		virtual const Matrix4& getProjectionMatrix() const;

		/** Returns the inverse of the projection matrix. See getProjectionMatrix(). */
		virtual const Matrix4& getProjectionMatrixInv() const;

		/** Gets the camera view matrix. Used for positioning/orienting the camera. */
		virtual const Matrix4& getViewMatrix() const;

		/** Returns the inverse of the view matrix. See getViewMatrix(). */
		virtual const Matrix4& getViewMatrixInv() const;

		/** 
		 * Sets whether the camera should use the custom view matrix. When this is enabled camera will no longer calculate
		 * its view matrix based on position/orientation and caller will be resonsible to keep the view matrix up to date.
		 */
		virtual void setCustomViewMatrix(bool enable, const Matrix4& viewMatrix = Matrix4::IDENTITY);

		/** Returns true if a custom view matrix is used. */
		virtual bool isCustomViewMatrixEnabled() const { return mCustomViewMatrix; }
		
		/** 
		 * Sets whether the camera should use the custom projection matrix. When this is enabled camera will no longer
		 * calculate its projection matrix based on field of view, aspect and other parameters and caller will be resonsible
		 * to keep the projection matrix up to date.
		 */
		virtual void setCustomProjectionMatrix(bool enable, const Matrix4& projectionMatrix = Matrix4::IDENTITY);

		/** Returns true if a custom projection matrix is used. */
		virtual bool isCustomProjectionMatrixEnabled() const { return mCustomProjMatrix; }

		/** Returns a convex volume representing the visible area of the camera, in local space. */
		virtual const ConvexVolume& getFrustum() const;

		/** Returns a convex volume representing the visible area of the camera, in world space. */
		virtual ConvexVolume getWorldFrustum() const;

		/**	Returns the bounding of the frustum. */
		const AABox& getBoundingBox() const;

		/**
		 * Determines the type of projection used by the camera. Projection type controls how is 3D geometry projected onto a 
		 * 2D plane.
		 */
		virtual void setProjectionType(ProjectionType pt);

		/** @copydoc setProjectionType() */
		virtual ProjectionType getProjectionType() const;

		/**
		 * Sets the orthographic window height, for use with orthographic rendering only. 
		 *
		 * @param[in]	w	Width of the window in world units.
		 * @param[in]	h	Height of the window in world units.
		 *
		 * @note	
		 * Calling this method will recalculate the aspect ratio, use setOrthoWindowHeight() or setOrthoWindowWidth() alone
		 * if you wish to preserve the aspect ratio but just fit one or other dimension to a particular size.
		 */
		virtual void setOrthoWindow(float w, float h);

		/**
		 * Determines the orthographic window height, for use with orthographic rendering only. The width of the window
		 * will be calculated from the aspect ratio. Value is specified in world units.
		 */
		virtual void setOrthoWindowHeight(float h);

		/** @copydoc setOrthoWindowHeight() */
		virtual float getOrthoWindowHeight() const;

		/**
		 * Determines the orthographic window width, for use with orthographic rendering only. The height of the window
		 * will be calculated from the aspect ratio. Value is specified in world units.
		 */
		virtual void setOrthoWindowWidth(float w);

		/** @copydoc setOrthoWindowWidth() */
		virtual float getOrthoWindowWidth() const;

		/**
		 * Determines a priority that determines in which orders the cameras are rendered. This only applies to cameras rendering
		 * to the same render target. Higher value means the camera will be rendered sooner. 
		 */
		void setPriority(INT32 priority) { mPriority = priority; _markCoreDirty(); }

		/** @copydoc setPriority() */
		INT32 getPriority() const { return mPriority; }

		/**	Determines layer bitfield that is used when determining which object should the camera render. */
		void setLayers(UINT64 layers) { mLayers = layers; _markCoreDirty(); }

		/** @copydoc setLayers() */
		UINT64 getLayers() const { return mLayers; }

		/** 
		 * Determines number of samples to use when rendering to this camera. Values larger than 1 will enable MSAA
		 * rendering.
		 */
		void setMSAACount(UINT32 count) { mMSAA = count; _markCoreDirty(); }

		/** @copydoc setMSAACount() */
		UINT32 getMSAACount() const { return mMSAA; }

		/** 
		 * Settings that control rendering for this view. They determine how will the renderer process this view, which
		 * effects will be enabled, and what properties will those effects use.
		 */
		void setRenderSettings(const SPtr<RenderSettings>& settings) { mRenderSettings = settings; _markCoreDirty(CameraDirtyFlag::RenderSettings); }

		/** @copydoc setRenderSettings() */
		const SPtr<RenderSettings>& getRenderSettings() const { return mRenderSettings; }

		/**
		 * Converts a point in world space to screen coordinates.
		 * 
		 * @param[in]	worldPoint		3D point in world space.
		 * @return						2D point on the render target attached to the camera's viewport, in pixels.
		 */
		Vector2I worldToScreenPoint(const Vector3& worldPoint) const;

		/**	
		 * Converts a point in world space to normalized device coordinates. 
		 *
		 * @param[in]	worldPoint		3D point in world space.
		 * @return						2D point in normalized device coordinates ([-1, 1] range), relative to the camera's viewport.
		 */
		Vector2 worldToNdcPoint(const Vector3& worldPoint) const;

		/** 
		 * Converts a point in world space to view space coordinates. 
		 * 
		 * @param[in]	worldPoint		3D point in world space.
		 * @return						3D point relative to the camera's coordinate system.
		 */
		Vector3 worldToViewPoint(const Vector3& worldPoint) const;

		/**
		 * Converts a point in screen space to a point in world space.
		 *
		 * @param[in]	screenPoint	2D point on the render target attached to the camera's viewport, in pixels.
		 * @param[in]	depth		Depth to place the world point at, in world coordinates. The depth is applied to the 
		 *							vector going from camera origin to the point on the near plane.
		 * @return					3D point in world space.
		 */
		Vector3 screenToWorldPoint(const Vector2I& screenPoint, float depth = 0.5f) const;

		/**
		* Converts a point in screen space (pixels corresponding to render target attached to the camera) to a point in
		* world space.
		*
		* @param[in]	screenPoint	Point to transform.
		* @param[in]	deviceDepth	Depth to place the world point at, in normalized device coordinates.
		* @return					3D point in world space.
		*/
		Vector3 screenToWorldPointDeviceDepth(const Vector2I& screenPoint, float deviceDepth = 0.5f) const;

		/**
		 * Converts a point in screen space to a point in view space.
		 *
		 * @param[in]	screenPoint	2D point on the render target attached to the camera's viewport, in pixels.
		 * @param[in]	depth		Depth to place the world point at, in device depth. The depth is applied to the 
		 *							vector going from camera origin to the point on the near plane.
		 * @return					3D point relative to the camera's coordinate system.
		 */
		Vector3 screenToViewPoint(const Vector2I& screenPoint, float depth = 0.5f) const;

		/**
		 * Converts a point in screen space to normalized device coordinates.
		 *
		 * @param[in]	screenPoint		2D point on the render target attached to the camera's viewport, in pixels.
		 * @return						2D point in normalized device coordinates ([-1, 1] range), relative to 
		 *								the camera's viewport.
		 */
		Vector2 screenToNdcPoint(const Vector2I& screenPoint) const;

		/** 
		 * Converts a point in view space to world space.
		 *
		 * @param[in]	viewPoint		3D point relative to the camera's coordinate system.
		 * @return						3D point in world space.
		 */
		Vector3 viewToWorldPoint(const Vector3& viewPoint) const;

		/** 
		 * Converts a point in view space to screen space.
		 *
		 * @param[in]	viewPoint		3D point relative to the camera's coordinate system.
		 * @return						2D point on the render target attached to the camera's viewport, in pixels.
		 */
		Vector2I viewToScreenPoint(const Vector3& viewPoint) const;

		/** 
		 * Converts a point in view space to normalized device coordinates.
		 *
		 * @param[in]	viewPoint		3D point relative to the camera's coordinate system.
		 * @return						2D point in normalized device coordinates ([-1, 1] range), relative to 
		 *								the camera's viewport.
		 */
		Vector2 viewToNdcPoint(const Vector3& viewPoint) const;

		/**
		 * Converts a point in normalized device coordinates to world space.
		 *
		 * @param[in]	ndcPoint	2D point in normalized device coordinates ([-1, 1] range), relative to 
		 *							the camera's viewport.
		 * @param[in]	depth		Depth to place the world point at. The depth is applied to the
		 *							vector going from camera origin to the point on the near plane.
		 * @return					3D point in world space.
		 */
		Vector3 ndcToWorldPoint(const Vector2& ndcPoint, float depth = 0.5f) const;

		/**
		 * Converts a point in normalized device coordinates to view space.
		 *
		 * @param[in]	ndcPoint	2D point in normalized device coordinates ([-1, 1] range), relative to 
		 *							the camera's viewport.
		 * @param[in]	depth		Depth to place the world point at. The depth is applied to the
		 *							vector going from camera origin to the point on the near plane.
		 * @return					3D point relative to the camera's coordinate system.
		 */
		Vector3 ndcToViewPoint(const Vector2& ndcPoint, float depth = 0.5f) const;

		/**
		 * Converts a point in normalized device coordinates to screen space.
		 *
		 * @param[in]	ndcPoint	2D point in normalized device coordinates ([-1, 1] range), relative to 
		 *							the camera's viewport.
		 * @return					2D point on the render target attached to the camera's viewport, in pixels.
		 */
		Vector2I ndcToScreenPoint(const Vector2& ndcPoint) const;

		/**
		 * Converts a point in screen space to a ray in world space.
		 *
		 * @param[in]	screenPoint		2D point on the render target attached to the camera's viewport, in pixels.
		 * @return						Ray in world space, originating at the selected point on the camera near plane.
		 */
		Ray screenPointToRay(const Vector2I& screenPoint) const;

		/**	
		 * Projects a point in view space to normalized device coordinates. Similar to viewToNdcPoint() but preserves
		 * the depth component.
		 *
		 * @param[in]	point			3D point relative to the camera's coordinate system.
		 * @return						3D point in normalized device coordinates ([-1, 1] range), relative to the 
		 *								camera's viewport. Z value range depends on active render API.
		 */
		Vector3 projectPoint(const Vector3& point) const;

		/**	Un-projects a point in normalized device space to view space.
		 *
		 * @param[in]	point			3D point in normalized device coordinates ([-1, 1] range), relative to the 
		 *								camera's viewport. Z value range depends on active render API.
		 * @return						3D point relative to the camera's coordinate system.
		 */
		Vector3 unprojectPoint(const Vector3& point) const;

		static const float INFINITE_FAR_PLANE_ADJUST; /**< Small constant used to reduce far plane projection to avoid inaccuracies. */

	protected:
		CameraBase();

		/**	Calculate projection parameters that are used when constructing the projection matrix. */
		virtual void calcProjectionParameters(float& left, float& right, float& bottom, float& top) const;

		/**	Recalculate frustum if dirty. */
		virtual void updateFrustum() const;

		/**	Recalculate frustum planes if dirty. */
		virtual void updateFrustumPlanes() const;

		/**
		 * Update view matrix from parent position/orientation.
		 *
		 * @note	Does nothing when custom view matrix is set.
		 */
		virtual void updateView() const;

		/**	Checks if the frustum requires updating. */
		virtual bool isFrustumOutOfDate() const;

		/**	Notify camera that the frustum requires to be updated. */
		virtual void invalidateFrustum() const;

		/**	Returns a rectangle that defines the viewport position and size, in pixels. */
		virtual Rect2I getViewportRect() const = 0;

		/** 
		 * Marks the simulation thread object as dirty and notifies the system its data should be synced with its core 
		 * thread counterpart. 
		 */
		virtual void _markCoreDirty(CameraDirtyFlag flag = CameraDirtyFlag::Everything) { }

	protected:
		UINT64 mLayers; /**< Bitfield that can be used for filtering what objects the camera sees. */

		Vector3 mPosition; /**< World space position. */
		Quaternion mRotation; /**< World space rotation. */
		bool mIsActive; /**< Is camera being rendered to. */

		ProjectionType mProjType; /**< Type of camera projection. */
		Radian mHorzFOV; /**< Horizontal field of view represents how wide is the camera angle. */
		float mFarDist; /**< Clip any objects further than this. Larger value decreases depth precision at smaller depths. */
		float mNearDist; /**< Clip any objects close than this. Smaller value decreases depth precision at larger depths. */
		float mAspect; /**< Width/height viewport ratio. */
		float mOrthoHeight; /**< Height in world units used for orthographic cameras. */
		INT32 mPriority; /**< Determines in what order will the camera be rendered. Higher priority means the camera will be rendered sooner. */

		bool mCustomViewMatrix; /**< Is custom view matrix set. */
		bool mCustomProjMatrix; /**< Is custom projection matrix set. */
		UINT8 mMSAA; /**< Number of samples to render the scene with. */

		SPtr<RenderSettings> mRenderSettings; /**< Settings used to control rendering for this camera. */

		bool mFrustumExtentsManuallySet; /**< Are frustum extents manually set. */

		mutable Matrix4 mProjMatrixRS; /**< Cached render-system specific projection matrix. */
		mutable Matrix4 mProjMatrix; /**< Cached projection matrix that determines how are 3D points projected to a 2D viewport. */
		mutable Matrix4 mViewMatrix; /**< Cached view matrix that determines camera position/orientation. */
		mutable Matrix4 mProjMatrixRSInv;
		mutable Matrix4 mProjMatrixInv;
		mutable Matrix4 mViewMatrixInv;

		mutable ConvexVolume mFrustum; /**< Main clipping planes describing cameras visible area. */
		mutable bool mRecalcFrustum : 1; /**< Should frustum be recalculated. */
		mutable bool mRecalcFrustumPlanes : 1; /**< Should frustum planes be recalculated. */
		mutable bool mRecalcView : 1; /**< Should view matrix be recalculated. */
		mutable float mLeft, mRight, mTop, mBottom; /**< Frustum extents. */
		mutable AABox mBoundingBox; /**< Frustum bounding box. */
	 };

	/** @} */

	/** @addtogroup Renderer-Internal
	 *  @{
	 */

	/** @copydoc CameraBase */
	class BS_CORE_EXPORT Camera : public IReflectable, public CoreObject, public CameraBase
	{
	public:
		/**	Returns the viewport used by the camera. */	
		SPtr<Viewport> getViewport() const { return mViewport; }

		/**
		 * Determines whether this is the main application camera. Main camera controls the final render surface that is
		 * displayed to the user.
		 */	
		void setMain(bool main) { mMain = main; }

		/** @copydoc setMain() */
		bool isMain() const { return mMain; }

		/** Retrieves an implementation of a camera handler usable only from the core thread. */
		SPtr<ct::Camera> getCore() const;

		/**	Creates a new camera that renders to the specified portion of the provided render target. */
		static SPtr<Camera> create(SPtr<RenderTarget> target = nullptr,
			float left = 0.0f, float top = 0.0f, float width = 1.0f, float height = 1.0f);

		/** @name Internal
		 *  @{
		 */

		/**	Returns the hash value that can be used to identify if the internal data needs an update. */
		UINT32 _getLastModifiedHash() const { return mLastUpdateHash; }

		/**	Sets the hash value that can be used to identify if the internal data needs an update. */
		void _setLastModifiedHash(UINT32 hash) { mLastUpdateHash = hash; }

		/** @} */

	protected:
		Camera(SPtr<RenderTarget> target = nullptr,
			float left = 0.0f, float top = 0.0f, float width = 1.0f, float height = 1.0f);

		/** @copydoc CameraBase */
		Rect2I getViewportRect() const override;

		/** @copydoc CoreObject::createCore */
		SPtr<ct::CoreObject> createCore() const override;

		/** @copydoc CameraBase::_markCoreDirty */
		void _markCoreDirty(CameraDirtyFlag flag = CameraDirtyFlag::Everything) override;

		/** @copydoc CoreObject::syncToCore */
		CoreSyncData syncToCore(FrameAlloc* allocator) override;

		/** @copydoc CoreObject::getCoreDependencies */
		void getCoreDependencies(Vector<CoreObject*>& dependencies) override;

		/**	Creates a new camera without initializing it. */
		static SPtr<Camera> createEmpty();

		SPtr<Viewport> mViewport; /**< Viewport that describes 2D rendering surface. */
		bool mMain;
		UINT32 mLastUpdateHash;

		/************************************************************************/
		/* 								RTTI		                     		*/
		/************************************************************************/
	public:
		friend class CameraRTTI;
		static RTTITypeBase* getRTTIStatic();
		RTTITypeBase* getRTTI() const override;
	};

	namespace ct
	{
	/** @copydoc CameraBase */
	class BS_CORE_EXPORT Camera : public CoreObject, public CameraBase
	{
	public:
		~Camera();

		/**	Returns the viewport used by the camera. */	
		SPtr<Viewport> getViewport() const { return mViewport; }

		/**	Sets an ID that can be used for uniquely identifying this object by the renderer. */
		void setRendererId(UINT32 id) { mRendererId = id; }

		/**	Retrieves an ID that can be used for uniquely identifying this object by the renderer. */
		UINT32 getRendererId() const { return mRendererId; }

	protected:
		friend class bs::Camera;

		Camera(SPtr<RenderTarget> target = nullptr,
			float left = 0.0f, float top = 0.0f, float width = 1.0f, float height = 1.0f);

		Camera(const SPtr<Viewport>& viewport);

		/** @copydoc CoreObject::initialize */
		void initialize() override;

		/** @copydoc CameraBase */
		Rect2I getViewportRect() const override;

		/** @copydoc CoreObject::syncToCore */
		void syncToCore(const CoreSyncData& data) override;

		UINT32 mRendererId;
		SPtr<Viewport> mViewport;
	};
	}

	/** @} */
}