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

EMERGENCY 5 audio component class. More...

#include <AudioComponent.h>

Public Types

enum  AudioSet {
  AUDIOSET_NONE, AUDIOSET_COW_RANDOM, AUDIOSET_SKI_LOOPED, AUDIOSET_DIVESPOT_LOOPED,
  AUDIOSET_DEMONSTRATION_MOB_HISTORIC, AUDIOSET_DEMONSTRATION_MOB_MODERN
}
 
- 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 Types inherited from qsf::MovableObjectRenderingListener
enum  State { SLEEPING, AWAKE }
 State of the listener. More...
 

Public Member Functions

 AudioComponent (qsf::Prototype *prototype)
 Constructor. More...
 
virtual ~AudioComponent ()
 Destructor. More...
 
AudioSet getAudioSet () const
 
void setAudioSet (AudioSet audioSet)
 
float getRandomWaitIntervalStart () const
 
void setRandomWaitIntervalStart (float randomWaitIntervalStart)
 
float getRandomWaitIntervalEnd () const
 
void setRandomWaitIntervalEnd (float randomWaitIntervalEnd)
 
float getRandomProbability () const
 
void setRandomProbability (float randomProbability)
 
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 ()
 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...
 
- Public Member Functions inherited from qsf::JobProxyMovableObjectRenderingListener
 JobProxyMovableObjectRenderingListener ()
 Constructor. More...
 
virtual ~JobProxyMovableObjectRenderingListener ()
 Destructor. More...
 
const TimegetNonvisibleUpdateTimeout () const
 Return the nonvisible update timeout. More...
 
void setNonvisibleUpdateTimeout (const Time &nonvisibleUpdateTimeout)
 Set the nonvisible update timeout. More...
 
- Public Member Functions inherited from qsf::MovableObjectRenderingListener
 MovableObjectRenderingListener ()
 Constructor. More...
 
virtual ~MovableObjectRenderingListener ()
 Destructor. More...
 
bool isMovableObjectRenderingListenerRegistered () const
 Return whether or not the movable object rendering listener is registered. More...
 
State getState () const
 Return the state of the listener. More...
 

Static Public Attributes

static const uint32 COMPONENT_ID
 "em5::AudioComponent" 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 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 ComponentgetMovableObjectRenderingListenerComponent () override
 Return the component the listener will spy on. More...
 
virtual void registerMovableObjectRenderingListener () override
 Register movable object rendering listener. More...
 
virtual void unregisterMovableObjectRenderingListener () override
 Unregister movable object rendering listener. More...
 
virtual void onUpdateMovableObjectRenderingJob (const qsf::JobArguments &jobArguments) override
 Main update function that is passed to the job manager. More...
 
- 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 onSetSimulating (bool simulating)
 Set whether or not the component is in simulating mode. 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...
 
- Protected Member Functions inherited from qsf::JobProxyMovableObjectRenderingListener
virtual void onObjectRenderingStartup () override
 Called when an OGRE movable object is about to be rendered for the first time after it has not been rendered for some time. More...
 
virtual void onObjectRendering (const Component &component, const Ogre::Camera &ogreCamera) override
 Called when an OGRE movable object of the camera to be used for rendering. More...
 
virtual void onObjectRenderingShutdown () override
 Called when an OGRE movable object is no longer be rendered for some time. More...
 
- Protected Member Functions inherited from qsf::MovableObjectRenderingListener
virtual void onObjectDestroyed ()
 Movable object has been destroyed. 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...
 
- Protected Attributes inherited from qsf::JobProxyMovableObjectRenderingListener
JobProxy mAnimationJobProxy
 Regular animation job proxy; for updates once a frame. More...
 
- Protected Attributes inherited from qsf::MovableObjectRenderingListener
bool mAllowRegistration = true
 

Detailed Description

EMERGENCY 5 audio component class.

Note
  • Enables efficient random and looped audio
Todo:
  • TODO(fw): We should really rename this component (without breaking editing of course), as it produces a lot of confusion when people mix it up with the "qsf::AudioComponent"

Definition at line 41 of file AudioComponent.h.

Member Enumeration Documentation

Enumerator
AUDIOSET_NONE 
AUDIOSET_COW_RANDOM 
AUDIOSET_SKI_LOOPED 
AUDIOSET_DIVESPOT_LOOPED 
AUDIOSET_DEMONSTRATION_MOB_HISTORIC 
AUDIOSET_DEMONSTRATION_MOB_MODERN 

Definition at line 51 of file AudioComponent.h.

Constructor & Destructor Documentation

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

Constructor.

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

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

em5::AudioComponent::~AudioComponent ( )
inlinevirtual

Destructor.

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

Member Function Documentation

AudioComponent::AudioSet em5::AudioComponent::getAudioSet ( ) const
inline

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

virtual Component* em5::AudioComponent::getMovableObjectRenderingListenerComponent ( )
overrideprotectedvirtual

Return the component the listener will spy on.

Returns
The component the listener will spy on, can be a null pointer, do not destroy the instance
Note
  • The default implementation is empty and returns a null pointer
  • Ease of use method in case a listener just listens to a single movable object (the common use case)

Reimplemented from qsf::MovableObjectRenderingListener.

float em5::AudioComponent::getRandomProbability ( ) const
inline

Definition at line 59 of file AudioComponent-inl.h.

float em5::AudioComponent::getRandomWaitIntervalEnd ( ) const
inline

Definition at line 49 of file AudioComponent-inl.h.

float em5::AudioComponent::getRandomWaitIntervalStart ( ) const
inline

Definition at line 39 of file AudioComponent-inl.h.

virtual void em5::AudioComponent::onSetActive ( bool  active)
overrideprotectedvirtual

Set whether or not the component is considered to be active.

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

Reimplemented from qsf::Component.

virtual void em5::AudioComponent::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::AudioComponent::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::AudioComponent::onUpdateMovableObjectRenderingJob ( const qsf::JobArguments jobArguments)
overrideprotectedvirtual

Main update function that is passed to the job manager.

Parameters
[in]jobArgumentsJob arguments
Note
  • The default implementation checks the time since last visible and puts the listener to sleep if required

Reimplemented from qsf::JobProxyMovableObjectRenderingListener.

virtual void em5::AudioComponent::registerMovableObjectRenderingListener ( )
overrideprotectedvirtual

Register movable object rendering listener.

Reimplemented from qsf::MovableObjectRenderingListener.

virtual void em5::AudioComponent::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::AudioComponent::setAudioSet ( AudioComponent::AudioSet  audioSet)
inline

Definition at line 34 of file AudioComponent-inl.h.

void em5::AudioComponent::setRandomProbability ( float  randomProbability)
inline

Definition at line 64 of file AudioComponent-inl.h.

void em5::AudioComponent::setRandomWaitIntervalEnd ( float  randomWaitIntervalEnd)
inline

Definition at line 54 of file AudioComponent-inl.h.

void em5::AudioComponent::setRandomWaitIntervalStart ( float  randomWaitIntervalStart)
inline

Definition at line 44 of file AudioComponent-inl.h.

virtual void em5::AudioComponent::unregisterMovableObjectRenderingListener ( )
overrideprotectedvirtual

Unregister movable object rendering listener.

Reimplemented from qsf::MovableObjectRenderingListener.

Member Data Documentation

const uint32 em5::AudioComponent::COMPONENT_ID
static

"em5::AudioComponent" unique component ID

Definition at line 49 of file AudioComponent.h.


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