usdrt::UsdTokensType

Defined in usdrt/scenegraph/usd/usd/tokens.h

Functions

• usdrt::UsdTokensType::UsdTokensType

Variables

• usdrt::UsdTokensType::allTokens: A vector of all of the tokens listed above.

• usdrt::UsdTokensType::apiSchemas: "apiSchemas"

• usdrt::UsdTokensType::clipSets: "clipSets"

• usdrt::UsdTokensType::clips: "clips"

• usdrt::UsdTokensType::collection: "collection"

• usdrt::UsdTokensType::exclude: "exclude"

• usdrt::UsdTokensType::excludes: "excludes"

• usdrt::UsdTokensType::expandPrims: "expandPrims"

• usdrt::UsdTokensType::expandPrimsAndProperties: "expandPrimsAndProperties"

• usdrt::UsdTokensType::expansionRule: "expansionRule"

• usdrt::UsdTokensType::explicitOnly: "explicitOnly"

• usdrt::UsdTokensType::fallbackPrimTypes: "fallbackPrimTypes"

• usdrt::UsdTokensType::includeRoot: "includeRoot"

• usdrt::UsdTokensType::includes: "includes"

class UsdTokensType

Provides standard set of public tokens for Usd schema. Access via the RtTokens helper accessor.

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:

prim.GetAttribute(RtTokens->worldPosition);

Public Functions

inline UsdTokensType()

Public Members

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.

const TfToken clips

“clips”

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

const TfToken clipSets

“clipSets”

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

const TfToken collection

“collection”

Property namespace prefix for the UsdCollectionAPI schema.

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.

const TfToken excludes

“excludes”

UsdCollectionAPI

const TfToken expandPrims

“expandPrims”

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

const TfToken expandPrimsAndProperties

“expandPrimsAndProperties”

Possible value for UsdCollectionAPI::GetExpansionRuleAttr()

const TfToken expansionRule

“expansionRule”

UsdCollectionAPI

const TfToken explicitOnly

“explicitOnly”

Possible value for UsdCollectionAPI::GetExpansionRuleAttr()

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.

const TfToken includeRoot

“includeRoot”

UsdCollectionAPI

const TfToken includes

“includes”

UsdCollectionAPI

const std::vector<TfToken> allTokens

A vector of all of the tokens listed above.