Skip to content

Latest commit

 

History

History
476 lines (304 loc) · 17.9 KB

class_sliderjoint.rst

File metadata and controls

476 lines (304 loc) · 17.9 KB
Raw
github_url

hide

SliderJoint

Inherits: Joint<class_Joint> < Spatial<class_Spatial> < Node<class_Node> < Object<class_Object>

Category: Core

Brief Description

Piston kind of slider between two bodies in 3D.

Properties

float<class_float> angular_limit/damping<class_SliderJoint_property_angular_limit/damping>
float<class_float> angular_limit/lower_angle<class_SliderJoint_property_angular_limit/lower_angle>
float<class_float> angular_limit/restitution<class_SliderJoint_property_angular_limit/restitution>
float<class_float> angular_limit/softness<class_SliderJoint_property_angular_limit/softness>
float<class_float> angular_limit/upper_angle<class_SliderJoint_property_angular_limit/upper_angle>
float<class_float> angular_motion/damping<class_SliderJoint_property_angular_motion/damping>
float<class_float> angular_motion/restitution<class_SliderJoint_property_angular_motion/restitution>
float<class_float> angular_motion/softness<class_SliderJoint_property_angular_motion/softness>
float<class_float> angular_ortho/damping<class_SliderJoint_property_angular_ortho/damping>
float<class_float> angular_ortho/restitution<class_SliderJoint_property_angular_ortho/restitution>
float<class_float> angular_ortho/softness<class_SliderJoint_property_angular_ortho/softness>
float<class_float> linear_limit/damping<class_SliderJoint_property_linear_limit/damping>
float<class_float> linear_limit/lower_distance<class_SliderJoint_property_linear_limit/lower_distance>
float<class_float> linear_limit/restitution<class_SliderJoint_property_linear_limit/restitution>
float<class_float> linear_limit/softness<class_SliderJoint_property_linear_limit/softness>
float<class_float> linear_limit/upper_distance<class_SliderJoint_property_linear_limit/upper_distance>
float<class_float> linear_motion/damping<class_SliderJoint_property_linear_motion/damping>
float<class_float> linear_motion/restitution<class_SliderJoint_property_linear_motion/restitution>
float<class_float> linear_motion/softness<class_SliderJoint_property_linear_motion/softness>
float<class_float> linear_ortho/damping<class_SliderJoint_property_linear_ortho/damping>
float<class_float> linear_ortho/restitution<class_SliderJoint_property_linear_ortho/restitution>
float<class_float> linear_ortho/softness<class_SliderJoint_property_linear_ortho/softness>

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_SliderJoint_Param> enum.

Description

Slides across the x-axis of the pivot object.

Property Descriptions

  • float<class_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<class_float> angular_limit/lower_angle

The lower limit of rotation in the slider.

  • float<class_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<class_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<class_float> angular_limit/upper_angle

The upper limit of rotation in the slider.

  • float<class_float> angular_motion/damping
Setter set_param(value)
Getter get_param()

The amount of damping of the rotation in the limits.

  • float<class_float> angular_motion/restitution
Setter set_param(value)
Getter get_param()

The amount of restitution of the rotation in the limits.

  • float<class_float> angular_motion/softness
Setter set_param(value)
Getter get_param()

A factor applied to the all rotation in the limits.

  • float<class_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<class_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<class_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<class_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<class_SliderJoint_property_linear_limit/lower_distance> and linear_limit/upper_distance<class_SliderJoint_property_linear_limit/upper_distance> is surpassed.

  • float<class_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<class_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<class_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<class_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<class_float> linear_motion/damping
Setter set_param(value)
Getter get_param()

The amount of damping inside the slider limits.

  • float<class_float> linear_motion/restitution
Setter set_param(value)
Getter get_param()

The amount of restitution inside the slider limits.

  • float<class_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<class_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<class_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<class_float> linear_ortho/softness
Setter set_param(value)
Getter get_param()

A factor applied to the movement across axes orthogonal to the slider.