All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
primOriginSchema.h
Go to the documentation of this file.
1//
2// Copyright 2023 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
8
9/* ************************************************************************** */
10/* ** ** */
11/* ** This file is generated by a script. ** */
12/* ** ** */
13/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
14/* ** Edit hdSchemaDefs.py instead to make changes. ** */
15/* ** ** */
16/* ************************************************************************** */
17
18#ifndef PXR_IMAGING_HD_PRIM_ORIGIN_SCHEMA_H
19#define PXR_IMAGING_HD_PRIM_ORIGIN_SCHEMA_H
20
22
23#include "pxr/imaging/hd/api.h"
24
25#include "pxr/imaging/hd/schema.h"
26
27// --(BEGIN CUSTOM CODE: Includes)--
28// --(END CUSTOM CODE: Includes)--
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32// --(BEGIN CUSTOM CODE: Declares)--
33// --(END CUSTOM CODE: Declares)--
34
35#define HD_PRIM_ORIGIN_SCHEMA_TOKENS \
36 (primOrigin) \
37 (scenePath) \
38
39TF_DECLARE_PUBLIC_TOKENS(HdPrimOriginSchemaTokens, HD_API,
40 HD_PRIM_ORIGIN_SCHEMA_TOKENS);
41
42//-----------------------------------------------------------------------------
43
44
45class HdPrimOriginSchema : public HdSchema
46{
47public:
50
51 HdPrimOriginSchema(HdContainerDataSourceHandle container)
52 : HdSchema(container) {}
53
59 HD_API
60 static HdPrimOriginSchema GetFromParent(
61 const HdContainerDataSourceHandle &fromParentContainer);
62
64
65// --(BEGIN CUSTOM CODE: Schema Methods)--
68 class OriginPath {
69 public:
70 OriginPath(const SdfPath &path)
71 : _path(path)
72 {
73 }
74
75 const SdfPath &GetPath() const { return _path; }
76
77 bool operator==(const OriginPath &other) const {
78 return _path == other._path;
79 }
80
81 private:
82 HD_API
83 friend std::ostream &operator <<(std::ostream &stream,
84 OriginPath const &p);
85
86 SdfPath _path;
87 };
88
90
93 HD_API SdfPath GetOriginPath(const TfToken &name) const;
94
95// --(END CUSTOM CODE: Schema Methods)--
96
99
101
104
107 HD_API
108 static const TfToken &GetSchemaToken();
109
112 HD_API
113 static const HdDataSourceLocator &GetDefaultLocator();
114
116
125
128 HD_API
129 static const HdDataSourceLocator &GetScenePathLocator();
131
134
136};
137
138PXR_NAMESPACE_CLOSE_SCOPE
139
140#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:26
A datasource representing a concretely-typed sampled value.
Definition: dataSource.h:193
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81