Value.h

Go to the documentation of this file.

/*

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

*/
#pragma once

#include "Impl.h"
#include "StringView.h"
#include "Macros.h"

MAQUINA_IGNORE_WARNINGS_BEGIN
#include <ImathBox.h>
#include <ImathColor.h>
#include <ImathMatrix.h>
#include <ImathQuat.h>
MAQUINA_IGNORE_WARNINGS_END

  namespace maquina
  {
    class UserData;
    class NodeDelegate;

    class MAQUINA_EXPORT Value
    {
    public:
      Value();


      Value(bool);
      Value(int);
      Value(float);
      Value(double);
      Value(const char *string);
      Value(const wchar_t *string);
      Value(const std::string &string);
      Value(const std::wstring &string);
      Value(const Imath::V2f &);
      Value(const Imath::V3f &);
      Value(const Imath::V4f &);
      Value(const Imath::V2d &);
      Value(const Imath::V3d &);
      Value(const Imath::V4d &);
      Value(const Imath::V2i &);
      Value(const Imath::V3i &);
      Value(const Imath::V4i &);
      Value(const Imath::Color4f &);
      Value(const Imath::M44f &);
      Value(const Imath::M44d &);
      Value(const Imath::Box3f &);
      Value(const Imath::Quatf &);
      Value(const Imath::Quatd &);
      Value(const std::shared_ptr<const UserData>& user_data);



      Value duplicate() const;


      bool as_bool() const;


      int as_int() const;


      float as_float() const;


      double as_double() const;


      const std::string& as_string() const;


      std::wstring as_wstring() const;


      Imath::V2f as_V2f() const;


      Imath::V3f as_V3f() const;


      Imath::V4f as_V4f() const;


      const Imath::V2d& as_V2d() const;


      const Imath::V3d& as_V3d() const;


      const Imath::V4d& as_V4d() const;


      const Imath::V2i& as_V2i() const;


      const Imath::V3i& as_V3i() const;


      const Imath::V4i& as_V4i() const;


      Imath::M44f as_M44f() const;


      const Imath::M44d &as_M44d() const;


      const Imath::Box3f& as_Box3f() const;


      const Imath::Color4f& as_Color4f() const;


      Imath::Quatf as_Quatf() const;


      const Imath::Quatd& as_Quatd() const;


      std::shared_ptr<const UserData> as_user_data() const;



      StringView type_name() const;

      bool has_node_delegate() const;

      std::shared_ptr< NodeDelegate> node_delegate( 
        const std::shared_ptr<NodeDelegate>& parent,
        const StringView& name) const;

      bool operator==(const Value& o) const;
      bool operator!=(const Value& o) const;

      bool is_instance( const char* value_type_name ) const;

      bool is_interpolable() const;

      Value lerp(const Value& other, double weight) const;

      static bool validate_type_name(const char* type_name);

      static Value get_default_value(const char* type_name);

      static const Value default_value;

      std::shared_ptr<Impl> _impl;

      Value(const std::shared_ptr<Impl> &impl) { _impl=impl; }
    };
  }

// A hash implementation which uses the implementation pointer.
// Consistent with the way equality works.
// Allows using Value as a map key.
template<>
struct std::hash<maquina::Value>
{
  std::size_t operator()(maquina::Value const &v) const noexcept
  {
    return std::hash<maquina::Impl *>{}(v._impl.get());
  }
};