Emergency 20 Dokumentation  4.2.0
em5::AudioSpecsGroup Class Reference

Audio specs group implementation. More...

#include <AudioSpecsGroup.h>

Inheritance diagram for em5::AudioSpecsGroup:
em5::SpecsGroup qsf::UniqueInstance< AudioSpecsGroup > qsf::ParameterGroup qsf::Pluginable< ParameterGroupManager > qsf::PluginableBase qsf::Object

Public Member Functions

 AudioSpecsGroup (SpecsGroupManager *specsGroupManager)
 Constructor. More...
 
virtual ~AudioSpecsGroup ()
 Destructor. More...
 
float getMaxMusicVolume () const
 
void setMaxMusicVolume (float time)
 
- Public Member Functions inherited from em5::SpecsGroup
virtual ~SpecsGroup ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::ParameterGroup
virtual ~ParameterGroup ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::Pluginable< ParameterGroupManager >
virtual ~Pluginable ()
 Destructor. More...
 
ParameterGroupManagergetManager () 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 PLUGINABLE_ID
 "em5::AudioSpecsGroup" unique pluginable specs group ID More...
 
static const uint32 MAX_MUSIC_VOLUME
 "MaxMusicVolume" unique class property ID inside the class 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 }
 
- Static Public Member Functions inherited from qsf::UniqueInstance< AudioSpecsGroup >
static AudioSpecsGroup * getInstance ()
 Return the global unique instance. More...
 
static AudioSpecsGroup & getInstanceSafe ()
 Return the global unique instance. More...
 
- Protected Member Functions inherited from em5::SpecsGroup
 SpecsGroup (SpecsGroupManager *specsGroupManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::ParameterGroup
 ParameterGroup (ParameterGroupManager *parameterGroupManager)
 Constructor. More...
 
void promotePropertyChange (uint32 propertyId)
 A component property value was changed. More...
 
template<typename T >
bool assignAndPromoteChange (T &variable, const T &newValue, uint32 propertyId)
 Comfort function for updating an exported member variable and promoting any change that happened. More...
 
- Protected Member Functions inherited from qsf::Pluginable< ParameterGroupManager >
 Pluginable (ParameterGroupManager *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...
 
- Protected Member Functions inherited from qsf::UniqueInstance< AudioSpecsGroup >
 UniqueInstance ()
 Default constructor. More...
 
virtual ~UniqueInstance ()
 Destructor. More...
 

Detailed Description

Audio specs group implementation.

Constructor & Destructor Documentation

em5::AudioSpecsGroup::AudioSpecsGroup ( SpecsGroupManager specsGroupManager)
inlineexplicit

Constructor.

Parameters
[in]specsGroupManagerOptional pointer to the specs group manager this specs group should be registered to, can be a null pointer
em5::AudioSpecsGroup::~AudioSpecsGroup ( )
inlinevirtual

Destructor.

Member Function Documentation

float em5::AudioSpecsGroup::getMaxMusicVolume ( ) const
inline
void em5::AudioSpecsGroup::setMaxMusicVolume ( float  time)

Member Data Documentation

const uint32 em5::AudioSpecsGroup::MAX_MUSIC_VOLUME
static

"MaxMusicVolume" unique class property ID inside the class

const uint32 em5::AudioSpecsGroup::PLUGINABLE_ID
static

"em5::AudioSpecsGroup" unique pluginable specs group ID


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