Loading...
Searching...
No Matches
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//
25
26/* ************************************************************************** */
27/* ** ** */
28/* ** This file is generated by a script. ** */
29/* ** ** */
30/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
31/* ** Edit hdSchemaDefs.py instead to make changes. ** */
32/* ** ** */
33/* ************************************************************************** */
34
35#ifndef PXR_IMAGING_HD_PRIM_ORIGIN_SCHEMA_H
36#define PXR_IMAGING_HD_PRIM_ORIGIN_SCHEMA_H
37
39
40#include "pxr/imaging/hd/api.h"
41
42#include "pxr/imaging/hd/schema.h"
43
44// --(BEGIN CUSTOM CODE: Includes)--
45// --(END CUSTOM CODE: Includes)--
46
47PXR_NAMESPACE_OPEN_SCOPE
48
49// --(BEGIN CUSTOM CODE: Declares)--
50// --(END CUSTOM CODE: Declares)--
51
52#define HD_PRIM_ORIGIN_SCHEMA_TOKENS \
53 (primOrigin) \
54 (scenePath) \
55
56TF_DECLARE_PUBLIC_TOKENS(HdPrimOriginSchemaTokens, HD_API,
57 HD_PRIM_ORIGIN_SCHEMA_TOKENS);
58
59//-----------------------------------------------------------------------------
60
61
62class HdPrimOriginSchema : public HdSchema
63{
64public:
67
68 HdPrimOriginSchema(HdContainerDataSourceHandle container)
69 : HdSchema(container) {}
70
76 HD_API
77 static HdPrimOriginSchema GetFromParent(
78 const HdContainerDataSourceHandle &fromParentContainer);
79
81
82// --(BEGIN CUSTOM CODE: Schema Methods)--
85 class OriginPath {
86 public:
87 OriginPath(const SdfPath &path)
88 : _path(path)
89 {
90 }
91
92 const SdfPath &GetPath() const { return _path; }
93
94 bool operator==(const OriginPath &other) const {
95 return _path == other._path;
96 }
97
98 private:
99 HD_API
100 friend std::ostream &operator <<(std::ostream &stream,
101 OriginPath const &p);
102
103 SdfPath _path;
104 };
105
107
110 HD_API SdfPath GetOriginPath(const TfToken &name) const;
111
112// --(END CUSTOM CODE: Schema Methods)--
113
116
118
121
124 HD_API
125 static const TfToken &GetSchemaToken();
126
129 HD_API
130 static const HdDataSourceLocator &GetDefaultLocator();
131
133
142
145 HD_API
146 static const HdDataSourceLocator &GetScenePathLocator();
148
151
153};
154
155PXR_NAMESPACE_CLOSE_SCOPE
156
157#endif
Represents an object that can identify the location of a data source.
Wraps an SdfPath so that it is not affected by the prefixing scene index.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:43
A datasource representing a concretely-typed sampled value.
Definition: dataSource.h:210
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:98