Loading...
Searching...
No Matches
coneSchema.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_CONE_SCHEMA_H
36#define PXR_IMAGING_HD_CONE_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_CONE_SCHEMA_TOKENS \
53 (cone) \
54 (height) \
55 (radius) \
56 (axis) \
57 (X) \
58 (Y) \
59 (Z) \
60
61TF_DECLARE_PUBLIC_TOKENS(HdConeSchemaTokens, HD_API,
62 HD_CONE_SCHEMA_TOKENS);
63
64//-----------------------------------------------------------------------------
65
66
67class HdConeSchema : public HdSchema
68{
69public:
72
73 HdConeSchema(HdContainerDataSourceHandle container)
74 : HdSchema(container) {}
75
81 HD_API
82 static HdConeSchema GetFromParent(
83 const HdContainerDataSourceHandle &fromParentContainer);
84
86
87// --(BEGIN CUSTOM CODE: Schema Methods)--
88// --(END CUSTOM CODE: Schema Methods)--
89
92
93 HD_API
94 HdDoubleDataSourceHandle GetHeight() const;
95
96 HD_API
97 HdDoubleDataSourceHandle GetRadius() const;
98
99 HD_API
100 HdTokenDataSourceHandle GetAxis() const;
101
103
106
109 HD_API
110 static const TfToken &GetSchemaToken();
111
114 HD_API
115 static const HdDataSourceLocator &GetDefaultLocator();
116
118
121
129 HD_API
130 static HdContainerDataSourceHandle
131 BuildRetained(
132 const HdDoubleDataSourceHandle &height,
133 const HdDoubleDataSourceHandle &radius,
134 const HdTokenDataSourceHandle &axis
135 );
136
144 {
145 public:
146 HD_API
147 Builder &SetHeight(
148 const HdDoubleDataSourceHandle &height);
149 HD_API
150 Builder &SetRadius(
151 const HdDoubleDataSourceHandle &radius);
152 HD_API
153 Builder &SetAxis(
154 const HdTokenDataSourceHandle &axis);
155
157 HD_API
158 HdContainerDataSourceHandle Build();
159
160 private:
161 HdDoubleDataSourceHandle _height;
162 HdDoubleDataSourceHandle _radius;
163 HdTokenDataSourceHandle _axis;
164
165 };
166
174 HD_API
175 static HdTokenDataSourceHandle BuildAxisDataSource(
176 const TfToken &axis);
177
179};
180
181PXR_NAMESPACE_CLOSE_SCOPE
182
183#endif
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
Definition: coneSchema.h:144
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