Skip to content

Commit

Permalink
ign -> gz Namespace Migration : gz-gui (#401)
Browse files Browse the repository at this point in the history
* Update header guards

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Migrate namespaces

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Add migration line

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Implement deprecation trick

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Add deprecation test

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Include config.hh

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Use pragma deprecation message instead

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Ticktock config macros

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Mention gz headers in migration

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Migrate includes to gz

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Update config.hh

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Migrate Export.hh headers and deprecated test

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Migrate IGN(ITION)_GUI_XXX macros and variables

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Migrate github links

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Migrate user-facing Ignition to Gazebo

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Migrate gz-common logging calls

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Migrate "ignition.msgs" -> "gz.msgs"

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Fix deprecated test

Creating a Dialog without any args and not using it somehow causes a segfault just in the deprecated test. This commit makes the test use a different object instead.

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Include config.hh in recursive directories and <lib>.hh

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Include config.hh in .h and .hpp redirection headers

Signed-off-by: methylDragon <methylDragon@gmail.com>

* `ignitionrobotics` -> `gazebosim`

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Rollback osrf-migration.github.io migrations

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Fix typo

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Wording changes

Signed-off-by: methylDragon <methylDragon@gmail.com>

* Migrate `igndbg` -> `gzdbg`

Signed-off-by: methylDragon <methylDragon@gmail.com>
  • Loading branch information
methylDragon authored May 29, 2022
1 parent 2c5d186 commit cf54ba2
Show file tree
Hide file tree
Showing 167 changed files with 2,190 additions and 2,093 deletions.
2 changes: 1 addition & 1 deletion .github/ci/after_make.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ set -x
make install

# For ign-tools
export IGN_CONFIG_PATH=/usr/local/share/ignition
export GZ_CONFIG_PATH=/usr/local/share/ignition
export LD_LIBRARY_PATH=/usr/local/lib/:$LD_LIBRARY_PATH

# For rendering / window tests
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ ign_find_package (Qt5
PKGCONFIG "Qt5Core Qt5Quick Qt5QuickControls2 Qt5Widgets"
)

set(IGNITION_GUI_PLUGIN_INSTALL_DIR
set(GZ_GUI_PLUGIN_INSTALL_DIR
${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/ign-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/plugins
)

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See the [Ignition contributing guide](https://ignitionrobotics.org/docs/all/contributing).
See the [Ignition contributing guide](https://gazebosim.org/docs/all/contributing).
580 changes: 290 additions & 290 deletions Changelog.md

Large diffs are not rendered by default.

31 changes: 17 additions & 14 deletions Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,59 +5,62 @@ Deprecated code produces compile-time warnings. These warning serve as
notification to users that their code should be upgraded. The next major
release will remove the deprecated code.

## Ignition GUI 6.X to 7.X
## Gazebo GUI 6.X to 7.X

* The environment variable `IGN_GUI_PLUGIN_PATH` is deprecated. Use `GZ_GUI_PLUGIN_PATH` instead.
* The `ignition` namespace is deprecated and will be removed in future versions. Use `gz` instead.

## Ignition GUI 6.2 to 6.3
* Header files under `ignition/...` are deprecated and will be removed in future versions.
Use `gz/...` instead.

## Gazebo GUI 6.2 to 6.3

* New QML dependencies, only needed for the NavSatMap plugin: `qml-module-qtlocation`, `qml-module-qtpositioning`

## Ignition GUI 6.1 to 6.2
## Gazebo GUI 6.1 to 6.2

* All features from `Grid3D` have been incorportated into `GridConfig`. The code
* All features from `Grid3D` have been incorporated into `GridConfig`. The code
for the original `Grid3D` has been removed and now the installed library is
just a copy of `GridConfig`. Existing `Grid3D` users shouldn't be affected and
may continue to use `Grid3D` as before.

## Ignition GUI 5.x to 6.x
## Gazebo GUI 5.x to 6.x

* The `Scene3D` plugin is deprecated, use `MinimalScene` with
`TransportSceneManager` instead.

## Ignition GUI 5.1 to 5.2
## Gazebo GUI 5.1 to 5.2

* The `Application::PluginAdded` signal used to send empty strings. Now it
sends the plugin's unique name.

## Ignition GUI 4.4 to 4.5
## Gazebo GUI 4.4 to 4.5

* The `Application::PluginAdded` signal used to send empty strings. Now it
sends the plugin's unique name.

## Ignition GUI 3.x to 4.x
## Gazebo GUI 3.x to 4.x

* Use rendering4, transport9 and msgs6.
* Deprecated `ignition::gui::convert` to `ignition::common::Time`.
Use `ignition::msgs::Convert` to `std::chrono::steady_clock::time_point`
instead.

## Ignition GUI 3.6 to 3.7
## Gazebo GUI 3.6 to 3.7

* The `Application::PluginAdded` signal used to send empty strings. Now it
sends the plugin's unique name.

## Ignition GUI 2.x to 3.x
## Gazebo GUI 2.x to 3.x

* Use rendering3, transport8 and msgs5.

## Ignition GUI 1.x to 2.x
## Gazebo GUI 1.x to 2.x

* Plugin headers are no longer installed.

* Use ignition msgs4, rendering2, and transport7.

## Ignition GUI 0.1.0 to 1.0.0

* Ignition GUI v1 uses QtQuick and it is not compatible with v0, which uses QWidgets.
## Gazebo GUI 0.1.0 to 1.0.0

* Gazebo GUI v1 uses QtQuick and it is not compatible with v0, which uses QWidgets.
2 changes: 1 addition & 1 deletion NEWS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
http://ignitionrobotics.org
http://gazebosim.org
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Ignition GUI : Graphical interfaces for robotics applications
# Gazebo GUI : Graphical interfaces for robotics applications

**Maintainer:** louise [AT] openrobotics [DOT] org

[![GitHub open issues](https://img.shields.io/github/issues-raw/ignitionrobotics/ign-gui.svg)](https://github.com/ignitionrobotics/ign-gui/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/ignitionrobotics/ign-gui.svg)](https://github.com/ignitionrobotics/ign-gui/pulls)
[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-gui.svg)](https://github.com/gazebosim/gz-gui/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-gui.svg)](https://github.com/gazebosim/gz-gui/pulls)
[![Discourse topics](https://img.shields.io/discourse/https/community.gazebosim.org/topics.svg)](https://community.gazebosim.org)
[![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0)

Build | Status
-- | --
Test coverage | [![codecov](https://codecov.io/gh/ignitionrobotics/ign-gui/branch/main/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-gui/branch/main)
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-gui/branch/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-gui/branch/main)
Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_gui-ci-main-focal-amd64)](https://build.osrfoundation.org/job/ignition_gui-ci-main-focal-amd64)
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_gui-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_gui-ci-main-homebrew-amd64)
Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ign_gui-ci-win)](https://build.osrfoundation.org/job/ign_gui-ci-win)

Ignition GUI builds on top of [Qt](https://www.qt.io/) to provide widgets which are
Gazebo GUI builds on top of [Qt](https://www.qt.io/) to provide widgets which are
useful when developing robotics applications, such as a 3D view, plots, dashboard, etc,
and can be used together in a convenient unified interface.

Ignition GUI ships with several widgets ready to use and offers a plugin interface
Gazebo GUI ships with several widgets ready to use and offers a plugin interface
which can be used to add custom widgets.

# Table of Contents
Expand Down Expand Up @@ -46,16 +46,16 @@ which can be used to add custom widgets.
* Qt-based widgets, with support for both Qt5 widgets and QtQuick
* Plugin-based interface, so it's easy to add new widgets
* Several plugins ready to be used
* 3D scene integration using [Ignition Rendering](https://github.com/ignitionrobotics/ign-rendering/)
* 3D scene integration using [Gazebo Rendering](https://github.com/gazebosim/gz-rendering/)

# Install

See the [installation tutorial](https://ignitionrobotics.org/api/gui/5.0/install.html).
See the [installation tutorial](https://gazebosim.org/api/gui/5.0/install.html).

# Usage

Take a look at the
[tutorials](https://ignitionrobotics.org/api/gui/5.0/tutorials.html)
[tutorials](https://gazebosim.org/api/gui/5.0/tutorials.html)
for usage instructions and API documentation.

## Known issue of command line tools
Expand All @@ -64,15 +64,15 @@ In the event that the installation is a mix of Debian and from source, command
line tools from `ign-tools` may not work correctly.

A workaround for a single package is to define the environment variable
`IGN_CONFIG_PATH` to point to the location of the Ignition library installation,
`GZ_CONFIG_PATH` to point to the location of the Ignition library installation,
where the YAML file for the package is found, such as
```
export IGN_CONFIG_PATH=/usr/local/share/ignition
export GZ_CONFIG_PATH=/usr/local/share/ignition
```

Multiple paths can be specified using the `:` delimiter. For example,
```
export IGN_CONFIG_PATH=/user/local/share/ignition/:/path/to/some/other/location
export GZ_CONFIG_PATH=/user/local/share/ignition/:/path/to/some/other/location
```

# Folder Structure
Expand All @@ -88,35 +88,35 @@ export IGN_CONFIG_PATH=/user/local/share/ignition/:/path/to/some/other/location
* `test`: All integration, performance and regression tests go here, under their
specific folders.

* `examples/standalone`: Example code for standalone applications using Ignition GUI
* `examples/standalone`: Example code for standalone applications using Gazebo GUI
as a library. Each example has instructions in a README file.

* `examples/config`: Example configuration files which can be loaded using
`ign gui -c <path to file>`

* `examples/plugin`: Example plugins which can be compiled and loaded as explained
in [this tutorial](https://ignitionrobotics.org/api/gui/5.0/plugins.html).
in [this tutorial](https://gazebosim.org/api/gui/5.0/plugins.html).

* `tutorials`: Markdown files for the [tutorials](https://ignitionrobotics.org/api/gui/5.0/tutorials.html).
* `tutorials`: Markdown files for the [tutorials](https://gazebosim.org/api/gui/5.0/tutorials.html).

* `conf`: Files needed by [ign-tools](https://github.com/ignitionrobotics/ign-tools).
* `conf`: Files needed by [ign-tools](https://github.com/gazebosim/gz-tools).

* `doc`: Files used by Doxygen when generating documentation.

# Contributing

Please see
[CONTRIBUTING.md](https://ignitionrobotics.org/docs/all/contributing).
[CONTRIBUTING.md](https://gazebosim.org/docs/all/contributing).

# Code of Conduct

Please see
[CODE\_OF\_CONDUCT.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CODE_OF_CONDUCT.md).
[CODE\_OF\_CONDUCT.md](https://github.com/gazebosim/gz-sim/blob/main/CODE_OF_CONDUCT.md).

# Versioning

This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Ignition project](https://ignitionrobotics.org) which periodically releases a versioned set of compatible and complimentary libraries. See the [Ignition website](https://ignitionrobotics.org) for version and release information.
This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Ignition project](https://gazebosim.org) which periodically releases a versioned set of compatible and complimentary libraries. See the [Ignition website](https://gazebosim.org) for version and release information.

# License

This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/ignitionrobotics/ign-gui/blob/main/LICENSE) file.
This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/gazebosim/gz-gui/blob/main/LICENSE) file.
6 changes: 3 additions & 3 deletions examples/plugin/custom_context_menu/CustomContext.cc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

#include "CustomContext.hh"

using namespace ignition;
using namespace gz;
using namespace gui;

/////////////////////////////////////////////////
Expand All @@ -35,5 +35,5 @@ CustomContext::~CustomContext()
}

// Register this plugin
IGNITION_ADD_PLUGIN(ignition::gui::CustomContext,
ignition::gui::Plugin);
IGNITION_ADD_PLUGIN(gz::gui::CustomContext,
gz::gui::Plugin);
2 changes: 1 addition & 1 deletion examples/plugin/custom_context_menu/CustomContext.hh
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#include <gz/gui/Plugin.hh>
#endif

namespace ignition
namespace gz
{
namespace gui
{
Expand Down
6 changes: 3 additions & 3 deletions examples/plugin/dialog_from_plugin/DialogFromPlugin.cc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

#include "DialogFromPlugin.hh"

using namespace ignition;
using namespace gz;
using namespace gui;

/////////////////////////////////////////////////
Expand All @@ -35,5 +35,5 @@ DialogFromPlugin::~DialogFromPlugin()
}

// Register this plugin
IGNITION_ADD_PLUGIN(ignition::gui::DialogFromPlugin,
ignition::gui::Plugin);
IGNITION_ADD_PLUGIN(gz::gui::DialogFromPlugin,
gz::gui::Plugin);
2 changes: 1 addition & 1 deletion examples/plugin/dialog_from_plugin/DialogFromPlugin.hh
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#include <gz/gui/Plugin.hh>
#endif

namespace ignition
namespace gz
{
namespace gui
{
Expand Down
4 changes: 2 additions & 2 deletions examples/plugin/gz_components/GzComponents.cc
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@
#include "GzComponents.hh"

// Register this plugin
IGNITION_ADD_PLUGIN(ignition::gui::GzComponents,
ignition::gui::Plugin);
IGNITION_ADD_PLUGIN(gz::gui::GzComponents,
gz::gui::Plugin);
2 changes: 1 addition & 1 deletion examples/plugin/gz_components/GzComponents.hh
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

#include <gz/gui/Plugin.hh>

namespace ignition
namespace gz
{
namespace gui
{
Expand Down
6 changes: 3 additions & 3 deletions examples/plugin/hello_plugin/HelloPlugin.cc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

#include "HelloPlugin.hh"

using namespace ignition;
using namespace gz;
using namespace gui;

/////////////////////////////////////////////////
Expand Down Expand Up @@ -53,5 +53,5 @@ void HelloPlugin::OnButton()
}

// Register this plugin
IGNITION_ADD_PLUGIN(ignition::gui::HelloPlugin,
ignition::gui::Plugin);
IGNITION_ADD_PLUGIN(gz::gui::HelloPlugin,
gz::gui::Plugin);
2 changes: 1 addition & 1 deletion examples/plugin/hello_plugin/HelloPlugin.hh
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#include <gz/gui/qt.h>
#include <gz/gui/Plugin.hh>

namespace ignition
namespace gz
{
namespace gui
{
Expand Down
6 changes: 3 additions & 3 deletions examples/plugin/multiple_qml/MultipleQml.cc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

#include "MultipleQml.hh"

using namespace ignition;
using namespace gz;
using namespace gui;

/////////////////////////////////////////////////
Expand All @@ -41,5 +41,5 @@ void MultipleQml::OnButton(const QString &_text)
}

// Register this plugin
IGNITION_ADD_PLUGIN(ignition::gui::MultipleQml,
ignition::gui::Plugin);
IGNITION_ADD_PLUGIN(gz::gui::MultipleQml,
gz::gui::Plugin);
2 changes: 1 addition & 1 deletion examples/plugin/multiple_qml/MultipleQml.hh
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#include <gz/gui/Plugin.hh>
#endif

namespace ignition
namespace gz
{
namespace gui
{
Expand Down
10 changes: 5 additions & 5 deletions examples/standalone/custom_drawer/custom_drawer.cc
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@
int main(int _argc, char **_argv)
{
// Increase verboosity so we see all messages
ignition::common::Console::SetVerbosity(4);
gz::common::Console::SetVerbosity(4);

// Initialize app
ignition::gui::Application app(_argc, _argv);
gz::gui::Application app(_argc, _argv);

// Hide original panel
app.LoadConfig("../custom_drawer.config");

// Let QML files use CustomActions' functions and properties
ignition::gui::CustomActions actions;
gz::gui::CustomActions actions;
auto context = new QQmlContext(app.Engine()->rootContext());
context->setContextProperty("CustomActions", &actions);

Expand All @@ -46,15 +46,15 @@ int main(int _argc, char **_argv)
auto item = qobject_cast<QQuickItem *>(component.create(context));
if (!item)
{
ignerr << "Failed to initialize custom panel" << std::endl;
gzerr << "Failed to initialize custom panel" << std::endl;
return 1;
}

// C++ ownership
QQmlEngine::setObjectOwnership(item, QQmlEngine::CppOwnership);

// Add to main window
auto win = app.findChild<ignition::gui::MainWindow *>()->QuickWindow();
auto win = app.findChild<gz::gui::MainWindow *>()->QuickWindow();
auto drawerItem = win->findChild<QQuickItem *>("sideDrawer");

item->setParentItem(drawerItem);
Expand Down
2 changes: 1 addition & 1 deletion examples/standalone/custom_drawer/custom_drawer.hh
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
#include <gz/gui/qt.h>
#endif

namespace ignition
namespace gz
{
namespace gui
{
Expand Down
6 changes: 3 additions & 3 deletions examples/standalone/dialogs/dialogs.cc
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ int main(int _argc, char **_argv)
std::cout << "Hello, GUI!" << std::endl;

// Increase verboosity so we see all messages
ignition::common::Console::SetVerbosity(4);
gz::common::Console::SetVerbosity(4);

// Initialize app
ignition::gui::Application app(_argc, _argv,
ignition::gui::WindowType::kDialog);
gz::gui::Application app(_argc, _argv,
gz::gui::WindowType::kDialog);

// Load plugins / config
app.LoadPlugin("Publisher");
Expand Down
Loading

0 comments on commit cf54ba2

Please sign in to comment.