BansheeEngine/Source/BansheeCore/Include/BsPhysicsMaterial.h

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

#include "BsCorePrerequisites.h"
#include "BsResource.h"

namespace bs
{
	/** @addtogroup Physics
	 *  @{
	 */

	/**
	 * Material that controls how two physical objects interact with each other. Materials of both objects are used during
	 * their interaction and their combined values are used.
	 */
	class BS_CORE_EXPORT BS_SCRIPT_EXPORT(m:Physics) PhysicsMaterial : public Resource
	{
	public:
		virtual ~PhysicsMaterial() { }

		/** 
		  * Controls friction when two in-contact objects are not moving lateral to each other (for example how difficult 
		  * it is to get an object moving from a static state while it is in contact with other object(s)).
		  */
		BS_SCRIPT_EXPORT(n:StaticFriction,pr:setter)
		virtual void setStaticFriction(float value) = 0;

		/** @copydoc setStaticFriction() */
		BS_SCRIPT_EXPORT(n:StaticFriction,pr:getter)
		virtual float getStaticFriction() const = 0;

		/**
		 * Controls friction when two in-contact objects are moving lateral to each other (for example how quickly does an
		 * object slow down when sliding along another object).
		 */
		BS_SCRIPT_EXPORT(n:DynamicFriction,pr:setter)
		virtual void setDynamicFriction(float value) = 0;

		/** @copydoc setDynamicFriction() */
		BS_SCRIPT_EXPORT(n:DynamicFriction,pr:getter)
		virtual float getDynamicFriction() const = 0;

		/** 
		 * Controls "bounciness" of an object during a collision. Value of 1 means the collision is elastic, and value of 0 
		 * means the value is inelastic. Must be in [0, 1] range.
		 */
		BS_SCRIPT_EXPORT(n:Restitution,pr:setter)
		virtual void setRestitutionCoefficient(float value) = 0;

		/** @copydoc setRestitutionCoefficient() */
		BS_SCRIPT_EXPORT(n:Restitution,pr:getter)
		virtual float getRestitutionCoefficient() const = 0;

		/** 
		 * Creates a new physics material. 
		 *
		 * @param[in]	staticFriction	Controls friction when two in-contact objects are not moving lateral to each other
		 *								(for example how difficult is to get an object moving from a static state while it
		 *								is in contact other object(s)).
		 * @param[in]	dynamicFriction	Sets dynamic friction of the material. Controls friction when two in-contact objects
		 *								are moving lateral to each other (for example how quickly does an object slow down
		 *								when sliding along another object).
		 * @param[in]	restitution		Controls "bounciness" of an object during a collision. Value of 1 means the
		 *								collision is elastic, and value of 0 means the value is inelastic. Must be in
		 *								[0, 1] range.
		 */
		BS_SCRIPT_EXPORT(ec:PhysicsMaterial)
		static HPhysicsMaterial create(float staticFriction = 0.0f, float dynamicFriction = 0.0f, float restitution = 0.0f);

		/** @name Internal
		 *  @{
		 */

		/** 
		 * @copydoc create()
		 *
		 * For internal use. Requires manual initialization after creation.
		 */
		static SPtr<PhysicsMaterial> _createPtr(float staticFriction = 0.0f, float dynamicFriction = 0.0f, 
			float restitution = 0.0f);

		/** @} */

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

	/** @} */
}