IO.h

Go to the documentation of this file.

/*

             *
            ***
           *****
   *********************       Mercenaries Engineering SARL
     *****************              Copyright (C) 2018
       *************
         *********        http://www.mercenaries-engineering.com
        ***********
       ****     ****
      **           **

*/
#pragma once

#include <functional>

#include "Export.h"
#include "Value.h"

  namespace maquina
  {
    class Plug;
    class Node;
    class Dict;


    MAQUINA_EXPORT void export_plug_values(
      const std::vector<Plug>& plugs, 
      const std::wstring& filepath,   
      const std::string_view& comments="", 
      const std::string_view& tags=""      
    );


    MAQUINA_EXPORT void export_plug_animation(
      const std::vector<Plug>& plugs,                                   
      const std::wstring& filepath,                                     
      bool single_layer=false,                                          
      const std::function<bool(float, const char*)>& progress=nullptr,  
      const std::string_view& comments="",                              
      const std::string_view& tags="",                                  
      float first_frame_clip=0,                                         
      float last_frame_clip=0
    );


    MAQUINA_EXPORT void export_settings(
      const std::wstring& filepath    
    );


    MAQUINA_EXPORT Dict load_pose(
      const std::wstring& filename  
    );

    MAQUINA_EXPORT void apply_pose(
        const Dict& pose,   
        float frame         
    );

    MAQUINA_EXPORT Dict load_animation_pose(
      const std::wstring& filename  
    );


    MAQUINA_EXPORT bool import_plug_animation(
      const std::vector<Plug>& plugs, 
      const std::wstring& filename,   
      const std::vector<std::string>& layers_to_import  
    );


    MAQUINA_EXPORT void import_settings(
      const std::wstring& filepath    
    );

    MAQUINA_EXPORT std::string serialize_nodes(
      const std::vector<Node>& nodes,   
      bool serialize_external_input_connections = false 
    );


    MAQUINA_EXPORT std::vector<Node> deserialize_nodes(
      std::string buffer,   
      Node* parent=nullptr,  
      const std::string& valid_types="" 
    );


    MAQUINA_EXPORT Value read_value(
      const std::wstring& file,               //< Path to the input file.
      const Dict& options                     //< The reader options
    );

    MAQUINA_EXPORT std::string serialize_pose(
      const Dict& pose
    );

    MAQUINA_EXPORT Dict deserialize_pose(
      std::string buffer   
    );

    MAQUINA_EXPORT Dict document_info(
      const std::wstring& file               //< Path to the input file.
    );
  }