Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


PhysicsWheelJointDefinition

A joint definition used to specify properties when creating a PhysicsWheelJoint.
Read time 2 minutesLast updated 10 days ago

Definition

public struct PhysicsWheelJointDefinition : IEquatable<PhysicsWheelJointDefinition>

Constructors

Constructor

Description

PhysicsWheelJointDefinition()Create a default PhysicsWheelJoint definition.
PhysicsWheelJointDefinition(System.Boolean)Create a default PhysicsWheelJoint definition.

Properties

Property

Description

autoAnchorAWhen set, _localAnchorA is recomputed from the bodies' current placement at create so both anchor frames coincide in world space.
autoAnchorBWhen set, _localAnchorB is recomputed from the bodies' current placement at create so both anchor frames coincide in world space.
autoAxisWhen set, local anchor frame A's rotation is recomputed at create so the slide axis is the direction from anchor A to anchor B.
bodyAThe first body the joint constrains.
bodyBThe second body the joint constrains.
collideConnectedWhether the shapes on the pair of bodies can come into contact.
drawScaleControls the scaling of the joint drawing. Not all joints have scalable elements but those that do will use this scaling.
enableLimitEnable/disable the joint translation limit.
enableMotorEnable/disable the joint motor.
enableSpringEnable/Disable a spring along the joint axis.
forceThresholdThe force threshold beyond which a joint event will be produced.
localAnchorAThe local anchor frame constraint relative to bodyA's origin.
localAnchorBThe local anchor frame constraint relative to bodyB's origin.
lowerTranslationLimitThe lower translation limit.
maxMotorTorqueThe maximum torque the motor can apply, usually in newton-meters.
motorSpeedThe desired motor speed, usually in degrees per second.
springDampingThe spring damping, non-dimensional. Use 1 for critical damping.
springFrequencyThe spring stiffness frequency, in cycles per second.
torqueThresholdThe torque threshold beyond which a joint event will be produced.
tuningDampingControls the joint stiffness damping, non-dimensional. Use 1 for critical damping.
tuningFrequencyControls the joint stiffness frequency, in cycles per second.
upperTranslationLimitThe upper translation limit.
worldDrawingControls whether this joint is automatically drawn when the world is drawn.

Static Properties

Property

Description

defaultDefinitionGet a default PhysicsWheelJoint definition.