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 PXR_USD_IMAGING_USD_IMAGING_COORD_SYS_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_COORD_SYS_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 
40 class UsdImagingCoordSysAdapter : public UsdImagingPrimAdapter {
41 public:
42  typedef UsdImagingPrimAdapter BaseAdapter;
43 
44  UsdImagingCoordSysAdapter()
46  {}
47 
48  USDIMAGING_API
49  virtual ~UsdImagingCoordSysAdapter();
50 
51  USDIMAGING_API
52  virtual SdfPath Populate(UsdPrim const& prim,
53  UsdImagingIndexProxy* index,
54  UsdImagingInstancerContext const* instancerContext = NULL);
55 
56  USDIMAGING_API
57  virtual bool IsSupported(UsdImagingIndexProxy const* index) const;
58 
59  // ---------------------------------------------------------------------- //
61  // ---------------------------------------------------------------------- //
62 
64  USDIMAGING_API
65  virtual void TrackVariability(UsdPrim const& prim,
66  SdfPath const& cachePath,
67  HdDirtyBits* timeVaryingBits,
69  instancerContext = NULL) const;
70 
71  USDIMAGING_API
72  virtual void ProcessPrimResync(SdfPath const& primPath,
73  UsdImagingIndexProxy* index);
74 
76  USDIMAGING_API
77  virtual void UpdateForTime(UsdPrim const& prim,
78  SdfPath const& cachePath,
79  UsdTimeCode time,
80  HdDirtyBits requestedBits,
82  instancerContext = NULL) const;
83 
84  // ---------------------------------------------------------------------- //
86  // ---------------------------------------------------------------------- //
87 
90  USDIMAGING_API
91  virtual HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
92  SdfPath const& cachePath,
93  TfToken const& propertyName);
94 
95  USDIMAGING_API
96  virtual void MarkDirty(UsdPrim const& prim,
97  SdfPath const& cachePath,
98  HdDirtyBits dirty,
99  UsdImagingIndexProxy* index);
100 
101  USDIMAGING_API
102  virtual void MarkTransformDirty(UsdPrim const& prim,
103  SdfPath const& cachePath,
104  UsdImagingIndexProxy* index);
105 
106 protected:
107  USDIMAGING_API
108  virtual void _RemovePrim(SdfPath const& cachePath,
109  UsdImagingIndexProxy* index);
110 };
111 
112 
113 PXR_NAMESPACE_CLOSE_SCOPE
114 
115 #endif // PXR_USD_IMAGING_USD_IMAGING_COORD_SYS_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:87
virtual bool IsSupported(UsdImagingIndexProxy const *index) const
Returns true if the adapter can be populated into the target index.
Definition: primAdapter.h:427
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:66
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
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...