iPcMechanicsThrusterController Struct Reference
Property class that controls the thrusters attached to an object through the use of balanced thruster groups. More...
#include <propclass/mechthruster.h>
Public Member Functions | |
virtual void | AddAxis (const char *name, celAxisType type, const csVector3 axis)=0 |
Add a named axis to the controller. | |
virtual void | AddBalancedGroup (iPcMechanicsBalancedGroup *group, const char *axisname)=0 |
Add a balanced thruster group to the specified axis. | |
virtual void | ApplyThrust (float thrust, const char *axisname, uint32 &id)=0 |
Apply the given percentage of total thrust for a given axis. | |
virtual void | CancelThrust (uint32 id)=0 |
Cancels specified thrust request. | |
virtual const csVector3 | GetAxis (const char *name)=0 |
Get the axis of rotation or translation. | |
virtual float | GetAxisMaxForce (const char *name)=0 |
Get the strength of the best thruster group in the given axis. | |
virtual float | GetAxisMaxThrust (const char *name)=0 |
Get the amount of thrust needed to produce the maximum force in the given axis. | |
virtual const celAxisType | GetAxisType (const char *name)=0 |
Get the type of the given axis. | |
virtual const float | GetAxisVelocity (const char *name)=0 |
Get the current velocity in the given axis. | |
virtual iPcMechanicsObject * | GetMechanicsObject ()=0 |
Get the associated mechanics object. | |
virtual void | RemoveBalancedGroup (const char *grouptag, const char *axisname)=0 |
Remove a thruster group from the specified axis. | |
virtual void | SetMechanicsObject (iPcMechanicsObject *mechobj)=0 |
Set the mechanics object to affect. |
Detailed Description
Property class that controls the thrusters attached to an object through the use of balanced thruster groups.This property class supports the following actions (add prefix 'cel.action.' to get the ID of the action and add prefix 'cel.parameter.' to get the ID of the parameter):
- InitThrusterController: parameters 'objectpctag' (string).
- AddAxis: parameters 'axisname' (string), 'axistype' (string, "rotation" or "translation"), 'axisdir' (vector3).
- ApplyThrust: parameters 'axisname' (string), 'thrust' (float).
- AddBalancedGroup: parameters 'axisname' (string), 'balancedgroup' (string).
Definition at line 211 of file mechthruster.h.
Member Function Documentation
|
Add a named axis to the controller.
|
|
Add a balanced thruster group to the specified axis.
|
|
Apply the given percentage of total thrust for a given axis.
|
|
Cancels specified thrust request.
|
|
Get the axis of rotation or translation.
|
|
Get the strength of the best thruster group in the given axis.
|
|
Get the amount of thrust needed to produce the maximum force in the given axis.
|
|
Get the type of the given axis.
|
|
Get the current velocity in the given axis.
|
|
Get the associated mechanics object.
|
|
Remove a thruster group from the specified axis.
|
|
Set the mechanics object to affect. This is required.
|
The documentation for this struct was generated from the following file:
- propclass/mechthruster.h
Generated for CEL: Crystal Entity Layer by doxygen 1.4.6