UsdRiTokensType Class Reference

#include <tokens.h>

Public Member Functions
USDRI_API	UsdRiTokensType ()

Public Attributes
const TfToken	bspline
	"bspline" More...
const TfToken	cameraVisibility
	"cameraVisibility" More...
const TfToken	catmullRom
	"catmull-rom" More...
const TfToken	collectionCameraVisibilityIncludeRoot
	"collection:cameraVisibility:includeRoot" More...
const TfToken	constant
	"constant" More...
const TfToken	interpolation
	"interpolation" More...
const TfToken	linear
	"linear" More...
const TfToken	matte
	"matte" More...
const TfToken	outputsRiDisplacement
	"outputs:ri:displacement" More...
const TfToken	outputsRiSurface
	"outputs:ri:surface" More...
const TfToken	outputsRiVolume
	"outputs:ri:volume" More...
const TfToken	positions
	"positions" More...
const TfToken	renderContext
	"ri" More...
const TfToken	spline
	"spline" More...
const TfToken	values
	"values" More...
const TfToken	RiMaterialAPI
	"RiMaterialAPI" More...
const TfToken	RiRenderPassAPI
	"RiRenderPassAPI" More...
const TfToken	RiSplineAPI
	"RiSplineAPI" More...
const TfToken	StatementsAPI
	"StatementsAPI" More...
const std::vector< TfToken >	allTokens
	A vector of all of the tokens listed above. More...

Detailed Description

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

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

gprim.GetMyTokenValuedAttr().Set(UsdRiTokens->bspline);

Definition at line 63 of file tokens.h.

Constructor & Destructor Documentation

USDRI_API UsdRiTokensType::UsdRiTokensType

(

)

Member Data Documentation

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

A vector of all of the tokens listed above.

Definition at line 142 of file tokens.h.

const TfToken UsdRiTokensType::bspline

"bspline"

UsdSplineAPI - BSpline spline interpolation

Definition at line 68 of file tokens.h.

const TfToken UsdRiTokensType::cameraVisibility

"cameraVisibility"

UsdRenderPassAPI - This token represents the collection name to use with UsdCollectionAPI to set the camera visibility attribute on the prims in the collection for the RenderPass.

Definition at line 72 of file tokens.h.

const TfToken UsdRiTokensType::catmullRom

"catmull-rom"

UsdSplineAPI - Catmull-Rom spline interpolation

Definition at line 76 of file tokens.h.

const TfToken UsdRiTokensType::collectionCameraVisibilityIncludeRoot

"collection:cameraVisibility:includeRoot"

UsdRiRenderPassAPI

Definition at line 80 of file tokens.h.

const TfToken UsdRiTokensType::constant

"constant"

UsdSplineAPI - Constant-value spline interpolation

Definition at line 84 of file tokens.h.

const TfToken UsdRiTokensType::interpolation

"interpolation"

UsdSplineAPI - Interpolation attribute name

Definition at line 88 of file tokens.h.

const TfToken UsdRiTokensType::linear

"linear"

UsdSplineAPI - Linear spline interpolation

Definition at line 92 of file tokens.h.

const TfToken UsdRiTokensType::matte

"matte"

UsdRenderPassAPI - This token represents the collection name to use with UsdCollectionAPI to set the matte attribute on the prims in the collection for the RenderPass.

Definition at line 96 of file tokens.h.

const TfToken UsdRiTokensType::outputsRiDisplacement

"outputs:ri:displacement"

UsdRiMaterialAPI

Definition at line 100 of file tokens.h.

const TfToken UsdRiTokensType::outputsRiSurface

"outputs:ri:surface"

UsdRiMaterialAPI

Definition at line 104 of file tokens.h.

const TfToken UsdRiTokensType::outputsRiVolume

"outputs:ri:volume"

UsdRiMaterialAPI

Definition at line 108 of file tokens.h.

const TfToken UsdRiTokensType::positions

"positions"

UsdSplineAPI - Positions attribute name

Definition at line 112 of file tokens.h.

const TfToken UsdRiTokensType::renderContext

"ri"

UsdShadeMaterial / Hydra render context token for UsdRi

Definition at line 116 of file tokens.h.

const TfToken UsdRiTokensType::RiMaterialAPI

"RiMaterialAPI"

Schema identifer and family for UsdRiMaterialAPI

Definition at line 128 of file tokens.h.

const TfToken UsdRiTokensType::RiRenderPassAPI

"RiRenderPassAPI"

Schema identifer and family for UsdRiRenderPassAPI

Definition at line 132 of file tokens.h.

const TfToken UsdRiTokensType::RiSplineAPI

"RiSplineAPI"

Schema identifer and family for UsdRiSplineAPI

Definition at line 136 of file tokens.h.

const TfToken UsdRiTokensType::spline

"spline"

UsdSplineAPI - Namespace for spline attributes

Definition at line 120 of file tokens.h.

const TfToken UsdRiTokensType::StatementsAPI

"StatementsAPI"

Schema identifer and family for UsdRiStatementsAPI

Definition at line 140 of file tokens.h.

const TfToken UsdRiTokensType::values

"values"

UsdSplineAPI - values attribute name

Definition at line 124 of file tokens.h.

---

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

• pxr/usd/usdRi/tokens.h