Emergency 2017 Dokumentation  v3.0.1
em5::WeatherComponent Class Reference

EMERGENCY 5 weather core component class. More...

#include <WeatherComponent.h>

Public Types

enum  EventWeather {
  WEATHER_UNDEFINED = 0, WEATHER_HOT, WEATHER_COLD, WEATHER_CLOUDY,
  WEATHER_FOGGY, WEATHER_RAINY, WEATHER_HEAVY_RAIN, WEATHER_STORM,
  WEATHER_HEAVY_STORM, WEATHER_THUNDER, WEATHER_HAIL, WEATHER_NORMAL
}
 
typedef qsf::EnumBitmask< uint32, EventWeatherWeatherBitmask
 
- Public Types inherited from qsf::Component
enum  TransformChangeFlag {
  TRANSFORM_CHANGE_POSITION = 0x01, TRANSFORM_CHANGE_ROTATION = 0x02, TRANSFORM_CHANGE_SCALE = 0x04, TRANSFORM_CHANGE_TRANSFORM = 0x07,
  TRANSFORM_CHANGE_FOR_SIMULATION = 0x08, TRANSFORM_CHANGE_FOR_ANIMATION = 0x10
}
 
typedef BitFlagSet< uint8, TransformChangeFlagTransformChangeFlags
 
- 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 }
 

Public Member Functions

 WeatherComponent (qsf::Prototype *prototype)
 Constructor. More...
 
virtual ~WeatherComponent ()
 Destructor. More...
 
bool getUseUmbrellas () const
 Check whether people should use umbrellas because of rain right now. More...
 
WeatherBitmask getEventWeather () const
 Calculate weather used in events. More...
 
virtual void serialize (qsf::BinarySerializer &serializer) override
 Serialize or deserialize the component using a binary serializer. More...
 
- Public Member Functions inherited from qsf::game::WeatherComponent
 WeatherComponent (Prototype *prototype)
 Constructor. More...
 
const WeatherConfigurationgetCurrentWeatherConfiguration ()
 Return current weather configuration. More...
 
const WeatherStategetCurrentWeatherState () const
 Return current weather state. More...
 
void setWeatherState (const WeatherState &weather)
 Set a new weather state. More...
 
void fadeToWeatherState (const WeatherState &weather, const Time &changeDuration)
 Will fade to the next weather. More...
 
bool getAutomaticTransition () const
 Return the status of the automatic transition. More...
 
void setAutomaticTransition (bool transition)
 Set the status of the automatic transition. More...
 
const std::string & getWeatherConfigurationName () const
 Return the current weather configuration name. More...
 
void setWeatherConfigurationByName (const std::string &name)
 Set the current weather configuration. More...
 
const std::string & getLastSetWeatherStateName () const
 Return the name of last set weather state. More...
 
void setWeatherStateByNameForCutscenes (const std::string &name)
 Set weather state for cutscene. More...
 
void backupMapState ()
 
void restoreMapState ()
 
void updateAfterMapChanges ()
 
void setCameraComponent (CameraComponent *cameraComponent)
 
void jumpToNextState ()
 
Time getRestFadeTime ()
 
- Public Member Functions inherited from qsf::Component
virtual ~Component ()
 Destructor. More...
 
PrototypegetPrototype () const
 Return the prototype this component is in. More...
 
EntitygetEntity () const
 Return a reference to the entity this component is in. More...
 
uint32 getId () const
 Return the unique component identifier. More...
 
ComponentManagergetComponentManager () const
 Return the component manager that's responsible for this component instance. More...
 
ComponentCollectiongetComponentCollection () const
 Return the component collection that's responsible for this component instance. More...
 
bool isSimulating () const
 Return whether or not the component is in simulating mode. More...
 
bool isActive () const
 Return whether or not the component is considered to be active. More...
 
void setActive (bool active)
 Set whether or not the component is considered to be active. More...
 
bool isDebug () const
 Return whether or not the component is considered to be in debug mode. More...
 
bool isHidden () const
 Return whether or not the component is hidden. More...
 
void setHidden (bool hidden)
 Set whether or not the component is hidden. More...
 
bool isGloballyHidden () const
 Return whether or not the component is globally hidden. More...
 
void setGloballyHidden (bool globallyHidden)
 Set whether or not the component is globally hidden. More...
 
bool isReallyHidden () const
 Return whether or not the component is really hidden. More...
 
bool startup ()
 Startup the component. More...
 
bool isRunning () const
 Return whether or not the component is up-and-running. More...
 
void shutdown ()
 Shutdown the component. More...
 
uint64 getPrototypeId () const
 Return the ID of the prototype this component is in. More...
 
uint64 getEntityId () const
 Return the ID of the entity this component is in. More...
 
virtual void onInvalidation ()
 Invalidate the component. More...
 
virtual void setDebug (bool debugMode)
 Set whether or not the component is considered to be in debug mode. More...
 
- Public Member Functions inherited from qsf::InheritedObject
void copyPropertyOverrideStateFrom (const InheritedObject &object, bool add=false)
 
void setAllPropertyOverrideFlags (bool value)
 
void autoCreatePropertyOverrideState ()
 
virtual camp::Value getPropertyDefaultValue (const StringHash &propertyId) const override
 
virtual PropertyOverrideState getPropertyOverrideState (const StringHash &propertyId) const override
 
virtual bool setPropertyOverrideState (const StringHash &propertyId, PropertyOverrideState overrideState) override
 
- 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 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 COMPONENT_ID
 "em5::WeatherComponent" unique component ID More...
 
- Static Public Attributes inherited from qsf::game::WeatherComponent
static const uint32 COMPONENT_ID
 "qsf::game::WeatherComponent" unique component ID More...
 
