This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
UsdLuxTokensType Class Reference

UsdLuxTokens provides static, efficient TfTokens for use in all public USD API. More...

#include <tokens.h>

Public Attributes

const TfToken angular
 "angular"
 
const TfToken automatic
 "automatic"
 
const TfToken collectionFilterLinkIncludeRoot
 "collection:filterLink:includeRoot"
 
const TfToken collectionLightLinkIncludeRoot
 "collection:lightLink:includeRoot"
 
const TfToken collectionShadowLinkIncludeRoot
 "collection:shadowLink:includeRoot"
 
const TfToken consumeAndContinue
 "consumeAndContinue"
 
const TfToken consumeAndHalt
 "consumeAndHalt"
 
const TfToken cubeMapVerticalCross
 "cubeMapVerticalCross"
 
const TfToken filterLink
 "filterLink"
 
const TfToken geometry
 "geometry"
 
const TfToken guideRadius
 "guideRadius"
 
const TfToken ignore
 "ignore"
 
const TfToken independent
 "independent"
 
const TfToken inputsAngle
 "inputs:angle"
 
const TfToken inputsColor
 "inputs:color"
 
const TfToken inputsColorTemperature
 "inputs:colorTemperature"
 
const TfToken inputsDiffuse
 "inputs:diffuse"
 
const TfToken inputsEnableColorTemperature
 "inputs:enableColorTemperature"
 
const TfToken inputsExposure
 "inputs:exposure"
 
const TfToken inputsHeight
 "inputs:height"
 
const TfToken inputsIntensity
 "inputs:intensity"
 
const TfToken inputsLength
 "inputs:length"
 
const TfToken inputsNormalize
 "inputs:normalize"
 
const TfToken inputsRadius
 "inputs:radius"
 
const TfToken inputsShadowColor
 "inputs:shadow:color"
 
const TfToken inputsShadowDistance
 "inputs:shadow:distance"
 
const TfToken inputsShadowEnable
 "inputs:shadow:enable"
 
const TfToken inputsShadowFalloff
 "inputs:shadow:falloff"
 
const TfToken inputsShadowFalloffGamma
 "inputs:shadow:falloffGamma"
 
const TfToken inputsShapingConeAngle
 "inputs:shaping:cone:angle"
 
const TfToken inputsShapingConeSoftness
 "inputs:shaping:cone:softness"
 
const TfToken inputsShapingFocus
 "inputs:shaping:focus"
 
const TfToken inputsShapingFocusTint
 "inputs:shaping:focusTint"
 
const TfToken inputsShapingIesAngleScale
 "inputs:shaping:ies:angleScale"
 
const TfToken inputsShapingIesFile
 "inputs:shaping:ies:file"
 
const TfToken inputsShapingIesNormalize
 "inputs:shaping:ies:normalize"
 
const TfToken inputsSpecular
 "inputs:specular"
 
const TfToken inputsTextureFile
 "inputs:texture:file"
 
const TfToken inputsTextureFormat
 "inputs:texture:format"
 
const TfToken inputsWidth
 "inputs:width"
 
const TfToken latlong
 "latlong"
 
const TfToken lightFilters
 "light:filters"
 
const TfToken lightFilterShaderId
 "lightFilter:shaderId"
 
const TfToken lightLink
 "lightLink"
 
const TfToken lightList
 "lightList"
 
const TfToken lightListCacheBehavior
 "lightList:cacheBehavior"
 
const TfToken lightMaterialSyncMode
 "light:materialSyncMode"
 
const TfToken lightShaderId
 "light:shaderId"
 
const TfToken materialGlowTintsLight
 "materialGlowTintsLight"
 
const TfToken MeshLight
 "MeshLight"
 
const TfToken mirroredBall
 "mirroredBall"
 
const TfToken noMaterialResponse
 "noMaterialResponse"
 
const TfToken orientToStageUpAxis
 "orientToStageUpAxis"
 
