Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update name and logo on UI, examples and API docs #398

Merged
merged 2 commits into from
May 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
This directory contains examples which are not shipped with Ignition GUI
This directory contains examples which are not shipped with Gazebo GUI

# Standalone

Examples of how to build and run standalone applications which use
Ignition-GUI as a library
Gazebo GUI as a library

# Plugin

Examples of how to build plugins which can then be used with Ignition GUI's
Examples of how to build plugins which can then be used with Gazebo GUI's
command line tool, or used by standalone applications.

# Config

Example configuration files which can be used with Ignition GUI's command
Example configuration files which can be used with Gazebo GUI's command
line tool or with standalone applications

2 changes: 1 addition & 1 deletion examples/config/plugin_params.config
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<plugin filename="Publisher">
<!--
All elements within <ignition-gui> are parsed by Ignition GUI and common to
All elements within <ignition-gui> are parsed by Gazebo GUI and common to
all plugins.
-->
<ignition-gui>
Expand Down
2 changes: 1 addition & 1 deletion examples/plugin/custom_context_menu/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ find_package (Qt5
REQUIRED
)

# Find the Ignition gui library
# Find the Gazebo GUI library
find_package(ignition-gui7 REQUIRED)
find_package(ignition-common5 REQUIRED)

Expand Down
2 changes: 1 addition & 1 deletion examples/plugin/dialog_from_plugin/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ find_package (Qt5
REQUIRED
)

# Find the Ignition gui library
# Find the Gazebo GUI library
find_package(ignition-gui7 REQUIRED)
find_package(ignition-common5 REQUIRED)

Expand Down
2 changes: 1 addition & 1 deletion examples/plugin/hello_plugin/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ find_package (Qt5
REQUIRED
)

# Find the Ignition gui library
# Find the Gazebo GUI library
find_package(ignition-gui7 REQUIRED)
find_package(ignition-common5 REQUIRED)

Expand Down
2 changes: 1 addition & 1 deletion examples/plugin/hello_plugin/HelloPlugin.hh
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ namespace ignition
/// \brief Destructor
public: virtual ~HelloPlugin();

/// \brief Called by Ignition GUI when plugin is instantiated.
/// \brief Called by Gazebo GUI when plugin is instantiated.
/// \param[in] _pluginElem XML configuration for this plugin.
public: virtual void LoadConfig(const tinyxml2::XMLElement *_pluginElem)
override;
Expand Down
2 changes: 1 addition & 1 deletion examples/plugin/ign_components/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Demo of QML components provided by Ignition GUI which can be
Demo of QML components provided by Gazebo GUI which can be
useful for downstream developers.

## Build
Expand Down
2 changes: 1 addition & 1 deletion examples/plugin/multiple_qml/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ find_package (Qt5
REQUIRED
)

# Find the Ignition gui library
# Find the Gazebo GUI library
find_package(ignition-gui7 REQUIRED)
find_package(ignition-common5 REQUIRED)

Expand Down
2 changes: 1 addition & 1 deletion examples/standalone/custom_drawer/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ find_package (Qt5
REQUIRED
)

# Find the Ignition gui library
# Find the Gazebo GUI library
find_package(ignition-gui7 REQUIRED)

QT5_ADD_RESOURCES(resources_RCC custom_drawer.qrc)
Expand Down
2 changes: 1 addition & 1 deletion examples/standalone/custom_drawer/CustomDrawer.qml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Rectangle {
actionElement: "cppActionFromQml"
}

