Skip to content
Snippets Groups Projects
Commit 66debc82 authored by Joseph Mirabel's avatar Joseph Mirabel
Browse files

Fix documentation.

parent d7b7cb59
No related branches found
No related tags found
No related merge requests found
FILE_PATTERNS = *.idl *.hh *.py *.idl *.dox FILE_PATTERNS = *.idl *.hh *.py *.idl
INPUT = @CMAKE_SOURCE_DIR@/include \ INPUT = @CMAKE_SOURCE_DIR@/include \
@CMAKE_SOURCE_DIR@/idl \ @CMAKE_SOURCE_DIR@/idl \
@CMAKE_SOURCE_DIR@/plugins \ @CMAKE_SOURCE_DIR@/plugins \
@CMAKE_SOURCE_DIR@/pyplugins \
@CMAKE_SOURCE_DIR@/src/gepetto\ @CMAKE_SOURCE_DIR@/src/gepetto\
@CMAKE_SOURCE_DIR@/doc @CMAKE_SOURCE_DIR@/doc
EXAMPLE_PATH = @CMAKE_SOURCE_DIR@/examples EXAMPLE_PATH = @CMAKE_SOURCE_DIR@/examples
LAYOUT_FILE = @CMAKE_SOURCE_DIR@/doc/layout.xml
TAGFILES += @QT_TAGFILES@
/** /**
\mainpage Gepetto Viewer \mainpage CORBA interface of Gepetto Viewer
This package provides a graphical user interface to visualize robots. There are This package implements a CORBA interface to \ref gepetto_viewer_index_html "gepetto-viewer".
two compatible interfaces to interact with the interface. Refers to its doc for further details on the interface itself.
\li the CORBA interface with Python and C++ clients.
\li the graphical user interface.
To start the interface, use \par Basic usage
\code{bash} gepetto-gui \endcode
To get some help on the command line options, use The IDL interface of the viewer is defined by gepetto::corbaserver::GraphicalInterface.
\code{bash} gepetto-gui --help \endcode
To get command line completion for `gepetto-gui` command, see package
https://github.com/humanoid-path-planner/hpp-tools.
\section gepetto_gui_corba CORBA interface
The IDL interface of the server is defined by gepetto::corbaserver::GraphicalInterface.
To create a client to the interface, you may use the following code.
\code{py} \code{py}
from gepetto.corbaserver import Client from gepetto.corbaserver import gui_client
client = Client () # Create a client to the GUI, a window name "w" and a group node "w".
# open a new window # dont_raise if the GUI is not available (in which case gui will be None).
client.gui.createWindow ("w") gui = gui_client(windowName = "w", dont_raise=True)
# refer to the idl interface to control gepetto-viewer. # refer to the idl interface to control gepetto-viewer.
\endcode \endcode
\section gepetto_gui_ui Graphical user interface Extra features can be found in gepetto.corbaserver.tools.
\par Configuration files
The interface can be customized using a few setting files.
See gepetto::gui::Settings::readSettingFile for more details on configuration files.
To generate a new configuration use:
\code{bash} gepetto-gui -c newConfigName -g \endcode
To use the configuration *config*:
\code{bash} gepetto-gui -c newConfigName \endcode
\par 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).
See the \ref pluginlist for some examples.
Building and installing plugins is made easy with \ref gepetto_viewer_corba_cmake_macros.
- *Python plugins*
See the documentation of gepetto::gui::PythonWidget for instructions
and examples of Python plugin usage.
The Python console is a good tool for debugging. The following variables
are accessible:
+ \c mainWindow: gepetto::gui::MainWindow
+ \c osg: the widget responsible for the first created window (class gepetto::gui::OSGWidget)
- *C++ Plugin*
See documentation of gepetto::gui::PluginInterface, for details on how to write a plugin.
\defgroup pluginlist List of available plugins
This is the list of available plugins. See each plugin to know how to activate it.
\defgroup plugin Plugin interfaces
\{
Interface of C++ and Python plugins.
\defgroup plugin_cpp C++ Plugin API
Descriptions of the available interfaces.
\defgroup plugin_python Python plugin API
These slots are available for Python scripting in plugins.
\}
*/ */
This diff is collapsed.
...@@ -162,6 +162,10 @@ class Vector6: ...@@ -162,6 +162,10 @@ class Vector6:
## - Vector6.linF ## - Vector6.linF
## - Vector6.angF ## - Vector6.angF
## \param groupName name of an **existing** group ## \param groupName name of an **existing** group
## \param angFactor the norm of the angular part of the vector is divided by
## this value
## \param linFactor the norm of the linear part of the vector is divided by
## this value
def __init__ (self, groupName, angFactor = pi, linFactor = 1.): def __init__ (self, groupName, angFactor = pi, linFactor = 1.):
self.name = groupName self.name = groupName
## The Linear part ## The Linear part
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment