diff --git a/planning/autoware_objects_of_interest_marker_interface/README.md b/planning/autoware_objects_of_interest_marker_interface/README.md index 9260ac0173..e85c756a03 100644 --- a/planning/autoware_objects_of_interest_marker_interface/README.md +++ b/planning/autoware_objects_of_interest_marker_interface/README.md @@ -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 visualizaed, 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 @@ -27,7 +28,9 @@ 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( @@ -35,7 +38,9 @@ objects_of_interest_marker_interface_.insertObjectData( ``` ### pubish + pubish object information to the rviz to visualize + ```cpp objects_of_interest_marker_interface_.publishMarkerArray(); -``` \ No newline at end of file +```