// Actions provided by Ignition GUI, with custom titles
// Actions provided by Gazebo GUI, with custom titles
ListElement {
title: "Call default action (Style)"
actionElement: "styleSettings"
Expand Down
2 changes: 1 addition & 1 deletion examples/standalone/dialogs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ find_package (Qt5
REQUIRED
)

# Find the Ignition gui library
# Find the Gazebo GUI library
find_package(ignition-gui7 REQUIRED)

set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${IGNITION-GUI_CXX_FLAGS}")
Expand Down
6 changes: 3 additions & 3 deletions examples/standalone/marker/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Ignition Visualization Marker Example
# Gazebo Visualization Marker Example

This example demonstrates how to create, modify, and delete visualization
markers in Ignition GUI.
markers in Gazebo GUI.

## Build Instructions

Expand All @@ -19,4 +19,4 @@ Launch ign gazebo unpaused then from the build directory above:
./marker

The terminal will output messages indicating visualization changes that
will occur in Ignition GUI's render window.
will occur in Gazebo GUI's render window.
4 changes: 2 additions & 2 deletions examples/standalone/scene_provider/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## Scene provider

This example demonstrates how to populate and update a 3D scene using
Ignition Transport.
Gazebo Transport.

This example is meant to be used with `examples/config/scened.config`, which
loads the `Scene3D` plugin to create the scene, and the `TransportSceneManager`
plugin to update the scene using Ignition Transport.
plugin to update the scene using Gazebo Transport.

## Build

Expand Down
2 changes: 1 addition & 1 deletion examples/standalone/window/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ find_package (Qt5
REQUIRED
)

# Find the Ignition gui library
# Find the Gazebo GUI library
find_package(ignition-gui7 REQUIRED)

set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${IGNITION-GUI_CXX_FLAGS}")
Expand Down
4 changes: 2 additions & 2 deletions include/gz/gui/Application.hh
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ namespace ignition
kDialog = 1
};

/// \brief An Ignition GUI application loads a QML engine and
/// \brief A Gazebo GUI application loads a QML engine and
/// provides an API to load plugins and configuration files. The application
/// supports either running a single main window or several plugins as
/// standalone dialogs.
Expand Down Expand Up @@ -139,7 +139,7 @@ namespace ignition
/// 1. Paths given by the environment variable
/// 2. Paths added by calling addPluginPath
/// 3. Path ~/.gz/gui/plugins
/// 4. The path where Ignition GUI plugins are installed
/// 4. The path where Gazebo GUI plugins are installed
///
/// \return A vector of pairs, where each pair contains:
/// * A path
Expand Down
30 changes: 15 additions & 15 deletions include/gz/gui/Conversions.hh
Original file line number Diff line number Diff line change
Expand Up @@ -44,62 +44,62 @@ namespace ignition
namespace gui
{
/// \brief Return the equivalent Qt color
/// \param[in] _color Ignition color to convert
/// \param[in] _color Gazebo color to convert
/// \return Qt color value
IGNITION_GUI_VISIBLE
QColor convert(const math::Color &_color);

/// \brief Return the equivalent Ignition color
/// \brief Return the equivalent Gazebo color
/// \param[in] _color Qt color to convert
/// \return Ignition color value
/// \return Gazebo color value
IGNITION_GUI_VISIBLE
math::Color convert(const QColor &_color);

/// \brief Return the equivalent QPointF.
/// \param[in] _pt Ignition vector to convert.
/// \param[in] _pt Gazebo vector to convert.
/// \return QPointF.
IGNITION_GUI_VISIBLE
QPointF convert(const math::Vector2d &_pt);

/// \brief Return the equivalent Ignition vector.
/// \brief Return the equivalent Gazebo vector.
/// \param[in] _pt QPointF to convert
/// \return Ignition Vector2d.
/// \return Gazebo Vector2d.
IGNITION_GUI_VISIBLE
math::Vector2d convert(const QPointF &_pt);

/// \brief Return the equivalent Qt vector 3d.
/// \param[in] _vec Ignition vector 3d to convert.
/// \param[in] _vec Gazebo vector 3d to convert.
/// \return Qt vector 3d value.
IGNITION_GUI_VISIBLE
QVector3D convert(const math::Vector3d &_vec);

/// \brief Return the equivalent Ignition vector 3d.
/// \brief Return the equivalent Gazebo vector 3d.
/// \param[in] _vec Qt vector 3d to convert.
/// \return Ignition vector 3d value
/// \return Gazebo vector 3d value
IGNITION_GUI_VISIBLE
math::Vector3d convert(const QVector3D &_vec);

/// \brief Return the equivalent Ignition mouse event.
/// \brief Return the equivalent Gazebo mouse event.
///
/// Note that there isn't a 1-1 mapping between these types, so fields such
/// as common::MouseEvent::PressPos need to be set afterwards.
/// \param[in] _e Qt mouse event
/// \return Ignition mouse event
/// \return Gazebo mouse event
IGNITION_GUI_VISIBLE
common::MouseEvent convert(const QMouseEvent &_e);

/// \brief Return the equivalent Ignition mouse event.
/// \brief Return the equivalent Gazebo mouse event.
///
/// Note that there isn't a 1-1 mapping between these types.
/// \param[in] _e Qt wheel event
/// \return Ignition mouse event
/// \return Gazebo mouse event
IGNITION_GUI_VISIBLE
common::MouseEvent convert(const QWheelEvent &_e);

/// \brief Return the equivalent ignition key event.
/// \brief Return the equivalent Gazebo key event.
///
/// \param[in] _e Qt key event
/// \return Ignition key event
/// \return Gazebo key event
IGNITION_GUI_VISIBLE
common::KeyEvent convert(const QKeyEvent &_e);
}
Expand Down
4 changes: 2 additions & 2 deletions include/gz/gui/Helpers.hh
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ namespace ignition

