HDK
 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 PXR_USD_IMAGING_USD_IMAGING_FIELD_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_FIELD_ADAPTER_H
26 
27 /// \file usdImaging/fieldAdapter.h
28 
29 #include "pxr/pxr.h"
32 
34 
35 
36 class UsdPrim;
37 
38 /// \class UsdImagingFieldAdapter
39 ///
40 /// Base class for all USD fields.
41 ///
43 public:
45 
46 
49  {}
50 
52  virtual ~UsdImagingFieldAdapter();
53 
55  virtual SdfPath Populate(UsdPrim const& prim,
57  UsdImagingInstancerContext const* instancerContext = NULL);
58 
60  virtual bool IsSupported(UsdImagingIndexProxy const* index) const;
61 
62  // ---------------------------------------------------------------------- //
63  /// \name Parallel Setup and Resolve
64  // ---------------------------------------------------------------------- //
65 
66  /// Thread Safe.
68  virtual void TrackVariability(UsdPrim const& prim,
69  SdfPath const& cachePath,
70  HdDirtyBits* timeVaryingBits,
72  instancerContext = NULL) const;
73 
74 
75  /// Thread Safe.
77  virtual void UpdateForTime(UsdPrim const& prim,
78  SdfPath const& cachePath,
80  HdDirtyBits requestedBits,
82  instancerContext = NULL) const;
83 
84  // ---------------------------------------------------------------------- //
85  /// \name Change Processing
86  // ---------------------------------------------------------------------- //
87 
88  /// Returns a bit mask of attributes to be udpated, or
89  /// HdChangeTracker::AllDirty if the entire prim must be resynchronized.
91  virtual HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
92  SdfPath const& cachePath,
93  TfToken const& propertyName);
94 
96  virtual void MarkDirty(UsdPrim const& prim,
97  SdfPath const& cachePath,
98  HdDirtyBits dirty,
100 
102  virtual void MarkTransformDirty(UsdPrim const& prim,
103  SdfPath const& cachePath,
105 
107  virtual void MarkVisibilityDirty(UsdPrim const& prim,
108  SdfPath const& cachePath,
110 
111  // ---------------------------------------------------------------------- //
112  /// \name Field adapter requirements
113  // ---------------------------------------------------------------------- //
114  /// Returns the token specifying the Hydra primitive type that is created
115  /// by this adapter.
117  virtual TfToken GetPrimTypeToken() const = 0;
118 
119 protected:
121  virtual void _RemovePrim(SdfPath const& cachePath,
123 };
124 
125 
127 
128 #endif // PXR_USD_IMAGING_USD_IMAGING_FIELD_ADAPTER_H
virtual USDIMAGING_API void MarkDirty(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits dirty, UsdImagingIndexProxy *index)
#define USDIMAGING_API
Definition: api.h:40
GT_API const UT_StringHolder time
GLuint index
Definition: glew.h:1814
uint32_t HdDirtyBits
Definition: types.h:127
UsdImagingPrimAdapter BaseAdapter
Definition: fieldAdapter.h:44
virtual USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName)
virtual USDIMAGING_API void MarkTransformDirty(UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index)
Definition: token.h:87
virtual USDIMAGING_API void _RemovePrim(SdfPath const &cachePath, UsdImagingIndexProxy *index)
virtual USDIMAGING_API TfToken GetPrimTypeToken() const =0
virtual USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const
Returns true if the adapter can be populated into the target index.
Definition: prim.h:132
Definition: path.h:288
virtual USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL)
virtual USDIMAGING_API void MarkVisibilityDirty(UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const
Thread Safe.
virtual USDIMAGING_API ~UsdImagingFieldAdapter()
virtual USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const
Thread Safe.