summaryrefslogtreecommitdiff
path: root/doc/classes/SliderJoint.xml
blob: 75406df39f22700953775b4a24aaeb9f086a9115 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SliderJoint" inherits="Joint" category="Core" version="3.2">
	<brief_description>
		Piston kind of slider between two bodies in 3D.
	</brief_description>
	<description>
		Slides across the x-axis of the pivot object.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="angular_limit/damping" type="float" setter="set_param" getter="get_param">
			The amount of damping of the rotation when the limit is surpassed.
			A lower damping value allows a rotation initiated by body A to travel to body B slower.
		</member>
		<member name="angular_limit/lower_angle" type="float" setter="_set_lower_limit_angular" getter="_get_lower_limit_angular">
			The lower limit of rotation in the slider.
		</member>
		<member name="angular_limit/restitution" type="float" setter="set_param" getter="get_param">
			The amount of restitution of the rotation when the limit is surpassed.
			Does not affect damping.
		</member>
		<member name="angular_limit/softness" type="float" setter="set_param" getter="get_param">
			A factor applied to the all rotation once the limit is surpassed.
			Makes all rotation slower when between 0 and 1.
		</member>
		<member name="angular_limit/upper_angle" type="float" setter="_set_upper_limit_angular" getter="_get_upper_limit_angular">
			The upper limit of rotation in the slider.
		</member>
		<member name="angular_motion/damping" type="float" setter="set_param" getter="get_param">
			The amount of damping of the rotation in the limits.
		</member>
		<member name="angular_motion/restitution" type="float" setter="set_param" getter="get_param">
			The amount of restitution of the rotation in the limits.
		</member>
		<member name="angular_motion/softness" type="float" setter="set_param" getter="get_param">
			A factor applied to the all rotation in the limits.
		</member>
		<member name="angular_ortho/damping" type="float" setter="set_param" getter="get_param">
			The amount of damping of the rotation across axes orthogonal to the slider.
		</member>
		<member name="angular_ortho/restitution" type="float" setter="set_param" getter="get_param">
			The amount of restitution of the rotation across axes orthogonal to the slider.
		</member>
		<member name="angular_ortho/softness" type="float" setter="set_param" getter="get_param">
			A factor applied to the all rotation across axes orthogonal to the slider.
		</member>
		<member name="linear_limit/damping" type="float" setter="set_param" getter="get_param">
			The amount of damping that happens once the limit defined by [member linear_limit/lower_distance] and [member linear_limit/upper_distance] is surpassed.
		</member>
		<member name="linear_limit/lower_distance" type="float" setter="set_param" getter="get_param">
			The minimum difference between the pivot points on their x-axis before damping happens.
		</member>
		<member name="linear_limit/restitution" type="float" setter="set_param" getter="get_param">
			The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.
		</member>
		<member name="linear_limit/softness" type="float" setter="set_param" getter="get_param">
			A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
		</member>
		<member name="linear_limit/upper_distance" type="float" setter="set_param" getter="get_param">
			The maximum difference between the pivot points on their x-axis before damping happens.
		</member>
		<member name="linear_motion/damping" type="float" setter="set_param" getter="get_param">
			The amount of damping inside the slider limits.
		</member>
		<member name="linear_motion/restitution" type="float" setter="set_param" getter="get_param">
			The amount of restitution inside the slider limits.
		</member>
		<member name="linear_motion/softness" type="float" setter="set_param" getter="get_param">
			A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement.
		</member>
		<member name="linear_ortho/damping" type="float" setter="set_param" getter="get_param">
			The amount of damping when movement is across axes orthogonal to the slider.
		</member>
		<member name="linear_ortho/restitution" type="float" setter="set_param" getter="get_param">
			The amount of restitution when movement is across axes orthogonal to the slider.
		</member>
		<member name="linear_ortho/softness" type="float" setter="set_param" getter="get_param">
			A factor applied to the movement across axes orthogonal to the slider.
		</member>
	</members>
	<constants>
		<constant name="PARAM_LINEAR_LIMIT_UPPER" value="0" enum="Param">
			The maximum difference between the pivot points on their x-axis before damping happens.
		</constant>
		<constant name="PARAM_LINEAR_LIMIT_LOWER" value="1" enum="Param">
			The minimum difference between the pivot points on their x-axis before damping happens.
		</constant>
		<constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2" enum="Param">
			A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
		</constant>
		<constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3" enum="Param">
			The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost.
		</constant>
		<constant name="PARAM_LINEAR_LIMIT_DAMPING" value="4" enum="Param">
			The amount of damping once the slider limits are surpassed.
		</constant>
		<constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5" enum="Param">
			A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement.
		</constant>
		<constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6" enum="Param">
			The amount of restitution inside the slider limits.
		</constant>
		<constant name="PARAM_LINEAR_MOTION_DAMPING" value="7" enum="Param">
			The amount of damping inside the slider limits.
		</constant>
		<constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8" enum="Param">
			A factor applied to the movement across axes orthogonal to the slider.
		</constant>
		<constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9" enum="Param">
			The amount of restitution when movement is across axes orthogonal to the slider.
		</constant>
		<constant name="PARAM_LINEAR_ORTHOGONAL_DAMPING" value="10" enum="Param">
			The amount of damping when movement is across axes orthogonal to the slider.
		</constant>
		<constant name="PARAM_ANGULAR_LIMIT_UPPER" value="11" enum="Param">
			The upper limit of rotation in the slider.
		</constant>
		<constant name="PARAM_ANGULAR_LIMIT_LOWER" value="12" enum="Param">
			The lower limit of rotation in the slider.
		</constant>
		<constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="13" enum="Param">
			A factor applied to the all rotation once the limit is surpassed.
		</constant>
		<constant name="PARAM_ANGULAR_LIMIT_RESTITUTION" value="14" enum="Param">
			The amount of restitution of the rotation when the limit is surpassed.
		</constant>
		<constant name="PARAM_ANGULAR_LIMIT_DAMPING" value="15" enum="Param">
			The amount of damping of the rotation when the limit is surpassed.
		</constant>
		<constant name="PARAM_ANGULAR_MOTION_SOFTNESS" value="16" enum="Param">
			A factor applied to the all rotation in the limits.
		</constant>
		<constant name="PARAM_ANGULAR_MOTION_RESTITUTION" value="17" enum="Param">
			The amount of restitution of the rotation in the limits.
		</constant>
		<constant name="PARAM_ANGULAR_MOTION_DAMPING" value="18" enum="Param">
			The amount of damping of the rotation in the limits.
		</constant>
		<constant name="PARAM_ANGULAR_ORTHOGONAL_SOFTNESS" value="19" enum="Param">
			A factor applied to the all rotation across axes orthogonal to the slider.
		</constant>
		<constant name="PARAM_ANGULAR_ORTHOGONAL_RESTITUTION" value="20" enum="Param">
			The amount of restitution of the rotation across axes orthogonal to the slider.
		</constant>
		<constant name="PARAM_ANGULAR_ORTHOGONAL_DAMPING" value="21" enum="Param">
			The amount of damping of the rotation across axes orthogonal to the slider.
		</constant>
		<constant name="PARAM_MAX" value="22" enum="Param">
			Represents the size of the [enum Param] enum.
		</constant>
	</constants>
</class>