UVehicleWheel

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

PhysXVehicles

Header

/Engine/Plugins/Runtime/PhysXVehicles/Source/PhysXVehicles/Public/VehicleWheel.h

Include

#include "VehicleWheel.h"

Syntax

UCLASS(BlueprintType, Blueprintable)
class UVehicleWheel : public UObject

Variables

Name Description

Public variable UProperty Category, EditAnywhere

bool

 

bAffectedByHandbrake

Whether handbrake should affect this wheel

Public variable UProperty Category, EditAnywhere

bool

 

bAutoAdjustCollisionSize

If true, ShapeRadius and ShapeWidth will be used to automatically scale collision taken from CollisionMesh to match wheel size.

Public variable UProperty Category, EditDefaultsOnly, Meta

bool

 

bDontCreateShape

If set, shape won't be created, but mapped from chassis mesh

Public variable UProperty Category, EditDefaultsOnly

UStaticMesh ...

 

CollisionMesh

Static mesh with collision setup for wheel, will be used to create wheel shape (if empty, sphere will be added as wheel shape, check bDontCreateShape flag)

Public variable UProperty Category, EditAnywhere, Meta

float

 

DampingRate

Damping rate for this wheel (Kgm^2/s)

Public variable UProperty Transient

float

 

DebugLatForce

Lateral force the wheel is applying to the chassis.

Public variable UProperty Transient

float

 

DebugLatSlip

Lateral slip experienced by the wheel.

Public variable UProperty Transient

float

 

DebugLongForce

Longitudinal force the wheel is applying to the chassis.

Public variable UProperty Transient

float

 

DebugLongSlip

Longitudinal slip experienced by the wheel.

Public variable UProperty Transient

float

 

DebugNormalizedTireLoad

How much force the tire experiences at rest divided by how much force it is experiencing now.

Public variable

float

 

DebugTireLoad

How much force the tire is experiencing now.

Public variable UProperty Transient

float

 

DebugWheelTorque

Wheel torque.

Public variable UProperty Category, EditAnywhere, Meta

float

 

LatStiffMaxLoad

Max normalized tire load at which the tire can deliver no more lateral stiffness no matter how much extra load is applied to the tire.

Public variable UProperty Category, EditAnywhere, Meta

float

 

LatStiffValue

How much lateral stiffness to have given lateral slip

Public variable UProperty Transient

FVector

 

Location

Worldspace location of this wheel.

Public variable UProperty Category, EditAnywhere

float

 

LongStiffValue

How much longitudinal stiffness to have given longitudinal slip

Public variable UProperty Category, EditAnywhere, Meta

float

 

Mass

Mass of this wheel

Public variable UProperty Category, EditAnywhere

float

 

MaxBrakeTorque

Max brake torque for this wheel (Nm)

Public variable UProperty Category, EditAnywhere

float

 

MaxHandBrakeTorque

Max handbrake brake torque for this wheel (Nm).

Public variable UProperty Category, EditAnywhere

FVector

 

Offset

If BoneName is specified, offset the wheel from the bone's location.

Public variable UProperty Transient

FVector

 

OldLocation

Worldspace location of this wheel last frame.

Public variable UProperty Category, EditAnywhere, Meta

float

 

ShapeRadius

Radius of the wheel

Public variable UProperty Category, EditAnywhere, Meta

float

 

ShapeWidth

Width of the wheel

Public variable UProperty Category, EditAnywhere, Meta

float

 

SteerAngle

Steer angle in degrees for this wheel

Public variable UProperty Category, EditAnywhere

float

 

SuspensionDampingRatio

The rate at which energy is dissipated from the spring.

Public variable UProperty Category, EditAnywhere

float

 

SuspensionForceOffset

Vertical offset from where suspension forces are applied (along Z-axis)

Public variable UProperty Category, EditAnywhere

float

 

SuspensionMaxDrop

How far the wheel can drop below the resting position

Public variable UProperty Category, EditAnywhere

float

 

SuspensionMaxRaise

How far the wheel can go above the resting position

Public variable UProperty Category, EditAnywhere

float

 

SuspensionNaturalFrequency

Oscillation frequency of suspension. Standard cars have values between 5 and 10

Public variable UProperty Category, EditAnywhere

TEnumAsByte< EW...

 

SweepType

Whether wheel suspension considers simple, complex, or both

Public variable UProperty Category, EditAnywhere

UTireConfig ...

 

TireConfig

Tire type for the wheel. Determines friction

Public variable UProperty

UTireType *

 

TireType

Deprecated

Public variable UProperty Transient

UWheeledVehicle...

 

VehicleSim

The vehicle that owns us

Public variable UProperty Transient

FVector

 

Velocity

Current velocity of the wheel center (change in location over time)

Public variable UProperty Transient

int32

 

WheelIndex

Our index in the vehicle's (and setup's) wheels array.

Public variable

physx::PxShape ...

 

WheelShape

Our wheelshape.

Constructors

Name Description

Public function

UVehicleWheel

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

UPhysicalMat...

 

GetContactSurfaceMaterial()

Get contact surface material

Protected function

FVector

 

GetPhysicsLocation()

Get the wheel's location in physics land

Public function Const UFunction BlueprintCallable, Category

float

 

GetRotationAngle()

Public function Const UFunction BlueprintCallable, Category

float

 

GetSteerAngle()

Public function Const UFunction BlueprintCallable, Category

float

 

GetSuspensionOffset()

Public function

FWheelSetup ...

 

GetWheelSetup()

Get the wheel setup we were created from

Public function Virtual

void

 

Init

(
    UWheeledVehicleMovementComponent&#...,
    int32 InWheelIndex
)

Initialize this wheel instance

Public function Const UFunction BlueprintCallable, Category

bool

 

IsInAir()

Public function Virtual

void

 

Shutdown()

Notify this wheel it will be removed from the scene

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

Tick this wheel when the vehicle ticks

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Respond to a property change in editor