Channel.h

Go to the documentation of this file.

/*

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

*/
#pragma once

#include <optional>
#include <unordered_set>

#include "ChannelMode.h"
#include "NodeDelegate.h"
#include "Plug.h"

namespace maquina
{
class AnimCurve;

MAQUINA_EXPORT std::string channel_plug_to_channel_path(const Plug& channel_plug);

MAQUINA_EXPORT std::optional<std::pair<Plug, std::string>> channel_plug_to_controller_plug(const Plug& channel_plug);


// TODO optional
MAQUINA_EXPORT Plug channel_path_to_channel_plug(const StringView& channel_path, const Node& document, Node* layer = nullptr);


MAQUINA_EXPORT bool extract_channel_path(const std::string& channel_path, std::string& asset_path,
  std::string& ctrl_path, std::string& plug, std::string& subchannel);


MAQUINA_EXPORT bool add_plugs_to_layer(
  const std::vector<Plug>& plugs, 
  Node& layer, 
  bool check_editable = true, 
  bool selection_mask = true 
);


MAQUINA_EXPORT void layer_animated_plugs(const Node& layer, std::unordered_set<Plug>& animated_plugs, bool only_curve = true, bool recursive = true);

MAQUINA_EXPORT std::vector<Plug> channels_in_layer(const Node& layer);


MAQUINA_EXPORT void remove_channels_from_layer(
  const std::vector<Plug>& channels, 
  Node& layer, 
  bool undo_stack
);

MAQUINA_EXPORT bool anim_curve_keys_selected();


class Channel
{
public:

  MAQUINA_EXPORT std::vector<Node> layers() const;


  MAQUINA_EXPORT bool assign_to_layer(Node& layer) const;

  MAQUINA_EXPORT void remove_from_layer(Node& layer, bool undo_stack=true) const;

  MAQUINA_EXPORT bool is_assigned(const Node& layer) const;

  MAQUINA_EXPORT bool is_editable() const;


  MAQUINA_EXPORT bool is_editable(const Node& layer) const;


  MAQUINA_EXPORT bool is_target(const Node& layer) const;

  // TODO optional
  MAQUINA_EXPORT std::unique_ptr<Node> target_layer() const;

  MAQUINA_EXPORT std::optional<Node> animation_layer_blend(const Node &layer) const;

  // TODO optional
  MAQUINA_EXPORT std::unique_ptr<Node> animation_curve_node(const Node& layer) const;

  // TODO optional
  MAQUINA_EXPORT std::unique_ptr<AnimCurve> animation_curve(const Node& layer) const;

  // TODO optional

  MAQUINA_EXPORT std::unique_ptr<AnimCurve> new_animation_curve() const;

  // TODO optional

  MAQUINA_EXPORT std::unique_ptr<AnimCurve> duplicate_animation_curve(const Node& layer) const;


  MAQUINA_EXPORT bool set_animation_curve(AnimCurve& animation_curve, const Node& layer);


  MAQUINA_EXPORT void remove_animation_curve(const Node& layer);

  // TODO optional

  MAQUINA_EXPORT Value value(float frame, const Node& layer) const;


  MAQUINA_EXPORT bool as_bool(float frame, const Node& layer) const;


  MAQUINA_EXPORT int as_int(float frame, const Node& layer) const;


  MAQUINA_EXPORT float as_float(float frame, const Node& layer) const;


  MAQUINA_EXPORT bool set_value(
    const Value& value, 
    const Node& layer  
  );


  MAQUINA_EXPORT bool set_key(
    const Value& value, 
    float frame,        
    const Node& layer   
  );

  MAQUINA_EXPORT ChannelType channel_type() const;

  MAQUINA_EXPORT ChannelMode channel_mode() const;

  Plug channel_plug() const { return _plug; }

  MAQUINA_EXPORT Channel(Plug);

  MAQUINA_EXPORT bool operator==(const Channel& o) const;
  MAQUINA_EXPORT bool operator!=(const Channel& o) const;
private:
  Plug _plug; // The channel plug
};


// TODO optional
MAQUINA_EXPORT Plug controller_plug(const Plug& channel_plug);

}