Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
VehiclePhysics.GroundMaterialManagerBase Class Referenceabstract

Base class for the components that host and manage the materials for the scene. More...

Inheritance diagram for VehiclePhysics.GroundMaterialManagerBase:
VehiclePhysics.VPGroundMaterialManager

Public Member Functions

abstract GroundMaterial GetGroundMaterial (VehicleBase vehicle, GroundMaterialHit groundHit)
 Must return a GroundMaterial object for the given GroundMaterialHit and vehicle. More...
 
virtual void GetGroundMaterialCached (VehicleBase vehicle, GroundMaterialHit groundHit, ref GroundMaterialHit cachedGroundHit, ref GroundMaterial groundMaterial)
 Update a GroundMaterial reference by invoking GetGroundMaterial only if the cached physic material has changed. Vehicles call this method for retrieving the ground material per wheel on each physics frame. More...
 

Detailed Description

Base class for the components that host and manage the materials for the scene.

Member Function Documentation

abstract GroundMaterial VehiclePhysics.GroundMaterialManagerBase.GetGroundMaterial ( VehicleBase  vehicle,
GroundMaterialHit  groundHit 
)
pure virtual

Must return a GroundMaterial object for the given GroundMaterialHit and vehicle.

Parameters
vehicleVehicleBase object which is querying the material.
groundHitContact information
Returns
A non-null GroundMaterial reference

Implemented in VehiclePhysics.VPGroundMaterialManager.

virtual void VehiclePhysics.GroundMaterialManagerBase.GetGroundMaterialCached ( VehicleBase  vehicle,
GroundMaterialHit  groundHit,
ref GroundMaterialHit  cachedGroundHit,
ref GroundMaterial  groundMaterial 
)
inlinevirtual

Update a GroundMaterial reference by invoking GetGroundMaterial only if the cached physic material has changed. Vehicles call this method for retrieving the ground material per wheel on each physics frame.

Parameters
vehicleVehicleBase object which is querying the material.
groundHitContact information.
cachedGroundHitReference to the cached contact information. Will be updated when necessary.
groundMaterialReference to the ground material. Will be updated only when the physic material changes.

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