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::TickBasedSource Class Referencefinal

#include <TickBasedSource.h>

Inherits ROS2::SensorEventSource< AZ::Event, AZ::EventHandler, float, AZ::ScriptTimePoint >, and AZ::TickBus::Handler.

Public Member Functions

 AZ_TYPE_INFO (TickBasedSource, "{AD3CC041-5F7C-45E8-AA2D-5D8A1D4CC466}")
 
void Start () override
 
void Stop () override
 
float GetDeltaTime (float deltaTime, AZ::ScriptTimePoint time) const override
 
- Public Member Functions inherited from ROS2::SensorEventSource< AZ::Event, AZ::EventHandler, float, AZ::ScriptTimePoint >
virtual void Start ()
 
virtual void Stop ()
 
virtual float GetDeltaTime (EventArgs... args) const=0
 
void ConnectToSourceEvent (SourceEventHandlerType &sourceEventHandler)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Public Types inherited from ROS2::SensorEventSource< AZ::Event, AZ::EventHandler, float, AZ::ScriptTimePoint >
using SourceBaseType = SensorEventSource< AZ::Event, AZ::EventHandler, EventArgs... >
 
using SourceCallbackType = AZStd::function< void(EventArgs...)>
 
using AdaptedCallbackType = AZStd::function< void(float, EventArgs...)>
 
using SourceEventType = AZ::Event< EventArgs... >
 
using SourceEventHandlerType = AZ::EventHandler< EventArgs... >
 
using AdaptedEventType = AZ::Event< float, EventArgs... >
 
using AdaptedEventHandlerType = AZ::EventHandler< float, EventArgs... >
 
- Protected Attributes inherited from ROS2::SensorEventSource< AZ::Event, AZ::EventHandler, float, AZ::ScriptTimePoint >
SourceEventType m_sourceEvent
 This event should be signalled based on specific event source specialization.
 

Detailed Description

Class implementing system TickBus (draw calls) as sensor event source. Source event (ROS2::SensorEventSource) is signalled based on system ticks.

See also
ROS2::SensorEventSource

Member Function Documentation

◆ Start()

void ROS2::TickBasedSource::Start ( )
overridevirtual

Starts event source - see specific event source description for more details. After call to this method event source is supposed to start signalling source event.

Reimplemented from ROS2::SensorEventSource< AZ::Event, AZ::EventHandler, float, AZ::ScriptTimePoint >.

◆ Stop()

void ROS2::TickBasedSource::Stop ( )
overridevirtual

Stops event source - see specific event source description for more details. After call to this method event source is supposed to stop signalling source event.

Reimplemented from ROS2::SensorEventSource< AZ::Event, AZ::EventHandler, float, AZ::ScriptTimePoint >.

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