Code/Engine/Foundation/Tracks/EventTrack.h - dev - redgpu/ezEngine

Code/Engine/Foundation/Tracks/EventTrack.h

54 строки2 KB

Ingrater

Implement parameter coding guidelines in clang-tidy (#808)

18 фев 2023, 13:18

18 фев 2023, 13:183c98d47

#pragma once

#include <Foundation/Basics.h>
#include <Foundation/Containers/DynamicArray.h>
#include <Foundation/Containers/HybridArray.h>
#include <Foundation/Strings/HashedString.h>
#include <Foundation/Time/Time.h>

/// \brief An event track is a time line that contains named events.
///
/// The time line can be sampled to query all events that occurred during a time period.
/// There is no way to sample an event track at a fixed point in time, because events occur at specific time points and thus
/// only range queries make sense.
class EZ_FOUNDATION_DLL ezEventTrack
{
public:
  ezEventTrack();
  ~ezEventTrack();

  /// \brief Removes all control points.
  void Clear();

  /// \brief Checks whether there are any control points in the track.
  bool IsEmpty() const;

  /// \brief Adds a named event into the track at the given time.
  void AddControlPoint(ezTime time, ezStringView sEvent);

  /// \brief Samples the event track from range [start; end) and adds all events that occured in that time period to the array.
  ///
  /// Note that the range is inclusive for the start time, and exclusive for the end time.
  ///
  /// If rangeStart is larger than rangeEnd, the events are returned in reverse order (backwards traversal).
  void Sample(ezTime rangeStart, ezTime rangeEnd, ezDynamicArray<ezHashedString>& out_events) const;

  void Save(ezStreamWriter& inout_stream) const;
  void Load(ezStreamReader& inout_stream);

private:
  struct ControlPoint
  {
    EZ_ALWAYS_INLINE bool operator<(const ControlPoint& rhs) const { return m_Time < rhs.m_Time; }

    ezTime m_Time;
    ezUInt32 m_uiEvent;
  };

  ezUInt32 FindControlPointAfter(ezTime x) const;
  ezInt32 FindControlPointBefore(ezTime x) const;

  mutable bool m_bSort = false;
  mutable ezDynamicArray<ControlPoint> m_ControlPoints;
  ezHybridArray<ezHashedString, 4> m_Events;
};