Loading...
Searching...
No Matches
UsdTokensType Class Reference

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

#include <tokens.h>

Public Attributes

const TfToken apiSchemas
 "apiSchemas"
 
const TfToken clips
 "clips"
 
const TfToken clipSets
 "clipSets"
 
const TfToken collection
 "collection"
 
const TfToken collection_MultipleApplyTemplate_
 "collection:__INSTANCE_NAME__"
 
const TfToken collection_MultipleApplyTemplate_Excludes
 "collection:__INSTANCE_NAME__:excludes"
 
const TfToken collection_MultipleApplyTemplate_ExpansionRule
 "collection:__INSTANCE_NAME__:expansionRule"
 
const TfToken collection_MultipleApplyTemplate_IncludeRoot
 "collection:__INSTANCE_NAME__:includeRoot"
 
const TfToken collection_MultipleApplyTemplate_Includes
 "collection:__INSTANCE_NAME__:includes"
 
const TfToken collection_MultipleApplyTemplate_MembershipExpression
 "collection:__INSTANCE_NAME__:membershipExpression"
 
const TfToken colorSpaceDefinition
 "colorSpaceDefinition"
 
const TfToken colorSpaceDefinition_MultipleApplyTemplate_BlueChroma
 "colorSpaceDefinition:__INSTANCE_NAME__:blueChroma"
 
const TfToken colorSpaceDefinition_MultipleApplyTemplate_Gamma
 "colorSpaceDefinition:__INSTANCE_NAME__:gamma"
 
const TfToken colorSpaceDefinition_MultipleApplyTemplate_GreenChroma
 "colorSpaceDefinition:__INSTANCE_NAME__:greenChroma"
 
const TfToken colorSpaceDefinition_MultipleApplyTemplate_LinearBias
 "colorSpaceDefinition:__INSTANCE_NAME__:linearBias"
 
const TfToken colorSpaceDefinition_MultipleApplyTemplate_Name
 "colorSpaceDefinition:__INSTANCE_NAME__:name"
 
const TfToken colorSpaceDefinition_MultipleApplyTemplate_RedChroma
 "colorSpaceDefinition:__INSTANCE_NAME__:redChroma"
 
const TfToken colorSpaceDefinition_MultipleApplyTemplate_WhitePoint
 "colorSpaceDefinition:__INSTANCE_NAME__:whitePoint"
 
const TfToken colorSpaceName
 "colorSpace:name"
 
const TfToken custom
 "custom"
 
const TfToken exclude
 "exclude"
 
const TfToken expandPrims
 "expandPrims"
 
const TfToken expandPrimsAndProperties
 "expandPrimsAndProperties"
 
const TfToken explicitOnly
 "explicitOnly"
 
const TfToken fallbackPrimTypes
 "fallbackPrimTypes"
 
const TfToken APISchemaBase
 "APISchemaBase"
 
const TfToken ClipsAPI
 "ClipsAPI"
 
const TfToken CollectionAPI
 "CollectionAPI"
 
const TfToken ColorSpaceAPI
 "ColorSpaceAPI"
 
const TfToken ColorSpaceDefinitionAPI
 "ColorSpaceDefinitionAPI"
 
const TfToken ModelAPI
 "ModelAPI"
 
const TfToken Typed
 "Typed"
 
const std::vector< TfTokenallTokens
 A vector of all of the tokens listed above.
 

Detailed Description

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

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

gprim.GetMyTokenValuedAttr().Set(UsdTokens->apiSchemas);
USD_API TfStaticData< UsdTokensType > UsdTokens
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 177 of file tokens.h.

◆ APISchemaBase

const TfToken APISchemaBase

"APISchemaBase"

Schema identifer and family for UsdAPISchemaBase

Definition at line 151 of file tokens.h.

◆ apiSchemas

const TfToken apiSchemas

"apiSchemas"

A listop metadata containing the API schemas which have been applied to this prim, using the Apply() method on the particular schema class.

Definition at line 51 of file tokens.h.

◆ clips

const TfToken clips

"clips"

Dictionary that contains the definition of the clip sets on this prim. See UsdClipsAPI::GetClips.

Definition at line 55 of file tokens.h.

◆ ClipsAPI

const TfToken ClipsAPI

"ClipsAPI"

Schema identifer and family for UsdClipsAPI

Definition at line 155 of file tokens.h.

◆ clipSets

const TfToken clipSets

"clipSets"

ListOp that may be used to affect how opinions from clip sets are applied during value resolution. See UsdClipsAPI::GetClipSets.

Definition at line 59 of file tokens.h.

◆ collection

const TfToken collection

"collection"

Property namespace prefix for the UsdCollectionAPI schema.

Definition at line 63 of file tokens.h.

◆ collection_MultipleApplyTemplate_

const TfToken collection_MultipleApplyTemplate_

"collection:__INSTANCE_NAME__"

UsdCollectionAPI

Definition at line 67 of file tokens.h.

◆ collection_MultipleApplyTemplate_Excludes

const TfToken collection_MultipleApplyTemplate_Excludes

"collection:__INSTANCE_NAME__:excludes"

UsdCollectionAPI

Definition at line 71 of file tokens.h.

◆ collection_MultipleApplyTemplate_ExpansionRule

const TfToken collection_MultipleApplyTemplate_ExpansionRule

"collection:__INSTANCE_NAME__:expansionRule"

UsdCollectionAPI

Definition at line 75 of file tokens.h.

◆ collection_MultipleApplyTemplate_IncludeRoot

const TfToken collection_MultipleApplyTemplate_IncludeRoot

"collection:__INSTANCE_NAME__:includeRoot"

