Skip to content

Commit

Permalink
Merge bd35ed1 into 1c0381d
Browse files Browse the repository at this point in the history
  • Loading branch information
chapulina authored Sep 24, 2021
2 parents 1c0381d + bd35ed1 commit 6a3620c
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 21 deletions.
3 changes: 3 additions & 0 deletions Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ since pose information is being logged in the `changed_state` topic.
+ `TransformControl`: Translate and rotate
+ `ViewAndle`: Move camera to preset angles

* The `gui.config` and `server.config` files are now located in a versioned
folder inside `$HOME/.ignition/gazebo`, i.e. `$HOME/.ignition/gazebo/6/gui.config`.

## Ignition Gazebo 4.x to 5.x

* Use `cli` component of `ignition-utils1`.
Expand Down
2 changes: 1 addition & 1 deletion src/ServerConfig.cc
Original file line number Diff line number Diff line change
Expand Up @@ -877,7 +877,7 @@ ignition::gazebo::loadPluginInfo(bool _isPlayback)
std::string defaultConfigDir;
ignition::common::env(IGN_HOMEDIR, defaultConfigDir);
defaultConfigDir = ignition::common::joinPaths(defaultConfigDir, ".ignition",
"gazebo");
"gazebo", IGNITION_GAZEBO_MAJOR_VERSION_STR);

auto defaultConfig = ignition::common::joinPaths(defaultConfigDir,
configFilename);
Expand Down
4 changes: 2 additions & 2 deletions src/cmd/ign.cc
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ extern "C" int runGui(const char *_guiConfig)
std::string defaultConfig;
ignition::common::env(IGN_HOMEDIR, defaultConfig);
defaultConfig = ignition::common::joinPaths(defaultConfig, ".ignition",
"gazebo", "gui.config");
"gazebo", IGNITION_GAZEBO_MAJOR_VERSION_STR, "gui.config");
app.SetDefaultConfigPath(defaultConfig);

// Customize window
Expand Down Expand Up @@ -418,7 +418,7 @@ extern "C" int runGui(const char *_guiConfig)
}
}

// Also set ~/.ignition/gazebo/gui.config as the default path
// Also set ~/.ignition/gazebo/ver/gui.config as the default path
if (!app.LoadConfig(defaultConfig))
{
ignerr << "Failed to load config file[" << _guiConfig << "]."
Expand Down
4 changes: 2 additions & 2 deletions src/gui/Gui.cc
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ std::unique_ptr<ignition::gui::Application> createGui(
}
ignition::common::env(IGN_HOMEDIR, defaultConfig);
defaultConfig = ignition::common::joinPaths(defaultConfig, ".ignition",
"gazebo", defaultGuiConfigName);
"gazebo", IGNITION_GAZEBO_MAJOR_VERSION_STR, defaultGuiConfigName);
}
else
{
Expand Down Expand Up @@ -279,7 +279,7 @@ std::unique_ptr<ignition::gui::Application> createGui(
}
}

