All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdShadeTokensType Class Reference

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

Public Attributes

const TfToken allPurpose
 "" More...
 
const TfToken bindMaterialAs
 "bindMaterialAs" More...
 
const TfToken coordSys
 "coordSys:" More...
 
const TfToken displacement
 "displacement" More...
 
const TfToken fallbackStrength
 "fallbackStrength" More...
 
const TfToken full
 "full" More...
 
const TfToken id
 "id" More...
 
const TfToken infoId
 "info:id" More...
 
const TfToken infoImplementationSource
 "info:implementationSource" More...
 
const TfToken inputs
 "inputs:" More...
 
const TfToken interfaceOnly
 "interfaceOnly" More...
 
const TfToken materialBind
 "materialBind" More...
 
const TfToken materialBinding
 "material:binding" More...
 
const TfToken materialBindingCollection
 "material:binding:collection" More...
 
const TfToken materialVariant
 "materialVariant" More...
 
const TfToken outputs
 "outputs:" More...
 
const TfToken outputsDisplacement
 "outputs:displacement" More...
 
const TfToken outputsSurface
 "outputs:surface" More...
 
const TfToken outputsVolume
 "outputs:volume" More...
 
const TfToken preview
 "preview" More...
 
const TfToken sdrMetadata
 "sdrMetadata" More...
 
const TfToken sourceAsset
 "sourceAsset" More...
 
const TfToken sourceCode
 "sourceCode" More...
 
const TfToken strongerThanDescendants
 "strongerThanDescendants" More...
 
const TfToken subIdentifier
 "subIdentifier" More...
 
const TfToken surface
 "surface" More...
 
const TfToken universalRenderContext
 "" More...
 
const TfToken universalSourceType
 "" More...
 
const TfToken volume
 "volume" More...
 
const TfToken weakerThanDescendants
 "weakerThanDescendants" More...
 
const std::vector< TfTokenallTokens
 A vector of all of the tokens listed above. More...
 

Detailed Description

UsdShadeTokens 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.

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

* gprim.GetMyTokenValuedAttr().Set(UsdShadeTokens->allPurpose);
*

Definition at line 63 of file tokens.h.

Member Data Documentation

const TfToken allPurpose

""

Possible value for the 'materialPurpose' parameter in the various methods available in UsdShadeMaterialBindingAPI. Its value is empty and its purpose is to represent a general purpose material-binding that applies in the absence of a specific-purpose binding.

Definition at line 68 of file tokens.h.

const std::vector<TfToken> allTokens

A vector of all of the tokens listed above.

Definition at line 186 of file tokens.h.

const TfToken bindMaterialAs

"bindMaterialAs"

Token valued metadata key authored on a material binding relationship to indicate the strength of the binding relative to bindings authored on descendants.

Definition at line 72 of file tokens.h.

const TfToken coordSys

"coordSys:"

Namespace prefix for relationships that bind coordinate systems.

Definition at line 76 of file tokens.h.

const TfToken displacement

"displacement"

Describes the displacement output terminal on a UsdShadeMaterial. It is used to define the terminal UsdShadeShader describing the displacement of a UsdShadeMaterial.

Definition at line 80 of file tokens.h.

const TfToken fallbackStrength

"fallbackStrength"

Sentinal value to be used for 'bindMaterialAs' metadata's default value. Clients should pass this in for the 'bindingStrength' argument to UsdShadeMaterialBindingAPI::Bind(), if they want to author the default value (weakerThanDescendants) sparsely. The value "fallbackStrength" never gets authored into scene description.

Definition at line 84 of file tokens.h.

const TfToken full

"full"

Possible value for 'connectability' metadata on a UsdShadeInput. When connectability of an input is set to "full", it implies that it can be connected to any input or output. , Possible value for the 'materialPurpose' parameter in UsdShadeMaterialBindingAPI, to be used when the purpose of the render is entirely about visualizing the truest representation of a scene, considering all lighting and material information, at highest fidelity.

Definition at line 88 of file tokens.h.

const TfToken id

"id"

Possible value for UsdShadeShader::GetInfoImplementationSourceAttr(), Default value for UsdShadeShader::GetInfoImplementationSourceAttr()

Definition at line 92 of file tokens.h.

const TfToken infoId

"info:id"

UsdShadeShader

Definition at line 96 of file tokens.h.

const TfToken infoImplementationSource

"info:implementationSource"

UsdShadeShader

