Open 3D Engine ROS2 Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Attributes | List of all members
ROS2::TwistNotifications Class Referenceabstract

#include <TwistBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = AZ::EntityId
 

Public Member Functions

virtual void TwistReceived (const AZ::Vector3 &linear, const AZ::Vector3 &angular)=0
 

Static Public Attributes

static constexpr AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

Interface class for handling Twist commands through EBus notifications. The interface serves to enable control through Twist (and TwistStamped) messages.

Member Function Documentation

◆ TwistReceived()

virtual void ROS2::TwistNotifications::TwistReceived ( const AZ::Vector3 &  linear,
const AZ::Vector3 &  angular 
)
pure virtual

Handle control command

Parameters
linearLinear speed in each axis, in robot reference frame, in m/s.
angularAngular speed in each axis, in robot reference frame, in m/s.
The documentation for this class was generated from the following file: