maliput_object

Description

Runtime interface for performing spacial queries on Maliput’s road network.

Note: For full information about Maliput please visit Maliput Documentation.

API Documentation

Refer to Maliput Object’s Online API Documentation.

Examples

• maliput_integration: Concentrates applications created for Maliput. See maliput_integration’s tutorials, in particular the maliput_query application provides queries that rely on maliput_object package.

Installation

Supported platforms

Ubuntu Focal Fossa 20.04 LTS.

Binary Installation on Ubuntu

See Installation Docs.

Source Installation on Ubuntu

Prerequisites

sudo apt install python3-rosdep python3-colcon-common-extensions

Build

1. Create colcon workspace if you don’t have one yet.

    mkdir colcon_ws/src -p
    

1. Clone this repository in the src folder

    cd colcon_ws/src
    git clone https://github.com/maliput/maliput_object.git
    

1. Install package dependencies via rosdep

    export ROS_DISTRO=foxy
    

    rosdep update
    rosdep install -i -y --rosdistro $ROS_DISTRO --from-paths src
    

1. Build the package

    colcon build --packages-up-to maliput_object
    

**Note**: To build documentation a `-BUILD_DOCS` cmake flag is required:

    colcon build --packages-select maliput_object --cmake-args " -DBUILD_DOCS=On"
    

More info at [Building Documentation](https://maliput.readthedocs.io/en/latest/developer_guidelines.html#building-the-documentation).

For further info refer to Source Installation on Ubuntu

For development

It is recommended to follow the guidelines for setting up a development workspace as described here.

Contributing

Please see CONTRIBUTING page.

License

Changelog for package maliput_object

0.1.2 (2022-08-16)

• Moves BoundingRegion, BoundingBox and OverlappingType to maliput (#44)
• Adds triage workflow. (#43)
• Improves README. (#42)
• Contributors: Franco Cipollone

0.1.1 (2022-06-21)

• Fixes include folder installation. (#41)
• Uses ros-action-ci for main workflow. (#40)
• Contributors: Franco Cipollone

0.1.0 (2022-06-10)

• Use <doc_depend> for ament_cmake_doxygen dependency. (#39)
• Moves package to root. (#38)
• Removes maliput_object_py from the repo (#37)
• Updates license. (#35)
• Uses ament_export_targets. (#34)
• Adds testing support for LoadFile to parse objects from a YAML. (#33)
• Creates bindings for the maliput::object::api namespace (#31)
• Implements the loader for ObjectBook (#32)
• Adds maliput_object_py to CI. (#30)
• Creates the package for the python bindings (#29)
• Adds documentation about the YAML specification for objects. (#24)
• Adds missing BoundingBox::box_size() method defintion. (#28)
• Adds ManualObjectBook. (#23)
• Updates misleading OverlappingType's docstring. (#26)
• Adds a SimpleObjectQuery implementation (#17)
• Adds BoundingBox Implementation (#7)
• Improves OverlappingTest definition. (#16)
• Adds ObjectQuery class. (#13)
• Creates ObjectBook API (#12)
• Creates Object class (#8)
• Adds BoundingRegion api class. (#6)
• Setup maliput_object repository/package (#2)
• Initial commit
• Contributors: Agustin Alba Chicar, Franco Cipollone, Voldivh