UsdLux module#

Summary: The UsdLux module provides a representation for lights and related components that are common to many graphics environments.

Classes:

`BoundableLightBase`
`CylinderLight`
`DiskLight`
`DistantLight`
`DomeLight`
`DomeLight_1`
`GeometryLight`
`LightAPI`
`LightFilter`
`LightListAPI`
`ListAPI`
`MeshLightAPI`
`NonboundableLightBase`
`PluginLight`
`PluginLightFilter`
`PortalLight`
`RectLight`
`ShadowAPI`
`ShapingAPI`
`SphereLight`
`Tokens`
`VolumeLightAPI`

class pxr.UsdLux.BoundableLightBase

Methods:

`CreateColorAttr`
`CreateColorTemperatureAttr`
`CreateDiffuseAttr`
`CreateEnableColorTemperatureAttr`
`CreateExposureAttr`
`CreateFiltersRel`
`CreateIntensityAttr`
`CreateNormalizeAttr`
`CreateSpecularAttr`
`Get`
`GetColorAttr`
`GetColorTemperatureAttr`
`GetDiffuseAttr`
`GetEnableColorTemperatureAttr`
`GetExposureAttr`
`GetFiltersRel`
`GetIntensityAttr`
`GetNormalizeAttr`
`GetSchemaAttributeNames`
`GetSpecularAttr`
`LightAPI`

CreateColorAttr()

CreateColorTemperatureAttr()

CreateDiffuseAttr()

CreateEnableColorTemperatureAttr()

CreateExposureAttr()

CreateFiltersRel()

CreateIntensityAttr()

CreateNormalizeAttr()

CreateSpecularAttr()

static Get()

GetColorAttr()

GetColorTemperatureAttr()

GetDiffuseAttr()

GetEnableColorTemperatureAttr()

GetExposureAttr()

GetFiltersRel()

GetIntensityAttr()

GetNormalizeAttr()

static GetSchemaAttributeNames()

GetSpecularAttr()

LightAPI()

class pxr.UsdLux.CylinderLight

Methods:

`CreateLengthAttr`
`CreateRadiusAttr`
`CreateTreatAsLineAttr`
`Define`
`Get`
`GetLengthAttr`
`GetRadiusAttr`
`GetSchemaAttributeNames`
`GetTreatAsLineAttr`

CreateLengthAttr()

CreateRadiusAttr()

CreateTreatAsLineAttr()

static Define()

static Get()

GetLengthAttr()

GetRadiusAttr()

static GetSchemaAttributeNames()

GetTreatAsLineAttr()

class pxr.UsdLux.DiskLight

Methods:

`CreateRadiusAttr`
`Define`
`Get`
`GetRadiusAttr`
`GetSchemaAttributeNames`

CreateRadiusAttr()

static Define()

static Get()

GetRadiusAttr()

static GetSchemaAttributeNames()

class pxr.UsdLux.DistantLight

Methods:

`CreateAngleAttr`
`Define`
`Get`
`GetAngleAttr`
`GetSchemaAttributeNames`

CreateAngleAttr()

static Define()

static Get()

GetAngleAttr()

static GetSchemaAttributeNames()

class pxr.UsdLux.DomeLight

Methods:

`CreateGuideRadiusAttr`
`CreatePortalsRel`
`CreateTextureFileAttr`
`CreateTextureFormatAttr`
`Define`
`Get`
`GetGuideRadiusAttr`
`GetPortalsRel`
`GetSchemaAttributeNames`
`GetTextureFileAttr`
`GetTextureFormatAttr`
`OrientToStageUpAxis`

CreateGuideRadiusAttr()

CreatePortalsRel()

CreateTextureFileAttr()

CreateTextureFormatAttr()

static Define()

static Get()

GetGuideRadiusAttr()

GetPortalsRel()

static GetSchemaAttributeNames()

GetTextureFileAttr()

GetTextureFormatAttr()

OrientToStageUpAxis()

