virtualx-engine/doc/classes/GrooveJoint2D.xml
2018-02-19 10:46:33 +01:00

25 lines
1,016 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GrooveJoint2D" inherits="Joint2D" category="Core" version="3.1-dev">
<brief_description>
Groove constraint for 2D physics.
</brief_description>
<description>
Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="initial_offset" type="float" setter="set_initial_offset" getter="get_initial_offset">
The body B's initial anchor position defined by the joint's origin and a local offset [member initial_offset] along the joint's y axis (along the groove). Default value: [code]25[/code]
</member>
<member name="length" type="float" setter="set_length" getter="get_length">
The groove's length. The groove is from the joint's origin towards [member length] along the joint's local y axis. Default value: [code]50[/code]
</member>
</members>
<constants>
</constants>
</class>