MapPart: Use boolean member 'visible'

The concept of dimming is not compatible with the current concept
of high-performance rendering.

Author: dg0yt

src/core/map_part.cpp

@@ -54,10 +54,9 @@ namespace literal
 
 namespace OpenOrienteering {
 
-MapPart::MapPart(const QString& name, Map* map, int visibility)
+MapPart::MapPart(const QString& name, Map* map)
 : name(name)
 , map(map)
-, visibility(visibility)
 {
 	Q_ASSERT(map);
 	; // nothing else
@@ -77,17 +76,17 @@ void MapPart::setName(const QString& new_name)
 		emit map->mapPartChanged(map->findPartIndex(this), this);
 }
 
-void MapPart::setVisibility(int new_visibility)
+void MapPart::setVisible(bool visible)
 {
-	if (visibility == new_visibility)
+	if (this->visible == visible)
 		return;
 
-	visibility = new_visibility;
+	this->visible = visible;
 	if (map)
 	{
 		emit map->mapPartChanged(map->findPartIndex(this), this);
-		applyOnAllObjects([new_visibility](Object* o) {
-			o->setVisible(new_visibility);
+		applyOnAllObjects([visible](Object* o) {
+			o->setVisible(visible);
 		});
 	}
 }
@@ -96,7 +95,7 @@ void MapPart::save(QXmlStreamWriter& xml) const
 {
 	XmlElementWriter part_element(xml, literal::part);
 	part_element.writeAttribute(literal::name, name);
-	part_element.writeAttribute(literal::visibility, visibility);
+	part_element.writeAttribute(literal::visibility, visible);
 	{
 		XmlElementWriter objects_element(xml, literal::objects);
 		objects_element.writeAttribute(literal::count, objects.size());
@@ -114,8 +113,9 @@ MapPart* MapPart::load(QXmlStreamReader& xml, Map& map, SymbolDictionary& symbol
 	Q_ASSERT(xml.name() == literal::part);
 
 	XmlElementReader part_element(xml);
-	int visibility = part_element.hasAttribute(literal::visibility) ? part_element.attribute<int>(literal::visibility) : 100;
-	auto part = new MapPart(part_element.attribute<QString>(literal::name), &map, visibility);
+	auto part = new MapPart(part_element.attribute<QString>(literal::name), &map);
+	if (part_element.hasAttribute(literal::visibility))
+		part->visible = part_element.attribute<bool>(literal::visibility);
 
 	while (xml.readNextStartElement())
 	{
@@ -132,7 +132,7 @@ MapPart* MapPart::load(QXmlStreamReader& xml, Map& map, SymbolDictionary& symbol
 				if (xml.name() == literal::object)
 				{
 					part->objects.push_back(Object::load(xml, &map, symbol_dict));
-					part->objects.back()->setVisible(visibility);
+					part->objects.back()->setVisible(part->visible);
 				}
 				else
 				{
@@ -172,7 +172,7 @@ void MapPart::setObject(Object* object, int pos, bool delete_old)
 		delete objects[pos];
 
 	objects[pos] = object;
-	object->setVisible(visibility);
+	object->setVisible(visible);
 	object->setMap(map);
 	object->update();
 	map->setObjectsDirty(); // TODO: remove from here, dirty state handling should be separate
@@ -186,7 +186,7 @@ void MapPart::addObject(Object* object)
 void MapPart::addObject(Object* object, int pos)
 {
 	objects.insert(objects.begin() + pos, object);
-	object->setVisible(visibility);
+	object->setVisible(visible);
 	object->setMap(map);
 	object->update();
 
@@ -251,7 +251,7 @@ std::unique_ptr<UndoStep> MapPart::importPart(const MapPart* other, const QHash<
 		new_object->transform(transform);
 
 		objects.push_back(new_object);
-		new_object->setVisible(visibility);
+		new_object->setVisible(visible);
 		new_object->setMap(map);
 		new_object->update();
 

src/core/map_part.h

@@ -69,7 +69,7 @@ class MapPart
 	/**
 	 * Creates a new map part with the given name for a map.
 	 */
-	MapPart(const QString& name, Map* map, int visibility=100);
+	MapPart(const QString& name, Map* map);
 
 	MapPart(const MapPart&) = delete;
 
@@ -107,12 +107,12 @@ class MapPart
 	/**
 	 * Returns the part's visibility.
 	 */
-	int getVisibility() const;
+	bool isVisible() const { return visible; };
 
 	/**
 	 * Sets the part's visibility.
 	 */
-	void setVisibility(int new_visibility);
+	void setVisible(bool visible);
 
 	/**
 	 * Returns the number of objects in the part.
@@ -276,7 +276,7 @@ class MapPart
 	QString name;
 	ObjectList objects;  ///< @todo This could be a spatial representation optimized for quick access
 	Map* const map;
-	int visibility;  // percentage as general approach, first use only values 0 and 100
+	bool visible = true;  ///< Visibility of the part's objects.
 };
 
 
@@ -289,12 +289,6 @@ const QString& MapPart::getName() const
 	return name;
 }
 
-inline
-int MapPart::getVisibility() const
-{
-	return visibility;
-}
-
 inline
 int MapPart::getNumObjects() const
 {

src/gui/map/map_editor.cpp

@@ -1094,7 +1094,7 @@ void MapEditorController::createActions()
 	mappart_add_act = newAction("addmappart", tr("Add new part..."), this, SLOT(addMapPart()));
 	mappart_rename_act = newAction("renamemappart", tr("Rename current part..."), this, SLOT(renameMapPart()));
 	mappart_remove_act = newAction("removemappart", tr("Remove current part"), this, SLOT(removeMapPart()));
-	mappart_visibility_act = newAction("visibilitymappart", tr("Hide current part"), this, SLOT(switchVisibilityMapPart()));	// exact text doesn't matter since replaced in updateMapPartsUI() below, so use something that is already in use
+	mappart_visibility_act = newAction("visibilitymappart", {/* set in updateMapPartsUI() */} , this, SLOT(toggleMapPartVisible()));
 	mappart_merge_act = newAction("mergemapparts", tr("Merge all parts"), this, SLOT(mergeAllMapParts()));
 
 	import_act = newAction("import", tr("Import..."), this, SLOT(importClicked()), nullptr, QString{}, "file_menu.html");
@@ -3803,7 +3803,7 @@ void MapEditorController::updateMapPartsUI()
 	if (mappart_visibility_act && count)
 	{
 		MapPart* const part = map->getCurrentPart();
-		mappart_visibility_act->setText(part->getVisibility() ? tr("Hide current part") : tr("Show current part"));
+		mappart_visibility_act->setText(part->isVisible() ? tr("Hide current part") : tr("Show current part"));
 	}
 
 	if (count > 0)
@@ -3844,7 +3844,7 @@ void MapEditorController::addMapPart()
 	                   &accepted );
 	if (accepted && !name.isEmpty())
 	{
-		auto* part = new MapPart(name, map, 100);
+		auto* part = new MapPart(name, map);
 		map->addPart(part, map->getCurrentPartIndex() + 1);
 		map->setCurrentPart(part);
 		map->push(new MapPartUndoStep(map, MapPartUndoStep::RemoveMapPart, part));
@@ -4005,10 +4005,10 @@ void MapEditorController::mergeAllMapParts()
 	}
 }
 
-void MapEditorController::switchVisibilityMapPart()
+void MapEditorController::toggleMapPartVisible()
 {
 	MapPart* const part = map->getCurrentPart();
-	part->setVisibility(part->getVisibility() ? 0 : 100);
+	part->setVisible(!part->isVisible());
 }
 
 void MapEditorController::templateAdded(int /*pos*/, const Template* /*temp*/)

src/gui/map/map_editor.h

@@ -520,8 +520,8 @@ public slots:
 	void mergeCurrentMapPartTo(int target);
 	/** Merges all map parts into the current one. */
 	void mergeAllMapParts();
-	/** Switches the visibility of the current map part */
-	void switchVisibilityMapPart();
+	/** Toggles the visibility of the current map part */
+	void toggleMapPartVisible();
 
 	/** Updates action enabled states after a template has been added */
 	void templateAdded(int pos, const OpenOrienteering::Template* temp);