keyframe_manager.h

Go to the documentation of this file.

#pragma once
 
#include "core/serializer.h"
#include "core/types.h"
 
#include <QObject>
#include <vector>
 
namespace KeyframeManagement
{
 
    ///
    /// \brief This is the class that manages keyframes
    class KeyframeManager : public QObject,
                            JSON
    {
        Q_OBJECT
 
      public:
        ///
        /// \brief Returns the singleton instance of the KeyframeManager
        /// \return A reference to the singleton instance of the KeyframeManager
        ///
        static KeyframeManager&
        Instance()
        {
            static KeyframeManager instance;
            return instance;
        }
 
        ///
        /// \brief Adds a keyframe to the keyframe list using x, y, and z
        /// coordinates
        /// \param agentId The ID of the agent
        /// \param timeStamp The timestamp of the keyframe
        /// \param x The x coordinate
        /// \param y The y coordinate
        /// \param z The z coordinate
        ///
        void AddKeyframe(int agentId, float timeStamp, float x, float y,
                         float z);
 
        ///
        /// \brief Adds a keyframe to the keyframe list using a
        /// CartesianCoordinate \param agentId The ID of the agent \param
        /// timeStamp The timestamp of the keyframe \param position The
        /// CartesianCoordinate representing the position
        ///
        void AddKeyframe(int agentId, float timeStamp,
                         Core::CartesianCoordinate position);
 
        ///
        /// \brief Adds a keyframe object to the keyframe list
        /// \param keyframe The keyframe object to add
        ///
        void AddKeyframe(Core::Keyframe& keyframe);
 
        ///
        /// \brief Removes a keyframe from the keyframe list
        /// \param keyframe The keyframe to remove
        ///
        void RemoveKeyframe(const Core::Keyframe& keyframe);
 
        ///
        /// \brief Dumps keyframe information to the console for debugging
        /// purposes
        ///
        void DebugDump(void) const;
 
        ///
        /// \brief Returns a reference to the list of keyframes
        /// \return A reference to the list of keyframes
        ///
        inline std::vector<Core::Keyframe>&
        GetKeyframes()
        {
            return m_Keyframes;
        }
 
      signals:
        void KeyframeAdded();
 
      private:
        KeyframeManager() {}  ///< Private constructor for singleton pattern
 
        ~KeyframeManager() {} ///< Private destructor for singleton pattern
 
        KeyframeManager(const KeyframeManager&) = delete;
        KeyframeManager& operator=(const KeyframeManager&) = delete;
 
        std::vector<Core::Keyframe> m_Keyframes;
 
        JSONSTART
        JSONMEMBERVECTOR(Core::Keyframe, m_Keyframes)
        JSONEND
    };
 
} // namespace KeyframeManagement