Public API Reference
|
Public API Reference |
|
|
Property class representing a thruster that affect forces on the attached object. More...
#include <propclass/mechthruster.h>
Public Member Functions | |
| virtual float | AvailableThrust ()=0 |
| How much thrust is available on this thruster? | |
| virtual float | GetMaxThrust ()=0 |
| Get the maximum thrust. | |
| virtual iPcMechanicsObject * | GetMechanicsObject ()=0 |
| Get the associated mechanics object. | |
| virtual const csVector3 & | GetOrientation ()=0 |
| Get the orientation of the thruster. | |
| virtual const csVector3 & | GetPosition ()=0 |
| Get the thruster's position relative to the object. | |
| virtual float | GetThrustForce (float thrust)=0 |
| Get the amount of force a given thrust will produce, taking into account the current environment. | |
| virtual void | SetMaxThrust (float maxthrust)=0 |
| Set the maximum thrust. | |
| virtual void | SetMechanicsObject (iPcMechanicsObject *mechsys)=0 |
| Set the mechanics object to affect. | |
| virtual void | SetOrientation (const csVector3 &orientation)=0 |
| Set the orientation of the thruster. | |
| virtual void | SetPosition (const csVector3 &pos)=0 |
| Set the thruster's position relative to the object. | |
| virtual void | ThrustChange (float deltathrust)=0 |
| Applies a delta to the thruster's current thrust. | |
Property class representing a thruster that affect forces on the attached object.
This property class supports the following actions (add prefix 'cel.mechanics.reactionary.action.' if you want to access this action through a message):
Definition at line 40 of file mechthruster.h.
| virtual float iPcMechanicsThruster::AvailableThrust | ( | ) | [pure virtual] |
How much thrust is available on this thruster?
| virtual float iPcMechanicsThruster::GetMaxThrust | ( | ) | [pure virtual] |
Get the maximum thrust.
| virtual iPcMechanicsObject* iPcMechanicsThruster::GetMechanicsObject | ( | ) | [pure virtual] |
Get the associated mechanics object.
| virtual const csVector3& iPcMechanicsThruster::GetOrientation | ( | ) | [pure virtual] |
Get the orientation of the thruster.
| virtual const csVector3& iPcMechanicsThruster::GetPosition | ( | ) | [pure virtual] |
Get the thruster's position relative to the object.
| virtual float iPcMechanicsThruster::GetThrustForce | ( | float | thrust | ) | [pure virtual] |
Get the amount of force a given thrust will produce, taking into account the current environment.
| thrust | the amount of thrust to convert. |
| virtual void iPcMechanicsThruster::SetMaxThrust | ( | float | maxthrust | ) | [pure virtual] |
Set the maximum thrust.
| maxthrust | the maximum amount of thrust this thruster can accomodate. |
| virtual void iPcMechanicsThruster::SetMechanicsObject | ( | iPcMechanicsObject * | mechsys | ) | [pure virtual] |
Set the mechanics object to affect.
This is required.
| mechsys | the object the thruster is attached to. |
| virtual void iPcMechanicsThruster::SetOrientation | ( | const csVector3 & | orientation | ) | [pure virtual] |
Set the orientation of the thruster.
| orientation | the direction in which the thruster points. |
| virtual void iPcMechanicsThruster::SetPosition | ( | const csVector3 & | pos | ) | [pure virtual] |
Set the thruster's position relative to the object.
| pos | the offset from the center of the object to the thruster. |
| virtual void iPcMechanicsThruster::ThrustChange | ( | float | deltathrust | ) | [pure virtual] |
Applies a delta to the thruster's current thrust.
| deltathrust | the change in thrust. |