TalanSoft Toolkits  201707
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
iDynamicsVehicle Struct Referenceabstract
Inheritance diagram for iDynamicsVehicle:
iUnknown

Detailed Description

Dynamics vehicle interface.

Public Member Functions

virtual iDynamicsBodyGetBody () const =0
 Get the vehicle's body. {Property}. More...
 
virtual void SetCollideQuery (iCollideQuery *apQuery)=0
 Set the vehicle collide query. {Property}. More...
 
virtual iCollideQueryGetCollideQuery () const =0
 Get the vehicle collide query. {Property}. More...
 
virtual tBool Control (tF32 afSteering, tBool abAnalogSteering, tF32 afAcc, tBool abAnalogAcc, tBool abHandbrake)=0
 Control. More...
 
virtual tI32 GetGear () const =0
 Get the current gear. {Property}. More...
 
virtual tU32 GetNumGears () const =0
 Get the number of gears. {Property}. More...
 
virtual tBool GearUp ()=0
 Gear up. More...
 
virtual tBool GearDown ()=0
 Gear down. More...
 
virtual tF32 GetDriveVelocity () const =0
 Get the current driving velocity. {Property}. More...
 
virtual tF32 GetMaxVelocity () const =0
 Get the maximum velocity. {Property}. More...
 
virtual void SetMaxVelocity ()=0
 Set the maximum velocity. {Property}. More...
 
virtual tF32 GetMaxEngineForce () const =0
 Get the maximum engine force. {Property}. More...
 
virtual void SetMaxEngineForce (tF32 afMaxEngineForce)=0
 Set the maximum engine force. {Property}. More...
 
virtual tF32 GetMaxBrakingForce () const =0
 Get the maximum breaking force. {Property}. More...
 
virtual void SetMaxBrakingForce (tF32 afMaxBrakingForce)=0
 Set the maximum breaking force. {Property}. More...
 
virtual tF32 GetSteeringValue () const =0
 Get the steering value. {Property}. More...
 
virtual void SetSteeringValue (tF32 afValue)=0
 Set the steering value. {Property}. More...
 
virtual tF32 GetSteeringClamp () const =0
 Get the steering maximum value. {Property}. More...
 
virtual void SetSteeringClamp (tF32 afValue)=0
 Set the steering maximum value. {Property}. More...
 
virtual tU32 GetNumWheels () const =0
 Get the number wheels. {Property}. More...
 
virtual tBool GetIsFrontWheel (tU32 anIndex) const =0
 Get whether the wheel in a front wheel. {Property}. More...
 
virtual tF32 GetWheelRPM (tU32 anIndex) const =0
 Get the wheel's rpm. {Property}. More...
 
virtual tF32 GetWheelRadius (tU32 anIndex) const =0
 Get the wheel's radius. {Property}. More...
 
virtual void SetWheelRadius (tU32 anIndex, tF32 afRadius)=0
 Set the wheel's radius. {Property}. More...
 
virtual sVec3f GetWheelPosition (tU32 anIndex) const =0
 Get the wheel's position. {Property}. More...
 
virtual tF32 GetWheelFriction (tU32 anIndex) const =0
 Get the wheel's friction. {Property}. More...
 
virtual void SetWheelFriction (tU32 anIndex, tF32 afFriction)=0
 Set the wheel's friction. {Property}. More...
 
virtual tF32 GetSuspensionStiffness (tU32 anIndex) const =0
 Get the suspension's stiffness. {Property}. More...
 
virtual void SetSuspensionStiffness (tU32 anIndex, tF32 afStiffness)=0
 Set the suspension's stiffness. {Property}. More...
 
virtual tF32 GetSuspensionTravelCm (tU32 anIndex) const =0
 Get the suspension's travel in centimeters. {Property}. More...
 
virtual void SetSuspensionTravelCm (tU32 anIndex, tF32 afTravelCm)=0
 Set the suspension's travel in centimeters. {Property}. More...
 