class pxr.UsdLux.DomeLight_1

Methods:

`CreateGuideRadiusAttr`
`CreatePoleAxisAttr`
`CreatePortalsRel`
`CreateTextureFileAttr`
`CreateTextureFormatAttr`
`Define`
`Get`
`GetGuideRadiusAttr`
`GetPoleAxisAttr`
`GetPortalsRel`
`GetSchemaAttributeNames`
`GetTextureFileAttr`
`GetTextureFormatAttr`

CreateGuideRadiusAttr()

CreatePoleAxisAttr()

CreatePortalsRel()

CreateTextureFileAttr()

CreateTextureFormatAttr()

static Define()

static Get()

GetGuideRadiusAttr()

GetPoleAxisAttr()

GetPortalsRel()

static GetSchemaAttributeNames()

GetTextureFileAttr()

GetTextureFormatAttr()

class pxr.UsdLux.GeometryLight

Methods:

`CreateGeometryRel`
`Define`
`Get`
`GetGeometryRel`
`GetSchemaAttributeNames`

CreateGeometryRel()

static Define()

static Get()

GetGeometryRel()

static GetSchemaAttributeNames()

class pxr.UsdLux.LightAPI

Methods:

`Apply`
`CanApply`
`ConnectableAPI`
`CreateColorAttr`
`CreateColorTemperatureAttr`
`CreateDiffuseAttr`
`CreateEnableColorTemperatureAttr`
`CreateExposureAttr`
`CreateFiltersRel`
`CreateInput`
`CreateIntensityAttr`
`CreateMaterialSyncModeAttr`
`CreateNormalizeAttr`
`CreateOutput`
`CreateShaderIdAttr`
`CreateShaderIdAttrForRenderContext`
`CreateSpecularAttr`
`Get`
`GetColorAttr`
`GetColorTemperatureAttr`
`GetDiffuseAttr`
`GetEnableColorTemperatureAttr`
`GetExposureAttr`
`GetFiltersRel`
`GetInput`
`GetInputs`
`GetIntensityAttr`
`GetLightLinkCollectionAPI`
`GetMaterialSyncModeAttr`
`GetNormalizeAttr`
`GetOutput`
`GetOutputs`
`GetSchemaAttributeNames`
`GetShaderId`
`GetShaderIdAttr`
`GetShaderIdAttrForRenderContext`
`GetShadowLinkCollectionAPI`
`GetSpecularAttr`

static Apply()

static CanApply()

ConnectableAPI()

CreateColorAttr()

CreateColorTemperatureAttr()

CreateDiffuseAttr()

CreateEnableColorTemperatureAttr()

CreateExposureAttr()

CreateFiltersRel()

CreateInput()

CreateIntensityAttr()

CreateMaterialSyncModeAttr()

CreateNormalizeAttr()

CreateOutput()

CreateShaderIdAttr()

CreateShaderIdAttrForRenderContext()

CreateSpecularAttr()

static Get()

GetColorAttr()

GetColorTemperatureAttr()

GetDiffuseAttr()

GetEnableColorTemperatureAttr()

GetExposureAttr()

GetFiltersRel()

GetInput()

GetInputs()

GetIntensityAttr()

GetLightLinkCollectionAPI()

GetMaterialSyncModeAttr()

GetNormalizeAttr()

GetOutput()

GetOutputs()

static GetSchemaAttributeNames()

GetShaderId()

GetShaderIdAttr()

GetShaderIdAttrForRenderContext()

GetShadowLinkCollectionAPI()

GetSpecularAttr()

class pxr.UsdLux.LightFilter

Methods:

`ConnectableAPI`
`CreateInput`
`CreateOutput`
`CreateShaderIdAttr`
`CreateShaderIdAttrForRenderContext`
`Define`
`Get`
`GetFilterLinkCollectionAPI`
`GetInput`
`GetInputs`
`GetOutput`
`GetOutputs`
`GetSchemaAttributeNames`
`GetShaderId`
`GetShaderIdAttr`
`GetShaderIdAttrForRenderContext`

