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

PhysicsHingeJointDefinition

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

Static Properties

Property Description
defaultDefinition Create a default PhysicsHingeJoint 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 angle limit.
enableMotor Enable/disable the joint motor.
enableSpring Enable/Disable the rotational spring.
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.
lowerAngleLimit The lower angle limit, in degrees.
maxMotorTorque The maximum torque the motor can apply, usually in newton-meters.
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 frequncy, in cycles per second.
springTargetAngle The spring target angle, in degrees.
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.
upperAngleLimit The upper angle limit, in degrees.

Constructors

Constructor Description
PhysicsHingeJointDefinition Create a default PhysicsHingeJoint definition.