Open 3D Engine ROS2 Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
ROS2::CollidersMaker Class Reference

Populates a given entity with all the contents of the <collider> tag in robot description. More...

#include <CollidersMaker.h>

Public Member Functions

 CollidersMaker (const AZStd::shared_ptr< Utils::UrdfAssetMap > &sdfAssetsMapping)
 
 CollidersMaker (const CollidersMaker &other)=delete
 Prevent copying of existing CollidersMaker.
 
void AddColliders (const sdf::Model &model, const sdf::Link *link, AZ::EntityId entityId)
 
void ProcessMeshes (BuildReadyCallback notifyBuildReadyCb)
 

Detailed Description

Populates a given entity with all the contents of the <collider> tag in robot description.

Constructor & Destructor Documentation

◆ CollidersMaker()

ROS2::CollidersMaker::CollidersMaker ( const AZStd::shared_ptr< Utils::UrdfAssetMap > &  sdfAssetsMapping)

Construct the class based on SDF asset mapping.

Parameters
sdfAssetsMappinga prepared mapping of Assets used by the source URDF/SDF.

Member Function Documentation

◆ AddColliders()

void ROS2::CollidersMaker::AddColliders ( const sdf::Model &  model,
const sdf::Link *  link,
AZ::EntityId  entityId 
)

Add zero, one or many collider elements (depending on link content).

Parameters
modelAn SDF model object provided by libsdformat from a parsed URDF/SDF
linkA parsed SDF tree link node which could hold information about colliders.
entityIdA non-active entity which will be affected.

◆ ProcessMeshes()

void ROS2::CollidersMaker::ProcessMeshes ( BuildReadyCallback  notifyBuildReadyCb)

Sends meshes required for colliders to asset processor.

Parameters
buildReadyCbFunction to call when the processing finishes.

The documentation for this class was generated from the following file: