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.
ROS2::VacuumGripperComponent Class Reference

#include <VacuumGripperComponent.h>

Inherits AZ::Component, GripperRequestBus::Handler, ImGui::ImGuiUpdateListenerBus::Handler, and AZ::TickBus::Handler.

Public Member Functions

 AZ_COMPONENT (VacuumGripperComponent, "{a29eb4fa-0f6f-11ee-be56-0242ac120002}", AZ::Component)
 
void Activate () override
 
void Deactivate () 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)
 

Static Public Attributes

static constexpr AZ::Crc32 GrippableTag = AZ_CRC_CE("Grippable")
 

Detailed Description

This component implements vacuum gripper functionality. It allows to attach to gripper objects that are in inside designated trigger collider to objects that has "Grippable" tag. To use component:

  • Attach component to root of robot articulation.
  • Assign to m_gripperEffectorCollider EntityId of the collider that will be used as the gripper effector.
  • Add tag "Grippable" to objects that can be gripped.

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