UsdVolTokensType Class Reference

#include <tokens.h>

Public Member Functions
USDVOL_API	UsdVolTokensType ()

Public Attributes
const TfToken	bool_
	"bool" More...
const TfToken	Color
	"Color" More...
const TfToken	double2
	"double2" More...
const TfToken	double3
	"double3" More...
const TfToken	double_
	"double" More...
const TfToken	field
	"field" More...
const TfToken	fieldClass
	"fieldClass" More...
const TfToken	fieldDataType
	"fieldDataType" More...
const TfToken	fieldIndex
	"fieldIndex" More...
const TfToken	fieldName
	"fieldName" More...
const TfToken	fieldPurpose
	"fieldPurpose" More...
const TfToken	filePath
	"filePath" More...
const TfToken	float2
	"float2" More...
const TfToken	float3
	"float3" More...
const TfToken	float_
	"float" More...
const TfToken	fogVolume
	"fogVolume" More...
const TfToken	half
	"half" More...
const TfToken	half2
	"half2" More...
const TfToken	half3
	"half3" More...
const TfToken	int2
	"int2" More...
const TfToken	int3
	"int3" More...
const TfToken	int64
	"int64" More...
const TfToken	int_
	"int" More...
const TfToken	levelSet
	"levelSet" More...
const TfToken	mask
	"mask" More...
const TfToken	matrix3d
	"matrix3d" More...
const TfToken	matrix4d
	"matrix4d" More...
const TfToken	None_
	"None" More...
const TfToken	Normal
	"Normal" More...
const TfToken	Point
	"Point" More...
const TfToken	quatd
	"quatd" More...
const TfToken	staggered
	"staggered" More...
const TfToken	string
	"string" More...
const TfToken	uint
	"uint" More...
const TfToken	unknown
	"unknown" More...
const TfToken	Vector
	"Vector" More...
const TfToken	vectorDataRoleHint
	"vectorDataRoleHint" More...
const TfToken	Field3DAsset
	"Field3DAsset" More...
const TfToken	FieldAsset
	"FieldAsset" More...
const TfToken	FieldBase
	"FieldBase" More...
const TfToken	OpenVDBAsset
	"OpenVDBAsset" More...
const TfToken	Volume
	"Volume" More...
const std::vector< TfToken >	allTokens
	A vector of all of the tokens listed above. More...

Detailed Description

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

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

gprim.GetMyTokenValuedAttr().Set(UsdVolTokens->bool_);

Definition at line 63 of file tokens.h.

Constructor & Destructor Documentation

USDVOL_API UsdVolTokensType::UsdVolTokensType

(

)

Member Data Documentation

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

A vector of all of the tokens listed above.

Definition at line 234 of file tokens.h.

const TfToken UsdVolTokensType::bool_

"bool"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 68 of file tokens.h.

const TfToken UsdVolTokensType::Color

"Color"

Possible value for UsdVolFieldAsset::GetVectorDataRoleHintAttr()

Definition at line 72 of file tokens.h.

const TfToken UsdVolTokensType::double2

"double2"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 76 of file tokens.h.

const TfToken UsdVolTokensType::double3

"double3"

Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr(), Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 80 of file tokens.h.

const TfToken UsdVolTokensType::double_

"double"

Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr(), Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 84 of file tokens.h.

const TfToken UsdVolTokensType::field

"field"

This is the namespace prefix used to specify the fields that make up a volume primitive.

Definition at line 88 of file tokens.h.

const TfToken UsdVolTokensType::Field3DAsset

"Field3DAsset"

Schema identifer and family for UsdVolField3DAsset

Definition at line 216 of file tokens.h.

const TfToken UsdVolTokensType::FieldAsset

"FieldAsset"

Schema identifer and family for UsdVolFieldAsset

Definition at line 220 of file tokens.h.

const TfToken UsdVolTokensType::FieldBase

"FieldBase"

Schema identifer and family for UsdVolFieldBase

Definition at line 224 of file tokens.h.

const TfToken UsdVolTokensType::fieldClass

"fieldClass"

UsdVolOpenVDBAsset

Definition at line 92 of file tokens.h.

