UsdLux: Add support for shaping:ies:normalize

(Internal change: 1974219)
USApp-io · May 29, 2019 · 875b9d4 · 875b9d4
1 parent 0bdbd7d
commit 875b9d4
Show file tree

Hide file tree

Showing 8 changed files with 71 additions and 0 deletions.
diff --git a/pxr/usd/lib/usdLux/generatedSchema.usda b/pxr/usd/lib/usdLux/generatedSchema.usda
@@ -335,6 +335,11 @@ class "ShapingAPI" (
         doc = """An IES (Illumination Engineering Society) light
         profile describing the angular distribution of light."""
     )
+    bool shaping:ies:normalize (
+        displayGroup = "Shaping"
+        doc = """Normalizes the IES profile so that it affects the shaping
+        of the light while preserving the overall energy output."""
+    )
 }
 
 class "ShadowAPI" (

diff --git a/pxr/usd/lib/usdLux/schema.usda b/pxr/usd/lib/usdLux/schema.usda
@@ -298,6 +298,11 @@ class "ShapingAPI" (
         doc = """Rescales the angular distribution of the IES profile.
         TODO: clarify semantics"""
     )
+    bool shaping:ies:normalize (
+        displayGroup = "Shaping"
+        doc = """Normalizes the IES profile so that it affects the shaping
+        of the light while preserving the overall energy output."""
+    )
 }
 
 class "ShadowAPI" (

diff --git a/pxr/usd/lib/usdLux/shapingAPI.cpp b/pxr/usd/lib/usdLux/shapingAPI.cpp
@@ -199,6 +199,23 @@ UsdLuxShapingAPI::CreateShapingIesAngleScaleAttr(VtValue const &defaultValue, bo
                        writeSparsely);
 }
 
