overlayContainerDataSource.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 //
24 #ifndef PXR_IMAGING_HD_OVERLAY_CONTAINER_DATA_SOURCE_H
25 #define PXR_IMAGING_HD_OVERLAY_CONTAINER_DATA_SOURCE_H
26 
27 #include "pxr/imaging/hd/dataSource.h"
28 
29 PXR_NAMESPACE_OPEN_SCOPE
30 
38 {
39 public:
40  HD_DECLARE_DATASOURCE(HdOverlayContainerDataSource);
41 
42  HD_DECLARE_DATASOURCE_INITIALIZER_LIST_NEW(
44  HdContainerDataSourceHandle);
45 
46  HD_API
48  std::initializer_list<HdContainerDataSourceHandle> sources);
49 
50  HD_API
52  size_t count,
53  HdContainerDataSourceHandle *containers);
54 
55  HD_API
57  const HdContainerDataSourceHandle &src1,
58  const HdContainerDataSourceHandle &src2);
59 
60  HD_API
62  const HdContainerDataSourceHandle &src1,
63  const HdContainerDataSourceHandle &src2,
64  const HdContainerDataSourceHandle &src3);
65 
66  HD_API
67  TfTokenVector GetNames() override;
68  HD_API
69  HdDataSourceBaseHandle Get(const TfToken &name) override;
70 
71 private:
73  _ContainerVector _containers;
74 };
75 
76 HD_DECLARE_DATASOURCE_HANDLES(HdOverlayContainerDataSource);
77 
78 PXR_NAMESPACE_CLOSE_SCOPE
79 
80 #endif
A datasource representing structured (named, hierarchical) data, for example a geometric primitive or...
Definition: dataSource.h:110
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
HD_API HdDataSourceBaseHandle Get(const TfToken &name) override
Returns the child datasource of the given name.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
HD_API TfTokenVector GetNames() override
Returns the list of names for which Get(...) is expected to return a non-null value.
Lazily composes two or more container source hierarchies Earlier entries on the containers array have...