zone_parameter_filter.hpp

// Copyright (c) 2026 Komada (aki1770-del)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef NAV2_COSTMAP_2D__COSTMAP_FILTERS__ZONE_PARAMETER_FILTER_HPP_
#define NAV2_COSTMAP_2D__COSTMAP_FILTERS__ZONE_PARAMETER_FILTER_HPP_
 
#include <map>
#include <memory>
#include <string>
#include <vector>
 
#include "geometry_msgs/msg/pose.hpp"
#include "nav_msgs/msg/occupancy_grid.hpp"
#include "rclcpp/parameter.hpp"
#include "rclcpp/parameter_client.hpp"
#include "std_msgs/msg/u_int8.hpp"
 
#include "nav2_costmap_2d/costmap_filters/costmap_filter.hpp"
#include "nav2_msgs/msg/costmap_filter_info.hpp"
 
namespace nav2_costmap_2d
{
 
class ZoneParameterFilter : public CostmapFilter
{
public:
  ZoneParameterFilter();
 
  void initializeFilter(const std::string & filter_info_topic) override;
 
  void process(
    nav2_costmap_2d::Costmap2D & master_grid,
    int min_i, int min_j, int max_i, int max_j,
    const geometry_msgs::msg::Pose & pose) override;
 
  void resetFilter() override;
 
  bool isActive();
 
protected:
  void filterInfoCallback(
    const nav2_msgs::msg::CostmapFilterInfo::ConstSharedPtr & msg);
 
  void maskCallback(
    const nav_msgs::msg::OccupancyGrid::ConstSharedPtr & msg);
 
  void loadStateConfig();
 
  void applyState(uint8_t new_state);
 
  void resetToNominal();
 
  void issueAsyncSetParameters(
    const std::string & target_node,
    const std::vector<rclcpp::Parameter> & params);
 
  void checkPendingParameterUpdates();
 
  nav2::Subscription<nav2_msgs::msg::CostmapFilterInfo>::SharedPtr filter_info_sub_;
  nav2::Subscription<nav_msgs::msg::OccupancyGrid>::SharedPtr mask_sub_;
  nav2::Publisher<std_msgs::msg::UInt8>::SharedPtr state_event_pub_;
 
  nav_msgs::msg::OccupancyGrid::ConstSharedPtr filter_mask_;
  std::string global_frame_;
 
  uint8_t current_state_{0};
  bool state_initialized_{false};
 
  // One per-state-override or per-nominal-default entry.
  struct StateParamEntry
  {
    std::string target_node;
    rclcpp::Parameter param;
  };
  std::map<uint8_t, std::vector<StateParamEntry>> state_param_map_;
  // Keyed by target_node; values are bare-named Parameters to restore.
  std::map<std::string, std::vector<rclcpp::Parameter>> nominal_defaults_;
  std::map<std::string, rclcpp::AsyncParametersClient::SharedPtr> param_clients_;
 
  std::vector<std::shared_future<
      std::vector<rcl_interfaces::msg::SetParametersResult>>> pending_futures_;
 
  std::string state_event_topic_;
 
  bool filter_info_received_{false};
};
 
}  // namespace nav2_costmap_2d
 
#endif  // NAV2_COSTMAP_2D__COSTMAP_FILTERS__ZONE_PARAMETER_FILTER_HPP_