virtualx-engine/doc/classes/DampedSpringJoint2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="DampedSpringJoint2D" inherits="Joint2D" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Damped spring constraint for 2D physics.
	</brief_description>
	<description>
		Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_damping" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
			</description>
		</method>
		<method name="get_length" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the maximum length of the spring joint.
			</description>
		</method>
		<method name="get_rest_length" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
			</description>
		</method>
		<method name="get_stiffness" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
			</description>
		</method>
		<method name="set_damping">
			<return type="void">
			</return>
			<argument index="0" name="damping" type="float">
			</argument>
			<description>
				Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
			</description>
		</method>
		<method name="set_length">
			<return type="void">
			</return>
			<argument index="0" name="length" type="float">
			</argument>
			<description>
				Set the maximum length of the spring joint.
			</description>
		</method>
		<method name="set_rest_length">
			<return type="void">
			</return>
			<argument index="0" name="rest_length" type="float">
			</argument>
			<description>
				Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
			</description>
		</method>
		<method name="set_stiffness">
			<return type="void">
			</return>
			<argument index="0" name="stiffness" type="float">
			</argument>
			<description>
				Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
			</description>
		</method>
	</methods>
	<members>
		<member name="damping" type="float" setter="set_damping" getter="get_damping">
			The spring joint's damping ratio. A value between [code]0[/code] and [code]1[/code]. When the two bodies move into different directions the system tries to align them to the spring axis again. A high [code]damping[/code] value forces the attached bodies to align faster. Default value: [code]1[/code]
		</member>
		<member name="length" type="float" setter="set_length" getter="get_length">
			The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: [code]50[/code]
		</member>
		<member name="rest_length" type="float" setter="set_rest_length" getter="get_rest_length">
			When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. Default value: [code]0[/code]
		</member>
		<member name="stiffness" type="float" setter="set_stiffness" getter="get_stiffness">
			The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. Default value: [code]20[/code]
		</member>
	</members>
	<constants>
	</constants>
</class>