Loading...
Searching...
No Matches
cylinderSchema.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_CYLINDER_SCHEMA_H
36#define PXR_IMAGING_HD_CYLINDER_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_CYLINDER_SCHEMA_TOKENS \
53 (cylinder) \
54 (height) \
55 (radius) \
56 (radiusTop) \
57 (radiusBottom) \
58 (axis) \
59 (X) \
60 (Y) \
61 (Z) \
62
63TF_DECLARE_PUBLIC_TOKENS(HdCylinderSchemaTokens, HD_API,
64 HD_CYLINDER_SCHEMA_TOKENS);
65
66//-----------------------------------------------------------------------------
67
68
69class HdCylinderSchema : public HdSchema
70{
71public:
74
75 HdCylinderSchema(HdContainerDataSourceHandle container)
76 : HdSchema(container) {}
77
83 HD_API
84 static HdCylinderSchema GetFromParent(
85 const HdContainerDataSourceHandle &fromParentContainer);
86
88
89// --(BEGIN CUSTOM CODE: Schema Methods)--
90// --(END CUSTOM CODE: Schema Methods)--
91
94
95 HD_API
96 HdDoubleDataSourceHandle GetHeight() const;
97
98 HD_API
99 HdDoubleDataSourceHandle GetRadius() const;
100
101 HD_API
102 HdDoubleDataSourceHandle GetRadiusTop() const;
103
104 HD_API
105 HdDoubleDataSourceHandle GetRadiusBottom() const;
106
107 HD_API
108 HdTokenDataSourceHandle GetAxis() const;
109
111
114
117 HD_API
118 static const TfToken &GetSchemaToken();
119
122 HD_API
123 static const HdDataSourceLocator &GetDefaultLocator();
124
126
129
137 HD_API
138 static HdContainerDataSourceHandle
139 BuildRetained(
140 const HdDoubleDataSourceHandle &height,
141 const HdDoubleDataSourceHandle &radius,
142 const HdDoubleDataSourceHandle &radiusTop,
143 const HdDoubleDataSourceHandle &radiusBottom,
144 const HdTokenDataSourceHandle &axis
145 );
146
154 {
155 public:
156 HD_API
157 Builder &SetHeight(
158 const HdDoubleDataSourceHandle &height);
159 HD_API
160 Builder &SetRadius(
161 const HdDoubleDataSourceHandle &radius);
162 HD_API
163 Builder &SetRadiusTop(
164 const HdDoubleDataSourceHandle &radiusTop);
165 HD_API
166 Builder &SetRadiusBottom(
167 const HdDoubleDataSourceHandle &radiusBottom);
168 HD_API
169 Builder &SetAxis(
170 const HdTokenDataSourceHandle &axis);
171
173 HD_API
174 HdContainerDataSourceHandle Build();
175
176 private:
177 HdDoubleDataSourceHandle _height;
178 HdDoubleDataSourceHandle _radius;
179 HdDoubleDataSourceHandle _radiusTop;
180 HdDoubleDataSourceHandle _radiusBottom;
181 HdTokenDataSourceHandle _axis;
182
183 };
184
192 HD_API
193 static HdTokenDataSourceHandle BuildAxisDataSource(
194 const TfToken &axis);
195
197};
198
199PXR_NAMESPACE_CLOSE_SCOPE
200
201#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:43
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