BansheeEngine/Source/BansheeCore/Include/BsLight.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 "BsVector3.h"
#include "BsQuaternion.h"
#include "BsColor.h"
#include "BsSphere.h"
#include "BsCoreObject.h"

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

	/** Light type that determines how is light information parsed by the renderer and other systems. */
	enum class LightType
	{
		Directional, 
		Point, 
		Spot
	};

	/**	Signals which portion of a LightInternal is dirty. */
	enum class LightDirtyFlag
	{
		Transform = 0x01,
		Everything = 0x02
	};

	/** @} */

	/** @addtogroup Implementation
	 *  @{
	 */

	/**
	 * Illuminates a portion of the scene covered by a light. Base class for both sim and core thread Light implementations.
	 */
	class BS_CORE_EXPORT LightBase
	{
	public:
		LightBase();
		LightBase(LightType type, Color color, float intensity, float range, 
			bool castsShadows, Degree spotAngle, Degree spotFalloffAngle);

		virtual ~LightBase() { }

		/**	Returns the position of the light, in world space. */
		Vector3 getPosition() const { return mPosition; }

		/**	Sets the position of the light, in world space. */
		void setPosition(const Vector3& position) { mPosition = position; _markCoreDirty(); updateBounds(); }

		/**	Returns the rotation of the light, in world space. */
		Quaternion getRotation() const { return mRotation; }

		/**	Sets the rotation of the light, in world space. */
		void setRotation(const Quaternion& rotation) { mRotation = rotation; _markCoreDirty(); updateBounds(); }

		/**	Returns the type of the light. */
		LightType getType() const { return mType; }

		/**	Changes the type of the light. */
		void setType(LightType type) { mType = type; _markCoreDirty(); updateBounds(); }

		/**	Checks does this light cast shadows when rendered. */
		bool getCastsShadow() const { return mCastsShadows; }

		/**	Sets whether this light will cast shadows when rendered. */
		void setCastsShadow(bool castsShadow) { mCastsShadows = castsShadow; _markCoreDirty(); }

		/**	Returns the color emitted from the light. */
		Color getColor() const { return mColor; }

		/**	Sets the color emitted from the light. */
		void setColor(const Color& color) { mColor = color; _markCoreDirty(); }

		/**	Returns the maximum range of the light. Light will not affect any geometry past that point. */
		float getRange() const { return mRange; }

		/**
		 * Sets the maximum range of the light. Light will not affect any geometry past that point. Value is ignored if
		 * physically based attenuation is active.
		 *
		 * @note	Normally you want to set this at a point where light intensity is too low due to attenuation.
		 */
		void setRange(float range);

		/** 
		 * Checks is physically based attenuation active. If true the range and attenuation of the light are controlled
		 * by inverse square of distance. If false then the user is allowed to set the range and attenuation is adjusted
		 * accordingly. 
		 */
		bool getPhysicallyBasedAttenuation() const { return mPhysCorrectAtten; }

		/** 
		 * Activates or deactivates physically based attenuation. If true the range and attenuation of the light are 
		 * controlled by inverse square of distance. If false then the user is allowed to set the range and attenuation is 
		 * adjusted accordingly. 
		 */
		void setPhysicallyBasedAttenuation(bool enabled);

		/**
		 * Gets the power of the light source. This is luminous flux for point & spot lights, and radiance for directional 
		 * lights.
		 */
		float getIntensity() const { return mIntensity; }

		/**
		 * Sets the power of the light source. This will be luminous flux for point & spot lights, and radiance for 
		 * directional lights.
		 */
		void setIntensity(float intensity);

		/**	Gets the total angle covered by a spot light. */
		Degree getSpotAngle() const { return mSpotAngle; }

		/**	Sets the total angle covered by a spot light. */
		void setSpotAngle(const Degree& spotAngle) { mSpotAngle = spotAngle; _markCoreDirty(); updateBounds(); }

		/**
		 * Gets the falloff angle covered by a spot light. Falloff angle determines at what point does light intensity 
		 * starts quadratically falling off as the angle approaches the total spot angle.
		 */
		Degree getSpotFalloffAngle() const { return mSpotFalloffAngle; }

		/**
		 * Sets the falloff angle covered by a spot light. Falloff angle determines at what point does light intensity 
		 * starts quadratically falling off as the angle approaches the total spot angle.
		 */
		void setSpotFalloffAngle(const Degree& spotFallofAngle) 
		{ mSpotFalloffAngle = spotFallofAngle; _markCoreDirty(); updateBounds(); }

		/**	Returns world space bounds that completely encompass the light's area of influence. */
		Sphere getBounds() const { return mBounds; }

		/**
		 * Returns the radiance of the light source. This is the value that should be used in lighting equations.
		 *
		 * @note	
		 * Ignores the light direction, therefore caller must ensure to properly handle non-uniform emitters like spot 
		 * lights.
		 */
		float getRadiance() const;

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

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

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

	protected:
		/** Updates the internal bounds for the light. Call this whenever a property affecting the bounds changes. */
		void updateBounds();

		/** Calculates maximum light range based on light intensity. */
		void updatePhysicallyCorrectRange();

		Vector3 mPosition; /**< World space position. */
		Quaternion mRotation; /**< World space rotation. */

		LightType mType; /**< Type of light that determines how are the rest of the parameters interpreted. */
		bool mCastsShadows; /**< Determines whether the light casts shadows. */
		Color mColor; /**< Color of the light. */
		float mRange; /**< Cut off range for the light when rendering. */
		float mIntensity; /**< Power of the light source. This will be luminous flux for point & spot lights, and radiance for directional lights. */
		Degree mSpotAngle; /**< Total angle covered by a spot light. */
		Degree mSpotFalloffAngle; /**< Spot light angle at which falloff starts. Must be smaller than total angle. */
		bool mIsActive; /**< Whether the light should be rendered or not. */
		Sphere mBounds; /**< Sphere that bounds the light area of influence. */
		bool mPhysCorrectAtten; /**< Determines is physically based attentuation active. */
	};

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

	namespace ct { class Light; }

	/**
	 * Sim thread usable version of a light.
	 *
	 * @see		LightBase
	 */
	class BS_CORE_EXPORT Light : public IReflectable, public CoreObject, public LightBase
	{
	public:
		/**	Retrieves an implementation of a light usable only from the core thread. */
		SPtr<ct::Light> getCore() const;

		/** 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; }

		/**
		 * Updates internal transform values from the specified scene object, in case that scene object's transform changed
		 * since the last call.
		 *
		 * @note	Assumes the same scene object will be provided every time.
		 */
		void _updateTransform(const HSceneObject& parent);

		/**
		 * Creates a new light with provided settings.
		 *
		 * @param[in]	type				Type of light that determines how are the rest of the parameters interpreted.
		 * @param[in]	color				Color of the light.
		 * @param[in]	intensity			Power of the light source. This will be luminous flux for point & spot lights, 
		 *									and radiance for directional lights.
		 * @param[in]	range				Cut off range for the light when rendering.
		 * @param[in]	castsShadows		Determines whether the light casts shadows.
		 * @param[in]	spotAngle			Total angle covered by a spot light.
		 * @param[in]	spotFalloffAngle	Spot light angle at which falloff starts. Must be smaller than total angle.
		 */
		static SPtr<Light> create(LightType type = LightType::Point, Color color = Color::White,
			float intensity = 100.0f, float range = 10.0f, bool castsShadows = false,
			Degree spotAngle = Degree(45), Degree spotFalloffAngle = Degree(40));

	protected:
		Light(LightType type, Color color, float intensity, float range, 
			bool castsShadows, Degree spotAngle, Degree spotFalloffAngle);

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

		/** @copydoc LightBase::_markCoreDirty */
		void _markCoreDirty(LightDirtyFlag flag = LightDirtyFlag::Everything) override;

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

		/**	Creates a light with without initializing it. Used for serialization. */
		static SPtr<Light> createEmpty();

		UINT32 mLastUpdateHash;

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

	protected:
		Light(); // Serialization only
	};

	namespace ct
	{
	/**
	 * Core thread usable version of a light.
	 *
	 * @see		LightBase
	 */
	class BS_CORE_EXPORT Light : public CoreObject, public LightBase
	{
	public:
		~Light();

		/**	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; }

		static const UINT32 LIGHT_CONE_NUM_SIDES;
		static const UINT32 LIGHT_CONE_NUM_SLICES;
	protected:
		friend class bs::Light;

		Light(LightType type, Color color, float intensity, 
			float range, bool castsShadows, Degree spotAngle, Degree spotFalloffAngle);

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

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

		UINT32 mRendererId;
		SPtr<Mesh> mMesh;
	};
	}

	/** @} */
}