Emergency 20 Dokumentation  4.2.0
em5::EnterVehicleTargetPointProvider Class Reference

Target point provider for entering a vehicle, the used door is defined in the vehicle editing. More...

#include <EnterVehicleTargetPointProvider.h>

Inheritance diagram for em5::EnterVehicleTargetPointProvider:
qsf::logic::TargetPointProvider qsf::Pluginable< TargetPointManager > qsf::PluginableBase qsf::Object

Public Member Functions

 EnterVehicleTargetPointProvider (qsf::logic::TargetPointManager *manager)
 Constructor. More...
 
virtual void calculateTargetPoints (qsf::Entity &caller, const qsf::Transform &callerTransform, qsf::Entity &target, const qsf::Transform &targetTransform, std::vector< qsf::logic::TargetPoint > &targetPoints) const override
 Deliver target points based on the two entities' current state but assuming a specific caller and target transform. This is used for future projections but also by the simple call providing the current state as parameters here. More...
 
- Public Member Functions inherited from qsf::logic::TargetPointProvider
 TargetPointProvider (TargetPointManager *manager)
 Constructor. More...
 
virtual ~TargetPointProvider ()
 Destructor. More...
 
void calculateTargetPoints (Entity &caller, Entity &target, std::vector< TargetPoint > &targetPoints) const
 Deliver target points based on the two entities' current state. More...
 
- Public Member Functions inherited from qsf::Pluginable< TargetPointManager >
virtual ~Pluginable ()
 Destructor. More...
 
TargetPointManager & getManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::PluginableBase
virtual ~PluginableBase ()
 Destructor. More...
 
template<typename T >
T & getPluginableManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::Object
virtual ~Object ()
 Destructor. More...
 
const camp::Class & getCampClass () const
 Return the CAMP class. More...
 
int getPropertyIndexById (const StringHash &propertyId) const
 Return the CAMP property index by using the unique class property ID. More...
 
uint32 getPropertyIdByIndex (int index) const
 Return the unique class property ID with the given index. More...
 
std::string getPropertyNameById (const StringHash &propertyId) const
 Return the CAMP property name by using the unique class property ID. More...
 
const camp::Property * getCampPropertyById (const StringHash &propertyId) const
 Return the CAMP property by using the unique class property ID. More...
 
void setPropertyValuesByString (const std::string &values)
 Set CAMP reflection property values by using a given string. More...
 
void setPropertiesToDefaultValues ()
 Set all CAMP reflection system properties to their default values. More...
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
void serializeToBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void deserializeFromBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL, bool setOverrideState=true)
 
virtual camp::Value getPropertyDefaultValue (const StringHash &propertyId) const
 
virtual PropertyOverrideState getPropertyOverrideState (const StringHash &propertyId) const
 
virtual bool setPropertyOverrideState (const StringHash &propertyId, PropertyOverrideState overrideState)
 
virtual void onPreDeserialize ()
 Called right before the object is deserialized using any of the above methods. Default implementation is empty. More...
 
virtual void onPostDeserialize ()
 Called right after the object was deserialized using any of the above methods. Default implementation is empty. More...
 
virtual ScriptgetAssociatedScript () const
 Return the script instance associated with this object instance. More...
 

Static Public Attributes

static const uint32 TARGET_POINT_ID
 "EnterVehicleTargetPointProvider" unique identifier More...
 

Additional Inherited Members

- Public Types inherited from qsf::Object
enum  PropertyOverrideState { PROPERTY_INVALID, PROPERTY_DEFAULT, PROPERTY_OVERRIDE, PROPERTY_REMOVED }
 
enum  SerializationMethod { SERIALIZE_FLAT, SERIALIZE_COMPLETE, SERIALIZE_DIFFERENTIAL, SERIALIZE_IGNORE_UNKNOWN }
 
enum  SerializationMode { MODE_MINIMAL, MODE_COMPATIBLE }
 
- Protected Member Functions inherited from qsf::Pluginable< TargetPointManager >
 Pluginable (TargetPointManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::PluginableBase
 PluginableBase (PluginableManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 

Detailed Description

Target point provider for entering a vehicle, the used door is defined in the vehicle editing.

Constructor & Destructor Documentation

em5::EnterVehicleTargetPointProvider::EnterVehicleTargetPointProvider ( qsf::logic::TargetPointManager manager)
explicit

Constructor.

Member Function Documentation

virtual void em5::EnterVehicleTargetPointProvider::calculateTargetPoints ( qsf::Entity caller,
const qsf::Transform callerTransform,
qsf::Entity target,
const qsf::Transform targetTransform,
std::vector< qsf::logic::TargetPoint > &  targetPoints 
) const
overridevirtual

Deliver target points based on the two entities' current state but assuming a specific caller and target transform. This is used for future projections but also by the simple call providing the current state as parameters here.

Parameters
[in]callerThe caller entity, i.e. the entity requesting a target point; is possibly ignored when calculating the target point
[in]targetThe target entity, i.e. the one to deliver a target point for
[in]callerTransformThe transform information to assume for the caller instead of the values defined inside its current transform.
[out]targetPointsThe target point options that should be used for an interaction between these two entities.
[in]targetTransformThe transform information to assume for the target entity instead of the values defined inside its current transform.

Implements qsf::logic::TargetPointProvider.

Member Data Documentation

const uint32 em5::EnterVehicleTargetPointProvider::TARGET_POINT_ID
static

"EnterVehicleTargetPointProvider" unique identifier


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