All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
coordSysAdapter.h
Go to the documentation of this file.
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 USDIMAGING_COORDSYS_ADAPTER_H
25 #define USDIMAGING_COORDSYS_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
31 #include "pxr/usdImaging/usdImaging/primAdapter.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 
36 class UsdPrim;
37 
38 typedef boost::shared_ptr<class UsdImagingCoordSysAdapter>
39  UsdImagingCoordSysAdapterSharedPtr;
40 
43 class UsdImagingCoordSysAdapter : public UsdImagingPrimAdapter {
44 public:
45  typedef UsdImagingPrimAdapter BaseAdapter;
46 
47  UsdImagingCoordSysAdapter()
49  {}
50 
51  USDIMAGING_API
52  virtual ~UsdImagingCoordSysAdapter();
53 
54  USDIMAGING_API
55  virtual SdfPath Populate(UsdPrim const& prim,
56  UsdImagingIndexProxy* index,
57  UsdImagingInstancerContext const* instancerContext = NULL);
58 
59  USDIMAGING_API
60  virtual bool IsSupported(UsdImagingIndexProxy const* index) const;
61 
62  // ---------------------------------------------------------------------- //
64  // ---------------------------------------------------------------------- //
65 
67  USDIMAGING_API
68  virtual void TrackVariability(UsdPrim const& prim,
69  SdfPath const& cachePath,
70  HdDirtyBits* timeVaryingBits,
72  instancerContext = NULL) const;
73 
74  USDIMAGING_API
75  virtual void ProcessPrimResync(SdfPath const& primPath,
76  UsdImagingIndexProxy* index);
77 
79  USDIMAGING_API
80  virtual void UpdateForTime(UsdPrim const& prim,
81  SdfPath const& cachePath,
82  UsdTimeCode time,
83  HdDirtyBits requestedBits,
85  instancerContext = NULL) const;
86 
87  // ---------------------------------------------------------------------- //
89  // ---------------------------------------------------------------------- //
90 
93  USDIMAGING_API
94  virtual HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
95  SdfPath const& cachePath,
96  TfToken const& propertyName);
97 
98  USDIMAGING_API
99  virtual void MarkDirty(UsdPrim const& prim,
100  SdfPath const& cachePath,
101  HdDirtyBits dirty,
102  UsdImagingIndexProxy* index);
103 
104  USDIMAGING_API
105  virtual void MarkTransformDirty(UsdPrim const& prim,
106  SdfPath const& cachePath,
107  UsdImagingIndexProxy* index);
108 
109 protected:
110  USDIMAGING_API
111  virtual void _RemovePrim(SdfPath const& cachePath,
112  UsdImagingIndexProxy* index);
113 };
114 
115 
116 PXR_NAMESPACE_CLOSE_SCOPE
117 
118 #endif // USDIMAGING_COORDSYS_ADAPTER_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
virtual bool IsSupported(UsdImagingIndexProxy const *index) const
Returns true if the adapter can be populated into the target index.
Definition: primAdapter.h:437
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 &quot;Prim&quot; 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 ...
virtual USDIMAGING_API void ProcessPrimResync(SdfPath const &cachePath, UsdImagingIndexProxy *index)
When a PrimResync event occurs, the prim may have been deleted entirely, adapter plug-ins should over...