virtual tF32 GetSuspensionDampingCompression (tU32 anIndex) const =0
 Get the suspension's damping compression. {Property}. More...
 
virtual void SetSuspensionDampingCompression (tU32 anIndex, tF32 afDampingCompression)=0
 Set the suspension's damping compression. {Property}. More...
 
virtual tF32 GetSuspensionDampingRelaxation (tU32 anIndex) const =0
 Get the suspension's damping relaxation. {Property}. More...
 
virtual void SetSuspensionDampingRelaxation (tU32 anIndex, tF32 afDampingRelaxation)=0
 Set the suspension's damping relaxation. {Property}. More...
 
virtual tF32 GetSuspensionRestLength (tU32 anIndex) const =0
 Get the suspension's rest length. {Property}. More...
 
virtual void SetSuspensionRestLength (tU32 anIndex, tF32 afRestLength)=0
 Set the suspension's rest length. {Property}. More...
 
virtual tF32 GetWheelRollInfluence (tU32 anIndex) const =0
 Get the wheel's roll influence. {Property}. More...
 
virtual void SetWheelRollInfluence (tU32 anIndex, tF32 afFriction)=0
 Set the wheel's roll influence. {Property}. More...
 
virtual sVec3f GetWheelContact (tU32 anIndex) const =0
 Get the wheel's contact position. {Property}. More...
 
virtual tF32 GetWheelTurnAngle (tU32 anIndex) const =0
 Get the wheel's turn angle. {Property}. More...
 
virtual ni::tBool WriteDataTable (ni::iDataTable *apDT)=0
 Write the vehicle's description to the specified datatable. More...
 
- Public Member Functions inherited from iUnknown
virtual tBool IsOK () const =0
 Check if the object is valid. More...
 
virtual tI32 AddRef ()=0
 Signal that one more reference of the object has been created. More...
 
virtual tI32 Release ()=0
 Release a reference of the object. More...
 
virtual void DeleteThis ()=0
 Bypass any reference counting and delete this object. More...
 
virtual void Invalidate ()=0
 Invalidate the object. More...
 
virtual iUnknownQueryInterface (const tUUID &aIID)=0
 Query an interface. More...
 
virtual void ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
 Fill a UUID list containing the UUIDs of the implemented interfaces. More...
 
virtual tI32 SetNumRefs (tI32 anNumRefs)=0
 Set the reference counter directly. More...
 
virtual tI32 GetNumRefs () const =0
 Get the number of references to this object. More...
 

Member Function Documentation

virtual iDynamicsBody* GetBody ( ) const
pure virtual

Get the vehicle's body. {Property}.

virtual void SetCollideQuery ( iCollideQuery apQuery)
pure virtual

Set the vehicle collide query. {Property}.

virtual iCollideQuery* GetCollideQuery ( ) const
pure virtual

Get the vehicle collide query. {Property}.

virtual tBool Control ( tF32  afSteering,
tBool  abAnalogSteering,
tF32  afAcc,
tBool  abAnalogAcc,
tBool  abHandbrake 
)
pure virtual

Control.

virtual tI32 GetGear ( ) const
pure virtual

Get the current gear. {Property}.

virtual tU32 GetNumGears ( ) const
pure virtual

Get the number of gears. {Property}.

virtual tBool GearUp ( )
pure virtual

Gear up.

virtual tBool GearDown ( )
pure virtual

Gear down.

virtual tF32 GetDriveVelocity ( ) const
pure virtual

Get the current driving velocity. {Property}.

virtual tF32 GetMaxVelocity ( ) const
pure virtual

Get the maximum velocity. {Property}.

virtual void SetMaxVelocity ( )
pure virtual

Set the maximum velocity. {Property}.

virtual tF32 GetMaxEngineForce ( ) const
pure virtual

Get the maximum engine force. {Property}.

virtual void SetMaxEngineForce ( tF32  afMaxEngineForce)
pure virtual

Set the maximum engine force. {Property}.

virtual tF32 GetMaxBrakingForce ( ) const
pure virtual

