Skip to content

Commit

Permalink
style(pre-commit): autofix
Browse files Browse the repository at this point in the history
  • Loading branch information
pre-commit-ci[bot] committed Jan 15, 2025
1 parent a145d20 commit 5f363bf
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions planning/autoware_objects_of_interest_marker_interface/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,24 @@

## Overview

`autoware_objects_of_interest_marker_interface` is a collection of object visualization function packages.
`autoware_objects_of_interest_marker_interface` is a collection of object visualization function packages.

## Design

This package implement a library to manage and visualize the object information by construct and publish it as marker array to rviz.

For a object to be visualized, it has three import characteristics.

- pose the position of the object
- shape the shape of the Bounding box of the object
- color the color of the Bounding box of the object



## Usage

### init

include the header file to use then init the library

```cpp
#include <autoware/objects_of_interest_marker_interface/objects_of_interest_marker_interface.hpp>

Expand All @@ -27,15 +28,19 @@ autoware::objects_of_interest_marker_interface::ObjectsOfInterestMarkerInterface
```
### insert
insert object information to the 'objects_of_interest_marker_interface' manager
```cpp
using autoware::objects_of_interest_marker_interface::ColorName;
objects_of_interest_marker_interface_.insertObjectData(
stopped_obstacle.pose, stopped_obstacle.shape, ColorName::RED);
```

### publish

publish object information to the rviz to visualize

```cpp
objects_of_interest_marker_interface_.publishMarkerArray();
```
```

0 comments on commit 5f363bf

Please sign in to comment.