HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
primOriginSchema.h
Go to the documentation of this file.
1 //
2 // Copyright 2023 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 ////////////////////////////////////////////////////////////////////////
25 
26 /* ************************************************************************** */
27 /* ** This file is generated by a script. Do not edit directly. Edit ** */
28 /* ** defs.py or the (*)Schema.template.h files to make changes. ** */
29 /* ************************************************************************** */
30 
31 #ifndef PXR_IMAGING_HD_PRIM_ORIGIN_SCHEMA_H
32 #define PXR_IMAGING_HD_PRIM_ORIGIN_SCHEMA_H
33 
34 #include "pxr/imaging/hd/api.h"
35 
36 #include "pxr/imaging/hd/schema.h"
37 
39 
40 //-----------------------------------------------------------------------------
41 
42 #define HD_PRIM_ORIGIN_SCHEMA_TOKENS \
43  (primOrigin) \
44  (scenePath) \
45 
46 TF_DECLARE_PUBLIC_TOKENS(HdPrimOriginSchemaTokens, HD_API,
48 
49 //-----------------------------------------------------------------------------
50 
52 {
53 public:
54  HdPrimOriginSchema(HdContainerDataSourceHandle container)
55  : HdSchema(container) {}
56 
57 // --(BEGIN CUSTOM CODE: Schema Methods)--
58  /// Wraps an SdfPath so that it is not affected by the
59  /// prefixing scene index.
60  class OriginPath {
61  public:
63  : _path(path)
64  {
65  }
66 
67  const SdfPath &GetPath() const { return _path; }
68 
69  bool operator==(const OriginPath &other) const {
70  return _path == other._path;
71  }
72 
73  private:
74  HD_API
75  friend std::ostream &operator <<(std::ostream &stream,
76  OriginPath const &p);
77 
78  SdfPath _path;
79  };
80 
82 
83  /// Extracts SdfPath from container that was added via
84  /// OriginPathDataSource.
85  HD_API SdfPath GetOriginPath(const TfToken &name) const;
86 
87 // --(END CUSTOM CODE: Schema Methods)--
88 
89 
90  /// Retrieves a container data source with the schema's default name token
91  /// "primOrigin" from the parent container and constructs a
92  /// HdPrimOriginSchema instance.
93  /// Because the requested container data source may not exist, the result
94  /// should be checked with IsDefined() or a bool comparison before use.
95  HD_API
97  const HdContainerDataSourceHandle &fromParentContainer);
98 
99  /// Returns a token where the container representing this schema is found in
100  /// a container by default.
101  HD_API
102  static const TfToken &GetSchemaToken();
103 
104  /// Returns an HdDataSourceLocator (relative to the prim-level data source)
105  /// where the container representing this schema is found by default.
106  HD_API
107  static const HdDataSourceLocator &GetDefaultLocator();
108 
109 
110  /// Returns an HdDataSourceLocator (relative to the prim-level data source)
111  /// where the scenepath data source can be found.
112  /// This is often useful for checking intersection against the
113  /// HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
114  HD_API
116 
117 };
118 
120 
121 #endif
GLuint GLuint stream
Definition: glcorearb.h:1832
bool operator==(const OriginPath &other) const
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
OriginPath(const SdfPath &path)
#define HD_API
Definition: api.h:40
HdPrimOriginSchema(HdContainerDataSourceHandle container)
HD_API SdfPath GetOriginPath(const TfToken &name) const
static HD_API const HdDataSourceLocator & GetDefaultLocator()
static HD_API const TfToken & GetSchemaToken()
Definition: token.h:87
const SdfPath & GetPath() const
TF_DECLARE_PUBLIC_TOKENS(HdPrimOriginSchemaTokens, HD_API, HD_PRIM_ORIGIN_SCHEMA_TOKENS)
GLuint const GLchar * name
Definition: glcorearb.h:786
Definition: path.h:290
HD_API friend std::ostream & operator<<(std::ostream &stream, OriginPath const &p)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
static HD_API HdPrimOriginSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static HD_API const HdDataSourceLocator & GetScenePathLocator()
#define HD_PRIM_ORIGIN_SCHEMA_TOKENS