Definition at line 100 of file tokens.h.

const TfToken inputs

"inputs:"

The prefix on shading attributes denoting an input.

Definition at line 104 of file tokens.h.

const TfToken interfaceOnly

"interfaceOnly"

Possible value for 'connectability' metadata on a UsdShadeInput. It implies that the input can only connect to a NodeGraph Input (which represents an interface override, not a render-time dataflow connection), or another Input whose connectability is also 'interfaceOnly'.

Definition at line 108 of file tokens.h.

const TfToken materialBind

"materialBind"

The name of the GeomSubset family used to identify face subsets defined for the purpose of binding materials to facesets.

Definition at line 112 of file tokens.h.

const TfToken materialBinding

"material:binding"

The relationship name on non-shading prims to denote a binding to a UsdShadeMaterial.

Definition at line 116 of file tokens.h.

const TfToken materialBindingCollection

"material:binding:collection"

The relationship name on non-shading prims to denote a collection-based binding to a UsdShadeMaterial.

Definition at line 120 of file tokens.h.

const TfToken materialVariant

"materialVariant"

The variant name of material variation described on a UsdShadeMaterial.

Definition at line 124 of file tokens.h.

const TfToken outputs

"outputs:"

The prefix on shading attributes denoting an output.

Definition at line 128 of file tokens.h.

const TfToken outputsDisplacement

"outputs:displacement"

UsdShadeMaterial

Definition at line 132 of file tokens.h.

const TfToken outputsSurface

"outputs:surface"

UsdShadeMaterial

Definition at line 136 of file tokens.h.

const TfToken outputsVolume

"outputs:volume"

UsdShadeMaterial

Definition at line 140 of file tokens.h.

const TfToken preview

"preview"

Possible value for the 'materialPurpose' parameter in UsdShadeMaterialBindingAPI, to be used when the render is in service of a goal other than a high fidelity "full" render (such as scene manipulation, modeling, or realtime playback). Latency and speed are generally of greater concern for preview renders, therefore preview materials are generally designed to be "lighterweight" compared to full materials.

Definition at line 144 of file tokens.h.

const TfToken sdrMetadata

"sdrMetadata"

Dictionary valued metadata key authored on Shader prims with implementationSource value of sourceAsset or sourceCode to pass along metadata to the shader parser or compiler. It is also used to author metadata on shader properties in a UsdShade-based shader definition file.

Definition at line 148 of file tokens.h.

const TfToken sourceAsset

"sourceAsset"

Possible value for UsdShadeShader::GetInfoImplementationSourceAttr()

Definition at line 152 of file tokens.h.

const TfToken sourceCode

"sourceCode"

Possible value for UsdShadeShader::GetInfoImplementationSourceAttr()

Definition at line 156 of file tokens.h.

const TfToken strongerThanDescendants

"strongerThanDescendants"

Possible value for 'bindMaterialAs' metadata on the collection-based material binding relationship. Indicates that the binding represented by the relationship is stronger than any bindings authored on the descendants.

Definition at line 160 of file tokens.h.

const TfToken subIdentifier

"subIdentifier"

This identifier is used in conjunction with a specific source asset to indicate a particular definition within the source asset, if the source asset specifies more than one shader node definition.

Definition at line 164 of file tokens.h.

const TfToken surface

"surface"

Describes the surface output terminal on a UsdShadeMaterial. It is used to define the terminal UsdShadeShader describing the surface of a UsdShadeMaterial.

Definition at line 168 of file tokens.h.

const TfToken universalRenderContext

""

Possible value for the "renderContext" parameter in UsdShadeMaterial_Outputs API. Represents the universal renderContext. An output with a universal renderContext is applicable to all possible rendering contexts.

Definition at line 172 of file tokens.h.

const TfToken universalSourceType

""

Possible value for the "sourceType" parameter in UsdShadeShader_ImplementationSource API. Represents the universal or fallback source type.

Definition at line 176 of file tokens.h.

const TfToken volume

"volume"

Describes the volume output terminal on a UsdShadeMaterial. It is used to define the terminal UsdShadeShader describing the volume of a UsdShadeMaterial.

Definition at line 180 of file tokens.h.

const TfToken weakerThanDescendants

"weakerThanDescendants"

Possible value for 'bindMaterialAs' metadata on the collection-based material binding relationship. Indicates that the binding represented by the relationship is weaker than any bindings authored on the descendants.

Definition at line 184 of file tokens.h.


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