Loading...
Searching...
No Matches
extentSchema.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_EXTENT_SCHEMA_H
36#define PXR_IMAGING_HD_EXTENT_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_EXTENT_SCHEMA_TOKENS \
53 (extent) \
54 (min) \
55 (max) \
56
57TF_DECLARE_PUBLIC_TOKENS(HdExtentSchemaTokens, HD_API,
58 HD_EXTENT_SCHEMA_TOKENS);
59
60//-----------------------------------------------------------------------------
61
62
63class HdExtentSchema : public HdSchema
64{
65public:
68
69 HdExtentSchema(HdContainerDataSourceHandle container)
70 : HdSchema(container) {}
71
77 HD_API
78 static HdExtentSchema GetFromParent(
79 const HdContainerDataSourceHandle &fromParentContainer);
80
82
83// --(BEGIN CUSTOM CODE: Schema Methods)--
84// --(END CUSTOM CODE: Schema Methods)--
85
88
89 HD_API
90 HdVec3dDataSourceHandle GetMin() const;
91
92 HD_API
93 HdVec3dDataSourceHandle GetMax() const;
94
96
99
102 HD_API
103 static const TfToken &GetSchemaToken();
104
107 HD_API
108 static const HdDataSourceLocator &GetDefaultLocator();
109
111
114
122 HD_API
123 static HdContainerDataSourceHandle
124 BuildRetained(
125 const HdVec3dDataSourceHandle &min,
126 const HdVec3dDataSourceHandle &max
127 );
128
136 {
137 public:
138 HD_API
139 Builder &SetMin(
140 const HdVec3dDataSourceHandle &min);
141 HD_API
142 Builder &SetMax(
143 const HdVec3dDataSourceHandle &max);
144
146 HD_API
147 HdContainerDataSourceHandle Build();
148
149 private:
150 HdVec3dDataSourceHandle _min;
151 HdVec3dDataSourceHandle _max;
152
153 };
154
156};
157
158PXR_NAMESPACE_CLOSE_SCOPE
159
160#endif
Represents an object that can identify the location of a data source.
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
Definition: extentSchema.h:136
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
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