Loading...
Searching...
No Matches
overlayContainerDataSource.h
1//
2// Copyright 2021 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_IMAGING_HD_OVERLAY_CONTAINER_DATA_SOURCE_H
8#define PXR_IMAGING_HD_OVERLAY_CONTAINER_DATA_SOURCE_H
9
10#include "pxr/imaging/hd/dataSource.h"
11
12PXR_NAMESPACE_OPEN_SCOPE
13
20class HdOverlayContainerDataSource : public HdContainerDataSource
21{
22public:
23 HD_DECLARE_DATASOURCE(HdOverlayContainerDataSource);
24
25 HD_DECLARE_DATASOURCE_INITIALIZER_LIST_NEW(
26 HdOverlayContainerDataSource,
27 HdContainerDataSourceHandle);
28
35 HD_API
36 static
37 HdContainerDataSourceHandle
38 OverlayedContainerDataSources(
39 const HdContainerDataSourceHandle &src1,
40 const HdContainerDataSourceHandle &src2);
41
42 HD_API
43 TfTokenVector GetNames() override;
44 HD_API
45 HdDataSourceBaseHandle Get(const TfToken &name) override;
46
47private:
48 HD_API
49 HdOverlayContainerDataSource(
50 const std::initializer_list<HdContainerDataSourceHandle> &sources);
51
52 HD_API
53 HdOverlayContainerDataSource(
54 size_t count,
55 HdContainerDataSourceHandle *sources);
56
57 using _ContainerVector = TfSmallVector<HdContainerDataSourceHandle, 8>;
58 HD_API
59 HdOverlayContainerDataSource(
60 _ContainerVector &&sources);
61
62 HD_API
63 HdOverlayContainerDataSource(
64 const HdContainerDataSourceHandle &src1,
65 const HdContainerDataSourceHandle &src2);
66
67 HD_API
68 HdOverlayContainerDataSource(
69 const HdContainerDataSourceHandle &src1,
70 const HdContainerDataSourceHandle &src2,
71 const HdContainerDataSourceHandle &src3);
72
73 _ContainerVector _sources;
74};
75
76HD_DECLARE_DATASOURCE_HANDLES(HdOverlayContainerDataSource);
77
82HD_API
83HdContainerDataSourceHandle
84HdCreateOverlayContainerDataSource(
85 size_t count,
86 HdContainerDataSourceHandle *containers);
87
92HD_API
93HdContainerDataSourceHandle
94HdCreateOverlayContainerDataSource(
95 const std::initializer_list<HdContainerDataSourceHandle> &sources);
96
98HD_API
99HdContainerDataSourceHandle
100HdCreateOverlayContainerDataSource(
101 const HdContainerDataSourceHandle &src1,
102 const HdContainerDataSourceHandle &src2);
103
104PXR_NAMESPACE_CLOSE_SCOPE
105
106#endif
HdContainerDataSource
A datasource representing structured (named, hierarchical) data, for example a geometric primitive or...
Definition dataSource.h:148
HdOverlayContainerDataSource
Lazily composes two or more container source hierarchies Earlier entries on the containers array have...
Definition overlayContainerDataSource.h:21
HdOverlayContainerDataSource::OverlayedContainerDataSources
static HD_API HdContainerDataSourceHandle OverlayedContainerDataSources(const HdContainerDataSourceHandle &src1, const HdContainerDataSourceHandle &src2)
Creates HdOverlayContainerDataSource from sources, but only if needed.
HdOverlayContainerDataSource::GetNames
HD_API TfTokenVector GetNames() override
Returns the list of names for which Get(...) is expected to return a non-null value.
HdOverlayContainerDataSource::Get
HD_API HdDataSourceBaseHandle Get(const TfToken &name) override
Returns the child datasource of the given name.
TfToken
Token for efficient comparison, assignment, and hashing of known strings.
Definition token.h:81
TfTokenVector
std::vector< TfToken > TfTokenVector
Convenience types.
Definition token.h:489