README.md 2.3 KB
Newer Older
Joseph Mirabel's avatar
Joseph Mirabel committed
1
2
# hpp-gui

Guilhem Saurel's avatar
Guilhem Saurel committed
3
4
[![Pipeline status](https://gepgitlab.laas.fr/humanoid-path-planner/hpp-gui/badges/master/pipeline.svg)](https://gepgitlab.laas.fr/humanoid-path-planner/hpp-gui/commits/master)
[![Coverage report](https://gepgitlab.laas.fr/humanoid-path-planner/hpp-gui/badges/master/coverage.svg?job=doc-coverage)](http://projects.laas.fr/gepetto/doc/humanoid-path-planner/hpp-gui/master/coverage/)
Joseph Mirabel's avatar
Joseph Mirabel committed
5
6
[![Build Status](https://travis-ci.org/jmirabel/hpp-gui.svg?branch=master)](https://travis-ci.org/jmirabel/hpp-gui)

heidydallard's avatar
heidydallard committed
7
**hpp-gui** is a set of plugins to integrate [HPP] inside `gepetto-gui`, which comes with the `gepetto-viewer-corba` package.
Joseph Mirabel's avatar
Joseph Mirabel committed
8

heidydallard's avatar
heidydallard committed
9
The plugin `hppcorbaserverplugin` create an instance of [hpp-corbaserver] at the gui start.
Joseph Mirabel's avatar
Joseph Mirabel committed
10

heidydallard's avatar
heidydallard committed
11
The plugin `hppwidgetsplugin` add a lot of widgets to define a problem.
Joseph Mirabel's avatar
Joseph Mirabel committed
12

heidydallard's avatar
heidydallard committed
13
The plugin `hppmanipulationwidgetsplugin` do the same things as `hppwidgetsplugin` but for the manipulation part of [HPP].
Joseph Mirabel's avatar
Joseph Mirabel committed
14
15
16
17

## Installation procedure
There are a few dependencies to be installed before installing *hpp-gui*.

Joseph Mirabel's avatar
Joseph Mirabel committed
18
19
### Dependencies
There are a few required dependencies and several optional ones.
Joseph Mirabel's avatar
Joseph Mirabel committed
20
You must install [HPP]. You will find the installation procedure in the [hpp-doc] github page.
heidydallard's avatar
heidydallard committed
21
You must also install `gepetto-gui` from [gepetto-viewer-corba].
Joseph Mirabel's avatar
Joseph Mirabel committed
22
23

This package depends on:
heidydallard's avatar
heidydallard committed
24
* [gepetto-viewer-corba] - contains `gepetto-gui`.
Joseph Mirabel's avatar
Joseph Mirabel committed
25
* [hpp-corbaserver] - comes with the [HPP] framework.
heidydallard's avatar
heidydallard committed
26
* [hpp-manipulation-corba] - comes with [HPP] framework.
Joseph Mirabel's avatar
Joseph Mirabel committed
27

Joseph Mirabel's avatar
Joseph Mirabel committed
28
29
The following packages are optional:
* [remoteimu] - enables controlling a robot body orientation with an IMU (typically, in a smart phone).
Joseph Mirabel's avatar
Joseph Mirabel committed
30

Joseph Mirabel's avatar
Joseph Mirabel committed
31
32
33
Other plugins can be found in the package [hpp-plot].

### Installation of *hpp-gui*
Joseph Mirabel's avatar
Joseph Mirabel committed
34
35
36
37
38
39
40
41
42
The installation procedure is a classic `cmake` installation.

```sh
git clone https://github.com/jmirabel/hpp-gui.git
mkdir hpp-gui/build && cd hpp-gui/build
cmake ..
make install
```

Joseph Mirabel's avatar
Joseph Mirabel committed
43
## Version
Joseph Mirabel's avatar
Joseph Mirabel committed
44
0.1
Joseph Mirabel's avatar
Joseph Mirabel committed
45
46
47

[HPP]:http://projects.laas.fr/gepetto/index.php/Software/Hpp
[hpp-corbaserver]:https://github.com/humanoid-path-planner/hpp-corbaserver
heidydallard's avatar
heidydallard committed
48
[hpp-manipulation-corba]:https://github.com/humanoid-path-planner/hpp-manipulation-corba
Joseph Mirabel's avatar
Joseph Mirabel committed
49
50
[gepetto-viewer-corba]:https://github.com/humanoid-path-planner/gepetto-viewer-corba
[hpp-doc]:https://github.com/humanoid-path-planner/hpp-doc
Joseph Mirabel's avatar
Joseph Mirabel committed
51
[remoteimu]:https://github.com/jmirabel/remoteimu
Joseph Mirabel's avatar
Joseph Mirabel committed
52
[hpp-plot]:https://github.com/jmirabel/hpp-plot