Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
G
gepetto-viewer-corba
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Gepetto
gepetto-viewer-corba
Commits
e92240e9
Commit
e92240e9
authored
8 years ago
by
Joseph Mirabel
Committed by
Joseph Mirabel
8 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Add more documentation
parent
17de7efe
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
doc/main.hh
+5
-0
5 additions, 0 deletions
doc/main.hh
include/gepetto/gui/doc.hh
+32
-0
32 additions, 0 deletions
include/gepetto/gui/doc.hh
include/gepetto/viewer/corba/doc.hh
+3
-4
3 additions, 4 deletions
include/gepetto/viewer/corba/doc.hh
with
40 additions
and
4 deletions
doc/main.hh
0 → 100644
+
5
−
0
View file @
e92240e9
/// \mainpage Gepetto Viewer user interfaces
///
/// This package provides two compatible interfaces to vizualise robots:
/// \li a \ref gepetto_viewer_corba_introduction "command line interface in Python"
/// \li a \ref gepetto_gui_introduction "graphical user interface" which is fully compatible with the Python interface.
This diff is collapsed.
Click to expand it.
include/gepetto/gui/doc.hh
0 → 100644
+
32
−
0
View file @
e92240e9
/// \page gepetto_gui_introduction Gepetto Gui introduction
///
/// Graphical user interface for the gepetto-viewer package.
///
/// \section gui_using_interface Using the interface
///
/// To start the interface, use
/// \code{bash} gepetto-gui \endcode
///
/// To get some help on the command line options, use
/// \code{bash} gepetto-gui --help \endcode
///
/// \section gui_extending_interface Extending the interface
///
/// There are two ways of extending the interface: Python and C++. Python
/// plugins are easier to write than C++ plugins, but they do not offer
/// full control of the interface (yet).
///
/// \subsection python_plugins Python plugins
///
/// See the documentation of gepetto::gui::PythonWidget to know how to write
/// plugins in Python. You may have a look at the file
/// \ref pyplugins/gepetto/gui/pythonwidget.py which is an example.
///
/// The Python console is a good tool for debugging. The following variables
/// are accessible:
/// \li \c mainWindow: gepetto::gui::MainWindow
/// \li \c osg: the widget responsible for the first created window (class gepetto::gui::OSGWidget)
///
/// \subsection cpp_plugins C++ Plugins
///
/// See documentation of gepetto::gui::PluginInterface, for details on how to write a plugin.
This diff is collapsed.
Click to expand it.
include/gepetto/viewer/corba/doc.hh
+
3
−
4
View file @
e92240e9
/// \mainpage
/// \section gepetto_viewer_corba_introduction
/// \page gepetto_viewer_corba_introduction Gepetto Viewer server
///
/// This package implements a corba server embedding gepetto-viewer library.
///
...
...
@@ -7,9 +6,9 @@
///
/// To use the graphical interface via python,
/// \li start executable
/// \code gepetto-viewer-server \endcode.
/// \code
{bash}
gepetto-viewer-server \endcode.
/// \li in a python terminal, create a client
/// \code
/// \code
{py}
/// from gepetto.corbaserver import Client
/// client = Client ()
/// # open a new window
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment