CrystalSpace

Public API Reference

CS::Physics::iVehicle Struct Reference

A physical, wheeled, grounded vehicle. More...

#include <ivaria/vehicle.h>

Inheritance diagram for CS::Physics::iVehicle:

List of all members.

Public Member Functions

virtual void Brake (size_t index, float scale=1.0f)=0
 Apply the given brake for the next simulation step.
virtual float GetEngineForce () const =0
 The engine force for the next time-step.
virtual float GetSpeedKMH () const =0
 Get the current speed in km/h (actually in kilo units per hour).
virtual iVehicleWheelGetWheel (size_t index) const =0
 Get the wheel at the given index.
virtual void SetEngineForce (float f)=0
 The engine force for the next time-step.
virtual void Steer (size_t index, float force=0.4f)=0
 Use the given steering device to increase the steering angle of the device-controlled wheels.

Detailed Description

A physical, wheeled, grounded vehicle.

Definition at line 318 of file vehicle.h.


Member Function Documentation

virtual void CS::Physics::iVehicle::Brake ( size_t  index,
float  scale = 1.0f 
) [pure virtual]

Apply the given brake for the next simulation step.

Parameters:
index The index of the brake in the iVehicleFactory.
scale A scale to be applied on the braking force. The value is supposed to be between 0 and 1.
virtual float CS::Physics::iVehicle::GetEngineForce (  )  const [pure virtual]

The engine force for the next time-step.

virtual float CS::Physics::iVehicle::GetSpeedKMH (  )  const [pure virtual]

Get the current speed in km/h (actually in kilo units per hour).

virtual iVehicleWheel* CS::Physics::iVehicle::GetWheel ( size_t  index  )  const [pure virtual]

Get the wheel at the given index.

virtual void CS::Physics::iVehicle::SetEngineForce ( float  f  )  [pure virtual]

The engine force for the next time-step.

virtual void CS::Physics::iVehicle::Steer ( size_t  index,
float  force = 0.4f 
) [pure virtual]

Use the given steering device to increase the steering angle of the device-controlled wheels.

Parameters:
index The index of the steering device in the iVehicleFactory.
force The steering increment to be applied on the steering angle. The total amount of steering will be clamped by the maximum angle of the device.

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

Generated for Crystal Space 2.1 by doxygen 1.6.1