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_LIGHT_H
25 #define PXR_IMAGING_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 
33 
34 #include <vector>
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 #define HD_LIGHT_TOKENS \
39  (angle) \
40  (color) \
41  (colorTemperature) \
42  (enableColorTemperature) \
43  (exposure) \
44  (height) \
45  (intensity) \
46  (radius) \
47  (length) \
48  ((textureFile, "texture:file")) \
49  ((textureFormat, "texture:format")) \
50  (width) \
51  (ambient) \
52  (diffuse) \
53  (specular) \
54  (normalize) \
55  (hasShadow) \
56  ((shapingFocus, "shaping:focus")) \
57  ((shapingFocusTint, "shaping:focusTint")) \
58  ((shapingConeAngle, "shaping:cone:angle")) \
59  ((shapingConeSoftness, "shaping:cone:softness")) \
60  ((shapingIesFile, "shaping:ies:file")) \
61  ((shapingIesAngleScale, "shaping:ies:angleScale")) \
62  ((shapingIesNormalize, "shaping:ies:normalize")) \
63  ((shadowEnable, "shadow:enable")) \
64  ((shadowColor, "shadow:color")) \
65  ((shadowDistance, "shadow:distance")) \
66  ((shadowFalloff, "shadow:falloff")) \
67  ((shadowFalloffGamma, "shadow:falloffGamma")) \
68  \
69  (params) \
70  (shadowCollection) \
71  (shadowParams)
72 
73 TF_DECLARE_PUBLIC_TOKENS(HdLightTokens, HD_API, HD_LIGHT_TOKENS);
74 
75 class HdSceneDelegate;
76 using HdLightPtrConstVector = std::vector<class HdLight const *>;
77 
82 class HdLight : public HdSprim
83 {
84 public:
85  HD_API
86  HdLight(SdfPath const & id);
87  HD_API
88  ~HdLight() override;
89 
90  // Change tracking for HdLight
91  enum DirtyBits : HdDirtyBits {
92  Clean = 0,
93  DirtyTransform = 1 << 0,
94  DirtyParams = 1 << 1,
95  DirtyShadowParams = 1 << 2,
96  DirtyCollection = 1 << 3,
97  DirtyResource = 1 << 4,
98  AllDirty = (DirtyTransform
99  |DirtyParams
100  |DirtyShadowParams
101  |DirtyCollection
102  |DirtyResource)
103  };
104 };
105 
106 PXR_NAMESPACE_CLOSE_SCOPE
107 
108 #endif // PXR_IMAGING_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:290
Sprim (state prim) is a base class of managing state for non-drawable scene entity (e....
Definition: sprim.h:51
This file defines some macros that are useful for declaring and using static TfTokens.
A light model, used in conjunction with HdRenderPass.
Definition: light.h:82