HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
utils.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_BASE_JS_UTILS_H
25 #define PXR_BASE_JS_UTILS_H
26 
27 /// \file js/utils.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/base/js/api.h"
31 #include "pxr/base/js/value.h"
32 
33 #include <hboost/none.hpp>
34 #include <hboost/optional.hpp>
35 #include <string>
36 
38 
39 typedef hboost::optional<JsValue> JsOptionalValue;
40 
41 /// Returns the value associated with \p key in the given \p object. If no
42 /// such key exists, and the supplied default is not supplied, this method
43 /// returns an uninitialized optional JsValue. Otherwise, the \p
44 /// defaultValue is returned.
45 JS_API
47  const JsObject& object,
48  const std::string& key,
49  const JsOptionalValue& defaultValue = hboost::none);
50 
52 
53 #endif // PXR_BASE_JS_UTILS_H
PXR_NAMESPACE_OPEN_SCOPE typedef hboost::optional< JsValue > JsOptionalValue
Definition: utils.h:39
bool none(const vbool4 &v)
Definition: simd.h:3373
JS_API JsOptionalValue JsFindValue(const JsObject &object, const std::string &key, const JsOptionalValue &defaultValue=hboost::none)
#define JS_API
Definition: api.h:40
std::map< std::string, JsValue > JsObject
Definition: types.h:37
GLsizei const GLchar *const * string
Definition: glew.h:1844
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91