BansheeEngine/Source/BansheeCore/Include/BsSphericalJoint.h

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

#include "BsCorePrerequisites.h"
#include "BsJoint.h"

namespace BansheeEngine
{
	/** @addtogroup Physics
	 *  @{
	 */

	struct SPHERICAL_JOINT_DESC;

	/** 
	 * A spherical joint removes all translational degrees of freedom but allows all rotational degrees of freedom. 
	 * Essentially this ensures that the anchor points of the two bodies are always coincident. Bodies are allowed to
	 * rotate around the anchor points, and their rotatation can be limited by an elliptical cone.
	 */
	class BS_CORE_EXPORT SphericalJoint : public Joint
	{
	public:
		/** Flags that control options for the spherical joint */
		enum class Flag
		{
			Limit = 0x1
		};

	public:
		SphericalJoint(const SPHERICAL_JOINT_DESC& desc) { }
		virtual ~SphericalJoint() { }

		/** 
		 * Returns the limit of the joint. This clamps the rotation inside an eliptical angular cone. You must enable limit
		 * flag on the joint in order for this to be recognized. 
		 */
		virtual LimitConeRange getLimit() const = 0;

		/** 
		 * Sets the limit of the joint. This clamps the rotation inside an eliptical angular cone. You must enable limit
		 * flag on the joint in order for this to be recognized. 
		 */
		virtual void setLimit(const LimitConeRange& limit) = 0;

		/** Enables or disables a flag that controls the joint's behaviour. */
		virtual void setFlag(Flag flag, bool enabled) = 0;

		/** Checks is the specified flag enabled. */
		virtual bool hasFlag(Flag flag) const = 0;

		/** Creates a new spherical joint. */
		static SPtr<SphericalJoint> create(const SPHERICAL_JOINT_DESC& desc);
	};

	/** Structure used for initializing a new SphericalJoint. */
	struct SPHERICAL_JOINT_DESC : JOINT_DESC
	{
		LimitConeRange limit;
		SphericalJoint::Flag flag = (SphericalJoint::Flag)0;
	};

	/** @} */
}