All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
extentSchema.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_EXTENT_SCHEMA_H
19#define PXR_IMAGING_HD_EXTENT_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_EXTENT_SCHEMA_TOKENS \
36 (extent) \
37 (min) \
38 (max) \
39
40TF_DECLARE_PUBLIC_TOKENS(HdExtentSchemaTokens, HD_API,
41 HD_EXTENT_SCHEMA_TOKENS);
42
43//-----------------------------------------------------------------------------
44
45
46class HdExtentSchema : public HdSchema
47{
48public:
51
52 HdExtentSchema(HdContainerDataSourceHandle container)
53 : HdSchema(container) {}
54
60 HD_API
61 static HdExtentSchema GetFromParent(
62 const HdContainerDataSourceHandle &fromParentContainer);
63
65
66// --(BEGIN CUSTOM CODE: Schema Methods)--
67// --(END CUSTOM CODE: Schema Methods)--
68
71
72 HD_API
73 HdVec3dDataSourceHandle GetMin() const;
74
75 HD_API
76 HdVec3dDataSourceHandle GetMax() const;
77
79
82
85 HD_API
86 static const TfToken &GetSchemaToken();
87
90 HD_API
91 static const HdDataSourceLocator &GetDefaultLocator();
92
94
97
105 HD_API
106 static HdContainerDataSourceHandle
107 BuildRetained(
108 const HdVec3dDataSourceHandle &min,
109 const HdVec3dDataSourceHandle &max
110 );
111
119 {
120 public:
121 HD_API
122 Builder &SetMin(
123 const HdVec3dDataSourceHandle &min);
124 HD_API
125 Builder &SetMax(
126 const HdVec3dDataSourceHandle &max);
127
129 HD_API
130 HdContainerDataSourceHandle Build();
131
132 private:
133 HdVec3dDataSourceHandle _min;
134 HdVec3dDataSourceHandle _max;
135
136 };
137
139};
140
141PXR_NAMESPACE_CLOSE_SCOPE
142
143#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:119
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: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