HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dataSharingSchema.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_DATA_SHARING_SCHEMA_H
29 #define PXR_IMAGING_HD_DATA_SHARING_SCHEMA_H
30 
31 #include "pxr/imaging/hd/api.h"
32 
33 #include "pxr/imaging/hd/schema.h"
34 
36 
37 //-----------------------------------------------------------------------------
38 
39 #define HDDATASHARING_SCHEMA_TOKENS \
40  (dataSharing) \
41  (sharingId) \
42 
43 TF_DECLARE_PUBLIC_TOKENS(HdDataSharingSchemaTokens, HD_API,
45 
46 //-----------------------------------------------------------------------------
47 
48 // A schema marking a prim as having an underlying data representation that
49 // may be shared by more than on HdPrim.
50 
52 {
53 public:
54  HdDataSharingSchema(HdContainerDataSourceHandle container)
55  : HdSchema(container) {}
56 
57  //ACCESSORS
58 
59  HD_API
61 
62  // RETRIEVING AND CONSTRUCTING
63 
64  /// Builds a container data source which includes the provided child data
65  /// sources. Parameters with nullptr values are excluded. This is a
66  /// low-level interface. For cases in which it's desired to define
67  /// the container with a sparse set of child fields, the Builder class
68  /// is often more convenient and readable.
69  HD_API
70  static HdContainerDataSourceHandle
73  );
74 
75  /// \class HdDataSharingSchema::Builder
76  ///
77  /// Utility class for setting sparse sets of child data source fields to be
78  /// filled as arguments into BuildRetained. Because all setter methods
79  /// return a reference to the instance, this can be used in the "builder
80  /// pattern" form.
81  class Builder
82  {
83  public:
84  HD_API
87 
88  /// Returns a container data source containing the members set thus far.
89  HD_API
90  HdContainerDataSourceHandle Build();
91 
92  private:
94  };
95 
96  /// Retrieves a container data source with the schema's default name token
97  /// "sharingId" from the parent container and constructs a
98  /// HdDataSharingSchema instance.
99  /// Because the requested container data source may not exist, the result
100  /// should be checked with IsDefined() or a bool comparison before use.
101  HD_API
103  const HdContainerDataSourceHandle &fromParentContainer);
104 
105  /// Returns an HdDataSourceLocator (relative to the prim-level data source)
106  /// where the container representing this schema is found by default.
107  HD_API
108  static const HdDataSourceLocator &GetDefaultLocator();
109 
110 };
111 
113 
114 #endif
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
#define HD_API
Definition: api.h:40
static HD_API HdDataSharingSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
HdDataSharingSchema(HdContainerDataSourceHandle container)
HD_API HdPathDataSourceHandle GetSharingId()
#define HDDATASHARING_SCHEMA_TOKENS
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static HD_API const HdDataSourceLocator & GetDefaultLocator()
HD_API Builder & SetPaths(const HdPathDataSourceHandle &path)
static HD_API HdContainerDataSourceHandle BuildRetained(const HdPathDataSourceHandle &path)
HdPathDataSource::Handle HdPathDataSourceHandle
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
TF_DECLARE_PUBLIC_TOKENS(HdDataSharingSchemaTokens, HD_API, HDDATASHARING_SCHEMA_TOKENS)