Loading...
Searching...
No Matches
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
52class HdConeSchema : public HdSchema
53{
54public:
57
58 HdConeSchema(HdContainerDataSourceHandle container)
59 : HdSchema(container) {}
60
66 HD_API
67 static HdConeSchema 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 HdTokenDataSourceHandle GetAxis() const;
86
88
91
94 HD_API
95 static const TfToken &GetSchemaToken();
96
99 HD_API
100 static const HdDataSourceLocator &GetDefaultLocator();
101
103
106
114 HD_API
115 static HdContainerDataSourceHandle
116 BuildRetained(
117 const HdDoubleDataSourceHandle &height,
118 const HdDoubleDataSourceHandle &radius,
119 const HdTokenDataSourceHandle &axis
120 );
121
129 {
130 public:
131 HD_API
132 Builder &SetHeight(
133 const HdDoubleDataSourceHandle &height);
134 HD_API
135 Builder &SetRadius(
136 const HdDoubleDataSourceHandle &radius);
137 HD_API
138 Builder &SetAxis(
139 const HdTokenDataSourceHandle &axis);
140
142 HD_API
143 HdContainerDataSourceHandle Build();
144
145 private:
146 HdDoubleDataSourceHandle _height;
147 HdDoubleDataSourceHandle _radius;
148 HdTokenDataSourceHandle _axis;
149
150 };
151
159 HD_API
160 static HdTokenDataSourceHandle BuildAxisDataSource(
161 const TfToken &axis);
162
164};
165
166PXR_NAMESPACE_CLOSE_SCOPE
167
168#endif
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
Definition: coneSchema.h:129
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:92