HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
site.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_USD_SDF_SITE_H
25 #define PXR_USD_SDF_SITE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/sdf/layer.h"
29 #include "pxr/usd/sdf/path.h"
30 
31 #include <set>
32 #include <vector>
33 #include <hboost/operators.hpp>
34 
36 
37 /// \class SdfSite
38 ///
39 /// An SdfSite is a simple representation of a location in a layer where
40 /// opinions may possibly be found. It is simply a pair of layer and path
41 /// within that layer.
42 ///
43 class SdfSite
44  : public hboost::totally_ordered<SdfSite>
45 {
46 public:
47  SdfSite() { }
48  SdfSite(const SdfLayerHandle& layer_, const SdfPath& path_)
49  : layer(layer_)
50  , path(path_)
51  { }
52 
53  bool operator==(const SdfSite& other) const
54  {
55  return layer == other.layer && path == other.path;
56  }
57 
58  bool operator<(const SdfSite& other) const
59  {
60  return layer < other.layer ||
61  (!(other.layer < layer) && path < other.path);
62  }
63 
64  /// Explicit bool conversion operator. A site object converts to \c true iff
65  /// both the layer and path fields are filled with valid values, \c false
66  /// otherwise.
67  /// This does NOT imply that there are opinions in the layer at that path.
68  explicit operator bool() const
69  {
70  return layer && !path.IsEmpty();
71  }
72 
73 public:
74  SdfLayerHandle layer;
76 };
77 
78 typedef std::set<SdfSite> SdfSiteSet;
79 typedef std::vector<SdfSite> SdfSiteVector;
80 
82 
83 #endif // PXR_USD_SDF_SITE_H
SdfPath path
Definition: site.h:75
std::vector< SdfSite > SdfSiteVector
Definition: site.h:79
bool operator==(const SdfSite &other) const
Definition: site.h:53
bool operator<(const SdfSite &other) const
Definition: site.h:58
Definition: site.h:43
SdfSite()
Definition: site.h:47
Definition: path.h:288
GLsizei const GLchar *const * path
Definition: glew.h:6461
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
SdfLayerHandle layer
Definition: site.h:74
GLint GLboolean GLint layer
Definition: glew.h:3601
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::set< SdfSite > SdfSiteSet
Definition: site.h:78
SdfSite(const SdfLayerHandle &layer_, const SdfPath &path_)
Definition: site.h:48