Defines a position on a vehicle

struct IVehicleHelper {
};

IVehicleSystem.h

The vehicle helper object is used to define a position on a vehicle. Several components of the vehicle system use this object type to define position on the vehicle (ie: seat position, firing position on vehicle weapons). The Matrices are updated to reflect any changes in the position or orientation parent part.

virtual ~IVehicleHelper();

Returns the helper translation in local space Notes The matrix is relative to the parent part

virtual Vec3 GetLocalSpaceTranslation() const = 0;

Returns the helper matrix in local space

virtual const Matrix34& GetLocalTM() const = 0;

The Matrix34 holding the local space matrix Notes The matrix is relative to the parent part

GetParentPart, GetVehicleTM, GetWorldTM

virtual void GetMemoryUsage(ICrySizer * pSizer) const = 0;

tmp(will be pure virtual soon)

Returns the parent part of the helper

virtual IVehiclePart* GetParentPart() const = 0;

A pointer to the parent part, which is never null

Returns the helper matrix in world space after reflecting the local translation across the yz plane (for left/right side of vehicle)

virtual void GetReflectedWorldTM(Matrix34 & reflectedWorldTM) const = 0;

The Matrix34 holding the world space matrix

GetLocalTM, GetVehicleTM, GetWorldTM

Returns the helper translation in vehicle space

virtual Vec3 GetVehicleSpaceTranslation() const = 0;

Returns the helper matrix in vehicle space

virtual void GetVehicleTM(Matrix34 & vehicleTM, bool forced = false) const = 0;

The Matrix34 holding the vehicle space matrix

GetLocalTM, GetWorldTM

Returns the helper translation in world space

virtual Vec3 GetWorldSpaceTranslation() const = 0;

Returns the helper matrix in world space

virtual void GetWorldTM(Matrix34 & worldTM) const = 0;

The Matrix34 holding the world space matrix

GetLocalTM, GetVehicleTM, GetReflectedWorldTM

Releases the VehicleHelper instance Notes Should usually be only used by the implementation of IVehicle

virtual void Release() = 0;