Skip to content

Commit 6343a94

Browse files
committed
Add editor and viewer guidelines
1 parent 135c691 commit 6343a94

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

docs/use_editor.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
URDF Editor
2+
===========
3+
4+
To open the text editor for any URDF file, simply right click on the file and
5+
from the menu select "Open With" :math:`\rightarrow` "Editor".
6+
7+
.. image:: _static/openEditor.png
8+
:alt: Right click opens editor option

docs/use_viewer.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
URDF Viewer
2+
===========
3+
4+
The simplest way to open the viewer is by double clicking on any already
5+
existing URDF file from the File Browser. New files can also be created from the
6+
top menu or from the launcher.
7+
8+
With the URDF editor open, files can be modified directly and the changes will
9+
be immediately reflected in the viewer.
10+
11+
.. image:: _static/urdfEditor.gif
12+
:alt: URDF live editor gif
13+
14+
The viewer provides a control panel to manually modify the joint positions.
15+
16+
.. note::
17+
The changes are only reflected in the viewer and are not saved to the URDF
18+
file.
19+
20+
.. image:: _static/urdfControls.gif
21+
:alt: Gif moving the robot joints from the panel
22+
23+
Only revolute and prismatic joints will be included in the panel, fixed joints
24+
are automatically ignored. Each joint must have upper and lower joint limits to
25+
be displayed on the control panel.

0 commit comments

Comments
 (0)