meshSchema.h
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 //
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_MESH_SCHEMA_H
29 #define PXR_IMAGING_HD_MESH_SCHEMA_H
30 
31 #include "pxr/imaging/hd/api.h"
32 
33 #include "pxr/imaging/hd/meshTopologySchema.h"
34 #include "pxr/imaging/hd/subdivisionTagsSchema.h"
35 #include "pxr/imaging/hd/geomSubsetsSchema.h"
36 
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
40 //-----------------------------------------------------------------------------
41 
42 #define HDMESH_SCHEMA_TOKENS \
43  (mesh) \
44  (topology) \
45  (subdivisionScheme) \
46  (subdivisionTags) \
47  (geomSubsets) \
48  (doubleSided) \
49 
50 TF_DECLARE_PUBLIC_TOKENS(HdMeshSchemaTokens, HD_API,
51  HDMESH_SCHEMA_TOKENS);
52 
53 //-----------------------------------------------------------------------------
54 
55 class HdMeshSchema : public HdSchema
56 {
57 public:
58  HdMeshSchema(HdContainerDataSourceHandle container)
59  : HdSchema(container) {}
60 
61  //ACCESSORS
62 
63  HD_API
64  HdMeshTopologySchema GetTopology();
65  HD_API
66  HdTokenDataSourceHandle GetSubdivisionScheme();
67  HD_API
68  HdSubdivisionTagsSchema GetSubdivisionTags();
69  HD_API
70  HdGeomSubsetsSchema GetGeomSubsets();
71  HD_API
72  HdBoolDataSourceHandle GetDoubleSided();
73 
74  // RETRIEVING AND CONSTRUCTING
75 
81  HD_API
82  static HdContainerDataSourceHandle
83  BuildRetained(
84  const HdContainerDataSourceHandle &topology,
85  const HdTokenDataSourceHandle &subdivisionScheme,
86  const HdContainerDataSourceHandle &subdivisionTags,
87  const HdContainerDataSourceHandle &geomSubsets,
88  const HdBoolDataSourceHandle &doubleSided
89  );
90 
97  class Builder
98  {
99  public:
100  HD_API
101  Builder &SetTopology(
102  const HdContainerDataSourceHandle &topology);
103  HD_API
104  Builder &SetSubdivisionScheme(
105  const HdTokenDataSourceHandle &subdivisionScheme);
106  HD_API
107  Builder &SetSubdivisionTags(
108  const HdContainerDataSourceHandle &subdivisionTags);
109  HD_API
110  Builder &SetGeomSubsets(
111  const HdContainerDataSourceHandle &geomSubsets);
112  HD_API
113  Builder &SetDoubleSided(
114  const HdBoolDataSourceHandle &doubleSided);
115 
117  HD_API
118  HdContainerDataSourceHandle Build();
119 
120  private:
121  HdContainerDataSourceHandle _topology;
122  HdTokenDataSourceHandle _subdivisionScheme;
123  HdContainerDataSourceHandle _subdivisionTags;
124  HdContainerDataSourceHandle _geomSubsets;
125  HdBoolDataSourceHandle _doubleSided;
126  };
127 
133  HD_API
134  static HdMeshSchema GetFromParent(
135  const HdContainerDataSourceHandle &fromParentContainer);
136 
139  HD_API
140  static const HdDataSourceLocator &GetDefaultLocator();
141 
142 
147  HD_API
148  static const HdDataSourceLocator &GetTopologyLocator();
149 
154  HD_API
155  static const HdDataSourceLocator &GetGeomSubsetsLocator();
156 
161  HD_API
162  static const HdDataSourceLocator &GetDoubleSidedLocator();
163 
168  HD_API
169  static const HdDataSourceLocator &GetSubdivisionTagsLocator();
170 
175  HD_API
176  static const HdDataSourceLocator &GetSubdivisionSchemeLocator();
177 
178 };
179 
180 PXR_NAMESPACE_CLOSE_SCOPE
181 
182 #endif
Represents an object that can identify the location of a data source.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
Definition: meshSchema.h:97
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