summaryrefslogtreecommitdiff
path: root/doc/classes/PinJoint.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/PinJoint.xml')
-rw-r--r--doc/classes/PinJoint.xml53
1 files changed, 0 insertions, 53 deletions
diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml
deleted file mode 100644
index de4cb9d98a..0000000000
--- a/doc/classes/PinJoint.xml
+++ /dev/null
@@ -1,53 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="PinJoint" inherits="Joint" version="4.0">
- <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>
- <methods>
- <method name="get_param" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="param" type="int" enum="PinJoint.Param">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_param">
- <return type="void">
- </return>
- <argument index="0" name="param" type="int" enum="PinJoint.Param">
- </argument>
- <argument index="1" name="value" type="float">
- </argument>
- <description>
- </description>
- </method>
- </methods>
- <members>
- <member name="params/bias" type="float" setter="set_param" getter="get_param" default="0.3">
- 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" default="1.0">
- 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" default="0.0">
- 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>