const TfToken poleAxis
 "poleAxis"
 
const TfToken portals
 "portals"
 
const TfToken scene
 "scene"
 
const TfToken shadowLink
 "shadowLink"
 
const TfToken treatAsLine
 "treatAsLine"
 
const TfToken treatAsPoint
 "treatAsPoint"
 
const TfToken VolumeLight
 "VolumeLight"
 
const TfToken Y
 "Y"
 
const TfToken Z
 "Z"
 
const TfToken BoundableLightBase
 "BoundableLightBase"
 
const TfToken CylinderLight
 "CylinderLight"
 
const TfToken DiskLight
 "DiskLight"
 
const TfToken DistantLight
 "DistantLight"
 
const TfToken DomeLight
 "DomeLight"
 
const TfToken DomeLight_1
 "DomeLight_1"
 
const TfToken GeometryLight
 "GeometryLight"
 
const TfToken LightAPI
 "LightAPI"
 
const TfToken LightFilter
 "LightFilter"
 
const TfToken LightListAPI
 "LightListAPI"
 
const TfToken ListAPI
 "ListAPI"
 
const TfToken MeshLightAPI
 "MeshLightAPI"
 
const TfToken NonboundableLightBase
 "NonboundableLightBase"
 
const TfToken PluginLight
 "PluginLight"
 
const TfToken PluginLightFilter
 "PluginLightFilter"
 
const TfToken PortalLight
 "PortalLight"
 
const TfToken RectLight
 "RectLight"
 
const TfToken ShadowAPI
 "ShadowAPI"
 
const TfToken ShapingAPI
 "ShapingAPI"
 
const TfToken SphereLight
 "SphereLight"
 
const TfToken VolumeLightAPI
 "VolumeLightAPI"
 
const std::vector< TfTokenallTokens
 A vector of all of the tokens listed above.
 

Detailed Description

UsdLuxTokens provides static, efficient TfTokens for use in all public USD API.

These tokens are auto-generated from the module's schema, representing property names, for when you need to fetch an attribute or relationship directly by name, e.g. UsdPrim::GetAttribute(), in the most efficient manner, and allow the compiler to verify that you spelled the name correctly.

UsdLuxTokens also contains all of the allowedTokens values declared for schema builtin attributes of 'token' scene description type. Use UsdLuxTokens like so:

gprim.GetMyTokenValuedAttr().Set(UsdLuxTokens->angular);
USDLUX_API TfStaticData< UsdLuxTokensType > UsdLuxTokens
A global variable with static, efficient TfTokens for use in all public USD API.

Definition at line 46 of file tokens.h.

Member Data Documentation

◆ allTokens

const std::vector<TfToken> allTokens

A vector of all of the tokens listed above.

Definition at line 381 of file tokens.h.

◆ angular

const TfToken angular

"angular"

Possible value for UsdLuxDomeLight::GetTextureFormatAttr(), Possible value for UsdLuxDomeLight_1::GetTextureFormatAttr()

Definition at line 51 of file tokens.h.

◆ automatic

const TfToken automatic

"automatic"

Fallback value for UsdLuxDomeLight::GetTextureFormatAttr(), Fallback value for UsdLuxDomeLight_1::GetTextureFormatAttr()

Definition at line 55 of file tokens.h.

◆ BoundableLightBase

const TfToken BoundableLightBase

"BoundableLightBase"

Schema identifer and family for UsdLuxBoundableLightBase

Definition at line 299 of file tokens.h.

◆ collectionFilterLinkIncludeRoot

const TfToken collectionFilterLinkIncludeRoot

"collection:filterLink:includeRoot"

UsdLuxLightFilter

Definition at line 59 of file tokens.h.

◆ collectionLightLinkIncludeRoot

const TfToken collectionLightLinkIncludeRoot

"collection:lightLink:includeRoot"

UsdLuxLightAPI

Definition at line 63 of file tokens.h.

◆ collectionShadowLinkIncludeRoot

