BansheeEngine/Source/BansheeCore/Physics/BsSliderJoint.h

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

#include "BsCorePrerequisites.h"
#include "Physics/BsJoint.h"

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

	struct SLIDER_JOINT_DESC;

	/** Flag that controls slider joint's behaviour. */
	enum class BS_SCRIPT_EXPORT(m:Physics) SliderJointFlag
	{
		Limit = 0x1 /**< Enables the linear range limit. */
	};

	/** 
	 * Joint that removes all but a single translational degree of freedom. Bodies are allowed to move along a single axis. 
	 */
	class BS_CORE_EXPORT SliderJoint : public Joint
	{
	public:
		SliderJoint(const SLIDER_JOINT_DESC& desc) { }
		virtual ~SliderJoint() { }

		/** Returns the current position of the slider. */
		virtual float getPosition() const = 0;

		/** Returns the current speed of the slider. */
		virtual float getSpeed() const = 0;

		/** @copydoc setLimit() */
		virtual LimitLinearRange getLimit() const = 0;

		/** 
		 * Determines a limit that constrains the movement of the joint to a specific minimum and maximum distance. You must
		 * enable the limit flag on the joint in order for this to be recognized. 
		 *
		 * @see LimitLinearRange
		 */
		virtual void setLimit(const LimitLinearRange& limit) = 0;

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

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

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

	/** Structure used for initializing a new SliderJoint. */
	struct SLIDER_JOINT_DESC : JOINT_DESC
	{
		LimitLinearRange limit;
		SliderJointFlag flag = (SliderJointFlag)0;
	};

	/** @} */
}