HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
USD_VisCache.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 _GUSD_USD_VISCACHE_
25 #define _GUSD_USD_VISCACHE_
26 
27 #include "gusd/api.h"
28 
29 #include "gusd/USD_DataCache.h"
30 #include "gusd/UT_CappedCache.h"
31 
32 #include <SYS/SYS_AtomicInt.h>
33 
34 #include "pxr/pxr.h"
37 
39 
40 /** Thread-safe, memory-capped visibility cache.
41  This does not cache varying visibility state; only unvarying visibility
42  values and information about whether or not visibility might vary
43  with time is cached.*/
44 class GusdUSD_VisCache final : public GusdUSD_DataCache
45 {
46 public:
47 
48  GUSD_API
49  static GusdUSD_VisCache& GetInstance();
50 
53 
54  ~GusdUSD_VisCache() override {}
55 
56  // Not cached.
57  GUSD_API
58  bool GetVisibility(const UsdPrim& prim, UsdTimeCode time);
59 
60  // Cached.
61  GUSD_API
62  bool GetResolvedVisibility(const UsdPrim& prim, UsdTimeCode time);
63 
64  GUSD_API
65  void Clear() override;
66 
67  GUSD_API
68  int64 Clear(const UT_StringSet& paths) override;
69 
70 private:
71  struct VisInfo : public UT_CappedItem
72  {
73  VisInfo(int flags, const UsdAttribute& attr)
74  : UT_CappedItem(), flags(flags), query(attr) {}
75 
76  ~VisInfo() override {}
77 
78  int64 getMemoryUsage() const override { return sizeof(*this); }
79 
82  };
83  typedef UT_IntrusivePtr<VisInfo> VisInfoHandle;
84 
85  VisInfoHandle _GetVisInfo(const UsdPrim& prim);
86 
87  /** Query visibility. Returns true if @a flags were modified.*/
88  bool _GetVisibility(int& flags,
89  const UsdAttributeQuery& query,
91  bool& vis);
92 
93  GusdUT_CappedCache _visInfos;
94 };
95 
97 
98 #endif /*_GUSD_USD_VISCACHE_*/
GUSD_API bool GetVisibility(const UsdPrim &prim, UsdTimeCode time)
GT_API const UT_StringHolder time
static GUSD_API GusdUSD_VisCache & GetInstance()
Wrapper around hboost::intrusive_ptr.
GUSD_API bool GetResolvedVisibility(const UsdPrim &prim, UsdTimeCode time)
long long int64
Definition: SYS_Types.h:116
Definition: prim.h:132
GLbitfield flags
Definition: glcorearb.h:1595
~GusdUSD_VisCache() override
Definition: USD_VisCache.h:54
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
#define GUSD_API
Definition: api.h:40
Base class for items in the UT_CappedCache.
GLenum query
Definition: glew.h:5734
GLenum const void * paths
Definition: glew.h:13872
GUSD_API void Clear() override
Clear all caches.