ConfigurableJoint
The configurable joint is an extremely flexible joint giving you complete control over rotation and linear motion.
Read time 9 minutesLast updated 3 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.PhysicsModule
- Inherits from: Joint
[RequireComponent(typeof(Rigidbody))]public class ConfigurableJoint : Joint
Remarks
You can build all other joints with it and much more but it is also more complicated to setup. It gives you control over motors, drives and joint limits for each rotation axis and and linear degree of freedom.
Properties
Property | Description |
|---|---|
| angularXDrive | Definition of how the joint's rotation will behave around its local X axis. Only used if Rotation Drive Mode is Swing & Twist. |
| angularXLimitSpring | The configuration of the spring attached to the angular X limit of the joint. |
| angularXMotion | Allow rotation around the X axis to be Free, completely Locked, or Limited according to Low and High Angular XLimit. |
| angularYLimit | Boundary defining rotation restriction, based on delta from original rotation. |
| angularYMotion | Allow rotation around the Y axis to be Free, completely Locked, or Limited according to Angular YLimit. |
| angularYZDrive | Definition of how the joint's rotation will behave around its local Y and Z axes. Only used if Rotation Drive Mode is Swing & Twist. |
| angularYZLimitSpring | The configuration of the spring attached to the angular Y and angular Z limits of the joint. |
| angularZLimit | Boundary defining rotation restriction, based on delta from original rotation. |
| angularZMotion | Allow rotation around the Z axis to be Free, completely Locked, or Limited according to Angular ZLimit. |
| configuredInWorldSpace | If enabled, all Target values will be calculated in world space instead of the object's local space. |
| highAngularXLimit | Boundary defining upper rotation restriction, based on delta from original rotation. |
| linearLimit | Boundary defining movement restriction, based on distance from the joint's origin. |
| linearLimitSpring | The configuration of the spring attached to the linear limit of the joint. |
| lowAngularXLimit | Boundary defining lower rotation restriction, based on delta from original rotation. |
| projectionAngle | Set the angular tolerance threshold (in degrees) for projection. |
| projectionDistance | Set the linear tolerance threshold for projection. |
| projectionMode | Brings violated constraints back into alignment even when the solver fails. Projection is not a physical process and does not preserve momentum or respect collision geometry. It is best avoided if practical, but can be useful in improving simulation quality where joint separation results in unacceptable artifacts. |
| rotationDriveMode | Control the object's rotation with either X & YZ or Slerp Drive by itself. |
| secondaryAxis | The joint's secondary axis. |
| slerpDrive | Definition of how the joint's rotation will behave around all local axes. Only used if Rotation Drive Mode is Slerp Only. |
| swapBodies | Enable this property to swap the order in which the physics engine processes the Rigidbodies involved in the joint. This results in different joint motion but has no impact on Rigidbodies and anchors. |
| targetAngularVelocity | This is a Vector3. It defines the desired angular velocity that the joint should rotate into. |
| targetPosition | The desired position that the joint should move into. |
| targetRotation | This is a Quaternion. It defines the desired rotation that the joint should rotate into. |
| targetVelocity | The desired velocity that the joint should move along. |
| xDrive | Definition of how the joint's movement will behave along its local X axis. |
| xMotion | Allow movement along the X axis to be Free, completely Locked, or Limited according to Linear Limit. |
| yDrive | Definition of how the joint's movement will behave along its local Y axis. |
| yMotion | Allow movement along the Y axis to be Free, completely Locked, or Limited according to Linear Limit. |
| zDrive | Definition of how the joint's movement will behave along its local Z axis. |
| zMotion | Allow movement along the Z axis to be Free, completely Locked, or Limited according to Linear Limit. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |