diff --git a/planning/behavior_path_planner/README.md b/planning/behavior_path_planner/README.md index e2a36059c7833..1f272d3f20f46 100644 --- a/planning/behavior_path_planner/README.md +++ b/planning/behavior_path_planner/README.md @@ -12,7 +12,7 @@ The `behavior_path_planner` module is responsible to generate ### Supported Scene Modules -Behavior Path Planner has following scene modules. +Behavior Path Planner has following scene modules (click on the image to view the video of the execution) | Name | Description | Details | | :----------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------- | @@ -39,11 +39,16 @@ Behavior Path Planner has following scene modules. +!!! note + Users can refer to [Planning component design](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture/planning/#supported-functions) for some additional behavior. #### How to add or implement new module? All scene modules are implemented by inheriting base class `scene_module_interface.hpp`. + +!!! warning + The remainder of this subsection is work in progress (WIP). ### Planner Manager @@ -58,6 +63,8 @@ To check the scene module's transition, i.e.: registered, approved and candidate ![Scene module's transition table](./image/checking_module_transition.png) +!!! note + For more in-depth information, refer to [Manager design](https://autowarefoundation.github.io/autoware.universe/main/planning/behavior_path_planner/docs/behavior_path_planner_manager_design/) document. ## Inputs / Outputs / API