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.
Public Member Functions | Static Public Member Functions | List of all members
ROS2::JointsPIDControllerComponent Class Reference

Handles position control commands for joints. More...

#include <JointsPIDControllerComponent.h>

Inherits AZ::Component, and JointsPositionControllerRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (JointsPIDControllerComponent, "{41A31EDB-90B0-412E-BBFA-D35D45546A8E}", AZ::Component)
 
bool SupportsArticulation () override
 
bool SupportsClassicJoints () override
 
AZ::Outcome< void, AZStd::string > PositionControl (const AZStd::string &jointName, JointInfo joint, JointPosition currentPosition, JointPosition targetPosition, float deltaTime) override
 

Static Public Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

Handles position control commands for joints.

Member Function Documentation

◆ PositionControl()

AZ::Outcome< void, AZStd::string > ROS2::JointsPIDControllerComponent::PositionControl ( const AZStd::string &  jointName,
JointInfo  joint,
JointPosition  currentPosition,
JointPosition  targetPosition,
float  deltaTime 
)
override
See also
ROS2::JointsPositionControllerRequestBus::PositionControl

◆ SupportsArticulation()

bool ROS2::JointsPIDControllerComponent::SupportsArticulation ( )
inlineoverride
See also
ROS2::JointsPositionControllerRequestBus::SupportsArticulation

◆ SupportsClassicJoints()

bool ROS2::JointsPIDControllerComponent::SupportsClassicJoints ( )
inlineoverride
See also
ROS2::JointsPositionControllerRequestBus::SupportsClassicJoints
The documentation for this class was generated from the following file: