HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
geomSubsetSchema.h
Go to the documentation of this file.
1 //
2 // Copyright 2021 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 //
24 ////////////////////////////////////////////////////////////////////////
25 // This file is generated by a script. Do not edit directly. Edit the
26 // schema.template.h file to make changes.
27 
28 #ifndef PXR_IMAGING_HD_GEOM_SUBSET_SCHEMA_H
29 #define PXR_IMAGING_HD_GEOM_SUBSET_SCHEMA_H
30 
31 #include "pxr/imaging/hd/api.h"
32 
33 #include "pxr/imaging/hd/schema.h"
34 
36 
37 //-----------------------------------------------------------------------------
38 
39 #define HDGEOMSUBSET_SCHEMA_TOKENS \
40  (type) \
41  (indices) \
42  (typeFaceSet) \
43  (typePointSet) \
44  (typeCurveSet) \
45 
46 TF_DECLARE_PUBLIC_TOKENS(HdGeomSubsetSchemaTokens, HD_API,
48 
49 //-----------------------------------------------------------------------------
50 
52 {
53 public:
54  HdGeomSubsetSchema(HdContainerDataSourceHandle container)
55  : HdSchema(container) {}
56 
57  //ACCESSORS
58 
59  HD_API
61  HD_API
63 
64  // RETRIEVING AND CONSTRUCTING
65 
66  /// Builds a container data source which includes the provided child data
67  /// sources. Parameters with nullptr values are excluded. This is a
68  /// low-level interface. For cases in which it's desired to define
69  /// the container with a sparse set of child fields, the Builder class
70  /// is often more convenient and readable.
71  HD_API
72  static HdContainerDataSourceHandle
76  );
77 
78  /// \class HdGeomSubsetSchema::Builder
79  ///
80  /// Utility class for setting sparse sets of child data source fields to be
81  /// filled as arguments into BuildRetained. Because all setter methods
82  /// return a reference to the instance, this can be used in the "builder
83  /// pattern" form.
84  class Builder
85  {
86  public:
87  HD_API
90  HD_API
93 
94  /// Returns a container data source containing the members set thus far.
95  HD_API
96  HdContainerDataSourceHandle Build();
97 
98  private:
101  };
102 
103  /// Returns token data source for use as type value.
104  /// Values of...
105  /// - HdGeomSubsetSchemaTokens->typeFaceSet
106  /// - HdGeomSubsetSchemaTokens->typePointSet
107  /// - HdGeomSubsetSchemaTokens->typeCurveSet
108  /// ...will be stored statically and reused for future calls.
109  HD_API
111  const TfToken &type);
112 
113 };
114 
116 
117 #endif
GLsizei GLenum const void * indices
Definition: glcorearb.h:406
HD_API HdIntArrayDataSourceHandle GetIndices()
HD_API HdTokenDataSourceHandle GetType()
#define HD_API
Definition: api.h:40
#define HDGEOMSUBSET_SCHEMA_TOKENS
TF_DECLARE_PUBLIC_TOKENS(HdGeomSubsetSchemaTokens, HD_API, HDGEOMSUBSET_SCHEMA_TOKENS)
Definition: token.h:87
HdIntArrayDataSource::Handle HdIntArrayDataSourceHandle
HD_API Builder & SetType(const HdTokenDataSourceHandle &type)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static HD_API HdContainerDataSourceHandle BuildRetained(const HdTokenDataSourceHandle &type, const HdIntArrayDataSourceHandle &indices)
static HD_API HdTokenDataSourceHandle BuildTypeDataSource(const TfToken &type)
type
Definition: core.h:1059
HD_API Builder & SetIndices(const HdIntArrayDataSourceHandle &indices)
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
HdTokenDataSource::Handle HdTokenDataSourceHandle
HdGeomSubsetSchema(HdContainerDataSourceHandle container)