graph.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#ifndef _SCENEPIC_GRAPH_H_
#define _SCENEPIC_GRAPH_H_
 
#include "color.h"
#include "json_value.h"
#include "matrix.h"
 
#include <memory>
#include <string>
#include <vector>
 
namespace scenepic
{
  class Graph
  {
  public:
    struct Margin
    {
      Margin();
 
      Margin(double size);
 
      Margin(double top, double right, double bottom, double left);
 
      std::string to_string() const;
 
      JsonValue to_json() const;
 
      double top;
 
      double right;
 
      double bottom;
 
      double left;
    };
 
    struct VerticalRule
    {
      VerticalRule(
        std::int64_t frame,
        const Color& color = scenepic::Colors::Black,
        float line_width = 1.0f);
 
      std::string to_string() const;
 
      JsonValue to_json() const;
 
      std::int64_t frame;
      Color color;
      float line_width;
    };
 
    const std::string& canvas_id() const;
 
    void add_sparkline(
      const std::string& name,
      const std::vector<float>& values,
      const scenepic::Color& line_color = scenepic::Colors::Black,
      float line_width = 1.0f,
      const std::vector<VerticalRule>& vertical_rules = {});
 
    std::string to_string() const;
 
    JsonValue to_json() const;
 
    const Color& background_color() const;
 
    Graph& background_color(const Color& color);
 
    const Margin& margin() const;
 
    Graph& margin(const Margin& margin);
 
    const std::string& name_align() const;
 
    Graph& name_align(const std::string& name_align);
 
    const std::string& value_align() const;
 
    Graph& value_align(const std::string& value_align);
 
    const std::string& font_family() const;
 
    Graph& font_family(const std::string& font_family);
 
    float name_size() const;
 
    Graph& name_size(float name_size);
 
    float value_size() const;
 
    Graph& value_size(float value_size);
 
    const std::string& media_id() const;
 
    Graph& media_id(const std::string& media_id);
 
  private:
    class Sparkline
    {
    public:
      Sparkline(
        const std::string& name,
        const ValueBuffer& values,
        const Color& color,
        float line_width,
        const std::vector<VerticalRule>& vertical_rules);
 
      std::string to_string() const;
      JsonValue to_json() const;
 
    private:
      std::string m_name;
      ValueBuffer m_values;
      Color m_color;
      float m_line_width;
      std::vector<VerticalRule> m_vertical_rules;
    };
 
    friend class Scene;
 
    Graph(const std::string& canvas_id);
 
    std::string m_canvas_id;
    std::string m_media_id;
    std::vector<Sparkline> m_sparklines;
    Color m_background_color;
    Margin m_margin;
    std::string m_font_family;
    std::string m_name_align;
    std::string m_value_align;
    float m_name_size;
    float m_value_size;
  };
} // namespace scenepic
 
#endif