All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
light.h
1 //
2 // Copyright 2016 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_IMAGING_HD_ST_LIGHT_H
25 #define PXR_IMAGING_HD_ST_LIGHT_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/light.h"
31 
32 #include "pxr/imaging/glf/simpleLight.h"
33 
34 #include "pxr/base/vt/value.h"
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
42 class HdStLight final : public HdLight {
43 public:
44  HDST_API
45  HdStLight(SdfPath const & id, TfToken const &lightType);
46  HDST_API
47  ~HdStLight() override;
48 
50  HDST_API
51  void Sync(HdSceneDelegate *sceneDelegate,
52  HdRenderParam *renderParam,
53  HdDirtyBits *dirtyBits) override;
54 
56  HDST_API
57  VtValue Get(TfToken const &token) const;
58 
62  HDST_API
63  HdDirtyBits GetInitialDirtyBitsMask() const override;
64 
65 private:
66  // Converts area lights (sphere lights and distant lights) into
67  // glfSimpleLights and inserts them in the dictionary so
68  // SimpleLightTask can use them later on as if they were regular lights.
69  GlfSimpleLight _ApproximateAreaLight(SdfPath const &id,
70  HdSceneDelegate *sceneDelegate);
71 
72  // Collects data such as the environment map texture path for a
73  // dome light. The lighting shader is responsible for pre-calculating
74  // the different textures needed for IBL.
75  GlfSimpleLight _PrepareDomeLight(SdfPath const &id,
76  HdSceneDelegate *sceneDelegate);
77 
78 private:
79  // Stores the internal light type of this light.
80  TfToken _lightType;
81 
82  // Cached states.
83  TfHashMap<TfToken, VtValue, TfToken::HashFunctor> _params;
84 };
85 
86 
87 PXR_NAMESPACE_CLOSE_SCOPE
88 
89 #endif // PXR_IMAGING_HD_ST_LIGHT_H
HDST_API VtValue Get(TfToken const &token) const
Accessor for tasks to get the parameters cached in this object.
The HdRenderParam is an opaque (to core Hydra) handle, to an object that is obtained from the render ...
A light model, used in conjunction with HdRenderPass.
Definition: light.h:42
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Adapter class providing data exchange with the client scene graph.
HDST_API HdDirtyBits GetInitialDirtyBitsMask() const override
Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of thi...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
HDST_API void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
Synchronizes state from the delegate to this object.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:174
A light model, used in conjunction with HdRenderPass.
Definition: light.h:83