const TfToken collectionShadowLinkIncludeRoot

"collection:shadowLink:includeRoot"

UsdLuxLightAPI

Definition at line 67 of file tokens.h.

◆ consumeAndContinue

const TfToken consumeAndContinue

"consumeAndContinue"

Possible value for UsdLuxLightListAPI::GetLightListCacheBehaviorAttr(), Possible value for UsdLuxListAPI::GetLightListCacheBehaviorAttr()

Definition at line 71 of file tokens.h.

◆ consumeAndHalt

const TfToken consumeAndHalt

"consumeAndHalt"

Possible value for UsdLuxLightListAPI::GetLightListCacheBehaviorAttr(), Possible value for UsdLuxListAPI::GetLightListCacheBehaviorAttr()

Definition at line 75 of file tokens.h.

◆ cubeMapVerticalCross

const TfToken cubeMapVerticalCross

"cubeMapVerticalCross"

Possible value for UsdLuxDomeLight::GetTextureFormatAttr(), Possible value for UsdLuxDomeLight_1::GetTextureFormatAttr()

Definition at line 79 of file tokens.h.

◆ CylinderLight

const TfToken CylinderLight

"CylinderLight"

Schema identifer and family for UsdLuxCylinderLight, Fallback value for UsdLuxCylinderLight schema attribute light:shaderId

Definition at line 303 of file tokens.h.

◆ DiskLight

const TfToken DiskLight

"DiskLight"

Schema identifer and family for UsdLuxDiskLight, Fallback value for UsdLuxDiskLight schema attribute light:shaderId

Definition at line 307 of file tokens.h.

◆ DistantLight

const TfToken DistantLight

"DistantLight"

Schema identifer and family for UsdLuxDistantLight, Fallback value for UsdLuxDistantLight schema attribute light:shaderId

Definition at line 311 of file tokens.h.

◆ DomeLight

const TfToken DomeLight

"DomeLight"

Schema identifer and family for UsdLuxDomeLight, Schema family for UsdLuxDomeLight_1, Fallback value for UsdLuxDomeLight schema attribute light:shaderId, Fallback value for UsdLuxDomeLight_1 schema attribute light:shaderId

Definition at line 315 of file tokens.h.

◆ DomeLight_1

const TfToken DomeLight_1

"DomeLight_1"

Schema identifer for UsdLuxDomeLight_1

Definition at line 319 of file tokens.h.

◆ filterLink

const TfToken filterLink

"filterLink"

This token represents the collection name to use with UsdCollectionAPI to represent filter-linking of a UsdLuxLightFilter prim.

Definition at line 83 of file tokens.h.

◆ geometry

const TfToken geometry

"geometry"

UsdLuxGeometryLight

Definition at line 87 of file tokens.h.

◆ GeometryLight

const TfToken GeometryLight

"GeometryLight"

Schema identifer and family for UsdLuxGeometryLight, Fallback value for UsdLuxGeometryLight schema attribute light:shaderId

Definition at line 323 of file tokens.h.

◆ guideRadius

const TfToken guideRadius

"guideRadius"

UsdLuxDomeLight, UsdLuxDomeLight_1

Definition at line 91 of file tokens.h.

◆ ignore

const TfToken ignore

"ignore"

Possible value for UsdLuxLightListAPI::GetLightListCacheBehaviorAttr(), Possible value for UsdLuxListAPI::GetLightListCacheBehaviorAttr()

Definition at line 95 of file tokens.h.

◆ independent

const TfToken independent

"independent"

Possible value for UsdLuxLightAPI::GetMaterialSyncModeAttr()

Definition at line 99 of file tokens.h.

◆ inputsAngle

const TfToken inputsAngle

"inputs:angle"

UsdLuxDistantLight

Definition at line 103 of file tokens.h.

◆ inputsColor

const TfToken inputsColor

"inputs:color"

UsdLuxLightAPI

Definition at line 107 of file tokens.h.

