HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
sceneIndexPlugin.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 #ifndef PXR_IMAGING_HD_SCENE_INDEX_PLUGIN_H
25 #define PXR_IMAGING_HD_SCENE_INDEX_PLUGIN_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
31 
33 
35 {
36 public:
37 
38  HD_API
39  HdSceneIndexBaseRefPtr AppendSceneIndex(
40  const HdSceneIndexBaseRefPtr &inputScene,
41  const HdContainerDataSourceHandle &inputArgs);
42 
43 protected:
44 
45  /// Subclasses implement this to instantiate one or more scene indicies
46  /// which take the provided scene as input. The return value should be
47  /// the final scene created -- or the inputScene itself if nothing is
48  /// created.
49  HD_API
50  virtual HdSceneIndexBaseRefPtr _AppendSceneIndex(
51  const HdSceneIndexBaseRefPtr &inputScene,
52  const HdContainerDataSourceHandle &inputArgs);
53 
54  HdSceneIndexPlugin() = default;
55  HD_API
56  ~HdSceneIndexPlugin() override;
57 
58 };
59 
61 
62 #endif // PXR_IMAGING_HD_SCENE_INDEX_PLUGIN_H
HD_API ~HdSceneIndexPlugin() override
#define HD_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
HD_API HdSceneIndexBaseRefPtr AppendSceneIndex(const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)
virtual HD_API HdSceneIndexBaseRefPtr _AppendSceneIndex(const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)
HdSceneIndexPlugin()=default
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91