ConeTwistJoint

Inherits: Joint < Spatial < Node < Object

A twist joint between two 3D bodies.

Description

The joint can rotate the bodies across an axis defined by the local x-axes of the Joint.

The twist axis is initiated as the X axis of the Joint.

Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies.

Methods

floatget_param ( Param param ) const
voidset_param ( Param param, float value )

Enumerations

enum Param:

  • PARAM_SWING_SPAN = 0 — 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 ConeTwistJoint.

If below 0.05, this behavior is locked.

  • PARAM_TWIST_SPAN = 1 — Twist is the rotation around the twist axis, this value defined how far the joint can twist.

Twist is locked if below 0.05.

  • PARAM_BIAS = 2 — The speed with which the swing or twist will take place.

The higher, the faster.

  • PARAM_SOFTNESS = 3 — The ease with which the joint starts to twist. If it’s too low, it takes more force to start twisting the joint.
  • PARAM_RELAXATION = 4 — Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
  • PARAM_MAX = 5 — Represents the size of the Param enum.

Property Descriptions

Default0.3
Setterset_param(value)
Getterget_param()

The speed with which the swing or twist will take place.

The higher, the faster.


Default1.0
Setterset_param(value)
Getterget_param()

Defines, how fast the swing- and twist-speed-difference on both sides gets synced.


Default0.8
Setterset_param(value)
Getterget_param()

The ease with which the joint starts to twist. If it’s too low, it takes more force to start twisting the joint.


Default45.0

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 ConeTwistJoint.

If below 0.05, this behavior is locked.


Default180.0

Twist is the rotation around the twist axis, this value defined how far the joint can twist.

Twist is locked if below 0.05.

Method Descriptions


doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:31:13. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.