◆ inputsColorTemperature

const TfToken inputsColorTemperature

"inputs:colorTemperature"

UsdLuxLightAPI

Definition at line 111 of file tokens.h.

◆ inputsDiffuse

const TfToken inputsDiffuse

"inputs:diffuse"

UsdLuxLightAPI

Definition at line 115 of file tokens.h.

◆ inputsEnableColorTemperature

const TfToken inputsEnableColorTemperature

"inputs:enableColorTemperature"

UsdLuxLightAPI

Definition at line 119 of file tokens.h.

◆ inputsExposure

const TfToken inputsExposure

"inputs:exposure"

UsdLuxLightAPI

Definition at line 123 of file tokens.h.

◆ inputsHeight

const TfToken inputsHeight

"inputs:height"

UsdLuxRectLight, UsdLuxPortalLight

Definition at line 127 of file tokens.h.

◆ inputsIntensity

const TfToken inputsIntensity

"inputs:intensity"

UsdLuxLightAPI, UsdLuxDistantLight

Definition at line 131 of file tokens.h.

◆ inputsLength

const TfToken inputsLength

"inputs:length"

UsdLuxCylinderLight

Definition at line 135 of file tokens.h.

◆ inputsNormalize

const TfToken inputsNormalize

"inputs:normalize"

UsdLuxLightAPI

Definition at line 139 of file tokens.h.

◆ inputsRadius

const TfToken inputsRadius

"inputs:radius"

UsdLuxDiskLight, UsdLuxSphereLight, UsdLuxCylinderLight

Definition at line 143 of file tokens.h.

◆ inputsShadowColor

const TfToken inputsShadowColor

"inputs:shadow:color"

UsdLuxShadowAPI

Definition at line 147 of file tokens.h.

◆ inputsShadowDistance

const TfToken inputsShadowDistance

"inputs:shadow:distance"

UsdLuxShadowAPI

Definition at line 151 of file tokens.h.

◆ inputsShadowEnable

const TfToken inputsShadowEnable

"inputs:shadow:enable"

UsdLuxShadowAPI

Definition at line 155 of file tokens.h.

◆ inputsShadowFalloff

const TfToken inputsShadowFalloff

"inputs:shadow:falloff"

UsdLuxShadowAPI

Definition at line 159 of file tokens.h.

◆ inputsShadowFalloffGamma

const TfToken inputsShadowFalloffGamma

"inputs:shadow:falloffGamma"

UsdLuxShadowAPI

Definition at line 163 of file tokens.h.

◆ inputsShapingConeAngle

const TfToken inputsShapingConeAngle

"inputs:shaping:cone:angle"

UsdLuxShapingAPI

Definition at line 167 of file tokens.h.

◆ inputsShapingConeSoftness

const TfToken inputsShapingConeSoftness

"inputs:shaping:cone:softness"

UsdLuxShapingAPI

Definition at line 171 of file tokens.h.

◆ inputsShapingFocus

const TfToken inputsShapingFocus

"inputs:shaping:focus"

UsdLuxShapingAPI

Definition at line 175 of file tokens.h.

◆ inputsShapingFocusTint

const TfToken inputsShapingFocusTint

"inputs:shaping:focusTint"

UsdLuxShapingAPI

Definition at line 179 of file tokens.h.

◆ inputsShapingIesAngleScale

const TfToken inputsShapingIesAngleScale

"inputs:shaping:ies:angleScale"

UsdLuxShapingAPI

Definition at line 183 of file tokens.h.

◆ inputsShapingIesFile

const TfToken inputsShapingIesFile

"inputs:shaping:ies:file"

UsdLuxShapingAPI

Definition at line 187 of file tokens.h.

◆ inputsShapingIesNormalize

const TfToken inputsShapingIesNormalize

"inputs:shaping:ies:normalize"

UsdLuxShapingAPI

Definition at line 191 of file tokens.h.

◆ inputsSpecular

const TfToken inputsSpecular

