Open 3D Engine ROS2 Gem API Reference  23.05.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::MotorizedJointComponent Class Reference

#include <MotorizedJointComponent.h>

Inherits Component, Handler, and Handler.

Public Member Functions

 AZ_COMPONENT (MotorizedJointComponent,"{AE9207DB-5B7E-4F70-A7DD-C4EAD8DD9403}", AZ::Component)
 
void Activate () override
 
void Deactivate () override
 
void SetSetpoint (float setpoint) override
 
float GetSetpoint () override
 
float GetError () override
 
float GetCurrentMeasurement () override
 
AZ::Vector3 GetDir () const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

A prototype component for simulated joint with a motor. It works with either TransformBus or RigidBodyBus. TransformBus mode, called AnimationMode changes local transform. In this mode, you cannot have a rigid body controller enabled. With RigidBodyBus it applies forces and torque according to PID control.

Note
This class is already used through ROS2FrameComponent.

Member Function Documentation

AZ::Vector3 ROS2::MotorizedJointComponent::GetDir ( ) const
inline

Get a degree of freedom direction.

Returns
direction of joint movement in global coordinates.
The documentation for this class was generated from the following file: