canvas2d.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#ifndef _SCENEPIC_CANVAS2D_H_
#define _SCENEPIC_CANVAS2D_H_
 
#include "color.h"
#include "frame2d.h"
#include "json_value.h"
#include "layer_settings.h"
 
#include <map>
#include <memory>
#include <string>
#include <vector>
 
namespace scenepic
{
  class Canvas2D
  {
  public:
    const std::string& canvas_id() const;
 
    std::shared_ptr<Frame2D> create_frame(const std::string& frame_id = "");
 
    void clear_script();
 
    std::string to_string() const;
 
    JsonValue to_json() const;
 
    const Color& background_color() const;
 
    Canvas2D& background_color(const Color& color);
 
    double width() const;
 
    double height() const;
 
    const std::string& media_id() const;
 
    void set_layer_settings(
      const std::map<std::string, LayerSettings> layer_settings);
 
    Canvas2D& media_id(const std::string& media_id);
 
  private:
    friend class Scene;
 
    Canvas2D(const std::string& canvas_id, double width, double height);
 
    std::string m_canvas_id;
    std::string m_media_id;
    std::vector<std::string> m_layer_ids;
    std::map<std::string, LayerSettings> m_layer_settings;
    std::map<std::string, std::uint8_t> m_layer_lookup;
    std::vector<std::shared_ptr<Frame2D>> m_frames;
    Color m_background_color;
    double m_width;
    double m_height;
 
    // This will get out of sync with the above after a call to clear_script()
    // DO NOT REMOVE - it is important
    std::size_t m_num_frames;
  };
} // namespace scenepic
 
#endif