+UsdAttribute
+UsdLuxShapingAPI::GetShapingIesNormalizeAttr() const
+{
+    return GetPrim().GetAttribute(UsdLuxTokens->shapingIesNormalize);
+}
+
+UsdAttribute
+UsdLuxShapingAPI::CreateShapingIesNormalizeAttr(VtValue const &defaultValue, bool writeSparsely) const
+{
+    return UsdSchemaBase::_CreateAttr(UsdLuxTokens->shapingIesNormalize,
+                       SdfValueTypeNames->Bool,
+                       /* custom = */ false,
+                       SdfVariabilityVarying,
+                       defaultValue,
+                       writeSparsely);
+}
+
 namespace {
 static inline TfTokenVector
 _ConcatenateAttributeNames(const TfTokenVector& left,const TfTokenVector& right)
@@ -222,6 +239,7 @@ UsdLuxShapingAPI::GetSchemaAttributeNames(bool includeInherited)
         UsdLuxTokens->shapingConeSoftness,
         UsdLuxTokens->shapingIesFile,
         UsdLuxTokens->shapingIesAngleScale,
+        UsdLuxTokens->shapingIesNormalize,
     };
     static TfTokenVector allNames =
         _ConcatenateAttributeNames(

diff --git a/pxr/usd/lib/usdLux/shapingAPI.h b/pxr/usd/lib/usdLux/shapingAPI.h
@@ -274,6 +274,28 @@ class UsdLuxShapingAPI : public UsdAPISchemaBase
     USDLUX_API
     UsdAttribute CreateShapingIesAngleScaleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
+public:
+    // --------------------------------------------------------------------- //
+    // SHAPINGIESNORMALIZE 
+    // --------------------------------------------------------------------- //
+    /// Normalizes the IES profile so that it affects the shaping
+    /// of the light while preserving the overall energy output.
+    ///
+    /// \n  C++ Type: bool
+    /// \n  Usd Type: SdfValueTypeNames->Bool
+    /// \n  Variability: SdfVariabilityVarying
+    /// \n  Fallback Value: No Fallback
+    USDLUX_API
+    UsdAttribute GetShapingIesNormalizeAttr() const;
+
+    /// See GetShapingIesNormalizeAttr(), and also 
+    /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
+    /// If specified, author \p defaultValue as the attribute's default,
+    /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
+    /// the default for \p writeSparsely is \c false.
+    USDLUX_API
+    UsdAttribute CreateShapingIesNormalizeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
+
 public:
     // ===================================================================== //
     // Feel free to add custom code below this line, it will be preserved by 

diff --git a/pxr/usd/lib/usdLux/tokens.cpp b/pxr/usd/lib/usdLux/tokens.cpp
@@ -69,6 +69,7 @@ UsdLuxTokensType::UsdLuxTokensType() :
     shapingFocusTint("shaping:focusTint", TfToken::Immortal),
     shapingIesAngleScale("shaping:ies:angleScale", TfToken::Immortal),
     shapingIesFile("shaping:ies:file", TfToken::Immortal),
+    shapingIesNormalize("shaping:ies:normalize", TfToken::Immortal),
     specular("specular", TfToken::Immortal),
     textureFile("texture:file", TfToken::Immortal),
     textureFormat("texture:format", TfToken::Immortal),
@@ -119,6 +120,7 @@ UsdLuxTokensType::UsdLuxTokensType() :
         shapingFocusTint,
         shapingIesAngleScale,
         shapingIesFile,
+        shapingIesNormalize,
         specular,
         textureFile,
         textureFormat,

diff --git a/pxr/usd/lib/usdLux/tokens.h b/pxr/usd/lib/usdLux/tokens.h
@@ -234,6 +234,10 @@ struct UsdLuxTokensType {
     /// 
     /// UsdLuxShapingAPI
     const TfToken shapingIesFile;
+    /// \brief "shaping:ies:normalize"
+    /// 
+    /// UsdLuxShapingAPI
+    const TfToken shapingIesNormalize;
     /// \brief "specular"
     /// 
     /// UsdLuxLight

diff --git a/pxr/usd/lib/usdLux/wrapShapingAPI.cpp b/pxr/usd/lib/usdLux/wrapShapingAPI.cpp
@@ -90,6 +90,13 @@ _CreateShapingIesAngleScaleAttr(UsdLuxShapingAPI &self,
     return self.CreateShapingIesAngleScaleAttr(
         UsdPythonToSdfType(defaultVal, SdfValueTypeNames->Float), writeSparsely);
 }
+
+static UsdAttribute
+_CreateShapingIesNormalizeAttr(UsdLuxShapingAPI &self,
+                                      object defaultVal, bool writeSparsely) {
+    return self.CreateShapingIesNormalizeAttr(
+        UsdPythonToSdfType(defaultVal, SdfValueTypeNames->Bool), writeSparsely);
+}
 
 } // anonymous namespace
 
@@ -165,6 +172,13 @@ void wrapUsdLuxShapingAPI()
              &_CreateShapingIesAngleScaleAttr,
              (arg("defaultValue")=object(),
               arg("writeSparsely")=false))
+
+        .def("GetShapingIesNormalizeAttr",
+             &This::GetShapingIesNormalizeAttr)
+        .def("CreateShapingIesNormalizeAttr",
+             &_CreateShapingIesNormalizeAttr,
+             (arg("defaultValue")=object(),
+              arg("writeSparsely")=false))
 
     ;
 

diff --git a/pxr/usd/lib/usdLux/wrapTokens.cpp b/pxr/usd/lib/usdLux/wrapTokens.cpp
@@ -107,6 +107,7 @@ void wrapUsdLuxTokens()
     _AddToken(cls, "shapingFocusTint", UsdLuxTokens->shapingFocusTint);
     _AddToken(cls, "shapingIesAngleScale", UsdLuxTokens->shapingIesAngleScale);
     _AddToken(cls, "shapingIesFile", UsdLuxTokens->shapingIesFile);
+    _AddToken(cls, "shapingIesNormalize", UsdLuxTokens->shapingIesNormalize);
     _AddToken(cls, "specular", UsdLuxTokens->specular);
     _AddToken(cls, "textureFile", UsdLuxTokens->textureFile);
     _AddToken(cls, "textureFormat", UsdLuxTokens->textureFormat);