Developer Documentation
SingleObjectPropertyModel.hh
1/*===========================================================================*\
2* *
3* OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39* *
40\*===========================================================================*/
41
42
43#pragma once
44
45#include "PropertyModel.hh"
46#include "PropertyVisualizer/PropertyVisualizer.hh"
47
51
52#include <vector>
53#include <iostream>
54#include <set>
55#include <typeinfo>
56
57#include <QPushButton>
58#if QT_VERSION_MAJOR < 6
59#include <QScriptValue>
60#include <QScriptContext>
61#endif
62
63#include <Widgets/VectorWidget.hh>
64
65
77{
78 Q_OBJECT
79
80signals:
81 void log(Logtype _type, QString _message);
82 void log(QString _message);
83
84private slots:
85 void slotLog(Logtype _type, QString _message){ emit log(_type, _message); }
86 void slotLog(QString _message){ emit log(_message);}
87
88public:
89 virtual void pickModeChanged(const std::string& _mode) override {}
90 virtual void mouseEvent(QMouseEvent* _event) override {}
91
92 explicit SingleObjectPropertyModel(QObject *parent = 0);
94
95 virtual int rowCount(const QModelIndex & parent = QModelIndex()) const override;
96 virtual QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const override;
97 virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
98 virtual QModelIndex index(int row, int column, QModelIndex const & parent = QModelIndex()) const override;
99
101 virtual void objectUpdated() override;
102
104 virtual void visualize(QModelIndexList selectedIndices, QWidgetList widgets = QWidgetList()) override;
105
107 virtual void removeProperty(QModelIndexList selectedIndices) override;
108
110 virtual void duplicateProperty(QModelIndexList selectedIndices) override;
111
113 virtual void gatherProperties() override { /* implemented by subclass */ }
114
116 virtual void clear(QModelIndexList selectedIndices) override;
117
119 inline void hideWidget() override { widgets->hide(); }
120
122 inline QWidget* getWidget() override { return widgets; }
123
125 virtual void updateWidget(const QModelIndexList& selectedIndices) override;
126
128 void connectLogs(PropertyVisualizer* propViz) override;
129
131 virtual PropertyInfo getPropertyInfo(const QModelIndex index) const override;
132
133 #if QT_VERSION_MAJOR < 6
135 virtual QScriptValue getScriptObject(const QModelIndex index, QScriptContext *ctx);
136 #endif
137
138
139protected:
140
142 PropertyVisualizer* getPropertyVisualizer(QString propName, PropertyInfo::ENTITY_FILTER filter, TypeInfoWrapper typeInfo);
143
145 bool isPropertyFree(QString propName, PropertyInfo::ENTITY_FILTER filter, TypeInfoWrapper typeInfo);
146
147
149 QString getLoadFilename();
150
152 virtual QString getLoadFilenameFilter();
153
155 QString getSaveFilename(unsigned int propId);
156
158 virtual QString getSaveFilenameFilter(unsigned int propId);
159
161 virtual QString getDefaultSaveFilename(unsigned int propId);
162
164 void saveProperty(unsigned int propId);
165
167 void loadProperty();
168
170 virtual void setPropertyFromFile(QTextStream &file_stream, unsigned int n, PropertyVisualizer *propVis);
171
183 virtual bool parseHeader(QString header, PropertyVisualizer*& propVis, unsigned int& n){ return false; }
184
185protected:
186 std::vector<PropertyVisualizer*> propertyVisualizers;
187 QWidget* widgets;
188 QModelIndexList currentlySelectedIndices;
189 std::vector<unsigned int> currentlyVisualizedIndices;
190};
191
192
Logtype
Log types for Message Window.
Cellection of information about a property.
Definition: Utils.hh:109
This class vizualizes a property.
This class manages the visualizers for a single object.
void connectLogs(PropertyVisualizer *propViz) override
Connects the PropertyVisualizer log signals with the log slot.
virtual void updateWidget(const QModelIndexList &selectedIndices) override
Updates the widget.
virtual void gatherProperties() override
Searches for properties and creates PropertyVisualizers.
virtual void objectUpdated() override
Revisualizes visualized properties.
virtual void removeProperty(QModelIndexList selectedIndices) override
Removes the selected properties.
virtual QString getSaveFilenameFilter(unsigned int propId)
Returns the filename filter for saving.
virtual bool parseHeader(QString header, PropertyVisualizer *&propVis, unsigned int &n)
Parses the property file header.
bool isPropertyFree(QString propName, PropertyInfo::ENTITY_FILTER filter, TypeInfoWrapper typeInfo)
Checks if the property name is still available.
virtual QScriptValue getScriptObject(const QModelIndex index, QScriptContext *ctx)
Returns a qscript object that can be used to access visualisation parameters.
virtual void duplicateProperty(QModelIndexList selectedIndices) override
Duplicates the selected properties.
void saveProperty(unsigned int propId)
Saves property.
QWidget * getWidget() override
Returns the widget.
void hideWidget() override
Hides the widget.
virtual QString getLoadFilenameFilter()
Returns the filename filter for loading.
QString getSaveFilename(unsigned int propId)
Asks the user for a file to load.
virtual QString getDefaultSaveFilename(unsigned int propId)
Returns the default file name.
virtual void visualize(QModelIndexList selectedIndices, QWidgetList widgets=QWidgetList()) override
Visualizes the selected properties.
virtual void clear(QModelIndexList selectedIndices) override
Clears the selected property visualization.
QString getLoadFilename()
Asks the user for a file to load.
PropertyVisualizer * getPropertyVisualizer(QString propName, PropertyInfo::ENTITY_FILTER filter, TypeInfoWrapper typeInfo)
Returns a PropertyVisualizer.
virtual void setPropertyFromFile(QTextStream &file_stream, unsigned int n, PropertyVisualizer *propVis)
Sets the property values from a given file.
virtual PropertyInfo getPropertyInfo(const QModelIndex index) const override
Returns the property info for the property with the given index.
Wraps the information of a type.
Definition: Utils.hh:73