UsdCollectionAPI

Definition at line 79 of file tokens.h.

◆ collection_MultipleApplyTemplate_Includes

const TfToken collection_MultipleApplyTemplate_Includes

"collection:__INSTANCE_NAME__:includes"

UsdCollectionAPI

Definition at line 83 of file tokens.h.

◆ collection_MultipleApplyTemplate_MembershipExpression

const TfToken collection_MultipleApplyTemplate_MembershipExpression

"collection:__INSTANCE_NAME__:membershipExpression"

UsdCollectionAPI

Definition at line 87 of file tokens.h.

◆ CollectionAPI

const TfToken CollectionAPI

"CollectionAPI"

Schema identifer and family for UsdCollectionAPI

Definition at line 159 of file tokens.h.

◆ ColorSpaceAPI

const TfToken ColorSpaceAPI

"ColorSpaceAPI"

Schema identifer and family for UsdColorSpaceAPI

Definition at line 163 of file tokens.h.

◆ colorSpaceDefinition

const TfToken colorSpaceDefinition

"colorSpaceDefinition"

Property namespace prefix for the UsdColorSpaceDefinitionAPI schema.

Definition at line 91 of file tokens.h.

◆ colorSpaceDefinition_MultipleApplyTemplate_BlueChroma

const TfToken colorSpaceDefinition_MultipleApplyTemplate_BlueChroma

"colorSpaceDefinition:__INSTANCE_NAME__:blueChroma"

UsdColorSpaceDefinitionAPI

Definition at line 95 of file tokens.h.

◆ colorSpaceDefinition_MultipleApplyTemplate_Gamma

const TfToken colorSpaceDefinition_MultipleApplyTemplate_Gamma

"colorSpaceDefinition:__INSTANCE_NAME__:gamma"

UsdColorSpaceDefinitionAPI

Definition at line 99 of file tokens.h.

◆ colorSpaceDefinition_MultipleApplyTemplate_GreenChroma

const TfToken colorSpaceDefinition_MultipleApplyTemplate_GreenChroma

"colorSpaceDefinition:__INSTANCE_NAME__:greenChroma"

UsdColorSpaceDefinitionAPI

Definition at line 103 of file tokens.h.

◆ colorSpaceDefinition_MultipleApplyTemplate_LinearBias

const TfToken colorSpaceDefinition_MultipleApplyTemplate_LinearBias

"colorSpaceDefinition:__INSTANCE_NAME__:linearBias"

UsdColorSpaceDefinitionAPI

Definition at line 107 of file tokens.h.

◆ colorSpaceDefinition_MultipleApplyTemplate_Name

const TfToken colorSpaceDefinition_MultipleApplyTemplate_Name

"colorSpaceDefinition:__INSTANCE_NAME__:name"

UsdColorSpaceDefinitionAPI

Definition at line 111 of file tokens.h.

◆ colorSpaceDefinition_MultipleApplyTemplate_RedChroma

const TfToken colorSpaceDefinition_MultipleApplyTemplate_RedChroma

"colorSpaceDefinition:__INSTANCE_NAME__:redChroma"

UsdColorSpaceDefinitionAPI

Definition at line 115 of file tokens.h.

◆ colorSpaceDefinition_MultipleApplyTemplate_WhitePoint

const TfToken colorSpaceDefinition_MultipleApplyTemplate_WhitePoint

"colorSpaceDefinition:__INSTANCE_NAME__:whitePoint"

UsdColorSpaceDefinitionAPI

Definition at line 119 of file tokens.h.

◆ ColorSpaceDefinitionAPI

const TfToken ColorSpaceDefinitionAPI

"ColorSpaceDefinitionAPI"

Schema identifer and family for UsdColorSpaceDefinitionAPI

Definition at line 167 of file tokens.h.

◆ colorSpaceName

const TfToken colorSpaceName

"colorSpace:name"

UsdColorSpaceAPI

Definition at line 123 of file tokens.h.

◆ custom

const TfToken custom

"custom"

Fallback value for UsdColorSpaceDefinitionAPI::GetNameAttr()

Definition at line 127 of file tokens.h.

◆ exclude

const TfToken exclude

"exclude"

This is the token used to exclude a path from a collection. Although it is not a possible value for the "expansionRule" attribute, it is used as the expansionRule for excluded paths in UsdCollectionAPI::MembershipQuery::IsPathIncluded.

Definition at line 131 of file tokens.h.

◆ expandPrims

const TfToken expandPrims

"expandPrims"

Fallback value for UsdCollectionAPI::GetExpansionRuleAttr()

Definition at line 135 of file tokens.h.

◆ expandPrimsAndProperties

const TfToken expandPrimsAndProperties

"expandPrimsAndProperties"

Possible value for UsdCollectionAPI::GetExpansionRuleAttr()

Definition at line 139 of file tokens.h.

◆ explicitOnly

const TfToken explicitOnly

"explicitOnly"

Possible value for UsdCollectionAPI::GetExpansionRuleAttr()

Definition at line 143 of file tokens.h.

◆ fallbackPrimTypes

const TfToken fallbackPrimTypes

"fallbackPrimTypes"

A dictionary metadata that maps the name of a concrete schema prim type to an ordered list of schema prim types to use instead if the schema prim type doesn't exist in version of USD being used.

Definition at line 147 of file tokens.h.

◆ ModelAPI

const TfToken ModelAPI

"ModelAPI"

Schema identifer and family for UsdModelAPI

Definition at line 171 of file tokens.h.

◆ Typed

const TfToken Typed

"Typed"

Schema identifer and family for UsdTyped

Definition at line 175 of file tokens.h.


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