All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
planeSchema.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_PLANE_SCHEMA_H
19#define PXR_IMAGING_HD_PLANE_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_PLANE_SCHEMA_TOKENS \
36 (plane) \
37 (doubleSided) \
38 (axis) \
39 (length) \
40 (width) \
41 (X) \
42 (Y) \
43 (Z) \
44
45TF_DECLARE_PUBLIC_TOKENS(HdPlaneSchemaTokens, HD_API,
46 HD_PLANE_SCHEMA_TOKENS);
47
48//-----------------------------------------------------------------------------
49
50
51class HdPlaneSchema : public HdSchema
52{
53public:
56
57 HdPlaneSchema(HdContainerDataSourceHandle container)
58 : HdSchema(container) {}
59
65 HD_API
66 static HdPlaneSchema GetFromParent(
67 const HdContainerDataSourceHandle &fromParentContainer);
68
70
71// --(BEGIN CUSTOM CODE: Schema Methods)--
72// --(END CUSTOM CODE: Schema Methods)--
73
76
77 HD_API
78 HdBoolDataSourceHandle GetDoubleSided() const;
79
80 HD_API
81 HdTokenDataSourceHandle GetAxis() const;
82
83 HD_API
84 HdDoubleDataSourceHandle GetLength() const;
85
86 HD_API
87 HdDoubleDataSourceHandle GetWidth() const;
88
90
93
96 HD_API
97 static const TfToken &GetSchemaToken();
98
101 HD_API
102 static const HdDataSourceLocator &GetDefaultLocator();
103
105
108
116 HD_API
117 static HdContainerDataSourceHandle
118 BuildRetained(
119 const HdBoolDataSourceHandle &doubleSided,
120 const HdTokenDataSourceHandle &axis,
121 const HdDoubleDataSourceHandle &length,
122 const HdDoubleDataSourceHandle &width
123 );
124
132 {
133 public:
134 HD_API
135 Builder &SetDoubleSided(
136 const HdBoolDataSourceHandle &doubleSided);
137 HD_API
138 Builder &SetAxis(
139 const HdTokenDataSourceHandle &axis);
140 HD_API
141 Builder &SetLength(
142 const HdDoubleDataSourceHandle &length);
143 HD_API
144 Builder &SetWidth(
145 const HdDoubleDataSourceHandle &width);
146
148 HD_API
149 HdContainerDataSourceHandle Build();
150
151 private:
152 HdBoolDataSourceHandle _doubleSided;
153 HdTokenDataSourceHandle _axis;
154 HdDoubleDataSourceHandle _length;
155 HdDoubleDataSourceHandle _width;
156
157 };
158
166 HD_API
167 static HdTokenDataSourceHandle BuildAxisDataSource(
168 const TfToken &axis);
169
171};
172
173PXR_NAMESPACE_CLOSE_SCOPE
174
175#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...
Definition: planeSchema.h:132
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