Templates dock #1612

thabetx · 2017-06-12T15:42:52Z

This pull request represents the second checkpoint of the Reusable Object Templates project, it's mainly concerned with creating the dock and managing the created templates.

These are the main items I will focus on doing:

Create the templates dock.
Display the templates in a tree structure.
Load the templates on startup from a predefined path.
Create a new template group via a button in the templates dock.
Save an object to a specific template group.
Load an existing template group.
Add a button to the dock to unload a template group.

bjorn

Only a few minor comments. It's looking good and I think you've planned a good next step. I'm looking forward to see the remaining functionality!

bjorn · 2017-06-12T20:14:00Z

src/tiled/objecttemplatemodel.cpp

+QModelIndex ObjectTemplateModel::index(int row, int column,
+                                       const QModelIndex &parent) const
+{
+    if (parent == QModelIndex())


Please use if (!parent.isValid())

bjorn · 2017-06-12T20:16:12Z

src/tiled/objecttemplatemodel.cpp

+QModelIndex ObjectTemplateModel::parent(const QModelIndex &index) const
+{
+    if (ObjectTemplate *objectTemplate = toObjectTemplate(index))
+        return createIndex(0, 0, objectTemplate->templateGroup());


Row 0 can't be always right, you need to determine the index of the template group in mTemplateGroups.

bjorn · 2017-06-12T20:17:56Z

src/tiled/objecttemplatemodel.h

+    Q_OBJECT
+
+public:
+    ObjectTemplateModel(const QList<TemplateGroup *> &templateGroups, QObject *parent = 0);


Please use nullptr.

The dock shows a pre-made template group as a list.

thabetx · 2017-06-14T14:47:57Z

I've finished loading templates on startup. testing is cumbersome because the file doesn't exist by default.

The file is called templatedocuments.xml and is located in the default data location, this is it's structure

<templatedocuments>
 <templatedocument path="templateGroup1.ttx"/>
 <templatedocument path="templateGroup2.ttx"/>
</templatedocuments>

I think renaming it to templategroups.xml and have internal elements as templategroups might be a good idea but not sure.

To make testing easier I will start implementing the new group button to be able to create groups then will work on adding an object to a loaded group as a template, after that I will work on error handling.

One particular part that I don't like is getting a parent of a template group in the model, I loop through all the documents to find the correct parent.

bjorn · 2017-06-14T21:10:10Z

I think renaming it to templategroups.xml and have internal elements as templategroups might be a good idea but not sure.

Yes, I think these would be better names as well. The "Document" is only an internal thing referring to the fact that it is a file of which the changes and format are tracked. I'm considering to rename this to "Asset", which is a common name for this as well.

One particular part that I don't like is getting a parent of a template group in the model, I loop through all the documents to find the correct parent.

That's fine.

bjorn

Lots of small comments this time. :-)

bjorn · 2017-06-14T21:22:52Z

src/libtiled/templategroup.h

 private:
    QList<ObjectTemplate*> mTemplates;
    QVector<SharedTileset> mTilesets;
    TemplateGroupFormat *mFormat;
    QString mName;
 };

+typedef QList<TemplateGroup*> TemplateGroups;


Unused now, should be removed.

bjorn · 2017-06-14T21:23:39Z

src/tiled/objecttemplatemodel.cpp

