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::ROS2Transform Class Reference

#include <ROS2Transform.h>

Public Member Functions

 ROS2Transform (AZStd::string parentFrame, AZStd::string childFrame, bool isDynamic)
 
void Publish (const AZ::Transform &transform)
 

Detailed Description

Publishes transforms as standard ROS2 tf2 messages. Static transforms are published once.

Note
This class is already used through ROS2FrameComponent.

Constructor & Destructor Documentation

◆ ROS2Transform()

ROS2::ROS2Transform::ROS2Transform ( AZStd::string  parentFrame,
AZStd::string  childFrame,
bool  isDynamic 
)

Create a transform between given frames.

Parameters
parentFrameid of parent frame of transformation.
childFrameid of child frame of transformation.
isDynamicwhether the transformation is dynamic (should be computed every frame) or static (only once).

Member Function Documentation

◆ Publish()

void ROS2::ROS2Transform::Publish ( const AZ::Transform &  transform)

Construct and delegate publishing of a transform according to members' values.

Parameters
transformAZ::Transform with current transformation between m_parentFrame and m_childFrame.
Note
The actual publishing is done by singleton tf broadcasters.

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