// Also set ~/.ignition/gazebo/gui.config as the default path
// Also set ~/.ignition/gazebo/ver/gui.config as the default path
if (!app->LoadConfig(defaultConfig))
{
ignerr << "Failed to load config file[" << defaultConfig << "]."
Expand Down
13 changes: 7 additions & 6 deletions tutorials/gui_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,16 @@ There are a few places where the GUI configuration can come from:

1. A file passed to the `--gui-config` command line argument
2. A `<gui>` element inside an SDF file
3. The default configuration file at `$HOME/.ignition/gazebo/gui.config` \*
3. The default configuration file at `$HOME/.ignition/gazebo/<#>/gui.config` \*,
where `<#>` is Gazebo's major version.

Each of the items above takes precedence over the ones below it. For example,
if a user chooses a `--gui-config`, the SDF's `<gui>` element is ignored. And
the default configuration file is only loaded if no configuration is passed
through the command line or the SDF file.

> \* For log-playback, the default file is
> `$HOME/.ignition/gazebo/playback_gui.config`
> `$HOME/.ignition/gazebo/<#>/playback_gui.config`
## Try it out

Expand All @@ -39,7 +40,7 @@ You should see an empty world with several plugins loaded by default, such as th

By default, you're loading this file:

`$HOME/.ignition/gazebo/gui.config`
`$HOME/.ignition/gazebo/<#>/gui.config`

That file is created the first time you load Ignition Gazebo. Once it is
created, Ignition will never write to it again unless you delete it. This
Expand All @@ -50,7 +51,7 @@ Let's try customizing it:

1. Open this file with your favorite editor:

`$HOME/.ignition/gazebo/gui.config`
`$HOME/.ignition/gazebo/<#>/gui.config`

2. Change `material_theme` from `Light` to `Dark`

Expand All @@ -67,7 +68,7 @@ provided by Ignition (when you update to a newer version for example). In
that case, just delete that file, and the next time Gazebo is started a new file
will be created with default values:

`rm $HOME/.ignition/gazebo/gui.config`
`rm $HOME/.ignition/gazebo/<#>/gui.config`

### SDF

Expand Down Expand Up @@ -168,7 +169,7 @@ hand, we'll create it from the UI.
3. Gazebo should open with your custom layout.

**Tip**: From the top-left menu, you can choose "Save client configuration" to
save directly to `$HOME/.ignition/gazebo/gui.config`.
save directly to `$HOME/.ignition/gazebo/<#>/gui.config`.

@image html files/gui_config/cmd_line.png

Expand Down
4 changes: 2 additions & 2 deletions tutorials/migration_sdf.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,8 +259,8 @@ and [xacro](http://wiki.ros.org/xacro) to generate SDF files with the correct pl

Ignition Gazebo is more modular than Gazebo classic, so most features are optional.
For example, by default, Ignition will load all the system plugins defined on
the `~/.ignition/gazebo/server.config` file and all GUI plugins defined on the
`~/.ignition/gazebo/gui.config` file. But the user can always remove plugins from
the `~/.ignition/gazebo/<#>/server.config` file and all GUI plugins defined on the
`~/.ignition/gazebo/<#>/gui.config` file. But the user can always remove plugins from
those files, or choose different ones by adding `<plugin>` tags to the SDF file.
(For more details, see the [Server configuration tutorial](server_config.html)
and the [GUI configuration tutorial](gui_config.html)).
Expand Down
2 changes: 1 addition & 1 deletion tutorials/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ can come from the following, in order:

1. The command line option `--gui-config <file path>`
2. Plugins within SDF's `<world><gui>`
3. `$HOME/.ignition/gazebo/gui.config` (if that file doesn't
3. `$HOME/.ignition/gazebo/<#>/gui.config` (if that file doesn't
exist, the default `gui.config` file that is installed with Ignition Gazebo
will be copied to that location)

11 changes: 6 additions & 5 deletions tutorials/server_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ There are a few places where the plugins can be defined:

1. `<plugin>` elements inside an SDF file.
2. File path defined by the `IGN_GAZEBO_SERVER_CONFIG_PATH` environment variable.
3. The default configuration file at `$HOME/.ignition/gazebo/server.config` \*
3. The default configuration file at `$HOME/.ignition/gazebo/<#>/server.config` \*,
where `<#>` is Gazebo's major version.

Each of the items above takes precedence over the ones below it. For example,
if a the SDF file has any `<plugin>` elements, then the
Expand All @@ -23,7 +24,7 @@ file is only loaded if no plugins are passed through the SDF file or the
environment variable.

> \* For log-playback, the default file is
> `$HOME/.ignition/gazebo/playback_gui.config`
> `$HOME/.ignition/gazebo/<#>/playback_server.config`
## Try it out

Expand All @@ -48,7 +49,7 @@ broadcaster is loaded.

By default, you're loading this file:

`$HOME/.ignition/gazebo/server.config`
`$HOME/.ignition/gazebo/<#>/server.config`

That file is created the first time you load Ignition Gazebo. Once it is
created, Ignition will never write to it again unless you delete it. This
Expand All @@ -59,7 +60,7 @@ Let's try customizing it:

1. Open this file with your favorite editor:

`$HOME/.ignition/gazebo/server.config`
`$HOME/.ignition/gazebo/<#>/server.config`

2. Remove the `<plugin>` block for the physics system

Expand All @@ -77,7 +78,7 @@ provided by Ignition (when you update to a newer version for example). In
that case, just delete that file, and the next time Gazebo is started a new file
will be created with default values:

`rm $HOME/.ignition/gazebo/server.config`
`rm $HOME/.ignition/gazebo/<#>/server.config`

### SDF

Expand Down
4 changes: 2 additions & 2 deletions tutorials/video_recorder.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ in the world SDF file so you will need to download a copy of the
and modify the GUI configuration in that file. On the other hand, if you
launched Ignition Gazebo with a world file that does not have GUI
configurations, you will need to specify the settings in
`$HOME/.ignition/gazebo/gui.config`.
`$HOME/.ignition/gazebo/<#>/gui.config`.

Recall that videos are recorded from the 3D scene, we will to set the video
configurations in the 3D scene plugin. Here is an example of the
Expand Down Expand Up @@ -105,7 +105,7 @@ going to the world SDF file, locate the

* **bitrate**: Video encoding bitrate in bps. This affects the quality of the
generated video. The default bitrate is 2Mbps.

## Hardware-accelerated encoding

Since Ignition Common 3.10.2, there is support for utilizing the power of GPUs
Expand Down

0 comments on commit 6a3620c

Please sign in to comment.