+{
+    if (!parent.isValid()) {
+        if (row < mTemplateDocuments.size()) {
+            return  createIndex(row, column, mTemplateDocuments.at(row)->templateGroup());


Coding style: One space too much after return. Also, when all branches of conditions are single lines, we leave out the { and }.

bjorn · 2017-06-14T21:25:39Z

src/tiled/objecttemplatemodel.cpp

+        if (row < mTemplateDocuments.size()) {
+            return  createIndex(row, column, mTemplateDocuments.at(row)->templateGroup());
+        } else {
+            return QModelIndex();


Line could be removed if the below if is changed to an else if.

bjorn · 2017-06-14T21:28:11Z

src/tiled/objecttemplatemodel.cpp

+QVariant ObjectTemplateModel::data(const QModelIndex &index, int role) const
+{
+    if (!index.isValid())
+        return QVariant();


These lines can be removed. In general no invalid index should be passed to data, but in case it happens, it will return QVariant() also without this additional check.

bjorn · 2017-06-14T21:34:42Z

src/tiled/templategroupdocument.cpp

+    writer.setAutoFormattingIndent(1);
+
+    writer.writeStartDocument();
+    writer.writeStartElement(QLatin1String("templateDocuments"));


Should keep the element names lowercase for consistency (also I see the reader requires it to be lowercase :-)).

bjorn · 2017-06-14T21:43:11Z

src/tiled/templategroupdocument.cpp

+        return false;
+    }
+
+    Format format = mFormat;


I think it sucks to have multiple formats, but since we did the same thing for maps, tilesets and the object types, it only makes sense to do the same thing for the templates since people's games are expected to load these things...

I somewhat wonder if there would be a way to serialize through some kind of interface, with different implementations storing things in different ways (XML, JSON, Lua...). Though that gets even more tricky for loading than for saving. And for sure it can't be done without changing some of these formats. :-(

Maybe we can serialize into a QVariantMap and then save that in the various other formats in some standard way (JSON is easy by using QJsonDocument::fromVariant). It's at least an approach we can try for new files.

bjorn · 2017-06-14T22:10:06Z

src/tiled/templategroupdocument.cpp

+            const QXmlStreamAttributes atts = reader.attributes();
+            const QString path(atts.value(QLatin1String("path")).toString());
+
+            auto templateGroupFormat = new TtxTemplateGroupFormat();


Hmm, there should be only one instance of TtxTemplateGroupFormat. Like this it is a memory leak. I would suggest to just make a singleton for now, by adding a static method:

TtxTemplateGroupFormat *TtxTemplateGroupFormat::instance() { static TtxTemplateGroupFormat format; return &format; }

This is a new way for implementing a singleton :), I thought of creating the static object as a member and manually checking every time when the instance function is called.

A member is only needed when the object needs to be manually deleted. This static variable is automatically destroyed at some point when the program exists, which I think will not cause any problems.

bjorn · 2017-06-14T22:15:34Z

src/tiled/templategroupdocument.cpp

+
+            auto templateGroupFormat = new TtxTemplateGroupFormat();
+
+            // TODO: handle errors that might happen while loading


Right, at least don't put nullptr into templateDocuments. :-)

Also, don't forget to initialize templateGroup in MapReaderPrivate::readTemplateGroup with nullptr or you're going to have trouble detecting errors.

bjorn · 2017-06-14T22:16:52Z

src/tiled/objecttemplatemodel.cpp

+
+    if (ObjectTemplate *objectTemplate = toObjectTemplate(index)) {
+        auto templateGroup = objectTemplate->templateGroup();
+        // TODO: this doesn't work properly when multiple documents have the same group


This can't happen. You're comparing pointers here and at no point in the code would it insert the same pointer twice.

bjorn · 2017-06-14T22:19:07Z

src/tiled/preferences.cpp

+void Preferences::setTemplateDocuments(const TemplateDocuments &templateDocuments)
+{
+    mTemplateDocuments = templateDocuments;
+    // This signal isn't used yet


Connect to it in TemplatesDock. :-)

thabetx · 2017-06-18T22:23:10Z

Currently groups can be created and templates can be saved and viewed in the dock, the workflow still need some refining I will work on it in the upcoming days.

There parts that I'm not sure how to do yet so I left TODOs there.

bjorn · 2017-06-19T09:44:04Z

src/tiled/objecttemplatemodel.cpp

+    auto templateGroupDocument = new TemplateGroupDocument(templateGroup, fileName);
+
+    if (!templateGroupDocument->save(fileName, error))
+        return false;


Will leak the above allocated objects. Can use QScopedPointer to prevent leaking (probably only for the templateGroupDocument, given that the document should probably own its template group and delete it in its destructor).

bjorn · 2017-06-19T11:00:05Z

src/tiled/templategroupdocument.cpp

+    for (const TemplateGroupDocument *templateDocument : templateDocuments) {
+        writer.writeStartElement(QLatin1String("templatedocument"));
+
+        writer.writeAttribute(QLatin1String("path"), templateDocument->fileName());


Please use a relative path here (can check the MapWriter for examples regarding external tilesets and tileset images).

bjorn · 2017-06-19T11:06:02Z

src/tiled/templatesdock.h

+    TemplatesView(QWidget *parent = nullptr);
+
+    void applyTemplateGroups();
+    ObjectTemplateModel *objectTemplateModel();


Should be const.

thabetx · 2017-06-19T22:21:51Z

I've done a punch of improvements

The new template dialog behavior is now similar to the new tileset dialog.
Insertion now works correctly and the expansion state of the tree will not change.
Overwriting a template group will also delete the old file from the tree.
Relative paths are used for the stored document.

I've also handled the tilesets so a template group will have no duplicates, this required storing a reference upon saving any template that had a new tileset.

The references then were required to be deleted upon exit which initially violated some assertions. I had to change the destruction order in the main window as the preferences object which stored the documents was deleted after the tileset manager.

bjorn

Alright, I think we're almost ready to merge this one. I've added some minor comments.

bjorn · 2017-06-20T07:15:12Z

src/tiled/objecttemplatemodel.cpp

+    while (it.hasNext()) {
+        if (it.next()->fileName() == fileName) {
+            int pos = mTemplateDocuments.indexOf(it.value());
+            delete it.value();


To avoid potential invalid memory access, you should move this delete to after the beginRemoveRows.

bjorn · 2017-06-20T07:17:07Z

src/tiled/objecttemplatemodel.cpp

+    QMutableListIterator<TemplateGroupDocument*> it(mTemplateDocuments);
+    while (it.hasNext()) {
+        if (it.next()->fileName() == fileName) {
+            int pos = mTemplateDocuments.indexOf(it.value());


Instead of iterating the list forwards and for each match, finding the index, you could instead iterate the list backwards like for (int i = mTemplateDocuments.size() - 1; i >= 0; --i) {.

bjorn · 2017-06-20T07:24:46Z

src/tiled/templategroupdocument.cpp

 }

 TemplateGroupDocument::~TemplateGroupDocument()
 {
+    TilesetManager *tilesetManager = TilesetManager::instance();
+    tilesetManager->removeReferences(mTemplateGroup->tilesets());


If you add references in the TemplateGroup, then please remove them there as well.

Embedded tileset references are not managed and are currently disabled.

Update the elements to "templategroup" instead of "templatedocument"

thabetx · 2017-06-26T12:22:00Z

The last two items in the list will be moved to other PRs.

bjorn requested changes Jun 12, 2017

View reviewed changes

thabetx force-pushed the templates-dock branch 2 times, most recently from 908f143 to 9ab31dc Compare June 12, 2017 20:57

thabetx added 2 commits June 14, 2017 15:38

Create basic templates dock

daa9407

The dock shows a pre-made template group as a list.

Display templates in a tree sturcture

62ac127

thabetx force-pushed the templates-dock branch 2 times, most recently from ca91c66 to 01d2b3d Compare June 14, 2017 14:12

bjorn requested changes Jun 14, 2017

View reviewed changes

thabetx force-pushed the templates-dock branch 2 times, most recently from 4523921 to 42709ac Compare June 17, 2017 16:32

bjorn requested changes Jun 19, 2017

View reviewed changes

thabetx force-pushed the templates-dock branch 6 times, most recently from d7cdc0d to 37b0744 Compare June 19, 2017 22:21

bjorn requested changes Jun 20, 2017

View reviewed changes

thabetx force-pushed the templates-dock branch 2 times, most recently from b64b0c7 to 899b9d8 Compare June 20, 2017 18:01

thabetx added 3 commits June 20, 2017 23:49

Load template groups on startup from the file system

404192f

Small fixes

91b439e

Add "Create Template Group" button to the templates dock

2c1e240

thabetx force-pushed the templates-dock branch from 234f9b8 to 5c3f7a2 Compare June 20, 2017 21:52

thabetx added 2 commits June 21, 2017 00:05

Create the save template dialog

d234c1e

Manage tileset references of template groups

f8a73da

Embedded tileset references are not managed and are currently disabled.

Update saved template groups file format

67e39b1

Update the elements to "templategroup" instead of "templatedocument"

thabetx force-pushed the templates-dock branch from 5c3f7a2 to 67e39b1 Compare June 20, 2017 22:29

bjorn merged commit 67e39b1 into mapeditor:wip/templates Jun 21, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Templates dock #1612

Templates dock #1612

thabetx commented Jun 12, 2017 •

edited

Loading

bjorn left a comment

bjorn Jun 12, 2017

bjorn Jun 12, 2017

bjorn Jun 12, 2017

thabetx commented Jun 14, 2017

bjorn commented Jun 14, 2017

bjorn left a comment

bjorn Jun 14, 2017

bjorn Jun 14, 2017

bjorn Jun 14, 2017

bjorn Jun 14, 2017

bjorn Jun 14, 2017

bjorn Jun 14, 2017

bjorn Jun 14, 2017

thabetx Jun 15, 2017

bjorn Jun 15, 2017

bjorn Jun 14, 2017

bjorn Jun 14, 2017

bjorn Jun 14, 2017

thabetx commented Jun 18, 2017

bjorn Jun 19, 2017

bjorn Jun 19, 2017

bjorn Jun 19, 2017

thabetx commented Jun 19, 2017

bjorn left a comment

bjorn Jun 20, 2017

bjorn Jun 20, 2017

bjorn Jun 20, 2017

thabetx commented Jun 26, 2017


		auto templateGroupFormat = new TtxTemplateGroupFormat();

		// TODO: handle errors that might happen while loading

Templates dock #1612

Templates dock #1612

Conversation

thabetx commented Jun 12, 2017 • edited Loading

bjorn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thabetx commented Jun 14, 2017

bjorn commented Jun 14, 2017

bjorn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thabetx commented Jun 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thabetx commented Jun 19, 2017

bjorn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thabetx commented Jun 26, 2017

thabetx commented Jun 12, 2017 •

edited

Loading