godot/doc/classes/ConeTwistJoint3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ConeTwistJoint3D" inherits="Joint3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A twist joint between two 3D PhysicsBodies.
	</brief_description>
	<description>
		The joint can rotate the bodies across an axis defined by the local x-axes of the [Joint3D].
		The twist axis is initiated as the X axis of the [Joint3D].
		Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint3D in the local space of the two Bodies. See also [Generic6DOFJoint3D].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_param" qualifiers="const">
			<return type="float" />
			<param index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" />
			<description>
			</description>
		</method>
		<method name="set_param">
			<return type="void" />
			<param index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" />
			<param index="1" name="value" type="float" />
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="bias" type="float" setter="set_param" getter="get_param" default="0.3">
			The speed with which the swing or twist will take place.
			The higher, the faster.
		</member>
		<member name="relaxation" type="float" setter="set_param" getter="get_param" default="1.0">
			Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
		</member>
		<member name="softness" type="float" setter="set_param" getter="get_param" default="0.8">
			The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
		</member>
		<member name="swing_span" type="float" setter="set_param" getter="get_param" default="0.785398">
			Swing is rotation from side to side, around the axis perpendicular to the twist axis.
			The swing span defines, how much rotation will not get corrected along the swing axis.
			Could be defined as looseness in the [ConeTwistJoint3D].
			If below 0.05, this behavior is locked.
		</member>
		<member name="twist_span" type="float" setter="set_param" getter="get_param" default="3.14159">
			Twist is the rotation around the twist axis, this value defined how far the joint can twist.
			Twist is locked if below 0.05.
		</member>
	</members>
	<constants>
		<constant name="PARAM_SWING_SPAN" value="0" enum="Param">
			Swing is rotation from side to side, around the axis perpendicular to the twist axis.
			The swing span defines, how much rotation will not get corrected along the swing axis.
			Could be defined as looseness in the [ConeTwistJoint3D].
			If below 0.05, this behavior is locked.
		</constant>
		<constant name="PARAM_TWIST_SPAN" value="1" enum="Param">
			Twist is the rotation around the twist axis, this value defined how far the joint can twist.
			Twist is locked if below 0.05.
		</constant>
		<constant name="PARAM_BIAS" value="2" enum="Param">
			The speed with which the swing or twist will take place.
			The higher, the faster.
		</constant>
		<constant name="PARAM_SOFTNESS" value="3" enum="Param">
			The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
		</constant>
		<constant name="PARAM_RELAXATION" value="4" enum="Param">
			Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
		</constant>
		<constant name="PARAM_MAX" value="5" enum="Param">
			Represents the size of the [enum Param] enum.
		</constant>
	</constants>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 21:18:53 +08:00			`<class name="ConeTwistJoint3D" inherits="Joint3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<brief_description>`
Fix confusing SliderJoint3D brief description 2020-12-24 08:46:56 +08:00			`A twist joint between two 3D PhysicsBodies.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</brief_description>`
			`<description>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-31 00:22:57 +08:00			`The joint can rotate the bodies across an axis defined by the local x-axes of the [Joint3D].`
			`The twist axis is initiated as the X axis of the [Joint3D].`
Fix confusing SliderJoint3D brief description 2020-12-24 08:46:56 +08:00			`Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint3D in the local space of the two Bodies. See also [Generic6DOFJoint3D].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 22:10:09 +08:00			`<method name="get_param" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="float" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" />`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 22:10:09 +08:00			`<description>`
			`</description>`
			`</method>`
			`<method name="set_param">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-07 02:11:48 +08:00			`<param index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" />`
			`<param index="1" name="value" type="float" />`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 22:10:09 +08:00			`<description>`
			`</description>`
			`</method>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="bias" type="float" setter="set_param" getter="get_param" default="0.3">`
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 18:19:03 +08:00			`The speed with which the swing or twist will take place.`
			`The higher, the faster.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="relaxation" type="float" setter="set_param" getter="get_param" default="1.0">`
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 18:19:03 +08:00			`Defines, how fast the swing- and twist-speed-difference on both sides gets synced.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="softness" type="float" setter="set_param" getter="get_param" default="0.8">`
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 18:19:03 +08:00			`The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
Joint3D: Remove utility method bindings for angular limits The inspector now supports converting degrees to radians automatically when using the `radians` hint, so all those utility bindings were redundant. This cleans things up by making these properties with slash properly bound to `set_param`/`get_param` which the users can call with the relevant enum. 2022-08-22 17:30:48 +08:00			`<member name="swing_span" type="float" setter="set_param" getter="get_param" default="0.785398">`
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 18:19:03 +08:00			`Swing is rotation from side to side, around the axis perpendicular to the twist axis.`
doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 17:10:53 +08:00			`The swing span defines, how much rotation will not get corrected along the swing axis.`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-31 00:22:57 +08:00			`Could be defined as looseness in the [ConeTwistJoint3D].`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`If below 0.05, this behavior is locked.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
Joint3D: Remove utility method bindings for angular limits The inspector now supports converting degrees to radians automatically when using the `radians` hint, so all those utility bindings were redundant. This cleans things up by making these properties with slash properly bound to `set_param`/`get_param` which the users can call with the relevant enum. 2022-08-22 17:30:48 +08:00			`<member name="twist_span" type="float" setter="set_param" getter="get_param" default="3.14159">`
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 18:19:03 +08:00			`Twist is the rotation around the twist axis, this value defined how far the joint can twist.`
			`Twist is locked if below 0.05.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="PARAM_SWING_SPAN" value="0" enum="Param">`
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 18:19:03 +08:00			`Swing is rotation from side to side, around the axis perpendicular to the twist axis.`
doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 17:10:53 +08:00			`The swing span defines, how much rotation will not get corrected along the swing axis.`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-31 00:22:57 +08:00			`Could be defined as looseness in the [ConeTwistJoint3D].`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`If below 0.05, this behavior is locked.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="PARAM_TWIST_SPAN" value="1" enum="Param">`
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 18:19:03 +08:00			`Twist is the rotation around the twist axis, this value defined how far the joint can twist.`
			`Twist is locked if below 0.05.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="PARAM_BIAS" value="2" enum="Param">`
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 18:19:03 +08:00			`The speed with which the swing or twist will take place.`
			`The higher, the faster.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="PARAM_SOFTNESS" value="3" enum="Param">`
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 18:19:03 +08:00			`The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="PARAM_RELAXATION" value="4" enum="Param">`
Added documentation for 3D Joints, the 2D Pin Joint, and the Physicsservers, also a minor bugfix in the 3D Pinjoint. 2017-10-14 18:19:03 +08:00			`Defines, how fast the swing- and twist-speed-difference on both sides gets synced.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="PARAM_MAX" value="5" enum="Param">`
doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 17:10:53 +08:00			`Represents the size of the [enum Param] enum.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</constant>`
			`</constants>`
			`</class>`