canvas3d.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#ifndef _SCENEPIC_CANVAS3D_H_
#define _SCENEPIC_CANVAS3D_H_
 
#include "camera.h"
#include "focus_point.h"
#include "frame3d.h"
#include "json_value.h"
#include "layer_settings.h"
#include "mesh.h"
#include "shading.h"
#include "ui_parameters.h"
 
#include <limits>
#include <map>
#include <memory>
#include <string>
 
namespace scenepic
{
  class Canvas3D
  {
  public:
    std::shared_ptr<Frame3D> create_frame(
      const std::string& frame_id = "",
      const FocusPoint& focus_point = FocusPoint::None(),
      const std::vector<std::string>& mesh_ids = std::vector<std::string>(),
      const Camera& camera = Camera::None());
 
    template<typename MeshType>
    std::shared_ptr<Frame3D> create_frame_with_meshes(
      const std::vector<std::shared_ptr<MeshType>>& meshes,
      const std::string& frame_id = "",
      const FocusPoint& focus_point = FocusPoint::None(),
      const Camera& camera = Camera::None())
    {
      std::vector<std::string> mesh_ids;
      std::transform(
        meshes.begin(),
        meshes.end(),
        std::back_inserter(mesh_ids),
        [](const std::shared_ptr<MeshType>& mesh) { mesh->mesh_id(); });
      return this->create_frame(frame_id, focus_point, mesh_ids, camera);
    }
 
    void set_layer_settings(
      const std::map<std::string, LayerSettings> layer_settings);
 
    const std::string& canvas_id() const;
 
    void clear_script();
 
    std::string to_string() const;
 
    JsonValue to_json() const;
 
    const Camera& camera() const;
 
    Canvas3D& camera(const Camera& value);
 
    const Shading& shading() const;
 
    Canvas3D& shading(const Shading& value);
 
    const FocusPoint& focus_point() const;
 
    Canvas3D& focus_point(const FocusPoint& value);
 
    const UIParameters& ui_parameters() const;
 
    Canvas3D& ui_parameters(const UIParameters& value);
 
    const std::string& media_id() const;
 
    Canvas3D& media_id(const std::string& audio_id);
 
    double width() const;
 
    double height() const;
 
  private:
    friend class Scene;
 
    Canvas3D(
      const std::string& canvas_id,
      double height,
      double width,
      const Camera& camera = Camera(),
      const Shading& shading = Shading(),
      const FocusPoint& focus_point = FocusPoint::None(),
      const UIParameters& ui_parameters = UIParameters());
 
    std::string m_canvas_id;
    Camera m_camera;
    Shading m_shading;
    FocusPoint m_focus_point;
    UIParameters m_ui_parameters;
    std::map<std::string, LayerSettings> m_layer_settings;
    std::vector<std::shared_ptr<Frame3D>> m_frames;
    std::string m_media_id;
    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