# moveit_visual_tools
**Repository Path**: kay2020/moveit_visual_tools
## Basic Information
- **Project Name**: moveit_visual_tools
- **Description**: moveit_visual_tools
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-09-16
- **Last Updated**: 2022-09-16
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# MoveIt Visual Tools
Helper functions for displaying and debugging MoveIt data in Rviz via published markers, trajectories, and MoveIt collision objects. It is sometimes hard to understand everything that is going on internally with MoveIt, but using these quick convenience functions allows one to easily visualize their code. This package is built in top of [rviz_visual_tools](https://github.com/davetcoleman/rviz_visual_tools) and all those features are included via class inheritance.
This package helps you visualize:
- Basic Rviz geometric shapes
- MoveIt collision objects
- MoveIt and ROS trajectories
- Robot states
- End effectors
- Interactive markers to move robot arms using IK from remote applications
This open source project was developed at [PickNik Robotics](https://picknik.ai/). Need professional ROS development and consulting? Contact us at projects@picknik.ai for a free consultation.
## Status:
* [](https://github.com/ros-planning/moveit_visual_tools/actions/workflows/format.yaml?branch=master) [](https://github.com/ros-planning/moveit_visual_tools/actions/workflows/industrial_ci_action.yaml?branch=master) GitHub Actions
* [](http://build.ros.org/view/Kbin_uX64/job/Kbin_uX64__moveit_visual_tools__ubuntu_xenial_amd64__binary/) ROS Buildfarm - AMD64 Xenial Debian Build - Ubuntu 16.04 LTS
* [](http://build.ros.org/view/Kdev/job/Kdev__moveit_visual_tools__ubuntu_xenial_amd64/) ROS Buildfarm - AMD64 Xenial Devel Build - Ubuntu 16.04 LTS
* [](http://build.ros.org/job/Msrc_uB__moveit_visual_tools__ubuntu_bionic__source/) ROS Buildfarm - AMD64 Bionic Source Build - Ubuntu 18.04 LTS
* [](http://build.ros.org/job/Mdev__moveit_visual_tools__ubuntu_bionic_amd64/) ROS Buildfarm - AMD64 Bionic Devel Build - Ubuntu 18.04 LTS
## Install
### Ubuntu Debian
sudo apt-get install ros-kinetic-moveit-visual-tools
### Install From Source
Clone this repository into a catkin workspace, then use the rosdep install tool to automatically download its dependencies. Depending on your current version of ROS, use:
rosdep install --from-paths src --ignore-src --rosdistro kinetic
## Quick Start Demo
First launch Rviz:
roslaunch moveit_visual_tools demo_rviz.launch
Then run some demos displaying robot states and collision objects:
roslaunch moveit_visual_tools demo.launch
## Code API
See [VisualTools Class Reference](http://docs.ros.org/kinetic/api/moveit_visual_tools/html/classmoveit__visual__tools_1_1MoveItVisualTools.html)
## Usage
We'll assume you will be using these helper functions within a class.
### Initialize
Add to your includes:
```
#include
```
Add to your class's member variables:
```
// For visualizing things in rviz
moveit_visual_tools::MoveItVisualToolsPtr visual_tools_;
```
In your class' constructor add:
```
visual_tools_.reset(new moveit_visual_tools::MoveItVisualTools("base_frame","/moveit_visual_markers"));
```
### Collision Object Functions
Helpers for adding and removing objects from the MoveIt planning scene. CO stands for Collision Object and ACO stands for Active Collision Object.
- cleanupCO
- cleanupACO
- attachCO
- publishCollisionBlock
- publishCollisionCylinder
- publishCollisionTree
- publishCollisionTable
- publishCollisionWall
And more...
### Animate Trajectories
Higher level robot and trajectory functions
- publishTrajectoryPath
- publishTrajectoryPoint
- publishRobotState
- publishAnimatedGrasps
- publishIKSolutions
## Show parts of a robot
These functions are a little more complicated
- publishEEMarkers
## Parent Class
This class is built on top of [rviz_visual_tools](https://github.com/davetcoleman/rviz_visual_tools) so all features and documentation for that package apply here as well.
## Developers Notes
Useful notes for anyone wanting to dig in deeper:
- All poses are published with respect to the world frame e.g. /world, /odom, or maybe /base
- All publish() ROS topics should be followed by a ``ros::spinOnce();`` but no sleep
- Do not want to load any features/publishers until they are actually needed since this library contains so many components
## Testing and Linting
To run [roslint](http://wiki.ros.org/roslint), use the following command with [catkin-tools](https://catkin-tools.readthedocs.org/):
catkin build --no-status --no-deps --this --make-args roslint
To run [catkin lint](https://pypi.python.org/pypi/catkin_lint), use the following command with [catkin-tools](https://catkin-tools.readthedocs.org/):
catkin lint -W2
Use the following command with [catkin-tools](https://catkin-tools.readthedocs.org/) to run the small amount of available tests:
catkin run_tests --no-deps --this -i
## Contribute
Please send PRs for new helper functions, fixes, etc!