-
Notifications
You must be signed in to change notification settings - Fork 208
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6249 from boberfly/features/cyclesUSDLightSchema
GafferUSD : Added Cycles-specific light parameters to USD Lux lights
- Loading branch information
Showing
6 changed files
with
261 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| ########################################################################## | ||
| # | ||
| # Copyright (c) 2025, Alex Fuller. All rights reserved. | ||
| # | ||
| # Redistribution and use in source and binary forms, with or without | ||
| # modification, are permitted provided that the following conditions are | ||
| # met: | ||
| # | ||
| # * Redistributions of source code must retain the above | ||
| # copyright notice, this list of conditions and the following | ||
| # disclaimer. | ||
| # | ||
| # * Redistributions in binary form must reproduce the above | ||
| # copyright notice, this list of conditions and the following | ||
| # disclaimer in the documentation and/or other materials provided with | ||
| # the distribution. | ||
| # | ||
| # * Neither the name of John Haddon nor the names of | ||
| # any other contributors to this software may be used to endorse or | ||
| # promote products derived from this software without specific prior | ||
| # written permission. | ||
| # | ||
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS | ||
| # IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, | ||
| # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR | ||
| # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
| # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | ||
| # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
| # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | ||
| # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | ||
| # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
| # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| # | ||
| ########################################################################## | ||
|
|
||
| import pathlib | ||
|
|
||
| from pxr import Plug | ||
|
|
||
| # Register a USD plugin that adds Cycles-specific auto-apply schemas for | ||
| # UsdLux lights. We deliberately don't add this to the `PXR_PLUGINPATH_NAME` | ||
| # search path because we don't want it to be loaded in any third-party | ||
| # applications that Gaffer might launch as subprocessses. So instead we | ||
| # register it manually with `RegisterPlugins`. See `GafferCycles.usda` | ||
| # for more details. | ||
|
|
||
| try : | ||
| import GafferCycles | ||
| Plug.Registry().RegisterPlugins( str( pathlib.Path( GafferCycles.__file__ ).parents[2] / "plugin" / "GafferCycles" / "plugInfo.json" ) ) | ||
| except ImportError : | ||
| # GafferCycles not available | ||
| pass |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| #usda 1.0 | ||
| ( | ||
| subLayers = [ | ||
| @usdLux/schema.usda@, | ||
| @usd/schema.usda@ | ||
| ] | ||
| ) | ||
|
|
||
| over "GLOBAL" ( | ||
| customData = { | ||
| string libraryName = "GafferCycles" | ||
| bool skipCodeGeneration = 1 | ||
| bool useLiteralIdentifier = 1 | ||
| } | ||
| ) | ||
| { | ||
| } | ||
|
|
||
| # Here we define a bunch of codeless auto-apply API schemas for extending the | ||
| # standard UsdLux lights with inputs specific to Cycles. This approach is | ||
| # modelled on the one used by UsdRiPxr to add RenderMan-specific inputs, and | ||
| # we believe is the one Pixar intends everyone to use. | ||
|
|
||
| class "GafferCyclesLightAPI" ( | ||
| customData = { | ||
| token[] apiSchemaAutoApplyTo = [ "DistantLight", "DiskLight", "DomeLight", "RectLight", "SphereLight" ] | ||
| string apiSchemaType = "singleApply" | ||
| string className = "GafferCyclesLightAPI" | ||
| } | ||
| inherits = </APISchemaBase> | ||
| ) | ||
| { | ||
|
|
||
| string inputs:cycles:lightgroup = "" ( | ||
| displayGroup = "Basic" | ||
| displayName = "Light Group (Cycles)" | ||
| ) | ||
|
|
||
| bool inputs:cycles:use_mis = true ( | ||
| displayGroup = "Refine" | ||
| displayName = "MIS (Cycles)" | ||
| ) | ||
|
|
||
| bool inputs:cycles:use_camera = true ( | ||
| displayGroup = "Refine" | ||
| displayName = "Camera (Cycles)" | ||
| ) | ||
|
|
||
| bool inputs:cycles:use_diffuse = true ( | ||
| displayGroup = "Refine" | ||
| displayName = "Diffuse (Cycles)" | ||
| ) | ||
|
|
||
| bool inputs:cycles:use_glossy = true ( | ||
| displayGroup = "Refine" | ||
| displayName = "Glossy (Cycles)" | ||
| ) | ||
|
|
||
| bool inputs:cycles:use_transmission = true ( | ||
| displayGroup = "Refine" | ||
| displayName = "Transmission (Cycles)" | ||
| ) | ||
|
|
||
| bool inputs:cycles:use_scatter = true ( | ||
| displayGroup = "Refine" | ||
| displayName = "Volume Scatter (Cycles)" | ||
| ) | ||
|
|
||
| bool inputs:cycles:use_caustics = false ( | ||
| displayGroup = "Refine" | ||
| displayName = "Shadow Caustics (Cycles)" | ||
| ) | ||
|
|
||
| int inputs:cycles:max_bounces = 1024 ( | ||
| displayGroup = "Refine" | ||
| displayName = "Max Bounces (Cycles)" | ||
| ) | ||
|
|
||
| } | ||
|
|
||
| class "GafferCyclesDiskLightAPI" ( | ||
| customData = { | ||
| token[] apiSchemaAutoApplyTo = ["DiskLight"] | ||
| string apiSchemaType = "singleApply" | ||
| string className = "GafferCyclesDiskLightAPI" | ||
| } | ||
| inherits = </APISchemaBase> | ||
| ) | ||
| { | ||
|
|
||
| float inputs:cycles:spread = 180.0 ( | ||
| displayGroup = "Geometry" | ||
| displayName = "Spread (Cycles)" | ||
| ) | ||
|
|
||
| } | ||
|
|
||
| class "GafferCyclesQuadLightAPI" ( | ||
| customData = { | ||
| token[] apiSchemaAutoApplyTo = ["RectLight"] | ||
| string apiSchemaType = "singleApply" | ||
| string className = "GafferCyclesQuadLightAPI" | ||
| } | ||
| inherits = </APISchemaBase> | ||
| ) | ||
| { | ||
|
|
||
| float inputs:cycles:spread = 180.0 ( | ||
| displayGroup = "Geometry" | ||
| displayName = "Spread (Cycles)" | ||
| ) | ||
|
|
||
| } | ||
|
|
||
| class "GafferCyclesBackgroundLightAPI" ( | ||
| customData = { | ||
| token[] apiSchemaAutoApplyTo = ["DomeLight"] | ||
| string apiSchemaType = "singleApply" | ||
| string className = "GafferCyclesBackgroundLightAPI" | ||
| } | ||
| inherits = </APISchemaBase> | ||
| ) | ||
| { | ||
|
|
||
| int inputs:cycles:map_resolution = 1024 ( | ||
| displayGroup = "Sampling" | ||
| displayName = "Map Resolution (Cycles)" | ||
| ) | ||
|
|
||
| } |