/// \brief Import path for ign-gui QML modules added to the Qt resource
/// system. This helper function returns the QRC resource path where custom
/// ignition QML modules can be imported from. To import an ignition QML
/// Gazebo QML modules can be imported from. To import a Gazebo QML
/// module, add this path to the QML engine's import path list before
/// attempting to load a QML file that imports ignition QML modules.
/// attempting to load a QML file that imports Gazebo QML modules.
/// \return Resousrce path prefix as a string
IGNITION_GUI_VISIBLE
const QString qmlQrcImportPath();
Expand Down
4 changes: 2 additions & 2 deletions include/gz/gui/Plugin.hh
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ namespace ignition
{
class PluginPrivate;

/// \brief Base class for Ignition GUI plugins.
/// \brief Base class for Gazebo GUI plugins.
///
/// When inheriting from this plugin, the following are assumed:
///
Expand Down Expand Up @@ -127,7 +127,7 @@ namespace ignition
protected: std::string configStr;

/// \brief Load configuration which is common to all plugins and handled
/// by Ignition GUI.
/// by Gazebo GUI.
/// \details Called when a plugin is first created.
/// \sa LoadConfig
/// \param[in] _ignGuiElem <ignition-gui> element within the <plugin>.
Expand Down
2 changes: 1 addition & 1 deletion include/gz/gui/config.hh.in
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#define IGNITION_GUI_VERSION "${PROJECT_VERSION}"
#define IGNITION_GUI_VERSION_FULL "${PROJECT_VERSION_FULL}"

#define IGNITION_GUI_VERSION_HEADER "Ignition ${IGN_DESIGNATION}, version ${PROJECT_VERSION_FULL}\nCopyright (C) 2017 Open Source Robotics Foundation.\nReleased under the Apache 2.0 License.\n\n"
#define IGNITION_GUI_VERSION_HEADER "Gazebo ${IGN_DESIGNATION}, version ${PROJECT_VERSION_FULL}\nCopyright (C) 2017 Open Source Robotics Foundation.\nReleased under the Apache 2.0 License.\n\n"
chapulina marked this conversation as resolved.
Show resolved Hide resolved

#cmakedefine BUILD_TYPE_PROFILE 1
#cmakedefine BUILD_TYPE_DEBUG 1
Expand Down
4 changes: 2 additions & 2 deletions include/gz/gui/qml/Main.qml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import "qrc:/qml"

ApplicationWindow
{
title: qsTr("Ignition GUI")
title: qsTr("Gazebo GUI")
width: 1200
height: 1000
minimumWidth: 300
Expand Down Expand Up @@ -255,7 +255,7 @@ ApplicationWindow
id: aboutDialog
modal: true
focus: true
title: "Ignition GUI"
title: "Gazebo GUI"
x: (window.width - width) / 2
y: window.height / 6
width: Math.min(window.width, window.height) / 3 * 2
Expand Down
Binary file added include/gz/gui/qml/images/gazebo_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed include/gz/gui/qml/images/ignition_logo_50x50.png
Binary file not shown.
2 changes: 1 addition & 1 deletion include/gz/gui/resources.qrc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<file>qml/StandaloneDialog.qml</file>
<file>qml/StyleDialog.qml</file>

<file>qml/images/ignition_logo_50x50.png</file>
<file>qml/images/gazebo_logo.png</file>
<file>qml/images/drawer.png</file>
<file>qml/images/menu.png</file>
<file>qml/images/export_icon.png</file>
Expand Down
4 changes: 2 additions & 2 deletions include/ignition/gui/qml/Main.qml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import "qrc:/qml"

ApplicationWindow
{
title: qsTr("Ignition GUI")
title: qsTr("Gazebo GUI")
width: 1200
height: 1000
minimumWidth: 300
Expand Down Expand Up @@ -255,7 +255,7 @@ ApplicationWindow
id: aboutDialog
modal: true
focus: true
title: "Ignition GUI"
title: "Gazebo GUI"
x: (window.width - width) / 2
y: window.height / 6
width: Math.min(window.width, window.height) / 3 * 2
Expand Down
Binary file not shown.
2 changes: 1 addition & 1 deletion include/ignition/gui/resources.qrc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<file>qml/StandaloneDialog.qml</file>
<file>qml/StyleDialog.qml</file>

<file>qml/images/ignition_logo_50x50.png</file>
<file>qml/images/gazebo_logo.png</file>
<file>qml/images/drawer.png</file>
<file>qml/images/menu.png</file>
<file>qml/images/export_icon.png</file>
Expand Down
6 changes: 3 additions & 3 deletions src/Application.cc
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ Application::Application(int &_argc, char **_argv, const WindowType _type)
{
igndbg << "Initializing application." << std::endl;

this->setOrganizationName("Ignition");
this->setOrganizationDomain("ignitionrobotics.org");
this->setApplicationName("Ignition GUI");
this->setOrganizationName("Gazebo");
this->setOrganizationDomain("gazebosim.org");
this->setApplicationName("Gazebo GUI");

#if __APPLE__
// Use the Metal graphics API on macOS.
Expand Down
12 changes: 6 additions & 6 deletions src/Conversions_TEST.cc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ using namespace gui;
/////////////////////////////////////////////////
TEST(ConversionsTest, Color)
{
// Ignition to Qt to Ignition
// Gazebo to Qt to Gazebo
{
double red = 0.1;
double green = 0.3;
Expand All @@ -48,7 +48,7 @@ TEST(ConversionsTest, Color)
EXPECT_NEAR(newColor.A(), newColor.A(), tol);
}

// Qt to Ignition to Qt
// Qt to Gazebo to Qt
{
int red = 100;
int green = 150;
Expand All @@ -66,13 +66,13 @@ TEST(ConversionsTest, Point2d)
double x = -0.5;
double y = 123;

// Ignition to Qt to Ignition
// Gazebo to Qt to Gazebo
{
math::Vector2d point(x, y);
EXPECT_EQ(convert(convert(point)), point);
}

// Qt to Ignition to Qt
// Qt to Gazebo to Qt
{
QPointF point(x, y);
EXPECT_EQ(convert(convert(point)), point);
Expand All @@ -86,13 +86,13 @@ TEST(ConversionsTest, Vector3d)
double y = 0;
double z = 1234;

// Ignition to Qt to Ignition
// Gazebo to Qt to Gazebo
{
math::Vector3d vec(x, y, z);
EXPECT_EQ(convert(convert(vec)), vec);
}

// Qt to Ignition to Qt
// Qt to Gazebo to Qt
{
QVector3D vec(x, y, z);
EXPECT_EQ(convert(convert(vec)), vec);
Expand Down
Loading