Skip to content

Commit ae5f747

Browse files
committed
Add tutorial with videos and images
Signed-off-by: methylDragon <[email protected]>
1 parent 2a2c8c2 commit ae5f747

16 files changed

+348
-2
lines changed
Binary file not shown.
Binary file not shown.

doc/how_to_guides/how_to_guides.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Configuring and Using MoveIt
2525
pick_ik/pick_ik_tutorial
2626
trac_ik/trac_ik_tutorial
2727
benchmarking/benchmarking_tutorial
28+
trajectory_cache/trajectory_cache_tutorial
2829

2930
Developing and Documenting MoveIt
3031
---------------------------------
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

doc/how_to_guides/trajectory_cache/src/trajectory_cache_demo.cpp

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,20 @@
5656
*
5757
* NOTE:
5858
* Tutorial notes will be commented like this block!
59-
*
59+
*
6060
* PRE-REQUISITES
6161
* ^^^^^^^^^^^^^^
6262
* This tutorial assumes knowledge of the MoveGroupInterface.
6363
*
6464
* INTERACTIVITY
6565
* ^^^^^^^^^^^^^
66+
* This demo has four phases that can be advanced using the `rviz_visual_tools` dialog box.
67+
*
68+
* 1. Plan and cache (no pruning)
69+
* 2. Plan and cache (with pruning)
70+
* 3. Fetch from cache and execute (while still planning and caching with pruning)
71+
* 4. Fetch from cache and execute, except with large start tolerances
72+
*
6673
* This tutorial also supports "reconfigurable" parameters!:
6774
*
6875
* You can adjust them with:
@@ -71,7 +78,7 @@
7178
* Tutorial parameters:
7279
* - planner:
7380
* Defaults to "RRTstar". The OMPL planner used.
74-
* It's better to use a random-sampling, non-optimal planner to see the cache working.
81+
* It is better to use a random-sampling, non-optimal planner to see the cache working.
7582
*
7683
* Cache parameters:
7784
* - start_tolerance:
@@ -648,6 +655,19 @@ int main(int argc, char** argv)
648655

649656
// Interactivity. ================================================================================
650657

658+
/** [TUTORIAL NOTE]
659+
* This demo has four phases that can be advanced using the `rviz_visual_tools` dialog box.
660+
*
661+
* 1. Plan and cache (no pruning)
662+
* - Showcases basic cache functionality.
663+
* 2. Plan and cache (with pruning)
664+
* - Showcases pruning functionality.
665+
* 3. Fetch from cache and execute (while still planning and caching with pruning)
666+
* - Showcases cache fetches.
667+
* 4. Fetch from cache and execute, except with large start tolerances
668+
* - Showcases fuzzy matching, and the impact of start tolerance.
669+
*/
670+
651671
std::atomic<size_t> demo_phase = 0;
652672
std::atomic<bool> run_execute = false;
653673

doc/how_to_guides/trajectory_cache/trajectory_cache_tutorial.rst

Lines changed: 325 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)