GSoC '17 - The past 3 weeks


Specific Tool Bar

The tool specific toolbar was recently merged and it was implemented in such a way so that new tools can be added easily! Thanks to Ablu and bjorn for their help throughout this patch. You can see the implementation here.

Previously I made a new class ToolSpecificToolBar which inherited the QToolBar class but it wasn’t a very good implementation design-wise. The final implementation was pretty simple infact, I added a function in the class AbstractTool which could be overriden to add new tools specific to a particular tool.

class AbstractTool : public QObject
{
Q_OBJECT

public:
AbstractTool(const QString &name,
const QIcon &icon,
const QKeySequence &shortcut,
QObject *parent = nullptr);

virtual ~AbstractTool() {}

...
...

virtual void populateToolBar(QToolBar*) {}

...
...

};
AbstractTool.h

This function would then be overriden by the tools to add the specific tools.

class StampBrush : public AbstractTileTool
{
Q_OBJECT

public:
StampBrush(QObject *parent = nullptr);
~StampBrush();

...
...

void populateToolBar(QToolBar *toolBar) override;

...
...

};
StampBrush.h

Protip: Don’t rely on copy-paste too much. I made this mistake which later bjorn corrected.

Move Selection Feature

The move selected feature turned out to be a bit more complicated than I expected. I rolled out a new tool by extending AbstractTileTool. The first way I implemented it was by using cut-paste. As in, when a user starts dragging, then the selected area would be removed from the layer, and copied into the ClipboardManager and then the dragging stops, the layer cut would be pasted over to the layer.

This was just to get an idea of the implementation. In the end the working is similar to StampBrush, but creating a preview layer and passing it onto BrushItem for previewing and then using PaintTileLayer to paint the preview layer over the current layer. You can look over the implementation here.

I proceeded to add a ‘Duplicate’ feature as well, which would duplicate the selected area instead of moving it. This can be done by holding the Ctrl modifier. The feature isn’t merged right now since bjorn suggested that it would be better to make an AbstractSelectionTool which would then be inherited by the Tile Selection Tool, Magic Wand Tool and Select Similar Tile tool as well.

This would reduce code repetition. Also, it would help in providing specific tools for all the selection tools with minimum effort. You can look over the discussion in this pull request to get an idea of what I’m talking about.

Layer Locking

This feature turned out to be pretty easy, and I think this would be my first pull request that got merged within two days

The main effort went into adding the locking option in the GUI. I moved the eye icon to a different column as well. This took a whole day (you’ll understand if you try Qt GUI). This was supported by adding isLocked() and isUnlocked() functions in the Layer class. isLocked() returns true if the current layer is locked and false otherwise. isUnlocked returns true if the current layer and all its parent layers are unlocked as well. The naming doesn’t make much sense, I know about that already.

bool Layer::isUnlocked() const
{
const Layer *layer = this;
while (layer && !layer->isLocked())
layer = layer->parentLayer();
return !layer;
}
Layer.cpp

The next day I added a check of currentLayer()->isUnlocked() in every place which could modify the layer. This was a pretty simple task, and just involved searching places throughout the codebase which could edit a tile layer.

There are still some features/issues left for Layer Locking, but it would be better to proceed after getting a user feedback.

Infinite Maps

Supporting infinite maps is the next task in my proposal. This will the toughest thing I’ll be working on Tiled so far. You can take a look over the discussion here. MyPaint is such a software which supports an infinite canvas. Paint.js is also a similar thing. I’ll first take a look into their working before starting to implement it in Tiled.

First Evaluation

It’s time for the first evaluation now. I’ve completed the tasks mentioned in my timeline that were upto the first evaluation so I’m confident that I’ll pass this one. Still, fingers crossed! :-)