"inputs:specular"

UsdLuxLightAPI

Definition at line 195 of file tokens.h.

◆ inputsTextureFile

const TfToken inputsTextureFile

"inputs:texture:file"

UsdLuxRectLight, UsdLuxDomeLight, UsdLuxDomeLight_1

Definition at line 199 of file tokens.h.

◆ inputsTextureFormat

const TfToken inputsTextureFormat

"inputs:texture:format"

UsdLuxDomeLight, UsdLuxDomeLight_1

Definition at line 203 of file tokens.h.

◆ inputsWidth

const TfToken inputsWidth

"inputs:width"

UsdLuxRectLight, UsdLuxPortalLight

Definition at line 207 of file tokens.h.

◆ latlong

const TfToken latlong

"latlong"

Possible value for UsdLuxDomeLight::GetTextureFormatAttr(), Possible value for UsdLuxDomeLight_1::GetTextureFormatAttr()

Definition at line 211 of file tokens.h.

◆ LightAPI

const TfToken LightAPI

"LightAPI"

Schema identifer and family for UsdLuxLightAPI

Definition at line 327 of file tokens.h.

◆ LightFilter

const TfToken LightFilter

"LightFilter"

Schema identifer and family for UsdLuxLightFilter

Definition at line 331 of file tokens.h.

◆ lightFilters

const TfToken lightFilters

"light:filters"

UsdLuxLightAPI

Definition at line 215 of file tokens.h.

◆ lightFilterShaderId

const TfToken lightFilterShaderId

"lightFilter:shaderId"

UsdLuxLightFilter

Definition at line 219 of file tokens.h.

◆ lightLink

const TfToken lightLink

"lightLink"

This token represents the collection name to use with UsdCollectionAPI to represent light-linking of a prim with an applied UsdLuxLightAPI.

Definition at line 223 of file tokens.h.

◆ lightList

const TfToken lightList

"lightList"

UsdLuxLightListAPI, UsdLuxListAPI

Definition at line 227 of file tokens.h.

◆ LightListAPI

const TfToken LightListAPI

"LightListAPI"

Schema identifer and family for UsdLuxLightListAPI

Definition at line 335 of file tokens.h.

◆ lightListCacheBehavior

const TfToken lightListCacheBehavior

"lightList:cacheBehavior"

UsdLuxLightListAPI, UsdLuxListAPI

Definition at line 231 of file tokens.h.

◆ lightMaterialSyncMode

const TfToken lightMaterialSyncMode

"light:materialSyncMode"

UsdLuxLightAPI, UsdLuxMeshLightAPI, UsdLuxVolumeLightAPI

Definition at line 235 of file tokens.h.

◆ lightShaderId

◆ ListAPI

const TfToken ListAPI

"ListAPI"

Schema identifer and family for UsdLuxListAPI

Definition at line 339 of file tokens.h.

◆ materialGlowTintsLight

const TfToken materialGlowTintsLight

"materialGlowTintsLight"

Possible value for UsdLuxLightAPI::GetMaterialSyncModeAttr(), Fallback value for UsdLuxMeshLightAPI schema attribute light:materialSyncMode, Fallback value for UsdLuxVolumeLightAPI schema attribute light:materialSyncMode

Definition at line 243 of file tokens.h.

◆ MeshLight

const TfToken MeshLight

"MeshLight"

Fallback value for UsdLuxMeshLightAPI schema attribute light:shaderId

Definition at line 247 of file tokens.h.

◆ MeshLightAPI

const TfToken MeshLightAPI

"MeshLightAPI"

Schema identifer and family for UsdLuxMeshLightAPI

Definition at line 343 of file tokens.h.

◆ mirroredBall

const TfToken mirroredBall

"mirroredBall"

Possible value for UsdLuxDomeLight::GetTextureFormatAttr(), Possible value for UsdLuxDomeLight_1::GetTextureFormatAttr()

Definition at line 251 of file tokens.h.

