All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
purposeSchema.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_PURPOSE_SCHEMA_H
19#define PXR_IMAGING_HD_PURPOSE_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_PURPOSE_SCHEMA_TOKENS \
36 (purpose) \
37
38TF_DECLARE_PUBLIC_TOKENS(HdPurposeSchemaTokens, HD_API,
39 HD_PURPOSE_SCHEMA_TOKENS);
40
41//-----------------------------------------------------------------------------
42
43
44class HdPurposeSchema : public HdSchema
45{
46public:
49
50 HdPurposeSchema(HdContainerDataSourceHandle container)
51 : HdSchema(container) {}
52
58 HD_API
59 static HdPurposeSchema GetFromParent(
60 const HdContainerDataSourceHandle &fromParentContainer);
61
63
64// --(BEGIN CUSTOM CODE: Schema Methods)--
65// --(END CUSTOM CODE: Schema Methods)--
66
69
70 HD_API
71 HdTokenDataSourceHandle GetPurpose() const;
72
74
77
80 HD_API
81 static const TfToken &GetSchemaToken();
82
85 HD_API
86 static const HdDataSourceLocator &GetDefaultLocator();
87
89
92
100 HD_API
101 static HdContainerDataSourceHandle
102 BuildRetained(
103 const HdTokenDataSourceHandle &purpose
104 );
105
113 {
114 public:
115 HD_API
116 Builder &SetPurpose(
117 const HdTokenDataSourceHandle &purpose);
118
120 HD_API
121 HdContainerDataSourceHandle Build();
122
123 private:
124 HdTokenDataSourceHandle _purpose;
125
126 };
127
129};
130
131PXR_NAMESPACE_CLOSE_SCOPE
132
133#endif
Represents an object that can identify the location of a data source.
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:26
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