const TfToken UsdVolTokensType::fieldDataType

"fieldDataType"

UsdVolFieldAsset, UsdVolField3DAsset, UsdVolOpenVDBAsset

Definition at line 96 of file tokens.h.

const TfToken UsdVolTokensType::fieldIndex

"fieldIndex"

UsdVolFieldAsset

Definition at line 100 of file tokens.h.

const TfToken UsdVolTokensType::fieldName

"fieldName"

UsdVolFieldAsset

Definition at line 104 of file tokens.h.

const TfToken UsdVolTokensType::fieldPurpose

"fieldPurpose"

UsdVolField3DAsset

Definition at line 108 of file tokens.h.

const TfToken UsdVolTokensType::filePath

"filePath"

UsdVolFieldAsset

Definition at line 112 of file tokens.h.

const TfToken UsdVolTokensType::float2

"float2"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 116 of file tokens.h.

const TfToken UsdVolTokensType::float3

"float3"

Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr(), Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 120 of file tokens.h.

const TfToken UsdVolTokensType::float_

"float"

Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr(), Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 124 of file tokens.h.

const TfToken UsdVolTokensType::fogVolume

"fogVolume"

Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()

Definition at line 128 of file tokens.h.

const TfToken UsdVolTokensType::half

"half"

Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr(), Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 132 of file tokens.h.

const TfToken UsdVolTokensType::half2

"half2"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 136 of file tokens.h.

const TfToken UsdVolTokensType::half3

"half3"

Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr(), Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 140 of file tokens.h.

const TfToken UsdVolTokensType::int2

"int2"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 144 of file tokens.h.

const TfToken UsdVolTokensType::int3

"int3"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 148 of file tokens.h.

const TfToken UsdVolTokensType::int64

"int64"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 152 of file tokens.h.

const TfToken UsdVolTokensType::int_

"int"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 156 of file tokens.h.

const TfToken UsdVolTokensType::levelSet

"levelSet"

Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()

Definition at line 160 of file tokens.h.

const TfToken UsdVolTokensType::mask

"mask"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 164 of file tokens.h.

const TfToken UsdVolTokensType::matrix3d

"matrix3d"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 168 of file tokens.h.

const TfToken UsdVolTokensType::matrix4d

"matrix4d"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 172 of file tokens.h.

const TfToken UsdVolTokensType::None_

"None"

Fallback value for UsdVolFieldAsset::GetVectorDataRoleHintAttr()

Definition at line 176 of file tokens.h.

const TfToken UsdVolTokensType::Normal

"Normal"

Possible value for UsdVolFieldAsset::GetVectorDataRoleHintAttr()

Definition at line 180 of file tokens.h.

const TfToken UsdVolTokensType::OpenVDBAsset

"OpenVDBAsset"

Schema identifer and family for UsdVolOpenVDBAsset

Definition at line 228 of file tokens.h.

const TfToken UsdVolTokensType::Point

"Point"

Possible value for UsdVolFieldAsset::GetVectorDataRoleHintAttr()

Definition at line 184 of file tokens.h.

const TfToken UsdVolTokensType::quatd

"quatd"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 188 of file tokens.h.

const TfToken UsdVolTokensType::staggered

"staggered"

Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()

Definition at line 192 of file tokens.h.

const TfToken UsdVolTokensType::string

"string"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 196 of file tokens.h.

const TfToken UsdVolTokensType::uint

"uint"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 200 of file tokens.h.

const TfToken UsdVolTokensType::unknown

"unknown"

Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()

Definition at line 204 of file tokens.h.

const TfToken UsdVolTokensType::Vector

"Vector"

Possible value for UsdVolFieldAsset::GetVectorDataRoleHintAttr()

Definition at line 208 of file tokens.h.

const TfToken UsdVolTokensType::vectorDataRoleHint

"vectorDataRoleHint"

UsdVolFieldAsset

Definition at line 212 of file tokens.h.

const TfToken UsdVolTokensType::Volume

"Volume"

Schema identifer and family for UsdVolVolume

Definition at line 232 of file tokens.h.

---

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

• pxr/usd/usdVol/tokens.h