ConnectableAPI()

CreateInput()

CreateOutput()

CreateShaderIdAttr()

CreateShaderIdAttrForRenderContext()

static Define()

static Get()

GetFilterLinkCollectionAPI()

GetInput()

GetInputs()

GetOutput()

GetOutputs()

static GetSchemaAttributeNames()

GetShaderId()

GetShaderIdAttr()

GetShaderIdAttrForRenderContext()

class pxr.UsdLux.LightListAPI

Classes:

ComputeMode

Methods:

`Apply`
`CanApply`
`ComputeLightList`
`CreateLightListCacheBehaviorAttr`
`CreateLightListRel`
`Get`
`GetLightListCacheBehaviorAttr`
`GetLightListRel`
`GetSchemaAttributeNames`
`InvalidateLightList`
`StoreLightList`

Attributes:

`ComputeModeConsultModelHierarchyCache`
`ComputeModeIgnoreCache`

class ComputeMode

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()

allValues = (UsdLux.LightListAPI.ComputeModeConsultModelHierarchyCache, UsdLux.LightListAPI.ComputeModeIgnoreCache)

static Apply()

static CanApply()

ComputeLightList()

CreateLightListCacheBehaviorAttr()

CreateLightListRel()

static Get()

GetLightListCacheBehaviorAttr()

GetLightListRel()

static GetSchemaAttributeNames()

InvalidateLightList()

StoreLightList()

ComputeModeConsultModelHierarchyCache = UsdLux.LightListAPI.ComputeModeConsultModelHierarchyCache

ComputeModeIgnoreCache = UsdLux.LightListAPI.ComputeModeIgnoreCache

class pxr.UsdLux.ListAPI

Classes:

ComputeMode

Methods:

`Apply`
`CanApply`
`ComputeLightList`
`CreateLightListCacheBehaviorAttr`
`CreateLightListRel`
`Get`
`GetLightListCacheBehaviorAttr`
`GetLightListRel`
`GetSchemaAttributeNames`
`InvalidateLightList`
`StoreLightList`

Attributes:

`ComputeModeConsultModelHierarchyCache`
`ComputeModeIgnoreCache`

class ComputeMode

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()

allValues = (UsdLux.ListAPI.ComputeModeConsultModelHierarchyCache, UsdLux.ListAPI.ComputeModeIgnoreCache)

static Apply()

static CanApply()

ComputeLightList()

CreateLightListCacheBehaviorAttr()

CreateLightListRel()

static Get()

GetLightListCacheBehaviorAttr()

GetLightListRel()

static GetSchemaAttributeNames()

InvalidateLightList()

StoreLightList()

ComputeModeConsultModelHierarchyCache = UsdLux.ListAPI.ComputeModeConsultModelHierarchyCache

ComputeModeIgnoreCache = UsdLux.ListAPI.ComputeModeIgnoreCache

class pxr.UsdLux.MeshLightAPI

Methods:

`Apply`
`CanApply`
`Get`
`GetSchemaAttributeNames`

static Apply()

static CanApply()

static Get()

static GetSchemaAttributeNames()

class pxr.UsdLux.NonboundableLightBase

Methods:

`CreateColorAttr`
`CreateColorTemperatureAttr`
`CreateDiffuseAttr`
`CreateEnableColorTemperatureAttr`
`CreateExposureAttr`
`CreateFiltersRel`
`CreateIntensityAttr`
`CreateNormalizeAttr`
`CreateSpecularAttr`
`Get`
`GetColorAttr`
`GetColorTemperatureAttr`
`GetDiffuseAttr`
`GetEnableColorTemperatureAttr`
`GetExposureAttr`
`GetFiltersRel`
`GetIntensityAttr`
`GetNormalizeAttr`
`GetSchemaAttributeNames`
`GetSpecularAttr`
`LightAPI`

CreateColorAttr()

CreateColorTemperatureAttr()

