All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
capsuleSchema.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_CAPSULE_SCHEMA_H
19#define PXR_IMAGING_HD_CAPSULE_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_CAPSULE_SCHEMA_TOKENS \
36 (capsule) \
37 (height) \
38 (radius) \
39 (radiusTop) \
40 (radiusBottom) \
41 (axis) \
42 (X) \
43 (Y) \
44 (Z) \
45
46TF_DECLARE_PUBLIC_TOKENS(HdCapsuleSchemaTokens, HD_API,
47 HD_CAPSULE_SCHEMA_TOKENS);
48
49//-----------------------------------------------------------------------------
50
51
52class HdCapsuleSchema : public HdSchema
53{
54public:
57
58 HdCapsuleSchema(HdContainerDataSourceHandle container)
59 : HdSchema(container) {}
60
66 HD_API
67 static HdCapsuleSchema GetFromParent(
68 const HdContainerDataSourceHandle &fromParentContainer);
69
71
72// --(BEGIN CUSTOM CODE: Schema Methods)--
73// --(END CUSTOM CODE: Schema Methods)--
74
77
78 HD_API
79 HdDoubleDataSourceHandle GetHeight() const;
80
81 HD_API
82 HdDoubleDataSourceHandle GetRadius() const;
83
84 HD_API
85 HdDoubleDataSourceHandle GetRadiusTop() const;
86
87 HD_API
88 HdDoubleDataSourceHandle GetRadiusBottom() const;
89
90 HD_API
91 HdTokenDataSourceHandle GetAxis() const;
92
94
97
100 HD_API
101 static const TfToken &GetSchemaToken();
102
105 HD_API
106 static const HdDataSourceLocator &GetDefaultLocator();
107
109
112
120 HD_API
121 static HdContainerDataSourceHandle
122 BuildRetained(
123 const HdDoubleDataSourceHandle &height,
124 const HdDoubleDataSourceHandle &radius,
125 const HdDoubleDataSourceHandle &radiusTop,
126 const HdDoubleDataSourceHandle &radiusBottom,
127 const HdTokenDataSourceHandle &axis
128 );
129
137 {
138 public:
139 HD_API
140 Builder &SetHeight(
141 const HdDoubleDataSourceHandle &height);
142 HD_API
143 Builder &SetRadius(
144 const HdDoubleDataSourceHandle &radius);
145 HD_API
146 Builder &SetRadiusTop(
147 const HdDoubleDataSourceHandle &radiusTop);
148 HD_API
149 Builder &SetRadiusBottom(
150 const HdDoubleDataSourceHandle &radiusBottom);
151 HD_API
152 Builder &SetAxis(
153 const HdTokenDataSourceHandle &axis);
154
156 HD_API
157 HdContainerDataSourceHandle Build();
158
159 private:
160 HdDoubleDataSourceHandle _height;
161 HdDoubleDataSourceHandle _radius;
162 HdDoubleDataSourceHandle _radiusTop;
163 HdDoubleDataSourceHandle _radiusBottom;
164 HdTokenDataSourceHandle _axis;
165
166 };
167
175 HD_API
176 static HdTokenDataSourceHandle BuildAxisDataSource(
177 const TfToken &axis);
178
180};
181
182PXR_NAMESPACE_CLOSE_SCOPE
183
184#endif
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.
Represents an object that can identify the location of a data source.
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