SliderJoint¶
Inherits: Joint < Spatial < Node < Object
Category: Core
Brief Description¶
Piston kind of slider between two bodies in 3D.
Properties¶
Enumerations¶
enum Param:
- PARAM_LINEAR_LIMIT_UPPER = 0 — The maximum difference between the pivot points on their x-axis before damping happens.
- PARAM_LINEAR_LIMIT_LOWER = 1 — The minimum difference between the pivot points on their x-axis before damping happens.
- PARAM_LINEAR_LIMIT_SOFTNESS = 2 — A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
- PARAM_LINEAR_LIMIT_RESTITUTION = 3 — The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost.
- PARAM_LINEAR_LIMIT_DAMPING = 4 — The amount of damping once the slider limits are surpassed.
- PARAM_LINEAR_MOTION_SOFTNESS = 5 — 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.
- PARAM_LINEAR_MOTION_RESTITUTION = 6 — The amount of restitution inside the slider limits.
- PARAM_LINEAR_MOTION_DAMPING = 7 — The amount of damping inside the slider limits.
- PARAM_LINEAR_ORTHOGONAL_SOFTNESS = 8 — A factor applied to the movement across axes orthogonal to the slider.
- PARAM_LINEAR_ORTHOGONAL_RESTITUTION = 9 — The amount of restitution when movement is across axes orthogonal to the slider.
- PARAM_LINEAR_ORTHOGONAL_DAMPING = 10 — The amount of damping when movement is across axes orthogonal to the slider.
- PARAM_ANGULAR_LIMIT_UPPER = 11 — The upper limit of rotation in the slider.
- PARAM_ANGULAR_LIMIT_LOWER = 12 — The lower limit of rotation in the slider.
- PARAM_ANGULAR_LIMIT_SOFTNESS = 13 — A factor applied to the all rotation once the limit is surpassed.
- PARAM_ANGULAR_LIMIT_RESTITUTION = 14 — The amount of restitution of the rotation when the limit is surpassed.
- PARAM_ANGULAR_LIMIT_DAMPING = 15 — The amount of damping of the rotation when the limit is surpassed.
- PARAM_ANGULAR_MOTION_SOFTNESS = 16 — A factor applied to the all rotation in the limits.
- PARAM_ANGULAR_MOTION_RESTITUTION = 17 — The amount of restitution of the rotation in the limits.
- PARAM_ANGULAR_MOTION_DAMPING = 18 — The amount of damping of the rotation in the limits.
- PARAM_ANGULAR_ORTHOGONAL_SOFTNESS = 19 — A factor applied to the all rotation across axes orthogonal to the slider.
- PARAM_ANGULAR_ORTHOGONAL_RESTITUTION = 20 — The amount of restitution of the rotation across axes orthogonal to the slider.
- PARAM_ANGULAR_ORTHOGONAL_DAMPING = 21 — The amount of damping of the rotation across axes orthogonal to the slider.
- PARAM_MAX = 22 — Represents the size of the Param enum.
Description¶
Slides across the x-axis of the pivot object.
Property Descriptions¶
- float angular_limit/damping
Setter | set_param(value) |
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.
- float angular_limit/lower_angle
The lower limit of rotation in the slider.
- float angular_limit/restitution
Setter | set_param(value) |
Getter | get_param() |
The amount of restitution of the rotation when the limit is surpassed.
Does not affect damping.
- float angular_limit/softness
Setter | set_param(value) |
Getter | get_param() |
A factor applied to the all rotation once the limit is surpassed.
Makes all rotation slower when between 0 and 1.
- float angular_limit/upper_angle
The upper limit of rotation in the slider.
- float angular_motion/damping
Setter | set_param(value) |
Getter | get_param() |
The amount of damping of the rotation in the limits.
- float angular_motion/restitution
Setter | set_param(value) |
Getter | get_param() |
The amount of restitution of the rotation in the limits.
- float angular_motion/softness
Setter | set_param(value) |
Getter | get_param() |
A factor applied to the all rotation in the limits.
- float angular_ortho/damping
Setter | set_param(value) |
Getter | get_param() |
The amount of damping of the rotation across axes orthogonal to the slider.
- float angular_ortho/restitution
Setter | set_param(value) |
Getter | get_param() |
The amount of restitution of the rotation across axes orthogonal to the slider.
- float angular_ortho/softness
Setter | set_param(value) |
Getter | get_param() |
A factor applied to the all rotation across axes orthogonal to the slider.
- float linear_limit/damping
Setter | set_param(value) |
Getter | get_param() |
The amount of damping that happens once the limit defined by linear_limit/lower_distance and linear_limit/upper_distance is surpassed.
- float linear_limit/lower_distance
Setter | set_param(value) |
Getter | get_param() |
The minimum difference between the pivot points on their x-axis before damping happens.
- float linear_limit/restitution
Setter | set_param(value) |
Getter | get_param() |
The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost.
- float linear_limit/softness
Setter | set_param(value) |
Getter | get_param() |
A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.
- float linear_limit/upper_distance
Setter | set_param(value) |
Getter | get_param() |
The maximum difference between the pivot points on their x-axis before damping happens.
- float linear_motion/damping
Setter | set_param(value) |
Getter | get_param() |
The amount of damping inside the slider limits.
- float linear_motion/restitution
Setter | set_param(value) |
Getter | get_param() |
The amount of restitution inside the slider limits.
- float linear_motion/softness
Setter | set_param(value) |
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.
- float linear_ortho/damping
Setter | set_param(value) |
Getter | get_param() |
The amount of damping when movement is across axes orthogonal to the slider.
- float linear_ortho/restitution
Setter | set_param(value) |
Getter | get_param() |
The amount of restitution when movement is across axes orthogonal to the slider.
- float linear_ortho/softness
Setter | set_param(value) |
Getter | get_param() |
A factor applied to the movement across axes orthogonal to the slider.