Emergency 20 Dokumentation  4.1.0
Public Member Functions | List of all members
qsf::StreetEdge Class Reference

Street edge class. More...

#include <StreetEdge.h>

Inheritance diagram for qsf::StreetEdge:
Inheritance graph
[legend]
Collaboration diagram for qsf::StreetEdge:
Collaboration graph
[legend]

Public Member Functions

 StreetEdge ()
 
 StreetEdge (uint32 beginNode, uint32 endNode, uint32 laneType=0, uint32 tag=0)
 
 StreetEdge (const StreetEdge &source)
 Copy constructor. More...
 
bool isValid () const
 Return "true" if begin and end node is initialize. More...
 
uint32 getBeginNode () const
 Return the index of the begin node. "qsf::getUninitialized<uint32>()" if invalid. More...
 
void setBeginNode (uint32 beginNode)
 
uint32 getEndNode () const
 Return the index of the end node. "qsf::getUninitialized<uint32>()" if invalid. More...
 
void setEndNode (uint32 endNode)
 
uint32 getLaneType () const
 Return the lane type. "qsf::getUninitialized<uint32>()" if invalid. More...
 
void setLaneType (uint32 laneType)
 
void serialize (BinarySerializer &serializer)
 
StreetEdgeoperator= (const StreetEdge &source)
 
bool operator== (const StreetEdge &source) const
 
uint32 getTag () const
 Access to the tag property which is used by the AI to build a relation to a traffic light with the same tag inside one crossing. This relation means that the traffic light manages the passability of this lane. The default is zero which means that it is not associated to a traffic light at all. More...
 
void setTag (uint32 tag)
 
- 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...
 

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::Object
 Object ()
 Default constructor. More...
 

Detailed Description

Street edge class.

Remarks
Represents the smallest line segment in streets. Saves begin/end node. Begin/end indices represent the node index in used street component. Further properties are a type of street which is used by the AI to decide which entities might move here and a tag which may be used to signal that this lane is regulated by a traffic light with the matching tag inside the same crossing.

Constructor & Destructor Documentation

qsf::StreetEdge::StreetEdge ( )
inline
qsf::StreetEdge::StreetEdge ( uint32  beginNode,
uint32  endNode,
uint32  laneType = 0,
uint32  tag = 0 
)
inline
qsf::StreetEdge::StreetEdge ( const StreetEdge source)
inline

Copy constructor.

Member Function Documentation

uint32 qsf::StreetEdge::getBeginNode ( ) const
inline

Return the index of the begin node. "qsf::getUninitialized<uint32>()" if invalid.

uint32 qsf::StreetEdge::getEndNode ( ) const
inline

Return the index of the end node. "qsf::getUninitialized<uint32>()" if invalid.

uint32 qsf::StreetEdge::getLaneType ( ) const
inline

Return the lane type. "qsf::getUninitialized<uint32>()" if invalid.

uint32 qsf::StreetEdge::getTag ( ) const
inline

Access to the tag property which is used by the AI to build a relation to a traffic light with the same tag inside one crossing. This relation means that the traffic light manages the passability of this lane. The default is zero which means that it is not associated to a traffic light at all.

bool qsf::StreetEdge::isValid ( ) const
inline

Return "true" if begin and end node is initialize.

Todo:
(mk) Add identity check
StreetEdge & qsf::StreetEdge::operator= ( const StreetEdge source)
inline
bool qsf::StreetEdge::operator== ( const StreetEdge source) const
inline
void qsf::StreetEdge::serialize ( BinarySerializer serializer)
void qsf::StreetEdge::setBeginNode ( uint32  beginNode)
inline
void qsf::StreetEdge::setEndNode ( uint32  endNode)
inline
void qsf::StreetEdge::setLaneType ( uint32  laneType)
inline
void qsf::StreetEdge::setTag ( uint32  tag)
inline

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