CrystalSpace

Public API Reference

CS::Physics::iVehicleBrake Struct Reference

A brake acts on a given set of wheels with a given amount of force. More...

#include <ivaria/vehicle.h>

Inheritance diagram for CS::Physics::iVehicleBrake:

List of all members.

Public Member Functions

virtual void AddAffectedWheel (size_t index)=0
 Add a new wheel to be affected by this brake.
virtual size_t GetAffectedWheel (size_t index) const =0
 Get the wheel affected by this brake of the given index.
virtual size_t GetAffectedWheelCount () const =0
 Get the amount of wheels affected by this brake.
virtual float GetMaximumForce () const =0
 Get the maximum breaking force that can be applied by this brake.
virtual void SetMaximumForce (float f)=0
 Set the maximum breaking force that can be applied by this brake.

Detailed Description

A brake acts on a given set of wheels with a given amount of force.

Definition at line 223 of file vehicle.h.


Member Function Documentation

virtual void CS::Physics::iVehicleBrake::AddAffectedWheel ( size_t  index  )  [pure virtual]

Add a new wheel to be affected by this brake.

index is the index of the wheel in the iVehicleFactory.

virtual size_t CS::Physics::iVehicleBrake::GetAffectedWheel ( size_t  index  )  const [pure virtual]

Get the wheel affected by this brake of the given index.

The value returned is the index of the wheel in the iVehicleFactory.

virtual size_t CS::Physics::iVehicleBrake::GetAffectedWheelCount (  )  const [pure virtual]

Get the amount of wheels affected by this brake.

virtual float CS::Physics::iVehicleBrake::GetMaximumForce (  )  const [pure virtual]

Get the maximum breaking force that can be applied by this brake.

This total amount of force will be divided up among all affected wheels.

virtual void CS::Physics::iVehicleBrake::SetMaximumForce ( float  f  )  [pure virtual]

Set the maximum breaking force that can be applied by this brake.

This total amount of force will be divided up among all affected wheels. The default value is 1000.0f.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1