All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dirtyList.h
1 //
2 // Copyright 2016 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 HD_DIRTY_LIST_H
25 #define HD_DIRTY_LIST_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/rprimCollection.h"
31 #include "pxr/imaging/hd/types.h"
32 
33 #include <boost/shared_ptr.hpp>
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 class HdRenderIndex;
38 
39 typedef boost::shared_ptr<class HdDirtyList> HdDirtyListSharedPtr;
40 typedef boost::weak_ptr<class HdDirtyList> HdDirtyListPtr;
41 
102 class HdDirtyList {
103 public:
104  HD_API
105  HdDirtyList(HdRprimCollection const& collection,
106  HdRenderIndex &index);
107  HD_API
108  ~HdDirtyList();
109 
117  HD_API
118  SdfPathVector const& GetDirtyRprims(const TfTokenVector &renderTags);
119 
122  HD_API
123  bool ApplyEdit(HdRprimCollection const& newCollection);
124 
125 private:
126  void _BuildDirtyList(const TfTokenVector& renderTags,
127  HdDirtyBits mask);
128 
129  HdRprimCollection _collection;
130  SdfPathVector _dirtyIds;
131  HdRenderIndex &_renderIndex;
132 
133  unsigned int _sceneStateVersion;
134  unsigned int _rprimIndexVersion;
135  unsigned int _renderTagVersion;
136  unsigned int _varyingStateVersion;
137 };
138 
139 
140 PXR_NAMESPACE_CLOSE_SCOPE
141 
142 #endif // HD_DIRTY_LIST_H
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:119
HD_API SdfPathVector const & GetDirtyRprims(const TfTokenVector &renderTags)
Returns a reference of dirty ids.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A named, semantic collection of objects.
Used for faster iteration of dirty rprims, filtered by mask.
Definition: dirtyList.h:102
HD_API bool ApplyEdit(HdRprimCollection const &newCollection)
Update the tracking state for this HdDirtyList with the new collection, if the update cannot be appli...