All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
skelRootAdapter.h
1 //
2 // Copyright 2019 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 USDSKELIMAGING_SKELROOTADAPTER_H
25 #define USDSKELIMAGING_SKELROOTADAPTER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usdImaging/usdImaging/primAdapter.h"
29 #include "pxr/usdImaging/usdSkelImaging/api.h"
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
44 class UsdSkelImagingSkelRootAdapter : public UsdImagingPrimAdapter {
45 public:
46  using BaseAdapter = UsdImagingPrimAdapter;
47 
48  UsdSkelImagingSkelRootAdapter()
49  : BaseAdapter()
50  {}
51 
52  USDSKELIMAGING_API
53  virtual ~UsdSkelImagingSkelRootAdapter();
54 
55  // ---------------------------------------------------------------------- //
57  // ---------------------------------------------------------------------- //
58  USDSKELIMAGING_API
59  SdfPath
60  Populate(const UsdPrim& prim,
61  UsdImagingIndexProxy* index,
63  instancerContext=nullptr) override;
64 
65  // ---------------------------------------------------------------------- //
67  // ---------------------------------------------------------------------- //
68 
70  USDSKELIMAGING_API
71  void TrackVariability(const UsdPrim& prim,
72  const SdfPath& cachePath,
73  HdDirtyBits* timeVaryingBits,
75  instancerContext = nullptr) const override;
76 
78  USDSKELIMAGING_API
79  void UpdateForTime(const UsdPrim& prim,
80  const SdfPath& cachePath,
81  UsdTimeCode time,
82  HdDirtyBits requestedBits,
84  instancerContext=nullptr) const override;
85 
86  // ---------------------------------------------------------------------- //
88  // ---------------------------------------------------------------------- //
89 
90  USDSKELIMAGING_API
91  HdDirtyBits ProcessPropertyChange(const UsdPrim& prim,
92  const SdfPath& cachePath,
93  const TfToken& propertyName) override;
94 
95  USDSKELIMAGING_API
96  void MarkDirty(const UsdPrim& prim,
97  const SdfPath& cachePath,
98  HdDirtyBits dirty,
99  UsdImagingIndexProxy* index) override;
100 
101 protected:
102  USDSKELIMAGING_API
103  void _RemovePrim(const SdfPath& cachePath,
104  UsdImagingIndexProxy* index) override;
105 };
106 
107 
108 PXR_NAMESPACE_CLOSE_SCOPE
109 
110 #endif // USDSKELIMAGING_SKELROOTADAPTER_H
virtual void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const =0
Populates the cache for the given prim, time and requestedBits.
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
virtual SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL)=0
Called to populate the RenderIndex for this UsdPrim.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
Base class for all PrimAdapters.
Definition: primAdapter.h:67
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
virtual void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const =0
For the given prim, variability is detected and stored in timeVaryingBits.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
virtual HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName)=0
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must ...