CreateDiffuseAttr()

CreateEnableColorTemperatureAttr()

CreateExposureAttr()

CreateFiltersRel()

CreateIntensityAttr()

CreateNormalizeAttr()

CreateSpecularAttr()

static Get()

GetColorAttr()

GetColorTemperatureAttr()

GetDiffuseAttr()

GetEnableColorTemperatureAttr()

GetExposureAttr()

GetFiltersRel()

GetIntensityAttr()

GetNormalizeAttr()

static GetSchemaAttributeNames()

GetSpecularAttr()

LightAPI()

class pxr.UsdLux.PluginLight

Methods:

`Define`
`Get`
`GetNodeDefAPI`
`GetSchemaAttributeNames`

static Define()

static Get()

GetNodeDefAPI()

static GetSchemaAttributeNames()

class pxr.UsdLux.PluginLightFilter

Methods:

`Define`
`Get`
`GetNodeDefAPI`
`GetSchemaAttributeNames`

static Define()

static Get()

GetNodeDefAPI()

static GetSchemaAttributeNames()

class pxr.UsdLux.PortalLight

Methods:

`CreateHeightAttr`
`CreateWidthAttr`
`Define`
`Get`
`GetHeightAttr`
`GetSchemaAttributeNames`
`GetWidthAttr`

CreateHeightAttr()

CreateWidthAttr()

static Define()

static Get()

GetHeightAttr()

static GetSchemaAttributeNames()

GetWidthAttr()

class pxr.UsdLux.RectLight

Methods:

`CreateHeightAttr`
`CreateTextureFileAttr`
`CreateWidthAttr`
`Define`
`Get`
`GetHeightAttr`
`GetSchemaAttributeNames`
`GetTextureFileAttr`
`GetWidthAttr`

CreateHeightAttr()

CreateTextureFileAttr()

CreateWidthAttr()

static Define()

static Get()

GetHeightAttr()

static GetSchemaAttributeNames()

GetTextureFileAttr()

GetWidthAttr()

class pxr.UsdLux.ShadowAPI

Methods:

`Apply`
`CanApply`
`ConnectableAPI`
`CreateInput`
`CreateOutput`
`CreateShadowColorAttr`
`CreateShadowDistanceAttr`
`CreateShadowEnableAttr`
`CreateShadowFalloffAttr`
`CreateShadowFalloffGammaAttr`
`Get`
`GetInput`
`GetInputs`
`GetOutput`
`GetOutputs`
`GetSchemaAttributeNames`
`GetShadowColorAttr`
`GetShadowDistanceAttr`
`GetShadowEnableAttr`
`GetShadowFalloffAttr`
`GetShadowFalloffGammaAttr`

static Apply()

static CanApply()

ConnectableAPI()

CreateInput()

CreateOutput()

CreateShadowColorAttr()

CreateShadowDistanceAttr()

CreateShadowEnableAttr()

CreateShadowFalloffAttr()

CreateShadowFalloffGammaAttr()

static Get()

GetInput()

GetInputs()

GetOutput()

GetOutputs()

static GetSchemaAttributeNames()

GetShadowColorAttr()

GetShadowDistanceAttr()

GetShadowEnableAttr()

GetShadowFalloffAttr()

GetShadowFalloffGammaAttr()

class pxr.UsdLux.ShapingAPI

Methods:

`Apply`
`CanApply`
`ConnectableAPI`
`CreateInput`
`CreateOutput`
`CreateShapingConeAngleAttr`
`CreateShapingConeSoftnessAttr`
`CreateShapingFocusAttr`
`CreateShapingFocusTintAttr`
`CreateShapingIesAngleScaleAttr`
`CreateShapingIesFileAttr`
`CreateShapingIesNormalizeAttr`
`Get`
`GetInput`
`GetInputs`
`GetOutput`
`GetOutputs`
`GetSchemaAttributeNames`
`GetShapingConeAngleAttr`
`GetShapingConeSoftnessAttr`
`GetShapingFocusAttr`
`GetShapingFocusTintAttr`
`GetShapingIesAngleScaleAttr`
`GetShapingIesFileAttr`
`GetShapingIesNormalizeAttr`

