HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
lightAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2017 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_LIGHT_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_LIGHT_ADAPTER_H
26 
27 /// \file usdImaging/lightAdapter.h
28 
29 #include "pxr/pxr.h"
32 
34 
35 
36 class UsdPrim;
37 
38 /// \class UsdImagingLightAdapter
39 ///
40 /// Base class for all lights.
41 ///
43 public:
45 
47  static bool IsEnabledSceneLights();
48 
51  {}
52 
54  virtual ~UsdImagingLightAdapter();
55 
56  // ---------------------------------------------------------------------- //
57  /// \name Parallel Setup and Resolve
58  // ---------------------------------------------------------------------- //
59 
60  /// Thread Safe.
62  virtual void TrackVariability(UsdPrim const& prim,
63  SdfPath const& cachePath,
64  HdDirtyBits* timeVaryingBits,
66  instancerContext = NULL) const;
67 
68 
69  /// Thread Safe.
71  virtual void UpdateForTime(UsdPrim const& prim,
72  SdfPath const& cachePath,
74  HdDirtyBits requestedBits,
76  instancerContext = NULL) const;
77 
78  // ---------------------------------------------------------------------- //
79  /// \name Change Processing
80  // ---------------------------------------------------------------------- //
81 
82  /// Returns a bit mask of attributes to be udpated, or
83  /// HdChangeTracker::AllDirty if the entire prim must be resynchronized.
85  virtual HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
86  SdfPath const& cachePath,
87  TfToken const& propertyName);
88 
90  virtual void MarkDirty(UsdPrim const& prim,
91  SdfPath const& cachePath,
92  HdDirtyBits dirty,
94 
96  virtual void MarkTransformDirty(UsdPrim const& prim,
97  SdfPath const& cachePath,
99 
101  virtual void MarkVisibilityDirty(UsdPrim const& prim,
102  SdfPath const& cachePath,
104 };
105 
106 
108 
109 #endif // PXR_USD_IMAGING_USD_IMAGING_LIGHT_ADAPTER_H
#define USDIMAGING_API
Definition: api.h:40
virtual USDIMAGING_API void MarkDirty(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits dirty, UsdImagingIndexProxy *index)
GT_API const UT_StringHolder time
GLuint index
Definition: glew.h:1814
uint32_t HdDirtyBits
Definition: types.h:127
static USDIMAGING_API bool IsEnabledSceneLights()
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 ~UsdImagingLightAdapter()
Definition: token.h:87
Definition: prim.h:132
virtual USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const
Thread Safe.
Definition: path.h:288
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 MarkVisibilityDirty(UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index)
UsdImagingPrimAdapter BaseAdapter
Definition: lightAdapter.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)