All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
fieldAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2018 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_FIELD_ADAPTER_H
25 #define USDIMAGING_FIELD_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 
43 public:
45 
46 
49  {}
50 
51  USDIMAGING_API
52  virtual ~UsdImagingFieldAdapter();
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 
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  USDIMAGING_API
107  virtual void MarkVisibilityDirty(UsdPrim const& prim,
108  SdfPath const& cachePath,
109  UsdImagingIndexProxy* index);
110 
111  // ---------------------------------------------------------------------- //
113  // ---------------------------------------------------------------------- //
116  USDIMAGING_API
117  virtual TfToken GetPrimTypeToken() const = 0;
118 
119 protected:
120  USDIMAGING_API
121  virtual void _RemovePrim(SdfPath const& cachePath,
122  UsdImagingIndexProxy* index);
123 };
124 
125 
126 PXR_NAMESPACE_CLOSE_SCOPE
127 
128 #endif // USDIMAGING_FIELD_ADAPTER_H
virtual USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName)
Returns a bit mask of attributes to be udpated, or HdChangeTracker::AllDirty if the entire prim must ...
virtual USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL)
Called to populate the RenderIndex for this UsdPrim.
Base class for all USD fields.
Definition: fieldAdapter.h:42
virtual USDIMAGING_API TfToken GetPrimTypeToken() const =0
Returns the token specifying the Hydra primitive type that is created by this adapter.
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
virtual USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const
Thread Safe.
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 USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const
Returns true if the adapter can be populated into the target index.
virtual USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const
Thread Safe.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...