Open3D (C++ API)  0.16.1
IJsonConvertible.h
Go to the documentation of this file.
1 // ----------------------------------------------------------------------------
2 // - Open3D: www.open3d.org -
3 // ----------------------------------------------------------------------------
4 // The MIT License (MIT)
5 //
6 // Copyright (c) 2018-2021 www.open3d.org
7 //
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to deal
10 // in the Software without restriction, including without limitation the rights
11 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 // copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
14 //
15 // The above copyright notice and this permission notice shall be included in
16 // all copies or substantial portions of the Software.
17 //
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 // IN THE SOFTWARE.
25 // ----------------------------------------------------------------------------
26 
27 #pragma once
28 
29 #include <fmt/format.h>
30 
31 #include <Eigen/Core>
32 
33 #include "open3d/utility/Eigen.h"
34 
36 namespace Json {
37 class Value;
38 } // namespace Json
40 
41 namespace open3d {
42 namespace utility {
43 
49 Json::Value StringToJson(const std::string &json_str);
50 
55 std::string JsonToString(const Json::Value &json);
56 
60 public:
61  virtual ~IJsonConvertible() {}
62 
63 public:
64  virtual bool ConvertToJsonValue(Json::Value &value) const = 0;
65  virtual bool ConvertFromJsonValue(const Json::Value &value) = 0;
66 
68  virtual std::string ToString() const;
69 
70 public:
71  static bool EigenVector3dFromJsonArray(Eigen::Vector3d &vec,
72  const Json::Value &value);
73  static bool EigenVector3dToJsonArray(const Eigen::Vector3d &vec,
74  Json::Value &value);
75  static bool EigenVector4dFromJsonArray(Eigen::Vector4d &vec,
76  const Json::Value &value);
77  static bool EigenVector4dToJsonArray(const Eigen::Vector4d &vec,
78  Json::Value &value);
79  static bool EigenMatrix3dFromJsonArray(Eigen::Matrix3d &mat,
80  const Json::Value &value);
81  static bool EigenMatrix3dToJsonArray(const Eigen::Matrix3d &mat,
82  Json::Value &value);
83  static bool EigenMatrix4dFromJsonArray(Eigen::Matrix4d &mat,
84  const Json::Value &value);
85  static bool EigenMatrix4dToJsonArray(const Eigen::Matrix4d &mat,
86  Json::Value &value);
87  static bool EigenMatrix4dFromJsonArray(Eigen::Matrix4d_u &mat,
88  const Json::Value &value);
89  static bool EigenMatrix4dToJsonArray(const Eigen::Matrix4d_u &mat,
90  Json::Value &value);
91  static bool EigenMatrix6dFromJsonArray(Eigen::Matrix6d &mat,
92  const Json::Value &value);
93  static bool EigenMatrix6dToJsonArray(const Eigen::Matrix6d &mat,
94  Json::Value &value);
95  static bool EigenMatrix6dFromJsonArray(Eigen::Matrix6d_u &mat,
96  const Json::Value &value);
97  static bool EigenMatrix6dToJsonArray(const Eigen::Matrix6d_u &mat,
98  Json::Value &value);
99 };
100 
101 } // namespace utility
102 } // namespace open3d
103 
104 namespace fmt {
105 template <>
106 struct formatter<Json::Value> {
107  template <typename FormatContext>
108  auto format(const Json::Value &value, FormatContext &ctx)
109  -> decltype(ctx.out()) {
110  return format_to(ctx.out(), "{}", open3d::utility::JsonToString(value));
111  }
112 
113  template <typename ParseContext>
114  constexpr auto parse(ParseContext &ctx) -> decltype(ctx.begin()) {
115  return ctx.begin();
116  }
117 };
118 
119 } // namespace fmt
Definition: IJsonConvertible.h:59
static bool EigenMatrix4dFromJsonArray(Eigen::Matrix4d &mat, const Json::Value &value)
Definition: IJsonConvertible.cpp:125
static bool EigenVector3dFromJsonArray(Eigen::Vector3d &vec, const Json::Value &value)
Definition: IJsonConvertible.cpp:60
static bool EigenVector4dFromJsonArray(Eigen::Vector4d &vec, const Json::Value &value)
Definition: IJsonConvertible.cpp:81
virtual bool ConvertFromJsonValue(const Json::Value &value)=0
static bool EigenMatrix6dFromJsonArray(Eigen::Matrix6d &mat, const Json::Value &value)
Definition: IJsonConvertible.cpp:167
static bool EigenMatrix3dFromJsonArray(Eigen::Matrix3d &mat, const Json::Value &value)
Definition: IJsonConvertible.cpp:104
static bool EigenMatrix6dToJsonArray(const Eigen::Matrix6d &mat, Json::Value &value)
Definition: IJsonConvertible.cpp:179
virtual bool ConvertToJsonValue(Json::Value &value) const =0
static bool EigenMatrix4dToJsonArray(const Eigen::Matrix4d &mat, Json::Value &value)
Definition: IJsonConvertible.cpp:137
static bool EigenVector4dToJsonArray(const Eigen::Vector4d &vec, Json::Value &value)
Definition: IJsonConvertible.cpp:94
static bool EigenVector3dToJsonArray(const Eigen::Vector3d &vec, Json::Value &value)
Definition: IJsonConvertible.cpp:72
virtual std::string ToString() const
Convert to a styled string representation of JSON data for display.
Definition: IJsonConvertible.cpp:54
static bool EigenMatrix3dToJsonArray(const Eigen::Matrix3d &mat, Json::Value &value)
Definition: IJsonConvertible.cpp:116
virtual ~IJsonConvertible()
Definition: IJsonConvertible.h:61
Definition: IJsonConvertible.h:104
Json::Value StringToJson(const std::string &json_str)
Parse string and convert to Json::value. Throws exception if the conversion is invalid.
Definition: IJsonConvertible.cpp:38
std::string JsonToString(const Json::Value &json)
Serialize a Json::Value to a string.
Definition: IJsonConvertible.cpp:50
Definition: PinholeCameraIntrinsic.cpp:35
constexpr auto parse(ParseContext &ctx) -> decltype(ctx.begin())
Definition: IJsonConvertible.h:114
auto format(const Json::Value &value, FormatContext &ctx) -> decltype(ctx.out())
Definition: IJsonConvertible.h:108