HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
sortedIds.h
Go to the documentation of this file.
1 //
2 // Copyright 2017 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_SORTED_IDS_H
25 #define PXR_IMAGING_HD_SORTED_IDS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 
30 #include "pxr/usd/sdf/path.h"
31 
33 
34 ///
35 /// Manages a container of Hydra Ids in a sorted order.
36 ///
37 /// For performance reasons, sorting of the list is deferred
38 /// due to inserting a large number of items at once.
39 ///
40 /// The class chooses the type of sort based on how many unsorted items
41 /// there are in the list.
42 ///
43 class Hd_SortedIds {
44 public:
45  HD_API
46  Hd_SortedIds();
47 
48  HD_API
49  ~Hd_SortedIds() = default;
50 
51  HD_API
52  Hd_SortedIds(Hd_SortedIds &&other);
53 
54  /// Sorts the ids if needed and returns the sorted list of ids.
55  HD_API
56  const SdfPathVector &GetIds();
57 
58  /// Add a new id to the collection
59  HD_API
60  void Insert(const SdfPath &id);
61 
62  /// Remove an id from the collection.
63  HD_API
64  void Remove(const SdfPath &id);
65 
66  /// Remove a range of id from the collection.
67  /// Range defined by position index in sorted list.
68  /// end is inclusive.
69  HD_API
70  void RemoveRange(size_t start, size_t end);
71 
72  /// Removes all ids from the collection.
73  HD_API
74  void Clear();
75 
76 private:
77  SdfPathVector _ids;
78  size_t _sortedCount;
79  ptrdiff_t _afterLastDeletePoint;
80 
81  void _InsertSort();
82  void _FullSort();
83  void _Sort();
84 
85  Hd_SortedIds(const Hd_SortedIds &) = delete;
86  Hd_SortedIds &operator =(const Hd_SortedIds &) = delete;
87 };
88 
90 
91 #endif // PXR_IMAGING_HD_SORTED_IDS_H
HD_API void Remove(const SdfPath &id)
Remove an id from the collection.
GLuint start
Definition: glcorearb.h:474
#define HD_API
Definition: api.h:40
HD_API void Insert(const SdfPath &id)
Add a new id to the collection.
HD_API Hd_SortedIds()
HD_API void RemoveRange(size_t start, size_t end)
GLuint GLuint end
Definition: glcorearb.h:474
Definition: path.h:288
std::vector< class SdfPath > SdfPathVector
A vector of SdfPaths.
Definition: path.h:209
HD_API ~Hd_SortedIds()=default
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HD_API const SdfPathVector & GetIds()
Sorts the ids if needed and returns the sorted list of ids.
HD_API void Clear()
Removes all ids from the collection.