Emergency 20 Dokumentation  4.2.0
em5::ContaminationCloudComponent Class Reference

EMERGENCY 5 contamination cloud component class. More...

#include <ContaminationCloudComponent.h>

Inheritance diagram for em5::ContaminationCloudComponent:
qsf::Component qsf::InheritedObject qsf::WeakPtrTarget qsf::Object

Public Types

enum  State { STATE_INACTIVE, STATE_STARTUP, STATE_ACTIVE, STATE_SHUTDOWN }
 
typedef Injury::ContaminationType ContaminationType
 
- 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

 ContaminationCloudComponent (qsf::Prototype *prototype)
 Constructor. More...
 
virtual ~ContaminationCloudComponent ()
 Destructor. More...
 
void startSimulation ()
 Start the simulation after a timer delay and activate particles effect. More...
 
State getSimulationState () const
 Return current state of the simulation. More...
 
void stopSimulation ()
 Stop the simulation after a timer delay and activate particles effect. More...
 
float getMinContaminationDelay () const
 Get the minimum contamination delay. More...
 
void setMinContaminationDelay (float contaminationDelay)
 Set the minimum contamination delay. More...
 
float getMaxContaminationDelay () const
 Get the maximum contamination delay. More...
 
void setMaxContaminationDelay (float contaminationDelay)
 Set the maximum contamination delay. More...
 
float getContaminationRadius () const
 Get the contamination radius. More...
 
void setContaminationRadius (float contaminationRadius)
 Set the contamination radius. More...
 
bool isInsideContaminationRadius (const glm::vec3 &position) const
 Check if the position is inside the contamination radius. More...
 
bool getHealthComponentsInsideContaminationRadius (std::vector< HealthComponent * > &healthComponents) const
 Check if the position is inside the contamination radius. More...
 
virtual void serialize (qsf::BinarySerializer &serializer) override
 Serialize or deserialize the component using a binary serializer. More...
 
- 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 (bool ownerIsRunning)
 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::ContaminationCloudComponent" unique component ID More...
 
- Static Public Attributes inherited from qsf::Component
static const uint32 COMPONENT_ID
 "qsf::Component" unique component ID More...
 

Protected Member Functions

virtual bool onStartup () override
 Startup the component. More...
 
virtual void onShutdown () override
 Shutdown the component. More...
 
virtual void onSetSimulating (bool simulating) override
 Set whether or not the component is in simulating mode. More...
 
virtual void onSetDebug (bool debug) override
 Set whether or not the component is considered to be in debug mode. More...
 
virtual bool implementsOnComponentPropertyChange () const override
 Signal whether this component needs the "onComponentPropertyChange" callback at all. More...
 
virtual void onComponentPropertyChange (const Component &component, uint32 propertyId) override
 
- 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 ignoreOwnerRunningState () const
 Return whether or not the component will only startup if the owner is in running state. 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 onSetActive (bool active)
 Set whether or not the component is considered to be active. 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 contamination cloud component class.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator
STATE_INACTIVE 
STATE_STARTUP 
STATE_ACTIVE 
STATE_SHUTDOWN 

Constructor & Destructor Documentation

em5::ContaminationCloudComponent::ContaminationCloudComponent ( qsf::Prototype prototype)
explicit

Constructor.

Parameters
[in]prototypeThe prototype this component is in, no null pointer allowed
em5::ContaminationCloudComponent::~ContaminationCloudComponent ( )
inlinevirtual

Destructor.

Member Function Documentation

float em5::ContaminationCloudComponent::getContaminationRadius ( ) const
inline

Get the contamination radius.

bool em5::ContaminationCloudComponent::getHealthComponentsInsideContaminationRadius ( std::vector< HealthComponent * > &  healthComponents) const

Check if the position is inside the contamination radius.

float em5::ContaminationCloudComponent::getMaxContaminationDelay ( ) const
inline

Get the maximum contamination delay.

float em5::ContaminationCloudComponent::getMinContaminationDelay ( ) const
inline

Get the minimum contamination delay.

ContaminationCloudComponent::State em5::ContaminationCloudComponent::getSimulationState ( ) const
inline

Return current state of the simulation.

virtual bool em5::ContaminationCloudComponent::implementsOnComponentPropertyChange ( ) const
inlineoverrideprotectedvirtual

Signal whether this component needs the "onComponentPropertyChange" callback at all.

Returns
If "true", this component can receive property change callbacks, otherwise "onComponentPropertyChange" won't get called

Reimplemented from qsf::Component.

bool em5::ContaminationCloudComponent::isInsideContaminationRadius ( const glm::vec3 &  position) const

Check if the position is inside the contamination radius.

virtual void em5::ContaminationCloudComponent::onComponentPropertyChange ( const Component component,
uint32  propertyId 
)
overrideprotectedvirtual
virtual void em5::ContaminationCloudComponent::onSetDebug ( bool  debug)
overrideprotectedvirtual

Set whether or not the component is considered to be in debug mode.

Parameters
[in]debug"true" if the component is considered to be in debug mode, else "false"
Note
  • The default implementation is empty
  • This method is only called in case there's a real state change
See also
  • "qsf::Component::setDebug()"

Reimplemented from qsf::Component.

virtual void em5::ContaminationCloudComponent::onSetSimulating ( bool  simulating)
overrideprotectedvirtual

Set whether or not the component is in simulating mode.

Parameters
[in]active"true" if the component is in simulating mode, else "false"
Note
  • The default implementation is empty
  • This method is only called in case there's a real state change
  • In contrast to internal flags (e.g. Active, Debug), the simulating mode state can only be changed globally for a whole map
  • On component shutdown and simulating enabled, "onSetSimulating()" is automatically called with "false" before calling "onShutdown()"

Reimplemented from qsf::Component.

virtual void em5::ContaminationCloudComponent::onShutdown ( )
overrideprotectedvirtual

Shutdown the component.

Note
  • Only called in case "onStartup()" returned successfully
  • The default implementation is empty

Reimplemented from qsf::Component.

virtual bool em5::ContaminationCloudComponent::onStartup ( )
overrideprotectedvirtual

Startup the component.

Returns
"true" if all went fine, else "false"
Note
  • The default implementation is empty
  • Only components which are part of entities (concrete prototype instances) get started
  • When this method gets called, the properties might still be on default values but it's also possible that properties already have customized values. Take this into account when implementing your method.

Reimplemented from qsf::Component.

virtual void em5::ContaminationCloudComponent::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::Component.

void em5::ContaminationCloudComponent::setContaminationRadius ( float  contaminationRadius)

Set the contamination radius.

void em5::ContaminationCloudComponent::setMaxContaminationDelay ( float  contaminationDelay)
inline

Set the maximum contamination delay.

void em5::ContaminationCloudComponent::setMinContaminationDelay ( float  contaminationDelay)
inline

Set the minimum contamination delay.

void em5::ContaminationCloudComponent::startSimulation ( )

Start the simulation after a timer delay and activate particles effect.

void em5::ContaminationCloudComponent::stopSimulation ( )

Stop the simulation after a timer delay and activate particles effect.

Member Data Documentation

const uint32 em5::ContaminationCloudComponent::COMPONENT_ID
static

"em5::ContaminationCloudComponent" unique component ID


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