Jolt Physics
A multi core friendly Game Physics Engine
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
VehicleController Class Referenceabstract

Runtime data for interface that controls acceleration / deceleration of the vehicle. More...

#include <VehicleController.h>

Inheritance diagram for VehicleController:
RefTarget< VehicleController > NonCopyable TrackedVehicleController WheeledVehicleController MotorcycleController

Public Member Functions

JPH_OVERRIDE_NEW_DELETE VehicleController (VehicleConstraint &inConstraint)
 Constructor / destructor.
 
virtual ~VehicleController ()=default
 
VehicleConstraint & GetConstraint ()
 Access the vehicle constraint that this controller is part of.
 
const VehicleConstraint & GetConstraint () const
 
- Public Member Functions inherited from RefTarget< VehicleController >
 RefTarget ()=default
 Constructor.
 
 RefTarget (const RefTarget &)
 
 ~RefTarget ()
 assert no one is referencing us
 
void SetEmbedded () const
 
RefTarget & operator= (const RefTarget &)
 Assignment operator.
 
uint32 GetRefCount () const
 Get current refcount of this object.
 
void AddRef () const
 Add or release a reference to this object.
 
void Release () const
 
- Public Member Functions inherited from NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
void operator= (const NonCopyable &)=delete
 

Protected Member Functions

virtual Wheel * ConstructWheel (const WheelSettings &inWheel) const =0
 
virtual bool AllowSleep () const =0
 
virtual void PreCollide (float inDeltaTime, PhysicsSystem &inPhysicsSystem)=0
 
virtual void PostCollide (float inDeltaTime, PhysicsSystem &inPhysicsSystem)=0
 
virtual bool SolveLongitudinalAndLateralConstraints (float inDeltaTime)=0
 
virtual void SaveState (StateRecorder &inStream) const =0
 
virtual void RestoreState (StateRecorder &inStream)=0
 
virtual void Draw (DebugRenderer *inRenderer) const =0
 

Protected Attributes

VehicleConstraint & mConstraint
 The vehicle constraint we belong to.
 
- Protected Attributes inherited from RefTarget< VehicleController >
atomic< uint32 > mRefCount
 Current reference count.
 

Friends

class VehicleConstraint
 

Additional Inherited Members

- Static Public Member Functions inherited from RefTarget< VehicleController >
static int sInternalGetRefCountOffset ()
 INTERNAL HELPER FUNCTION USED BY SERIALIZATION.
 
- Static Protected Attributes inherited from RefTarget< VehicleController >
static constexpr uint32 cEmbedded
 A large value that gets added to the refcount to mark the object as embedded.
 

Detailed Description

Runtime data for interface that controls acceleration / deceleration of the vehicle.

Constructor & Destructor Documentation

◆ VehicleController()

JPH_OVERRIDE_NEW_DELETE VehicleController::VehicleController ( VehicleConstraint &  inConstraint)
inlineexplicit

Constructor / destructor.

◆ ~VehicleController()

virtual VehicleController::~VehicleController ( )
virtualdefault

Member Function Documentation

◆ AllowSleep()

virtual bool VehicleController::AllowSleep ( ) const
protectedpure virtual

Implemented in TrackedVehicleController, and WheeledVehicleController.

◆ ConstructWheel()

virtual Wheel * VehicleController::ConstructWheel ( const WheelSettings &  inWheel) const
protectedpure virtual

Implemented in TrackedVehicleController, and WheeledVehicleController.

◆ Draw()

virtual void VehicleController::Draw ( DebugRenderer *  inRenderer) const
protectedpure virtual

Implemented in MotorcycleController, TrackedVehicleController, and WheeledVehicleController.

◆ GetConstraint() [1/2]

VehicleConstraint & VehicleController::GetConstraint ( )
inline

Access the vehicle constraint that this controller is part of.

◆ GetConstraint() [2/2]

const VehicleConstraint & VehicleController::GetConstraint ( ) const
inline

◆ PostCollide()

virtual void VehicleController::PostCollide ( float  inDeltaTime,
PhysicsSystem &  inPhysicsSystem 
)
protectedpure virtual

Implemented in TrackedVehicleController, and WheeledVehicleController.

◆ PreCollide()

virtual void VehicleController::PreCollide ( float  inDeltaTime,
PhysicsSystem &  inPhysicsSystem 
)
protectedpure virtual

Implemented in MotorcycleController, TrackedVehicleController, and WheeledVehicleController.

◆ RestoreState()

virtual void VehicleController::RestoreState ( StateRecorder &  inStream)
protectedpure virtual

Implemented in MotorcycleController, TrackedVehicleController, and WheeledVehicleController.

◆ SaveState()

virtual void VehicleController::SaveState ( StateRecorder &  inStream) const
protectedpure virtual

Implemented in MotorcycleController, TrackedVehicleController, and WheeledVehicleController.

◆ SolveLongitudinalAndLateralConstraints()

virtual bool VehicleController::SolveLongitudinalAndLateralConstraints ( float  inDeltaTime)
protectedpure virtual

Implemented in MotorcycleController, TrackedVehicleController, and WheeledVehicleController.

Friends And Related Symbol Documentation

◆ VehicleConstraint

friend class VehicleConstraint
friend

Member Data Documentation

◆ mConstraint

VehicleConstraint& VehicleController::mConstraint
protected

The vehicle constraint we belong to.

The documentation for this class was generated from the following file: