NewFrameMessage.h

// Copyright (c) 2012 The Foundry Visionmongers Ltd. All Rights Reserved.

#ifndef NEWFRAMEMESSAGE_H
#define NEWFRAMEMESSAGE_H

#include <stdint.h>
#include <string>

#include "Message.h"

namespace Foundry
{
namespace Katana
{
class NewFrameMessage : public Message
{
public:
    NewFrameMessage(float frameTime = 0.0,
                    uint32_t height = 0,
                    uint32_t width = 0,
                    int xorigin = 0,
                    int yorigin = 0);

    virtual ~NewFrameMessage() {}

    int setFrameName(const std::string& name);

    void setFrameTime(float time);

    void setFrameDimensions(uint32_t width, uint32_t height);

    void setFrameOrigin(int ox, int oy);

    const uint8_t* frameUUID() const;

    uint32_t frameHeight() const;
    uint32_t frameWidth() const;
    int frameXOrigin() const;
    int frameYOrigin() const;
    float frameTime() const;
    const std::string& frameName() const;
    uint32_t frameNameLength() const;

private:
    NewFrameMessage(const NewFrameMessage& rhs);
    NewFrameMessage& operator=(const NewFrameMessage& rhs);

    mutable std::string _frameName;
};

void encodeLegacyName(const std::string& legacyFrameName,
                      int legacyFrameNumber,
                      std::string& buffer);

}  // namespace Katana
}  // namespace Foundry

#endif