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 HD_LIGHT_H
25 #define HD_LIGHT_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/sprim.h"
31 
32 #include "pxr/base/tf/staticTokens.h"
33 #include "pxr/base/vt/dictionary.h"
34 #include "pxr/base/vt/value.h"
35 
36 #include <boost/shared_ptr.hpp>
37 
38 #include <vector>
39 
40 PXR_NAMESPACE_OPEN_SCOPE
41 
42 #define HD_LIGHT_TOKENS \
43  (angle) \
44  (color) \
45  (colorTemperature) \
46  (enableColorTemperature) \
47  (exposure) \
48  (height) \
49  (intensity) \
50  (radius) \
51  (length) \
52  ((textureFile, "texture:file")) \
53  (textureResource) \
54  (width) \
55  (diffuse) \
56  (specular) \
57  (normalize) \
58  ((shapingFocus, "shaping:focus")) \
59  ((shapingFocusTint, "shaping:focusTint")) \
60  ((shapingConeAngle, "shaping:cone:angle")) \
61  ((shapingConeSoftness, "shaping:cone:softness")) \
62  ((shapingIesFile, "shaping:ies:file")) \
63  ((shapingIesAngleScale, "shaping:ies:angleScale")) \
64  ((shapingIesNormalize, "shaping:ies:normalize")) \
65  ((shadowEnable, "shadow:enable")) \
66  ((shadowColor, "shadow:color")) \
67  ((shadowDistance, "shadow:distance")) \
68  ((shadowFalloff, "shadow:falloff")) \
69  ((shadowFalloffGamma, "shadow:falloffGamma")) \
70  \
71  (params) \
72  (shadowCollection) \
73  (shadowParams) \
74  (transform)
75 
76 TF_DECLARE_PUBLIC_TOKENS(HdLightTokens, HD_API, HD_LIGHT_TOKENS);
77 
78 class HdSceneDelegate;
79 typedef boost::shared_ptr<class HdLight> HdLightSharedPtr;
80 typedef std::vector<class HdLight const *> HdLightPtrConstVector;
81 
86 class HdLight : public HdSprim {
87 public:
88  HD_API
89  HdLight(SdfPath const & id);
90  HD_API
91  virtual ~HdLight();
92 
93  // Change tracking for HdLight
94  enum DirtyBits : HdDirtyBits {
95  Clean = 0,
96  DirtyTransform = 1 << 0,
97  DirtyParams = 1 << 1,
98  DirtyShadowParams = 1 << 2,
99  DirtyCollection = 1 << 3,
100  AllDirty = (DirtyTransform
101  |DirtyParams
102  |DirtyShadowParams
103  |DirtyCollection)
104  };
105 };
106 
107 PXR_NAMESPACE_CLOSE_SCOPE
108 
109 #endif // HD_LIGHT_H
Adapter class providing data exchange with the client scene graph.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
Sprim (state prim) is a base class of managing state for non-drawable scene entity (e...
Definition: sprim.h:54
A light model, used in conjunction with HdRenderPass.
Definition: light.h:86