diff --git a/configuration/packages/bt-plugins/conditions/IsPathValid.rst b/configuration/packages/bt-plugins/conditions/IsPathValid.rst index c79258491..56aaa7b56 100644 --- a/configuration/packages/bt-plugins/conditions/IsPathValid.rst +++ b/configuration/packages/bt-plugins/conditions/IsPathValid.rst @@ -3,9 +3,10 @@ IsPathValid =========== -Checks to see if the global path is valid. If there is a +Checks to see if the global path is valid. If there is an obstacle along the path, the condition returns FAILURE, otherwise -it returns SUCCESS. +it returns SUCCESS. Optionally checks specific costmap layers and +can use a custom footprint for validation. Input Ports ----------- @@ -54,10 +55,90 @@ Input Ports Description Whether to consider unknown cost (255) as obstacle. +:layer_name: + + ====== ======= + Type Default + ------ ------- + string "" + ====== ======= + + Description + Name of the specific costmap layer to check against. + If empty, checks against the full costmap. + +:footprint: + + ====== ======= + Type Default + ------ ------- + string "" + ====== ======= + + Description + Custom footprint specification as a bracketed array of arrays, + e.g., "[[x1,y1],[x2,y2],...]". If empty, uses the robot's + configured footprint. + +:check_full_path: + + ====== ======= + Type Default + ------ ------- + bool false + ====== ======= + + Description + Whether to check all poses in the path (true) or stop at the + first invalid pose (false). When true, all collision poses + are reported. + +Output Ports +------------ + +:collision_poses: + + ============================================ ======= + Type Default + -------------------------------------------- ------- + std::vector N/A + ============================================ ======= + + Description + Vector of poses in the path that are in collision or invalid. + Empty if the path is valid. + Example ------- .. code-block:: xml - + + +With custom footprint: + +.. code-block:: xml + + + +Checking a specific costmap layer: + +.. code-block:: xml + +