BansheeEngine/Source/BansheeCore/Include/BsSkybox.h

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

#include "BsCorePrerequisites.h"
#include "BsIReflectable.h"
#include "BsCoreObject.h"

namespace bs
{
	namespace ct
	{
		class RendererTask;
	}

	/** @addtogroup Implementation
	 *  @{
	 */

	/**	Signals which portion of a skybox is dirty. */
	enum class SkyboxDirtyFlag
	{
		Texture = 0x01,
		Everything = 0x02
	};

	/** Base class for both core and sim thread implementations of a skybox. */
	class BS_CORE_EXPORT SkyboxBase
	{
	public:
		SkyboxBase();
		virtual ~SkyboxBase() { }

		/**	Checks whether the skybox should be used or not. */
		bool getIsActive() const { return mIsActive; }

		/**	Sets whether the skybox should be used or not. */
		void setIsActive(bool active) { mIsActive = active; _markCoreDirty(); }

		/** 
		 * Brightness multiplier that will be applied to skybox values before they're being used. Allows you to make the
		 * skybox more or less bright. Equal to one by default. 
		 */
		void setBrightness(float brightness) { mBrightness = brightness; _markCoreDirty(); }

		/** @see setBrightness */
		float getBrightness() const { return mBrightness; }

		/** Returns an identifier that uniquely identifies the skybox. */
		const String& getUUID() const { return mUUID; }

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

	protected:
		String mUUID; /**< Identifier that uniquely identifies the skybox. */
		bool mIsActive; /**< Determines whether the skybox should be rendered or not. */
		float mBrightness; /**< Multiplier to apply to evaluated skybox values before using them. */
	};

	/** Templated base class for both core and sim thread implementations of a skybox. */
	template<bool Core>
	class BS_CORE_EXPORT TSkybox : public SkyboxBase
	{
		typedef typename TTextureType<Core>::Type TextureType;

	public:
		TSkybox();
		virtual ~TSkybox() { }

		/**
		 * Assigns an environment map to use for sampling skybox radiance. Must be a cube-map texture, and should ideally
		 * contain HDR data.
		 */
		void setTexture(const TextureType& texture) { mTexture = texture; _markCoreDirty(SkyboxDirtyFlag::Texture); }

		/** Gets the texture assigned through setTexture(). */
		TextureType getTexture() const { return mTexture; }

	protected:
		TextureType mTexture;
	};

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

	namespace ct { class Skybox; }

	/** Allows you to specify an environment map to use for sampling radiance of the sky. */
	class BS_CORE_EXPORT Skybox : public IReflectable, public CoreObject, public TSkybox<false>
	{
	public:
		~Skybox();
		
		/**	Retrieves an implementation of the skybox usable only from the core thread. */
		SPtr<ct::Skybox> getCore() const;

		/** Creates a new skybox. */
		static SPtr<Skybox> create();

	protected:
		Skybox();

		/** 
		 * Filters the skybox radiance texture, generating filtered radiance (for reflections) and irradiance. Should be 
		 * called any time the skybox texture changes. 
		 */
		void filterTexture();

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

		/** @copydoc SkyboxBase::_markCoreDirty */
		void _markCoreDirty(SkyboxDirtyFlag flags = SkyboxDirtyFlag::Everything) override;

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

		SPtr<Texture> mFilteredRadiance;
		SPtr<Texture> mIrradiance;
		SPtr<ct::RendererTask> mRendererTask;

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

	namespace ct
	{
		/** Core thread usable version of a bs::Skybox */
		class BS_CORE_EXPORT Skybox : public CoreObject, public TSkybox<true>
		{
		public:
			~Skybox();

			/** 
			 * Returns a texture containing filtered version of the radiance texture used for reflections. This might not
			 * be available if it hasn't been generated yet.
			 */
			SPtr<Texture> getFilteredRadiance() const { return mFilteredRadiance; }

			/**
			 * Returns a texture containing sky irradiance. This might not be available if it hasn't been generated yet.
			 */
			SPtr<Texture> getIrradiance() const { return mIrradiance; }

		protected:
			friend class bs::Skybox;

			Skybox(const SPtr<Texture>& filteredRadiance, const SPtr<Texture>& irradiance);

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

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

			SPtr<Texture> mFilteredRadiance;
			SPtr<Texture> mIrradiance;
		};
	}

	/** @} */
}