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

#include <tokens.h>

Public Member Functions

USDSHADE_API UsdShadeTokensType ()
 

Public Attributes

const TfToken allPurpose
 "" More...
 
const TfToken bindMaterialAs
 "bindMaterialAs" More...
 
const TfToken coordSys
 "coordSys" More...
 
const TfToken coordSys_MultipleApplyTemplate_Binding
 "coordSys:__INSTANCE_NAME__:binding" 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 TfToken ConnectableAPI
 "ConnectableAPI" More...
 
const TfToken CoordSysAPI
 "CoordSysAPI" More...
 
const TfToken Material
 "Material" More...
 
const TfToken MaterialBindingAPI
 "MaterialBindingAPI" More...
 
const TfToken NodeDefAPI
 "NodeDefAPI" More...
 
const TfToken NodeGraph
 "NodeGraph" More...
 
const TfToken Shader
 "Shader" 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 46 of file tokens.h.

Constructor & Destructor Documentation

USDSHADE_API UsdShadeTokensType::UsdShadeTokensType ( )

Member Data Documentation

const TfToken UsdShadeTokensType::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 51 of file tokens.h.

const std::vector<TfToken> UsdShadeTokensType::allTokens

A vector of all of the tokens listed above.

Definition at line 201 of file tokens.h.

const TfToken UsdShadeTokensType::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 55 of file tokens.h.

const TfToken UsdShadeTokensType::ConnectableAPI

"ConnectableAPI"

Schema identifer and family for UsdShadeConnectableAPI

Definition at line 175 of file tokens.h.

const TfToken UsdShadeTokensType::coordSys

"coordSys"

Property namespace prefix for the UsdShadeCoordSysAPI schema.

Definition at line 59 of file tokens.h.

const TfToken UsdShadeTokensType::coordSys_MultipleApplyTemplate_Binding

"coordSys:__INSTANCE_NAME__:binding"

UsdShadeCoordSysAPI

Definition at line 63 of file tokens.h.

const TfToken UsdShadeTokensType::CoordSysAPI

"CoordSysAPI"

Schema identifer and family for UsdShadeCoordSysAPI

Definition at line 179 of file tokens.h.

const TfToken UsdShadeTokensType::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 67 of file tokens.h.

const TfToken UsdShadeTokensType::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 71 of file tokens.h.

const TfToken UsdShadeTokensType::full

"full"

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

Definition at line 75 of file tokens.h.

const TfToken UsdShadeTokensType::id

"id"

Fallback value for UsdShadeNodeDefAPI::GetImplementationSourceAttr()

Definition at line 79 of file tokens.h.

const TfToken UsdShadeTokensType::infoId

"info:id"

UsdShadeNodeDefAPI

Definition at line 83 of file tokens.h.

const TfToken UsdShadeTokensType::infoImplementationSource

"info:implementationSource"

UsdShadeNodeDefAPI

Definition at line 87 of file tokens.h.

const TfToken UsdShadeTokensType::inputs

"inputs:"

The prefix on shading attributes denoting an input.

Definition at line 91 of file tokens.h.

const TfToken UsdShadeTokensType::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 95 of file tokens.h.

const TfToken UsdShadeTokensType::Material

"Material"

Schema identifer and family for UsdShadeMaterial

Definition at line 183 of file tokens.h.

const TfToken UsdShadeTokensType::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 99 of file tokens.h.

const TfToken UsdShadeTokensType::materialBinding

"material:binding"

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

Definition at line 103 of file tokens.h.

const TfToken UsdShadeTokensType::MaterialBindingAPI

"MaterialBindingAPI"

Schema identifer and family for UsdShadeMaterialBindingAPI

Definition at line 187 of file tokens.h.

const TfToken UsdShadeTokensType::materialBindingCollection

"material:binding:collection"

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

Definition at line 107 of file tokens.h.

const TfToken UsdShadeTokensType::materialVariant

"materialVariant"

The variant name of material variation described on a UsdShadeMaterial.

Definition at line 111 of file tokens.h.

const TfToken UsdShadeTokensType::NodeDefAPI

"NodeDefAPI"

Schema identifer and family for UsdShadeNodeDefAPI

Definition at line 191 of file tokens.h.

const TfToken UsdShadeTokensType::NodeGraph

"NodeGraph"

Schema identifer and family for UsdShadeNodeGraph

Definition at line 195 of file tokens.h.

const TfToken UsdShadeTokensType::outputs

"outputs:"

The prefix on shading attributes denoting an output.

Definition at line 115 of file tokens.h.

const TfToken UsdShadeTokensType::outputsDisplacement

"outputs:displacement"

UsdShadeMaterial

Definition at line 119 of file tokens.h.

const TfToken UsdShadeTokensType::outputsSurface

"outputs:surface"

UsdShadeMaterial

Definition at line 123 of file tokens.h.

const TfToken UsdShadeTokensType::outputsVolume

"outputs:volume"

UsdShadeMaterial

Definition at line 127 of file tokens.h.

const TfToken UsdShadeTokensType::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 131 of file tokens.h.

const TfToken UsdShadeTokensType::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 135 of file tokens.h.

const TfToken UsdShadeTokensType::Shader

"Shader"

Schema identifer and family for UsdShadeShader

Definition at line 199 of file tokens.h.

const TfToken UsdShadeTokensType::sourceAsset

"sourceAsset"

Possible value for UsdShadeNodeDefAPI::GetImplementationSourceAttr()

Definition at line 139 of file tokens.h.

const TfToken UsdShadeTokensType::sourceCode

"sourceCode"

Possible value for UsdShadeNodeDefAPI::GetImplementationSourceAttr()

Definition at line 143 of file tokens.h.

const TfToken UsdShadeTokensType::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 147 of file tokens.h.

const TfToken UsdShadeTokensType::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 151 of file tokens.h.

const TfToken UsdShadeTokensType::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 155 of file tokens.h.

const TfToken UsdShadeTokensType::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 159 of file tokens.h.

const TfToken UsdShadeTokensType::universalSourceType

""

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

Definition at line 163 of file tokens.h.

const TfToken UsdShadeTokensType::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 167 of file tokens.h.

const TfToken UsdShadeTokensType::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 171 of file tokens.h.


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