UsdTokensType Class Reference

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

Public Attributes

const TfToken apiSchemas
 "apiSchemas" More...
 
const TfToken clips
 "clips" More...
 
const TfToken clipSets
 "clipSets" More...
 
const TfToken collection
 "collection" More...
 
const TfToken collection_MultipleApplyTemplate_Excludes
 "collection:__INSTANCE_NAME__:excludes" More...
 
const TfToken collection_MultipleApplyTemplate_ExpansionRule
 "collection:__INSTANCE_NAME__:expansionRule" More...
 
const TfToken collection_MultipleApplyTemplate_IncludeRoot
 "collection:__INSTANCE_NAME__:includeRoot" More...
 
const TfToken collection_MultipleApplyTemplate_Includes
 "collection:__INSTANCE_NAME__:includes" More...
 
const TfToken exclude
 "exclude" More...
 
const TfToken expandPrims
 "expandPrims" More...
 
const TfToken expandPrimsAndProperties
 "expandPrimsAndProperties" More...
 
const TfToken explicitOnly
 "explicitOnly" More...
 
const TfToken fallbackPrimTypes
 "fallbackPrimTypes" More...
 
const std::vector< TfTokenallTokens
 A vector of all of the tokens listed above. More...
 

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);

Definition at line 63 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 118 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 68 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 72 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 76 of file tokens.h.

◆ collection

const TfToken collection

"collection"

Property namespace prefix for the UsdCollectionAPI schema.

Definition at line 80 of file tokens.h.

◆ collection_MultipleApplyTemplate_Excludes

const TfToken collection_MultipleApplyTemplate_Excludes

"collection:__INSTANCE_NAME__:excludes"

UsdCollectionAPI

Definition at line 84 of file tokens.h.

◆ collection_MultipleApplyTemplate_ExpansionRule

const TfToken collection_MultipleApplyTemplate_ExpansionRule

"collection:__INSTANCE_NAME__:expansionRule"

UsdCollectionAPI

Definition at line 88 of file tokens.h.

◆ collection_MultipleApplyTemplate_IncludeRoot

const TfToken collection_MultipleApplyTemplate_IncludeRoot

"collection:__INSTANCE_NAME__:includeRoot"

UsdCollectionAPI

Definition at line 92 of file tokens.h.

◆ collection_MultipleApplyTemplate_Includes

const TfToken collection_MultipleApplyTemplate_Includes

"collection:__INSTANCE_NAME__:includes"

UsdCollectionAPI

Definition at line 96 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 100 of file tokens.h.

◆ expandPrims

const TfToken expandPrims

"expandPrims"

Possible value for UsdCollectionAPI::GetExpansionRuleAttr(), Default value for UsdCollectionAPI::GetExpansionRuleAttr()

Definition at line 104 of file tokens.h.

◆ expandPrimsAndProperties

const TfToken expandPrimsAndProperties

"expandPrimsAndProperties"

Possible value for UsdCollectionAPI::GetExpansionRuleAttr()

Definition at line 108 of file tokens.h.

◆ explicitOnly

const TfToken explicitOnly

"explicitOnly"

Possible value for UsdCollectionAPI::GetExpansionRuleAttr()

Definition at line 112 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 116 of file tokens.h.


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