Scene.h

Go to the documentation of this file.

/*

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

*/
#pragma once

#include <functional>

#include "Shape.h"

  namespace maquina
  {

    class MAQUINA_EXPORT SceneConst : public Value
    {
    public:
      SceneConst();
      SceneConst(const Value &v);

      const std::string& name() const;

      const Imath::M44d& matrix() const;


      bool is_shown() const;

      bool is_selected() const;

      bool reset_matrix() const;

      bool has_geometry() const;

      const Shape geometry() const;


      Imath::Box3d bounding_box() const;


      bool has_attribute(const StringView& attribute) const;


      const Value attribute(const StringView& attribute) const;


      class MAQUINA_EXPORT Attributes
      {
      public:
        class MAQUINA_EXPORT Iterator
        {
        public:
          bool operator==(const Iterator &other) const;
          bool operator!=(const Iterator &other) const;
          Iterator& operator++();
          Iterator(void *iterator);
          Iterator(const Iterator& other);
          ~Iterator();

          StringView name() const;
          Value value() const;
        private:
          void *_internal;
        };

        Attributes(std::shared_ptr<Impl> _value);

        Iterator begin() const;
        Iterator end() const;

        size_t size() const;
      private:
        std::shared_ptr<Impl> _value;
      };

      Attributes read_attributes() const;


      std::shared_ptr<SceneConst> child(
        const std::string& path,   
        Imath::M44d* world_matrix = nullptr 
      ) const;


      std::pair<SceneConst, bool> filter(const std::function<std::pair<SceneConst, bool>(const SceneConst& scene, const StringView& path, const Imath::M44d* parent_world)>& filter_func,
        const StringView& root_path = "", const Imath::M44d* root_world = nullptr) const;


      class MAQUINA_EXPORT TraversalAttributes
      {
      public:
        class MAQUINA_EXPORT Iterator
        {
        public:
          bool operator==(const Iterator &other) const;
          bool operator!=(const Iterator &other) const;
          Iterator& operator++();
          Iterator(void *iterator);
          Iterator(const Iterator& other);
          ~Iterator();

          StringView name() const;
          Value value() const;
        private:
          void *_internal;
        };

        TraversalAttributes(void *internal_);
        Iterator begin() const;
        Iterator end() const;

        size_t size() const;
      private:
        void* _internal;
      };


      class MAQUINA_EXPORT Traversal
      {
      public:
        class MAQUINA_EXPORT Iterator
        {
        public:
          using iterator_category = std::forward_iterator_tag;
          using value_type = SceneConst;
          using difference_type = std::ptrdiff_t;
          using pointer = SceneConst;
          using reference = SceneConst;

          reference operator*() const;
          bool operator==(const Iterator &other) const;
          bool operator!=(const Iterator &other) const;
          Iterator& operator++();
          Iterator(void *iterator);
          Iterator( const Iterator &other );
          ~Iterator();

          Imath::M44d world_matrix() const;

          bool visible() const;

          std::string path() const;

          bool has_attribute(const StringView& attribute) const;


          Value attribute(const StringView& attribute) const;


          TraversalAttributes attributes() const;

        private:
          void *_internal;
        };

        Traversal( const std::shared_ptr<Impl>& value, bool children_only, bool shapes_only )
          : _value{ value }, _children_only(children_only), _shapes_only(shapes_only)
        {}
        Iterator begin() const;
        Iterator end() const;

        size_t size() const;
      private:
        std::shared_ptr<Impl> _value;
        bool _children_only;
        bool _shapes_only;
      };

      Traversal read_children(bool children_only = false, bool shapes_only = false) const;

      static const SceneConst default_value;

      SceneConst(std::shared_ptr<Impl> impl) { _impl=impl; }
    };

    class MAQUINA_EXPORT Scene : public SceneConst
    {
    public:
      Scene(const StringView& name = "", const gsl::span<SceneConst>& children = gsl::span<SceneConst>());

      void set_name(const char*);

      void set_matrix(const Imath::M44d&);

      void set_shown(bool shown);

      void set_selected(bool selected);

      void set_reset_matrix(bool reset);

      void set_geometry(const Shape& geometry);

      void remove_geometry();


      void set_attribute(const StringView& attribute, const Value& value);

      void remove_attribute(const StringView& attribute);

      void merge(const SceneConst& other, const std::function<void(Scene& a, const SceneConst& b)>& func);


      Scene add_child(
        const std::string& path   
      );

      void add_child(const SceneConst& child);

      void remove_child(const std::string& name);

      void clear_children();

      // Remove all children nodes which are empty
      void prune_empty_nodes();


      class MAQUINA_EXPORT Traversal
      {
      public:
        class MAQUINA_EXPORT Iterator
        {
        public:
          using iterator_category = std::forward_iterator_tag;
          using value_type = Scene;
          using difference_type = std::ptrdiff_t;
          using pointer = Scene;
          using reference = Scene;

          reference operator*() const;
          bool operator==(const Iterator &other) const;
          bool operator!=(const Iterator &other) const;
          Iterator& operator++();
          Iterator(void *iterator);
          Iterator(const Iterator &other);
          Iterator(Iterator &&other) noexcept;
          Iterator& operator=(const Iterator& other);
          Iterator& operator=(Iterator&& other) noexcept;
          ~Iterator();

          Imath::M44d world_matrix() const;

          bool visible() const;


          std::string path() const;

          bool has_attribute(const StringView& attribute) const;


          Value attribute(const StringView& attribute) const;


          TraversalAttributes attributes() const;
       private:
          void *_internal;
        };

        Traversal( const std::shared_ptr<Impl>& value, bool children_only, bool shapes_only )
          : _value{ value }, _children_only(children_only), _shapes_only(shapes_only)
        {}
        Iterator begin() const;
        Iterator end() const;

        size_t size() const;
      private:
        std::shared_ptr<Impl> _value;
        bool _children_only;
        bool _shapes_only;
      };

      Traversal write_children(bool children_only = false, bool shapes_only = false);

      Scene(std::shared_ptr<Impl> impl) { _impl=impl; }
    };

    MAQUINA_EXPORT Scene duplicate(
      const SceneConst& scene,  
      bool recursive);          

  }