Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

PhysicsSliderJointDefinition

struct in UnityEngine.LowLevelPhysics2D

/

Implemented in:UnityEngine.Physics2DModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A joint definition used to specify properties when creating a PhysicsSliderJoint.

Static Properties

Property Description
defaultDefinition Get a default PhysicsSliderJoint definition.

Properties

Property Description
bodyA The first body the joint constrains.
bodyB The second body the joint constrains.
collideConnected Whether the shapes on the pair of bodies can come into contact.
drawScale Controls the scaling of the joint drawing. Not all joints have scalable elements but those that do will use this scaling.
enableLimit Enable/disable the joint translation limit.
enableMotor Enable/disable the joint motor.
enableSpring Enable/Disable a spring along the slider joint axis.
forceThreshold The force threshold beyond which a joint event will be produced.
localAnchorA The local anchor frame constraint relative to bodyA's origin.
localAnchorB The local anchor frame constraint relative to bodyB's origin.
lowerTranslationLimit The lower translation limit of this joint. This will be clamped to a lower stable limit.
maxMotorForce The maximum force the motor can apply, usually in newtons.
motorSpeed The desired motor speed, usually in meters per second.
springDamping The spring damping, non-dimensional. Use 1 for critical damping.
springFrequency The spring stiffness frequency, in cycles per second.
springTargetTranslation The spring target translation, usually in meters. The spring-damper will drive to this translation.
torqueThreshold The torque threshold beyond which a joint event will be produced.
tuningDamping Controls the joint stiffness damping, non-dimensional. Use 1 for critical damping.
tuningFrequency Controls the joint stiffness frequency, in cycles per second.
upperTranslationLimit The upper trasnlation limit of this joint. Must be greater than or equal to the minimum length.

Constructors

Constructor Description
PhysicsSliderJointDefinition Create a default PhysicsSliderJoint definition.