static const uint32 ACTIVE
 "Active" unique class property ID inside the class More...
 
- Static Public Attributes inherited from qsf::Component
static const uint32 COMPONENT_ID
 "qsf::Component" unique component ID More...
 

Protected Member Functions

virtual void onWeatherChange () override
 
virtual void updateSimulation (const qsf::JobArguments &jobArguments) override
 
- Protected Member Functions inherited from qsf::game::WeatherComponent
virtual void onSetSimulating (bool simulating) override
 Set whether or not the component is in simulating mode. More...
 
virtual void onSetActive (bool active) override
 Set whether or not the component is considered to be active. More...
 
virtual bool onStartup () override
 Startup the component. More...
 
virtual void onShutdown () override
 Shutdown the component. More...
 
virtual void updateAnimation (const JobArguments &jobArguments)
 
- Protected Member Functions inherited from qsf::Component
 Component (Prototype *prototype)
 Constructor. More...
 
void promotePropertyChange (uint32 propertyId)
 A component property value was changed. More...
 
template<typename T , typename S >
bool assignAndPromoteChange (T &variable, const S &newValue, uint32 propertyId)
 Comfort function for updating an exported member variable and promoting any change that happened. More...
 
void setRegisterForSimulationTransformChanges (bool enable)
 Register or unregister this component as simulation transform listener. More...
 
void setRegisterForAnimationTransformChanges (bool enable)
 Register or unregister this component as animation transform listener. More...
 
virtual const ObjectgetPropertyDefaultsProvider () const override
 
virtual bool implementsOnComponentPropertyChange () const
 Signal whether this component needs the "onComponentPropertyChange" callback at all. More...
 
virtual void onComponentPropertyChange (const Component &component, uint32 propertyId)
 Called in case a component property value was changed. More...
 
virtual void onComponentTransformChange (const Transform &transform, TransformChangeFlags flags)
 Called in case a component transformation value was changed. More...
 
virtual void onSetDebug (bool debug)
 Set whether or not the component is considered to be in debug mode. More...
 
virtual void onSetHidden (bool hidden)
 Set whether or not the component is considered to be hidden. More...
 
- Protected Member Functions inherited from qsf::InheritedObject
 InheritedObject ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::WeakPtrTarget
 WeakPtrTarget ()
 Default constructor. More...
 
 WeakPtrTarget (const WeakPtrTarget &other)
 Copy constructor. More...
 
 WeakPtrTarget (WeakPtrTarget &&)=delete
 Delete the move constructor, as WeakPtrTarget would need a proper move constructor-implementation that ensures that its pointer gets updated in the WeakPtrBase as well. More...
 
 ~WeakPtrTarget ()
 Destructor. More...
 
void invalidateAllWeakPtr ()
 Invalidate all weak pointers to this object. More...
 
void operator= (const WeakPtrTarget &other)
 Copy operator. More...
 

Additional Inherited Members

- Protected Attributes inherited from qsf::InheritedObject
std::bitset< 128 > mPropertyOverrideFlags
 One bit for each property; if set, the property is overridden. More...
 

Detailed Description

EMERGENCY 5 weather core component class.

Note
  • Core component, see "qsf::Map::getCoreEntity()" documentation for details
  • High level controller
Todo:
  • TODO(co) Connect properties to the CAMP reflection system

Definition at line 41 of file WeatherComponent.h.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator
WEATHER_UNDEFINED 
WEATHER_HOT 

TODO(fw): Everyone likes enum value descriptions ;)

WEATHER_COLD 
WEATHER_CLOUDY 
WEATHER_FOGGY 
WEATHER_RAINY 
WEATHER_HEAVY_RAIN 
WEATHER_STORM 
WEATHER_HEAVY_STORM 
WEATHER_THUNDER 
WEATHER_HAIL 
WEATHER_NORMAL 

Definition at line 52 of file WeatherComponent.h.

Constructor & Destructor Documentation

em5::WeatherComponent::WeatherComponent ( qsf::Prototype prototype)
inlineexplicit

Constructor.

Parameters
[in]prototypeThe prototype this component is in, no null pointer allowed

Definition at line 14 of file WeatherComponent-inl.h.

em5::WeatherComponent::~WeatherComponent ( )
inlinevirtual

Destructor.

Reimplemented from qsf::game::WeatherComponent.

Definition at line 24 of file WeatherComponent-inl.h.

Member Function Documentation

WeatherBitmask em5::WeatherComponent::getEventWeather ( ) const

Calculate weather used in events.

Returns
Calculated event weather
Todo:
TODO(jm) Set the values of the event weather
bool em5::WeatherComponent::getUseUmbrellas ( ) const
inline

Check whether people should use umbrellas because of rain right now.

Definition at line 29 of file WeatherComponent-inl.h.

virtual void em5::WeatherComponent::onWeatherChange ( )
overrideprotectedvirtual

Reimplemented from qsf::game::WeatherComponent.

virtual void em5::WeatherComponent::serialize ( qsf::BinarySerializer serializer)
overridevirtual

Serialize or deserialize the component using a binary serializer.

Parameters
[in]serializerThe serializer, which can be either in read or write mode

Reimplemented from qsf::game::WeatherComponent.

virtual void em5::WeatherComponent::updateSimulation ( const qsf::JobArguments jobArguments)
overrideprotectedvirtual

Reimplemented from qsf::game::WeatherComponent.

Member Data Documentation

const uint32 em5::WeatherComponent::COMPONENT_ID
static

"em5::WeatherComponent" unique component ID

Definition at line 49 of file WeatherComponent.h.


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