static Apply()

static CanApply()

ConnectableAPI()

CreateInput()

CreateOutput()

CreateShapingConeAngleAttr()

CreateShapingConeSoftnessAttr()

CreateShapingFocusAttr()

CreateShapingFocusTintAttr()

CreateShapingIesAngleScaleAttr()

CreateShapingIesFileAttr()

CreateShapingIesNormalizeAttr()

static Get()

GetInput()

GetInputs()

GetOutput()

GetOutputs()

static GetSchemaAttributeNames()

GetShapingConeAngleAttr()

GetShapingConeSoftnessAttr()

GetShapingFocusAttr()

GetShapingFocusTintAttr()

GetShapingIesAngleScaleAttr()

GetShapingIesFileAttr()

GetShapingIesNormalizeAttr()

class pxr.UsdLux.SphereLight

Methods:

`CreateRadiusAttr`
`CreateTreatAsPointAttr`
`Define`
`Get`
`GetRadiusAttr`
`GetSchemaAttributeNames`
`GetTreatAsPointAttr`

CreateRadiusAttr()

CreateTreatAsPointAttr()

static Define()

static Get()

GetRadiusAttr()

static GetSchemaAttributeNames()

GetTreatAsPointAttr()

class pxr.UsdLux.Tokens

Attributes:

`BoundableLightBase`
`CylinderLight`
`DiskLight`
`DistantLight`
`DomeLight`
`DomeLight_1`
`GeometryLight`
`LightAPI`
`LightFilter`
`LightListAPI`
`ListAPI`
`MeshLight`
`MeshLightAPI`
`NonboundableLightBase`
`PluginLight`
`PluginLightFilter`
`PortalLight`
`RectLight`
`ShadowAPI`
`ShapingAPI`
`SphereLight`
`VolumeLight`
`VolumeLightAPI`
`Y`
`Z`
`angular`
`automatic`
`collectionFilterLinkIncludeRoot`
`collectionLightLinkIncludeRoot`
`collectionShadowLinkIncludeRoot`
`consumeAndContinue`
`consumeAndHalt`
`cubeMapVerticalCross`
`filterLink`
`geometry`
`guideRadius`
`ignore`
`independent`
`inputsAngle`
`inputsColor`
`inputsColorTemperature`
`inputsDiffuse`
`inputsEnableColorTemperature`
`inputsExposure`
`inputsHeight`
`inputsIntensity`
`inputsLength`
`inputsNormalize`
`inputsRadius`
`inputsShadowColor`
`inputsShadowDistance`
`inputsShadowEnable`
`inputsShadowFalloff`
`inputsShadowFalloffGamma`
`inputsShapingConeAngle`
`inputsShapingConeSoftness`
`inputsShapingFocus`
`inputsShapingFocusTint`
`inputsShapingIesAngleScale`
`inputsShapingIesFile`
`inputsShapingIesNormalize`
`inputsSpecular`
`inputsTextureFile`
`inputsTextureFormat`
`inputsWidth`
`latlong`
`lightFilterShaderId`
`lightFilters`
`lightLink`
`lightList`
`lightListCacheBehavior`
`lightMaterialSyncMode`
`lightShaderId`
`materialGlowTintsLight`
`mirroredBall`
`noMaterialResponse`
`orientToStageUpAxis`
`poleAxis`
`portals`
`scene`
`shadowLink`
`treatAsLine`
`treatAsPoint`

BoundableLightBase = 'BoundableLightBase'

CylinderLight = 'CylinderLight'

DiskLight = 'DiskLight'

DistantLight = 'DistantLight'

DomeLight = 'DomeLight'

DomeLight_1 = 'DomeLight_1'

GeometryLight = 'GeometryLight'

