Emergency 2017 Dokumentation  v3.0.1
em5::editor::FireMaterialsView Class Reference

EMERGENCY 5 fire materials view class. More...

#include <FireMaterialsView.h>

Public Member Functions

 FireMaterialsView (qsf::editor::ViewManager *viewManager, QWidget *qWidgetParent)
 Constructor. More...
 
virtual ~FireMaterialsView ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::editor::View
virtual ~View ()
 Destructor. More...
 
ApplicationgetApplication () const
 Return the QSF editor application. More...
 
MainWindowgetMainWindow () const
 Return the main window. More...
 
virtual void setVisible (bool visible) override
 
- Public Member Functions inherited from qsf::Pluginable< ViewManager >
virtual ~Pluginable ()
 Destructor. More...
 
ViewManager & getManager () 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::editor::FireMaterialsView" unique pluginable view ID More...
 

Protected Member Functions

virtual void retranslateUi () override
 Retranslate the UI. More...
 
virtual void changeVisibility (bool visible) override
 Change visibility. More...
 
- Protected Member Functions inherited from qsf::editor::View
 View (ViewManager *viewManager, QWidget *qWidgetParent)
 Constructor. More...
 
void addViewAndTabify (QMainWindow &qMainWindow, Qt::DockWidgetArea qtDockWidgetArea)
 Add the Qt dock widget to the given Qt main window and tabifies it. More...
 
virtual void readSettings (QSettings &qSettings)
 Read settings by using Qt's "QSettings". More...
 
virtual void writeSettings (QSettings &qSettings)
 Write settings by using Qt's "QSettings". More...
 
virtual QString getAutomaticWindowTitle (View &view) const
 Return the automatic window title by using the "Name"-tag of the CAMP reflection view. More...
 
virtual bool preChangeVisibility (bool visible)
 Filter method called before "qsf::editor::View::changeVisibility()" is called. More...
 
virtual void showEvent (QShowEvent *qShowEvent) override
 
virtual void hideEvent (QHideEvent *qHideEvent) override
 
virtual void changeEvent (QEvent *qEvent) override
 
- Protected Member Functions inherited from qsf::Pluginable< ViewManager >
 Pluginable (ViewManager *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...
 

Friends

class FireMaterialsMenu
 

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 }
 

Detailed Description

EMERGENCY 5 fire materials view class.

Note
  • The UI is created by using a Qt ui-file (create/edit it by using e.g. Qt Designer)
Todo:
  • TODO(fr) The view currently does not support undo/redo operations
  • TODO(co) There's no handling for the situation when new fire materials are added while the editor is up-and-running (rare situation, but should be handled to reduce chaos)

Definition at line 64 of file FireMaterialsView.h.

Constructor & Destructor Documentation

em5::editor::FireMaterialsView::FireMaterialsView ( qsf::editor::ViewManager viewManager,
QWidget *  qWidgetParent 
)

Constructor.

Parameters
[in]viewManagerOptional pointer to the view manager this view should be registered to, can be a null pointer
[in]qWidgetParentPointer to parent Qt widget, can be a null pointer (in this case you're responsible for destroying this view instance)
virtual em5::editor::FireMaterialsView::~FireMaterialsView ( )
virtual

Destructor.

Member Function Documentation

virtual void em5::editor::FireMaterialsView::changeVisibility ( bool  visible)
overrideprotectedvirtual

Change visibility.

Note
  • Unlike "QWidget::setVisible()" this method is only called if there was a real visibility state change
  • The default implementation is empty

Reimplemented from qsf::editor::View.

virtual void em5::editor::FireMaterialsView::retranslateUi ( )
overrideprotectedvirtual

Retranslate the UI.

Note
  • This method is only called in case the view is visible
  • The default implementation is empty

Reimplemented from qsf::editor::View.

Friends And Related Function Documentation

friend class FireMaterialsMenu
friend

Definition at line 71 of file FireMaterialsView.h.

Member Data Documentation

const uint32 em5::editor::FireMaterialsView::PLUGINABLE_ID
static

"em5::editor::FireMaterialsView" unique pluginable view ID

Definition at line 85 of file FireMaterialsView.h.


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