mapContainerDataSource.h
1 //
2 // Copyright 2022 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_MAP_CONTAINER_DATA_SOURCE_H
25 #define PXR_IMAGING_HD_MAP_CONTAINER_DATA_SOURCE_H
26 
27 #include "pxr/imaging/hd/dataSource.h"
28 
29 PXR_NAMESPACE_OPEN_SCOPE
30 
36 {
37 public:
38  HD_DECLARE_DATASOURCE(HdMapContainerDataSource);
39 
40  using ValueFunction =
41  std::function<HdDataSourceBaseHandle(const HdDataSourceBaseHandle &)>;
42 
45  HD_API
47  const ValueFunction &f,
48  const HdContainerDataSourceHandle &src);
49 
50  HD_API
51  ~HdMapContainerDataSource() override;
52 
53  HD_API
54  TfTokenVector GetNames() override;
55  HD_API
56  HdDataSourceBaseHandle Get(const TfToken &name) override;
57 private:
58  ValueFunction _f;
59 
60  HdContainerDataSourceHandle _src;
61 };
62 
63 HD_DECLARE_DATASOURCE_HANDLES(HdMapContainerDataSource);
64 
65 PXR_NAMESPACE_CLOSE_SCOPE
66 
67 #endif
HD_API HdMapContainerDataSource(const ValueFunction &f, const HdContainerDataSourceHandle &src)
(Lazily) Create new container data source by applying given function to all data sources.
HD_API HdDataSourceBaseHandle Get(const TfToken &name) override
Returns the child datasource of the given name.
A datasource representing structured (named, hierarchical) data, for example a geometric primitive or...
Definition: dataSource.h:110
HD_API TfTokenVector GetNames() override
Returns the list of names for which Get(...) is expected to return a non-null value.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
Applies function to all data sources in a container data source (non-recursively).