◆ noMaterialResponse

const TfToken noMaterialResponse

"noMaterialResponse"

Fallback value for UsdLuxLightAPI::GetMaterialSyncModeAttr()

Definition at line 255 of file tokens.h.

◆ NonboundableLightBase

const TfToken NonboundableLightBase

"NonboundableLightBase"

Schema identifer and family for UsdLuxNonboundableLightBase

Definition at line 347 of file tokens.h.

◆ orientToStageUpAxis

const TfToken orientToStageUpAxis

"orientToStageUpAxis"

This token represents the suffix for a UsdGeomXformOp used to orient a light with the stage's up axis.

Definition at line 259 of file tokens.h.

◆ PluginLight

const TfToken PluginLight

"PluginLight"

Schema identifer and family for UsdLuxPluginLight

Definition at line 351 of file tokens.h.

◆ PluginLightFilter

const TfToken PluginLightFilter

"PluginLightFilter"

Schema identifer and family for UsdLuxPluginLightFilter

Definition at line 355 of file tokens.h.

◆ poleAxis

const TfToken poleAxis

"poleAxis"

UsdLuxDomeLight_1

Definition at line 263 of file tokens.h.

◆ PortalLight

const TfToken PortalLight

"PortalLight"

Schema identifer and family for UsdLuxPortalLight, Fallback value for UsdLuxPortalLight schema attribute light:shaderId

Definition at line 359 of file tokens.h.

◆ portals

const TfToken portals

"portals"

UsdLuxDomeLight, UsdLuxDomeLight_1

Definition at line 267 of file tokens.h.

◆ RectLight

const TfToken RectLight

"RectLight"

Schema identifer and family for UsdLuxRectLight, Fallback value for UsdLuxRectLight schema attribute light:shaderId

Definition at line 363 of file tokens.h.

◆ scene

const TfToken scene

"scene"

Fallback value for UsdLuxDomeLight_1::GetPoleAxisAttr()

Definition at line 271 of file tokens.h.

◆ ShadowAPI

const TfToken ShadowAPI

"ShadowAPI"

Schema identifer and family for UsdLuxShadowAPI

Definition at line 367 of file tokens.h.

◆ shadowLink

const TfToken shadowLink

"shadowLink"

This token represents the collection name to use with UsdCollectionAPI to represent shadow-linking of a prim with an applied UsdLuxLightAPI.

Definition at line 275 of file tokens.h.

◆ ShapingAPI

const TfToken ShapingAPI

"ShapingAPI"

Schema identifer and family for UsdLuxShapingAPI

Definition at line 371 of file tokens.h.

◆ SphereLight

const TfToken SphereLight

"SphereLight"

Schema identifer and family for UsdLuxSphereLight, Fallback value for UsdLuxSphereLight schema attribute light:shaderId

Definition at line 375 of file tokens.h.

◆ treatAsLine

const TfToken treatAsLine

"treatAsLine"

UsdLuxCylinderLight

Definition at line 279 of file tokens.h.

◆ treatAsPoint

const TfToken treatAsPoint

"treatAsPoint"

UsdLuxSphereLight

Definition at line 283 of file tokens.h.

◆ VolumeLight

const TfToken VolumeLight

"VolumeLight"

Fallback value for UsdLuxVolumeLightAPI schema attribute light:shaderId

Definition at line 287 of file tokens.h.

◆ VolumeLightAPI

const TfToken VolumeLightAPI

"VolumeLightAPI"

Schema identifer and family for UsdLuxVolumeLightAPI

Definition at line 379 of file tokens.h.

◆ Y

const TfToken Y

"Y"

Possible value for UsdLuxDomeLight_1::GetPoleAxisAttr()

Definition at line 291 of file tokens.h.

◆ Z

const TfToken Z

"Z"

Possible value for UsdLuxDomeLight_1::GetPoleAxisAttr()

Definition at line 295 of file tokens.h.


The documentation for this class was generated from the following file: