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

EMERGENCY 5 supervisor compositor workspace configurator pluginable. More...

#include <SupervisorCompositorWorkspaceConfigurator.h>

Public Member Functions

 SupervisorCompositorWorkspaceConfigurator (qsf::CompositorWorkspaceConfiguratorManager *compositorWorkspaceConfiguratorManager)
 Constructor. More...
 
virtual ~SupervisorCompositorWorkspaceConfigurator ()
 Destructor. More...
 
virtual std::string getCompositorWorkspaceDefinitionName () const override
 Return the name of the compositor workspace definition to use. More...
 
virtual void configureCompositorWorkspace () override
 
virtual void workspacePreUpdate (Ogre::CompositorWorkspace &ogreCompositorWorkspace) override
 
virtual void passPreExecute (Ogre::CompositorPass &ogreCompositorPass) override
 
- Public Member Functions inherited from qsf::CompositorWorkspaceConfigurator
virtual ~CompositorWorkspaceConfigurator ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::Pluginable< CompositorWorkspaceConfiguratorManager >
virtual ~Pluginable ()
 Destructor. More...
 
CompositorWorkspaceConfiguratorManagergetManager () 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...
 

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::CompositorWorkspaceConfigurator
 CompositorWorkspaceConfigurator (CompositorWorkspaceConfiguratorManager *compositorWorkspaceConfiguratorManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::Pluginable< CompositorWorkspaceConfiguratorManager >
 Pluginable (CompositorWorkspaceConfiguratorManager *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...
 

Detailed Description

EMERGENCY 5 supervisor compositor workspace configurator pluginable.

Note
  • Compositing component counterpart is "em5::SupervisorCompositingComponent"
Todo:

Definition at line 58 of file SupervisorCompositorWorkspaceConfigurator.h.

Constructor & Destructor Documentation

em5::SupervisorCompositorWorkspaceConfigurator::SupervisorCompositorWorkspaceConfigurator ( qsf::CompositorWorkspaceConfiguratorManager compositorWorkspaceConfiguratorManager)
explicit

Constructor.

virtual em5::SupervisorCompositorWorkspaceConfigurator::~SupervisorCompositorWorkspaceConfigurator ( )
virtual

Destructor.

Member Function Documentation

virtual void em5::SupervisorCompositorWorkspaceConfigurator::configureCompositorWorkspace ( )
overridevirtual
virtual std::string em5::SupervisorCompositorWorkspaceConfigurator::getCompositorWorkspaceDefinitionName ( ) const
overridevirtual

Return the name of the compositor workspace definition to use.

Returns
The name of the compositor workspace definition to use

Implements qsf::CompositorWorkspaceConfigurator.

virtual void em5::SupervisorCompositorWorkspaceConfigurator::passPreExecute ( Ogre::CompositorPass &  ogreCompositorPass)
overridevirtual
virtual void em5::SupervisorCompositorWorkspaceConfigurator::workspacePreUpdate ( Ogre::CompositorWorkspace &  ogreCompositorWorkspace)
overridevirtual

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