OSVR-Core
PathTreeSerialization.h
Go to the documentation of this file.
1 
11 // Copyright 2015 Sensics, Inc.
12 //
13 // Licensed under the Apache License, Version 2.0 (the "License");
14 // you may not use this file except in compliance with the License.
15 // You may obtain a copy of the License at
16 //
17 // http://www.apache.org/licenses/LICENSE-2.0
18 //
19 // Unless required by applicable law or agreed to in writing, software
20 // distributed under the License is distributed on an "AS IS" BASIS,
21 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 // See the License for the specific language governing permissions and
23 // limitations under the License.
24 
25 #ifndef INCLUDED_PathTreeSerialization_h_GUID_06DB59AB_C47B_4EA0_253A_7D5A45E94F08
26 #define INCLUDED_PathTreeSerialization_h_GUID_06DB59AB_C47B_4EA0_253A_7D5A45E94F08
27 
28 // Internal Includes
29 #include <osvr/Common/Export.h>
32 
33 // Library/third-party includes
34 #include <json/value.h>
35 
36 // Standard includes
37 #include <string>
38 
39 namespace osvr {
40 namespace common {
41 
43  OSVR_COMMON_EXPORT Json::Value pathNodeToJson(PathNode const &node);
44 
47  OSVR_COMMON_EXPORT Json::Value pathTreeToJson(PathTree const &tree,
48  bool keepNulls = false);
49 
51  OSVR_COMMON_EXPORT void jsonToPathTree(PathTree &tree, Json::Value nodes);
52 } // namespace common
53 } // namespace osvr
54 
55 #endif // INCLUDED_PathTreeSerialization_h_GUID_06DB59AB_C47B_4EA0_253A_7D5A45E94F08
Handles spatial transformations.
Definition: SerializationTraitExample_Complicated.h:40
::osvr::util::TreeNode< PathElement > PathNode
The specific tree node type that contains a path element.
Definition: PathNode_fwd.h:42
The main namespace for all C++ elements of the framework, internal and external.
Definition: namespace_osvr.dox:3
OSVR_COMMON_EXPORT void jsonToPathTree(PathTree &tree, Json::Value nodes)
Deserialize a path tree from a JSON array of objects.
Definition: PathTreeSerialization.cpp:98
OSVR_COMMON_EXPORT Json::Value pathTreeToJson(PathTree const &tree, bool keepNulls=false)
Serialize a path tree to a JSON array of objects, one for each node.
Definition: PathTreeSerialization.cpp:92
OSVR_COMMON_EXPORT Json::Value pathNodeToJson(PathNode const &node)
Serialize a path node to a JSON object.