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

#include <tokens.h>

Public Member Functions

USD_API UsdTokensType ()
 

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_
 "collection:__INSTANCE_NAME__" 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 collection_MultipleApplyTemplate_MembershipExpression
 "collection:__INSTANCE_NAME__:membershipExpression" 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 TfToken APISchemaBase
 "APISchemaBase" More...
 
const TfToken ClipsAPI
 "ClipsAPI" More...
 
const TfToken CollectionAPI
 "CollectionAPI" More...
 
const TfToken ModelAPI
 "ModelAPI" More...
 
const TfToken Typed
 "Typed" 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.

Constructor & Destructor Documentation

USD_API UsdTokensType::UsdTokensType ( )

Member Data Documentation

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

A vector of all of the tokens listed above.

Definition at line 146 of file tokens.h.

const TfToken UsdTokensType::APISchemaBase

"APISchemaBase"

Schema identifer and family for UsdAPISchemaBase

Definition at line 128 of file tokens.h.

const TfToken UsdTokensType::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.

const TfToken UsdTokensType::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.

const TfToken UsdTokensType::ClipsAPI

"ClipsAPI"

Schema identifer and family for UsdClipsAPI

Definition at line 132 of file tokens.h.

const TfToken UsdTokensType::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.

const TfToken UsdTokensType::collection

"collection"

Property namespace prefix for the UsdCollectionAPI schema.

Definition at line 80 of file tokens.h.

const TfToken UsdTokensType::collection_MultipleApplyTemplate_

"collection:__INSTANCE_NAME__"

UsdCollectionAPI

Definition at line 84 of file tokens.h.

const TfToken UsdTokensType::collection_MultipleApplyTemplate_Excludes

"collection:__INSTANCE_NAME__:excludes"

UsdCollectionAPI

Definition at line 88 of file tokens.h.

const TfToken UsdTokensType::collection_MultipleApplyTemplate_ExpansionRule

"collection:__INSTANCE_NAME__:expansionRule"

UsdCollectionAPI

Definition at line 92 of file tokens.h.

const TfToken UsdTokensType::collection_MultipleApplyTemplate_IncludeRoot

"collection:__INSTANCE_NAME__:includeRoot"

UsdCollectionAPI

Definition at line 96 of file tokens.h.

const TfToken UsdTokensType::collection_MultipleApplyTemplate_Includes

"collection:__INSTANCE_NAME__:includes"

UsdCollectionAPI

Definition at line 100 of file tokens.h.

const TfToken UsdTokensType::collection_MultipleApplyTemplate_MembershipExpression

"collection:__INSTANCE_NAME__:membershipExpression"

UsdCollectionAPI

Definition at line 104 of file tokens.h.

const TfToken UsdTokensType::CollectionAPI

"CollectionAPI"

Schema identifer and family for UsdCollectionAPI

Definition at line 136 of file tokens.h.

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

const TfToken UsdTokensType::expandPrims

"expandPrims"

Fallback value for UsdCollectionAPI::GetExpansionRuleAttr()

Definition at line 112 of file tokens.h.

const TfToken UsdTokensType::expandPrimsAndProperties

"expandPrimsAndProperties"

Possible value for UsdCollectionAPI::GetExpansionRuleAttr()

Definition at line 116 of file tokens.h.

const TfToken UsdTokensType::explicitOnly

"explicitOnly"

Possible value for UsdCollectionAPI::GetExpansionRuleAttr()

Definition at line 120 of file tokens.h.

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

const TfToken UsdTokensType::ModelAPI

"ModelAPI"

Schema identifer and family for UsdModelAPI

Definition at line 140 of file tokens.h.

const TfToken UsdTokensType::Typed

"Typed"

Schema identifer and family for UsdTyped

Definition at line 144 of file tokens.h.


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