NodeDelegateVirtualPlug.h

Go to the documentation of this file.

/*

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

*/

#pragma once

#include "Array.h"
#include "Node.h"
#include "NodeDelegateRumba.h"
#include "Plug.h"
#include "Value.h"

#include <string>

#include <rapidjson/document.h>

namespace maquina
{

struct VirtualAttribute
{
  typedef std::function<void(const maquina::Plug&)> plug_callback;

  VirtualAttribute(const std::string& name_, const maquina::Value& default_value_, const maquina::Value& plug_creation_value_, const std::string& description_,
    const plug_callback& plug_added_ = plug_callback(), const plug_callback& plug_removed_ = plug_callback())
    : name(name_)
    , value_type(default_value_.type_name())
    , description{ maquina::AttributeDescriptor::get_descriptor(description_) }
    , default_value(default_value_)
    , plug_creation_value(plug_creation_value_)
    , plug_added(plug_added_)
    , plug_removed(plug_removed_)
  {
  }

  std::string name, value_type;
  std::shared_ptr<maquina::AttributeDescriptor> description;
  maquina::Value default_value, plug_creation_value;
  std::function<void(const maquina::Plug&)> plug_added, plug_removed;
};

class DescBuild;

class MAQUINA_EXPORT VirtualAttributesStore : public std::enable_shared_from_this<VirtualAttributesStore>
{
public:
  typedef std::shared_ptr<std::vector<VirtualAttribute>> Attributes;
  typedef std::shared_ptr<const std::vector<VirtualAttribute>> AttributesConst;

public:
  VirtualAttributesStore();
  bool needsRebuild() const;
  void reset();
  Attributes& attributes() const;
  std::shared_ptr<class AttributeDescriptor> description() const;

protected:
  void _addAttribute(const std::string& name, const maquina::Value& default_value, const maquina::Value& plug_creation_value,
    const VirtualAttribute::plug_callback& plug_added, const VirtualAttribute::plug_callback& plug_removed, const std::string& description) const;
  void _addAttribute(const std::string& name, const maquina::Value& default_value,
    const VirtualAttribute::plug_callback& plug_added, const VirtualAttribute::plug_callback& plug_removed, const std::string& description) const;
  void _addAttribute(const std::string& name, const std::string& display_name, const maquina::Value& default_value, const maquina::Value& plug_creation_value,
    const VirtualAttribute::plug_callback& plug_added, const VirtualAttribute::plug_callback& plug_removed, const std::string& description, DescBuild& desc_build) const;
  void _addAttribute(const std::string& name, const std::string& display_name, const maquina::Value& default_value,
    const VirtualAttribute::plug_callback& plug_added, const VirtualAttribute::plug_callback& plug_removed, const std::string& description, DescBuild& desc_build) const;
  void _sortAttributes() const;
  void _setDescription(std::shared_ptr<class AttributeDescriptor> d) const;

private:
  mutable Attributes _attributes;
  mutable std::shared_ptr<class AttributeDescriptor> _description;
};

class MAQUINA_EXPORT VirtualAttributeNodeDelegate : public maquina::NodeDelegateRumba
{
public:
  VirtualAttributeNodeDelegate(const maquina::Node& node, const std::shared_ptr<const VirtualAttributesStore> attribute_store);

  std::shared_ptr<class AttributeDescriptor> description() const override;
  virtual int attribute_count() const override;
  virtual std::shared_ptr<maquina::NodeDelegate::AttributeDelegate> attribute(const maquina::StringView& name) override;
  std::shared_ptr<maquina::NodeDelegate::AttributeDelegate> concreteAttribute(const maquina::StringView& name);
  virtual std::shared_ptr<AttributeIteratorDelegate> _attributes_begin() override;
  virtual std::shared_ptr<AttributeIteratorDelegate> _attributes_end() override;

protected:
  std::shared_ptr<const VirtualAttributesStore> _attribute_store;
};

class MAQUINA_EXPORT VirtualPlugAttributeDelegate : public maquina::NodeDelegate::AttributeDelegate, public std::enable_shared_from_this<VirtualPlugAttributeDelegate>
{
public:
  VirtualPlugAttributeDelegate(const std::shared_ptr<VirtualAttributeNodeDelegate> parent, const VirtualAttribute& attrib);
  virtual std::shared_ptr<maquina::NodeDelegate> owner() override;
  virtual std::string name() const override;
  virtual bool is_mutable() const override;
  virtual bool is_visible() const override;
  virtual bool is_animable() const override;
  virtual bool accepts_overrides() const override;
  virtual bool is_overridden() const override;
  virtual void add_override() override;
  virtual void remove_override() override;
  virtual maquina::Value value(const maquina::QueryContext& qc=maquina::QueryContext::at_current_frame) const override;
  virtual maquina::StringView type_name() const override;
  virtual bool is_plug() const override;
  virtual maquina::Plug plug() const override;
  virtual std::shared_ptr<AttributeDescriptor> description() const override;
  virtual bool has_node_delegate() const override;
  virtual std::shared_ptr<maquina::NodeDelegate> node_delegate() override;
  virtual void set_value(const maquina::Value& value, const maquina::ModificationContext& mc = maquina::ModificationContext::undoable) override;
  
  std::shared_ptr<maquina::NodeDelegate::Observer> create_observer(const std::function<void()>& function, bool in_interactive = true) override;

private:
  std::shared_ptr<VirtualAttributeNodeDelegate> _owner;
  VirtualAttribute _attrib;
};

class MAQUINA_EXPORT DescBuild
{
public:
  DescBuild(const maquina::Node& n);
  void addPlug(const std::string& plug_name, const std::string& display_name);
  void addPlugs(const maquina::Array& plugs, const std::string& parent_path);
  void setRefreshPlug(const std::string& plug_name);
  std::string closeDescription();

private:
  void _collectGroups(rapidjson::Value& parent, const std::string& parent_path, const std::string& parent_pointer);
  rapidjson::Value& _createGroup(const std::string& name, rapidjson::Value& parent, const std::string& parent_path, const std::string& parent_pointer);
  rapidjson::Value& _getGroup(const std::string& name);
  void _addPlug(const std::string& name, rapidjson::Value& parent);

private:
  rapidjson::Document document;
  std::map<std::string, std::string> group_path_to_pointer;
};

}