All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
geomSubsetSchema.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_GEOM_SUBSET_SCHEMA_H
19#define PXR_IMAGING_HD_GEOM_SUBSET_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_GEOM_SUBSET_SCHEMA_TOKENS \
36 (geomSubset) \
37 (type) \
38 (indices) \
39 (typeFaceSet) \
40 (typePointSet) \
41 (typeCurveSet) \
42
43TF_DECLARE_PUBLIC_TOKENS(HdGeomSubsetSchemaTokens, HD_API,
44 HD_GEOM_SUBSET_SCHEMA_TOKENS);
45
46//-----------------------------------------------------------------------------
47
48
49class HdGeomSubsetSchema : public HdSchema
50{
51public:
54
55 HdGeomSubsetSchema(HdContainerDataSourceHandle container)
56 : HdSchema(container) {}
57
63 HD_API
64 static HdGeomSubsetSchema GetFromParent(
65 const HdContainerDataSourceHandle &fromParentContainer);
66
68
69// --(BEGIN CUSTOM CODE: Schema Methods)--
70// --(END CUSTOM CODE: Schema Methods)--
71
74
75 HD_API
76 HdTokenDataSourceHandle GetType() const;
77
78 HD_API
79 HdIntArrayDataSourceHandle GetIndices() const;
80
82
85
88 HD_API
89 static const TfToken &GetSchemaToken();
90
93 HD_API
94 static const HdDataSourceLocator &GetDefaultLocator();
95
97
100
108 HD_API
109 static HdContainerDataSourceHandle
110 BuildRetained(
111 const HdTokenDataSourceHandle &type,
112 const HdIntArrayDataSourceHandle &indices
113 );
114
122 {
123 public:
124 HD_API
125 Builder &SetType(
126 const HdTokenDataSourceHandle &type);
127 HD_API
128 Builder &SetIndices(
129 const HdIntArrayDataSourceHandle &indices);
130
132 HD_API
133 HdContainerDataSourceHandle Build();
134
135 private:
136 HdTokenDataSourceHandle _type;
137 HdIntArrayDataSourceHandle _indices;
138
139 };
140
148 HD_API
149 static HdTokenDataSourceHandle BuildTypeDataSource(
150 const TfToken &type);
151
153};
154
155PXR_NAMESPACE_CLOSE_SCOPE
156
157#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...
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