diff options
Diffstat (limited to 'doc/classes/PinJoint3D.xml')
| -rw-r--r-- | doc/classes/PinJoint3D.xml | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/classes/PinJoint3D.xml b/doc/classes/PinJoint3D.xml new file mode 100644 index 0000000000..0af1e60839 --- /dev/null +++ b/doc/classes/PinJoint3D.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PinJoint3D" inherits="Joint3D" 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="PinJoint3D.Param"> + </argument> + <description> + Returns the value of the specified parameter. + </description> + </method> + <method name="set_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="PinJoint3D.Param"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + Sets the value of the specified parameter. + </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 Joint3D 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 Joint3D produces. + </constant> + </constants> +</class> |