virtualx-engine/doc/classes/PinJoint.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PinJoint" inherits="Joint" category="Core" version="3.1-dev">
	<brief_description>
		Pin Joint for 3D Shapes.
	</brief_description>
	<description>
		Pin Joint for 3D Rigid Bodies. It pins 2 bodies (rigid or static) together.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
	</methods>
	<members>
		<member name="params/bias" type="float" setter="set_param" getter="get_param">
			The force with which the pinned objects stay in positional relation to each other.
			The higher, the stronger.
		</member>
		<member name="params/damping" type="float" setter="set_param" getter="get_param">
			The force with which the pinned objects stay in velocity relation to each other.
			The higher, the stronger.
		</member>
		<member name="params/impulse_clamp" type="float" setter="set_param" getter="get_param">
			If above 0, this value is the maximum value for an impulse that this Joint produces.
		</member>
	</members>
	<constants>
		<constant name="PARAM_BIAS" value="0" enum="Param">
			The force with which the pinned objects stay in positional relation to each other.
			The higher, the stronger.
		</constant>
		<constant name="PARAM_DAMPING" value="1" enum="Param">
			The force with which the pinned objects stay in velocity relation to each other.
			The higher, the stronger.
		</constant>
		<constant name="PARAM_IMPULSE_CLAMP" value="2" enum="Param">
			If above 0, this value is the maximum value for an impulse that this Joint produces.
		</constant>
	</constants>
</class>