Ignition Gazebo

API Reference

5.0.0
LogVideoRecorder Class Reference

System which recordings videos from log playback There are two ways to specify what entities in the log playback to follow and record videos for: 1) by entity name and 2) by region. See the following parameters: <entity> Name of entity to record. <region> Axis-aligned box where entities are at start of log <min> Min corner position of box region. <max> Max corner position of box region. <start_time> Sim time when recording should start <end_time> Sim time when recording should end <exit_on_finish> Exit ign-gazebo when log playback recording ends When recording is finished. An end string will be published to the /log_video_recorder/status topic and the videos are saved to a timestamped directory. More...

#include <ignition/gazebo/systems/LogVideoRecorder.hh>

Public Member Functions

 LogVideoRecorder ()
 Constructor. More...
 
 ~LogVideoRecorder () final=default
 Destructor. More...
 
void Configure (const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) final
 Documentation inherited. More...
 
void PostUpdate (const UpdateInfo &_info, const EntityComponentManager &_ecm) final
 Documentation inherited. More...
 
- Public Member Functions inherited from System
 System ()=default
 Constructor. More...
 
virtual ~System ()=default
 Destructor. More...
 

Detailed Description

System which recordings videos from log playback There are two ways to specify what entities in the log playback to follow and record videos for: 1) by entity name and 2) by region. See the following parameters: <entity> Name of entity to record. <region> Axis-aligned box where entities are at start of log <min> Min corner position of box region. <max> Max corner position of box region. <start_time> Sim time when recording should start <end_time> Sim time when recording should end <exit_on_finish> Exit ign-gazebo when log playback recording ends When recording is finished. An end string will be published to the /log_video_recorder/status topic and the videos are saved to a timestamped directory.

Constructor & Destructor Documentation

◆ LogVideoRecorder()

Constructor.

◆ ~LogVideoRecorder()

~LogVideoRecorder ( )
finaldefault

Destructor.

Member Function Documentation

◆ Configure()

void Configure ( const Entity _entity,
const std::shared_ptr< const sdf::Element > &  _sdf,
EntityComponentManager _ecm,
EventManager _eventMgr 
)
finalvirtual

Documentation inherited.

Implements ISystemConfigure.

◆ PostUpdate()

void PostUpdate ( const UpdateInfo _info,
const EntityComponentManager _ecm 
)
finalvirtual

Documentation inherited.

Implements ISystemPostUpdate.


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