Struct WheelOnVehicle
Holds dynamic/calcualted wheel data. For wheel settings refer to Wheel.
Implements
Inherited Members
Namespace: Unity.Vehicles
Assembly: com.unity.vehicles.dll
Syntax
[InternalBufferCapacity(4)]
public struct WheelOnVehicle : IBufferElementDataFields
AngularVelocity
Current angular velocity of the wheel in radians per second.
Declaration
public float AngularVelocityField Value
| Type | Description |
|---|---|
| float |
AngularVelocityLimit
Maximum angular velocity the wheel can achieve.
Declaration
public float AngularVelocityLimitField Value
| Type | Description |
|---|---|
| float |
AxlePairedWheelEntity
Wheel entity that shares the same axle as this wheel.
Declaration
public Entity AxlePairedWheelEntityField Value
| Type | Description |
|---|---|
| Entity |
AxlePairedWheelIndex
Index of the wheel entity that shares the same axle as this wheel.
Declaration
public int AxlePairedWheelIndexField Value
| Type | Description |
|---|---|
| int |
BrakeTorque
Current brake torque of the wheel, expressed in Nm. The value can only be positive, and any value >0 will block motor torque from being applied.
Declaration
public float BrakeTorqueField Value
| Type | Description |
|---|---|
| float |
DisableStaticFrictionSingleFrame
Static friction is disabled for one frame when true. Allows the vehicle to get out of the static friction lock.
Declaration
public bool DisableStaticFrictionSingleFrameField Value
| Type | Description |
|---|---|
| bool |
Entity
The wheel entity
Declaration
public Entity EntityField Value
| Type | Description |
|---|---|
| Entity |
FrictionImpulse
Total friction impulse for the global physics step.
Declaration
public float3 FrictionImpulseField Value
| Type | Description |
|---|---|
| float3 |
FrictionSlip
Friction slip values. X represents the longitudinal slip, Y represents the lateral slip. Both values are normalized. Lateral slip value of 1 equals 90 degree lateral slip angle, while the longitudinal slip value represents slip ratio of 1.
Declaration
public float2 FrictionSlipField Value
| Type | Description |
|---|---|
| float2 |
FrictionSpeed
Friction speed values. X represents the longitudinal speed, Y represents the lateral speed. Expressed in m/s. Both values are in world space. To get the effective speeds for moving platforms, objects, etc. subtract the HitRigidbodyVelocity from this value.
Declaration
public float2 FrictionSpeedField Value
| Type | Description |
|---|---|
| float2 |
IsGrounded
Is the wheel touching the ground?
Declaration
public bool IsGroundedField Value
| Type | Description |
|---|---|
| bool |
MotorTorque
Current motor torque of the wheel, expressed in Nm.
Declaration
public float MotorTorqueField Value
| Type | Description |
|---|---|
| float |
RotationAngle
Rotation angle of the wheel, relative to the axle. The value is clamped to one full rotation and can be used to position the wheel visual.
Declaration
public float RotationAngleField Value
| Type | Description |
|---|---|
| float |
StaticFrictionRefPosition
Position of the anti-creep reference. The wheel will attempt to hold this position when stationary.
Declaration
public float3 StaticFrictionRefPositionField Value
| Type | Description |
|---|---|
| float3 |
StaticFrictionReferenceIsSet
Is the anti-creep position set? When true, the wheel will attempt to hold a fixed position to prevent creep on slopes.
Declaration
public bool StaticFrictionReferenceIsSetField Value
| Type | Description |
|---|---|
| bool |
SteerAngle
Current steer angle of the wheel in degrees.
Declaration
public float SteerAngleField Value
| Type | Description |
|---|---|
| float |
SuspensionImpulse
Total suspension impulse for the global physics step.
Declaration
public float3 SuspensionImpulseField Value
| Type | Description |
|---|---|
| float3 |
SuspensionLength
Current length of the suspension, expressed in meters.
Declaration
public float SuspensionLengthField Value
| Type | Description |
|---|---|
| float |
SuspensionLocalTransform
Local transform of the wheel suspension. This transform represents the origin and direction of the suspension travel.
Declaration
public RigidTransform SuspensionLocalTransformField Value
| Type | Description |
|---|---|
| RigidTransform |
VisualSuspensionLength
Smoothed suspension length for wheel meshes, expressed in meters.
Declaration
public float VisualSuspensionLengthField Value
| Type | Description |
|---|---|
| float |
Wheel
Wheel that belongs to this VehicleWheel buffer.
Declaration
public Wheel WheelField Value
| Type | Description |
|---|---|
| Wheel |
WheelHit
Data from the collider cast.
Declaration
public ColliderCastHit WheelHitField Value
| Type | Description |
|---|---|
| ColliderCastHit |
WheelProtectorChildColliderIndex
Index of the wheel protector child collider in the vehicle compound collider.
Declaration
public int WheelProtectorChildColliderIndexField Value
| Type | Description |
|---|---|
| int |