All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
coneSchema.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_CONE_SCHEMA_H
19#define PXR_IMAGING_HD_CONE_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_CONE_SCHEMA_TOKENS \
36 (cone) \
37 (height) \
38 (radius) \
39 (axis) \
40 (X) \
41 (Y) \
42 (Z) \
43
44TF_DECLARE_PUBLIC_TOKENS(HdConeSchemaTokens, HD_API,
45 HD_CONE_SCHEMA_TOKENS);
46
47//-----------------------------------------------------------------------------
48
49
50class HdConeSchema : public HdSchema
51{
52public:
55
56 HdConeSchema(HdContainerDataSourceHandle container)
57 : HdSchema(container) {}
58
64 HD_API
65 static HdConeSchema GetFromParent(
66 const HdContainerDataSourceHandle &fromParentContainer);
67
69
70// --(BEGIN CUSTOM CODE: Schema Methods)--
71// --(END CUSTOM CODE: Schema Methods)--
72
75
76 HD_API
77 HdDoubleDataSourceHandle GetHeight() const;
78
79 HD_API
80 HdDoubleDataSourceHandle GetRadius() const;
81
82 HD_API
83 HdTokenDataSourceHandle GetAxis() const;
84
86
89
92 HD_API
93 static const TfToken &GetSchemaToken();
94
97 HD_API
98 static const HdDataSourceLocator &GetDefaultLocator();
99
101
104
112 HD_API
113 static HdContainerDataSourceHandle
114 BuildRetained(
115 const HdDoubleDataSourceHandle &height,
116 const HdDoubleDataSourceHandle &radius,
117 const HdTokenDataSourceHandle &axis
118 );
119
127 {
128 public:
129 HD_API
130 Builder &SetHeight(
131 const HdDoubleDataSourceHandle &height);
132 HD_API
133 Builder &SetRadius(
134 const HdDoubleDataSourceHandle &radius);
135 HD_API
136 Builder &SetAxis(
137 const HdTokenDataSourceHandle &axis);
138
140 HD_API
141 HdContainerDataSourceHandle Build();
142
143 private:
144 HdDoubleDataSourceHandle _height;
145 HdDoubleDataSourceHandle _radius;
146 HdTokenDataSourceHandle _axis;
147
148 };
149
157 HD_API
158 static HdTokenDataSourceHandle BuildAxisDataSource(
159 const TfToken &axis);
160
162};
163
164PXR_NAMESPACE_CLOSE_SCOPE
165
166#endif
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
Definition: coneSchema.h:127
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