Get the maximum breaking force. {Property}.

virtual void SetMaxBrakingForce ( tF32  afMaxBrakingForce)
pure virtual

Set the maximum breaking force. {Property}.

virtual tF32 GetSteeringValue ( ) const
pure virtual

Get the steering value. {Property}.

virtual void SetSteeringValue ( tF32  afValue)
pure virtual

Set the steering value. {Property}.

virtual tF32 GetSteeringClamp ( ) const
pure virtual

Get the steering maximum value. {Property}.

virtual void SetSteeringClamp ( tF32  afValue)
pure virtual

Set the steering maximum value. {Property}.

virtual tU32 GetNumWheels ( ) const
pure virtual

Get the number wheels. {Property}.

virtual tBool GetIsFrontWheel ( tU32  anIndex) const
pure virtual

Get whether the wheel in a front wheel. {Property}.

virtual tF32 GetWheelRPM ( tU32  anIndex) const
pure virtual

Get the wheel's rpm. {Property}.

virtual tF32 GetWheelRadius ( tU32  anIndex) const
pure virtual

Get the wheel's radius. {Property}.

virtual void SetWheelRadius ( tU32  anIndex,
tF32  afRadius 
)
pure virtual

Set the wheel's radius. {Property}.

virtual sVec3f GetWheelPosition ( tU32  anIndex) const
pure virtual

Get the wheel's position. {Property}.

virtual tF32 GetWheelFriction ( tU32  anIndex) const
pure virtual

Get the wheel's friction. {Property}.

virtual void SetWheelFriction ( tU32  anIndex,
tF32  afFriction 
)
pure virtual

Set the wheel's friction. {Property}.

virtual tF32 GetSuspensionStiffness ( tU32  anIndex) const
pure virtual

Get the suspension's stiffness. {Property}.

virtual void SetSuspensionStiffness ( tU32  anIndex,
tF32  afStiffness 
)
pure virtual

Set the suspension's stiffness. {Property}.

virtual tF32 GetSuspensionTravelCm ( tU32  anIndex) const
pure virtual

Get the suspension's travel in centimeters. {Property}.

virtual void SetSuspensionTravelCm ( tU32  anIndex,
tF32  afTravelCm 
)
pure virtual

Set the suspension's travel in centimeters. {Property}.

virtual tF32 GetSuspensionDampingCompression ( tU32  anIndex) const
pure virtual

Get the suspension's damping compression. {Property}.

virtual void SetSuspensionDampingCompression ( tU32  anIndex,
tF32  afDampingCompression 
)
pure virtual

Set the suspension's damping compression. {Property}.

virtual tF32 GetSuspensionDampingRelaxation ( tU32  anIndex) const
pure virtual

Get the suspension's damping relaxation. {Property}.

virtual void SetSuspensionDampingRelaxation ( tU32  anIndex,
tF32  afDampingRelaxation 
)
pure virtual

Set the suspension's damping relaxation. {Property}.

virtual tF32 GetSuspensionRestLength ( tU32  anIndex) const
pure virtual

Get the suspension's rest length. {Property}.

virtual void SetSuspensionRestLength ( tU32  anIndex,
tF32  afRestLength 
)
pure virtual

Set the suspension's rest length. {Property}.

virtual tF32 GetWheelRollInfluence ( tU32  anIndex) const
pure virtual

Get the wheel's roll influence. {Property}.

virtual void SetWheelRollInfluence ( tU32  anIndex,
tF32  afFriction 
)
pure virtual

Set the wheel's roll influence. {Property}.

virtual sVec3f GetWheelContact ( tU32  anIndex) const
pure virtual

Get the wheel's contact position. {Property}.

virtual tF32 GetWheelTurnAngle ( tU32  anIndex) const
pure virtual

Get the wheel's turn angle. {Property}.

virtual ni::tBool WriteDataTable ( ni::iDataTable apDT)
pure virtual

Write the vehicle's description to the specified datatable.