LightAPI = 'LightAPI'

LightFilter = 'LightFilter'

LightListAPI = 'LightListAPI'

ListAPI = 'ListAPI'

MeshLight = 'MeshLight'

MeshLightAPI = 'MeshLightAPI'

NonboundableLightBase = 'NonboundableLightBase'

PluginLight = 'PluginLight'

PluginLightFilter = 'PluginLightFilter'

PortalLight = 'PortalLight'

RectLight = 'RectLight'

ShadowAPI = 'ShadowAPI'

ShapingAPI = 'ShapingAPI'

SphereLight = 'SphereLight'

VolumeLight = 'VolumeLight'

VolumeLightAPI = 'VolumeLightAPI'

Y = 'Y'

Z = 'Z'

angular = 'angular'

automatic = 'automatic'

collectionFilterLinkIncludeRoot = 'collection:filterLink:includeRoot'

collectionLightLinkIncludeRoot = 'collection:lightLink:includeRoot'

collectionShadowLinkIncludeRoot = 'collection:shadowLink:includeRoot'

consumeAndContinue = 'consumeAndContinue'

consumeAndHalt = 'consumeAndHalt'

cubeMapVerticalCross = 'cubeMapVerticalCross'

filterLink = 'filterLink'

geometry = 'geometry'

guideRadius = 'guideRadius'

ignore = 'ignore'

independent = 'independent'

inputsAngle = 'inputs:angle'

inputsColor = 'inputs:color'

inputsColorTemperature = 'inputs:colorTemperature'

inputsDiffuse = 'inputs:diffuse'

inputsEnableColorTemperature = 'inputs:enableColorTemperature'

inputsExposure = 'inputs:exposure'

inputsHeight = 'inputs:height'

inputsIntensity = 'inputs:intensity'

inputsLength = 'inputs:length'

inputsNormalize = 'inputs:normalize'

inputsRadius = 'inputs:radius'

inputsShadowColor = 'inputs:shadow:color'

inputsShadowDistance = 'inputs:shadow:distance'

inputsShadowEnable = 'inputs:shadow:enable'

inputsShadowFalloff = 'inputs:shadow:falloff'

inputsShadowFalloffGamma = 'inputs:shadow:falloffGamma'

inputsShapingConeAngle = 'inputs:shaping:cone:angle'

inputsShapingConeSoftness = 'inputs:shaping:cone:softness'

inputsShapingFocus = 'inputs:shaping:focus'

inputsShapingFocusTint = 'inputs:shaping:focusTint'

inputsShapingIesAngleScale = 'inputs:shaping:ies:angleScale'

inputsShapingIesFile = 'inputs:shaping:ies:file'

inputsShapingIesNormalize = 'inputs:shaping:ies:normalize'

inputsSpecular = 'inputs:specular'

inputsTextureFile = 'inputs:texture:file'

inputsTextureFormat = 'inputs:texture:format'

inputsWidth = 'inputs:width'

latlong = 'latlong'

lightFilterShaderId = 'lightFilter:shaderId'

lightFilters = 'light:filters'

lightLink = 'lightLink'

lightList = 'lightList'

lightListCacheBehavior = 'lightList:cacheBehavior'

lightMaterialSyncMode = 'light:materialSyncMode'

lightShaderId = 'light:shaderId'

materialGlowTintsLight = 'materialGlowTintsLight'

mirroredBall = 'mirroredBall'

noMaterialResponse = 'noMaterialResponse'

orientToStageUpAxis = 'orientToStageUpAxis'

poleAxis = 'poleAxis'

portals = 'portals'

scene = 'scene'

shadowLink = 'shadowLink'

treatAsLine = 'treatAsLine'

treatAsPoint = 'treatAsPoint'

class pxr.UsdLux.VolumeLightAPI

Methods:

`Apply`
`CanApply`
`Get`
`GetSchemaAttributeNames`

static Apply()

static CanApply()

static Get()

static GetSchemaAttributeNames()