Loading...
Searching...
No Matches
UsdVolTokensType Class Reference

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

#include <tokens.h>

Public Attributes

const TfToken bool_
 "bool"
 
const TfToken cameraDistance
 "cameraDistance"
 
const TfToken Color
 "Color"
 
const TfToken double2
 "double2"
 
const TfToken double3
 "double3"
 
const TfToken double_
 "double"
 
const TfToken field
 "field"
 
const TfToken fieldClass
 "fieldClass"
 
const TfToken fieldDataType
 "fieldDataType"
 
const TfToken fieldIndex
 "fieldIndex"
 
const TfToken fieldName
 "fieldName"
 
const TfToken fieldPurpose
 "fieldPurpose"
 
const TfToken filePath
 "filePath"
 
const TfToken float2
 "float2"
 
const TfToken float3
 "float3"
 
const TfToken float_
 "float"
 
const TfToken fogVolume
 "fogVolume"
 
const TfToken half
 "half"
 
const TfToken half2
 "half2"
 
const TfToken half3
 "half3"
 
const TfToken int2
 "int2"
 
const TfToken int3
 "int3"
 
const TfToken int64
 "int64"
 
const TfToken int_
 "int"
 
const TfToken levelSet
 "levelSet"
 
const TfToken mask
 "mask"
 
const TfToken matrix3d
 "matrix3d"
 
const TfToken matrix4d
 "matrix4d"
 
const TfToken None_
 "None"
 
const TfToken Normal
 "Normal"
 
const TfToken opacities
 "opacities"
 
const TfToken opacitiesh
 "opacitiesh"
 
const TfToken orientations
 "orientations"
 
const TfToken orientationsh
 "orientationsh"
 
const TfToken perspective
 "perspective"
 
const TfToken Point
 "Point"
 
const TfToken positions
 "positions"
 
const TfToken positionsh
 "positionsh"
 
const TfToken projectionModeHint
 "projectionModeHint"
 
const TfToken quatd
 "quatd"
 
const TfToken radianceSphericalHarmonicsCoefficients
 "radiance:sphericalHarmonicsCoefficients"
 
const TfToken radianceSphericalHarmonicsCoefficientsh
 "radiance:sphericalHarmonicsCoefficientsh"
 
const TfToken radianceSphericalHarmonicsDegree
 "radiance:sphericalHarmonicsDegree"
 
const TfToken scales
 "scales"
 
const TfToken scalesh
 "scalesh"
 
const TfToken sortingModeHint
 "sortingModeHint"
 
const TfToken staggered
 "staggered"
 
const TfToken string
 "string"
 
const TfToken tangential
 "tangential"
 
const TfToken uint
 "uint"
 
const TfToken unknown
 "unknown"
 
const TfToken Vector
 "Vector"
 
const TfToken vectorDataRoleHint
 "vectorDataRoleHint"
 
const TfToken zDepth
 "zDepth"
 
const TfToken Field3DAsset
 "Field3DAsset"
 
const TfToken FieldAsset
 "FieldAsset"
 
const TfToken FieldBase
 "FieldBase"
 
const TfToken OpenVDBAsset
 "OpenVDBAsset"
 
const TfToken ParticleField
 "ParticleField"
 
const TfToken ParticleField3DGaussianSplat
 "ParticleField3DGaussianSplat"
 
const TfToken ParticleFieldKernelBaseAPI
 "ParticleFieldKernelBaseAPI"
 
const TfToken ParticleFieldKernelConstantSurfletAPI
 "ParticleFieldKernelConstantSurfletAPI"
 
const TfToken ParticleFieldKernelGaussianEllipsoidAPI
 "ParticleFieldKernelGaussianEllipsoidAPI"
 
const TfToken ParticleFieldKernelGaussianSurfletAPI
 "ParticleFieldKernelGaussianSurfletAPI"
 
const TfToken ParticleFieldOpacityAttributeAPI
 "ParticleFieldOpacityAttributeAPI"
 
const TfToken ParticleFieldOrientationAttributeAPI
 "ParticleFieldOrientationAttributeAPI"
 
const TfToken ParticleFieldPositionAttributeAPI
 "ParticleFieldPositionAttributeAPI"
 
const TfToken ParticleFieldPositionBaseAPI
 "ParticleFieldPositionBaseAPI"
 
const TfToken ParticleFieldRadianceBaseAPI
 "ParticleFieldRadianceBaseAPI"
 
const TfToken ParticleFieldScaleAttributeAPI
 "ParticleFieldScaleAttributeAPI"
 
const TfToken ParticleFieldSphericalHarmonicsAttributeAPI
 "ParticleFieldSphericalHarmonicsAttributeAPI"
 
const TfToken Volume
 "Volume"
 
const TfToken VolumeFieldAsset
 "VolumeFieldAsset"
 
const TfToken VolumeFieldBase
 "VolumeFieldBase"
 
const std::vector< TfTokenallTokens
 A vector of all of the tokens listed above.
 

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_);
USDVOL_API TfStaticData< UsdVolTokensType > UsdVolTokens
A global variable with static, efficient TfTokens for use in all public USD API.

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

◆ bool_

const TfToken bool_

"bool"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 51 of file tokens.h.

◆ cameraDistance

const TfToken cameraDistance

"cameraDistance"

Possible value for UsdVolParticleField3DGaussianSplat::GetSortingModeHintAttr()

Definition at line 55 of file tokens.h.

◆ Color

const TfToken Color

"Color"

Possible value for UsdVolVolumeFieldAsset::GetVectorDataRoleHintAttr()

Definition at line 59 of file tokens.h.

◆ double2

const TfToken double2

"double2"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 63 of file tokens.h.

◆ double3

const TfToken double3

"double3"

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

Definition at line 67 of file tokens.h.

◆ double_

const TfToken double_

"double"

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

Definition at line 71 of file tokens.h.

◆ field

const TfToken field

"field"

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

Definition at line 75 of file tokens.h.

◆ Field3DAsset

const TfToken Field3DAsset

"Field3DAsset"

Schema identifer and family for UsdVolField3DAsset

Definition at line 267 of file tokens.h.

◆ FieldAsset

const TfToken FieldAsset

"FieldAsset"

Schema identifer and family for UsdVolFieldAsset

Definition at line 271 of file tokens.h.

◆ FieldBase

const TfToken FieldBase

"FieldBase"

Schema identifer and family for UsdVolFieldBase

Definition at line 275 of file tokens.h.

◆ fieldClass

const TfToken fieldClass

"fieldClass"

UsdVolOpenVDBAsset

Definition at line 79 of file tokens.h.

◆ fieldDataType

const TfToken fieldDataType

"fieldDataType"

UsdVolVolumeFieldAsset, UsdVolField3DAsset, UsdVolOpenVDBAsset

Definition at line 83 of file tokens.h.

◆ fieldIndex

const TfToken fieldIndex

"fieldIndex"

UsdVolVolumeFieldAsset

Definition at line 87 of file tokens.h.

◆ fieldName

const TfToken fieldName

"fieldName"

UsdVolVolumeFieldAsset

Definition at line 91 of file tokens.h.

◆ fieldPurpose

const TfToken fieldPurpose

"fieldPurpose"

UsdVolField3DAsset

Definition at line 95 of file tokens.h.

◆ filePath

const TfToken filePath

"filePath"

UsdVolVolumeFieldAsset

Definition at line 99 of file tokens.h.

◆ float2

const TfToken float2

"float2"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 103 of file tokens.h.

◆ float3

const TfToken float3

"float3"

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

Definition at line 107 of file tokens.h.

◆ float_

const TfToken float_

"float"

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

Definition at line 111 of file tokens.h.

◆ fogVolume

const TfToken fogVolume

"fogVolume"

Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()

Definition at line 115 of file tokens.h.

◆ half

const TfToken half

"half"

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

Definition at line 119 of file tokens.h.

◆ half2

const TfToken half2

"half2"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 123 of file tokens.h.

◆ half3

const TfToken half3

"half3"

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

Definition at line 127 of file tokens.h.

◆ int2

const TfToken int2

"int2"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 131 of file tokens.h.

◆ int3

const TfToken int3

"int3"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 135 of file tokens.h.

◆ int64

const TfToken int64

"int64"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 139 of file tokens.h.

◆ int_

const TfToken int_

"int"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 143 of file tokens.h.

◆ levelSet

const TfToken levelSet

"levelSet"

Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()

Definition at line 147 of file tokens.h.

◆ mask

const TfToken mask

"mask"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 151 of file tokens.h.

◆ matrix3d

const TfToken matrix3d

"matrix3d"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 155 of file tokens.h.

◆ matrix4d

const TfToken matrix4d

"matrix4d"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 159 of file tokens.h.

◆ None_

const TfToken None_

"None"

Fallback value for UsdVolVolumeFieldAsset::GetVectorDataRoleHintAttr()

Definition at line 163 of file tokens.h.

◆ Normal

const TfToken Normal

"Normal"

Possible value for UsdVolVolumeFieldAsset::GetVectorDataRoleHintAttr()

Definition at line 167 of file tokens.h.

◆ opacities

const TfToken opacities

"opacities"

UsdVolParticleFieldOpacityAttributeAPI

Definition at line 171 of file tokens.h.

◆ opacitiesh

const TfToken opacitiesh

"opacitiesh"

UsdVolParticleFieldOpacityAttributeAPI

Definition at line 175 of file tokens.h.

◆ OpenVDBAsset

const TfToken OpenVDBAsset

"OpenVDBAsset"

Schema identifer and family for UsdVolOpenVDBAsset

Definition at line 279 of file tokens.h.

◆ orientations

const TfToken orientations

"orientations"

UsdVolParticleFieldOrientationAttributeAPI

Definition at line 179 of file tokens.h.

◆ orientationsh

const TfToken orientationsh

"orientationsh"

UsdVolParticleFieldOrientationAttributeAPI

Definition at line 183 of file tokens.h.

◆ ParticleField

const TfToken ParticleField

"ParticleField"

Schema identifer and family for UsdVolParticleField

Definition at line 283 of file tokens.h.

◆ ParticleField3DGaussianSplat

const TfToken ParticleField3DGaussianSplat

"ParticleField3DGaussianSplat"

Schema identifer and family for UsdVolParticleField3DGaussianSplat

Definition at line 287 of file tokens.h.

◆ ParticleFieldKernelBaseAPI

const TfToken ParticleFieldKernelBaseAPI

"ParticleFieldKernelBaseAPI"

Schema identifer and family for UsdVolParticleFieldKernelBaseAPI

Definition at line 291 of file tokens.h.

◆ ParticleFieldKernelConstantSurfletAPI

const TfToken ParticleFieldKernelConstantSurfletAPI

"ParticleFieldKernelConstantSurfletAPI"

Schema identifer and family for UsdVolParticleFieldKernelConstantSurfletAPI

Definition at line 295 of file tokens.h.

◆ ParticleFieldKernelGaussianEllipsoidAPI

const TfToken ParticleFieldKernelGaussianEllipsoidAPI

"ParticleFieldKernelGaussianEllipsoidAPI"

Schema identifer and family for UsdVolParticleFieldKernelGaussianEllipsoidAPI

Definition at line 299 of file tokens.h.

◆ ParticleFieldKernelGaussianSurfletAPI

const TfToken ParticleFieldKernelGaussianSurfletAPI

"ParticleFieldKernelGaussianSurfletAPI"

Schema identifer and family for UsdVolParticleFieldKernelGaussianSurfletAPI

Definition at line 303 of file tokens.h.

◆ ParticleFieldOpacityAttributeAPI

const TfToken ParticleFieldOpacityAttributeAPI

"ParticleFieldOpacityAttributeAPI"

Schema identifer and family for UsdVolParticleFieldOpacityAttributeAPI

Definition at line 307 of file tokens.h.

◆ ParticleFieldOrientationAttributeAPI

const TfToken ParticleFieldOrientationAttributeAPI

"ParticleFieldOrientationAttributeAPI"

Schema identifer and family for UsdVolParticleFieldOrientationAttributeAPI

Definition at line 311 of file tokens.h.

◆ ParticleFieldPositionAttributeAPI

const TfToken ParticleFieldPositionAttributeAPI

"ParticleFieldPositionAttributeAPI"

Schema identifer and family for UsdVolParticleFieldPositionAttributeAPI

Definition at line 315 of file tokens.h.

◆ ParticleFieldPositionBaseAPI

const TfToken ParticleFieldPositionBaseAPI

"ParticleFieldPositionBaseAPI"

Schema identifer and family for UsdVolParticleFieldPositionBaseAPI

Definition at line 319 of file tokens.h.

◆ ParticleFieldRadianceBaseAPI

const TfToken ParticleFieldRadianceBaseAPI

"ParticleFieldRadianceBaseAPI"

Schema identifer and family for UsdVolParticleFieldRadianceBaseAPI

Definition at line 323 of file tokens.h.

◆ ParticleFieldScaleAttributeAPI

const TfToken ParticleFieldScaleAttributeAPI

"ParticleFieldScaleAttributeAPI"

Schema identifer and family for UsdVolParticleFieldScaleAttributeAPI

Definition at line 327 of file tokens.h.

◆ ParticleFieldSphericalHarmonicsAttributeAPI

const TfToken ParticleFieldSphericalHarmonicsAttributeAPI

"ParticleFieldSphericalHarmonicsAttributeAPI"

Schema identifer and family for UsdVolParticleFieldSphericalHarmonicsAttributeAPI

Definition at line 331 of file tokens.h.

◆ perspective

const TfToken perspective

"perspective"

Fallback value for UsdVolParticleField3DGaussianSplat::GetProjectionModeHintAttr()

Definition at line 187 of file tokens.h.

◆ Point

const TfToken Point

"Point"

Possible value for UsdVolVolumeFieldAsset::GetVectorDataRoleHintAttr()

Definition at line 191 of file tokens.h.

◆ positions

const TfToken positions

"positions"

UsdVolParticleFieldPositionAttributeAPI

Definition at line 195 of file tokens.h.

◆ positionsh

const TfToken positionsh

"positionsh"

UsdVolParticleFieldPositionAttributeAPI

Definition at line 199 of file tokens.h.

◆ projectionModeHint

const TfToken projectionModeHint

"projectionModeHint"

UsdVolParticleField3DGaussianSplat

Definition at line 203 of file tokens.h.

◆ quatd

const TfToken quatd

"quatd"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 207 of file tokens.h.

◆ radianceSphericalHarmonicsCoefficients

const TfToken radianceSphericalHarmonicsCoefficients

"radiance:sphericalHarmonicsCoefficients"

UsdVolParticleFieldSphericalHarmonicsAttributeAPI

Definition at line 211 of file tokens.h.

◆ radianceSphericalHarmonicsCoefficientsh

const TfToken radianceSphericalHarmonicsCoefficientsh

"radiance:sphericalHarmonicsCoefficientsh"

UsdVolParticleFieldSphericalHarmonicsAttributeAPI

Definition at line 215 of file tokens.h.

◆ radianceSphericalHarmonicsDegree

const TfToken radianceSphericalHarmonicsDegree

"radiance:sphericalHarmonicsDegree"

UsdVolParticleFieldSphericalHarmonicsAttributeAPI

Definition at line 219 of file tokens.h.

◆ scales

const TfToken scales

"scales"

UsdVolParticleFieldScaleAttributeAPI

Definition at line 223 of file tokens.h.

◆ scalesh

const TfToken scalesh

"scalesh"

UsdVolParticleFieldScaleAttributeAPI

Definition at line 227 of file tokens.h.

◆ sortingModeHint

const TfToken sortingModeHint

"sortingModeHint"

UsdVolParticleField3DGaussianSplat

Definition at line 231 of file tokens.h.

◆ staggered

const TfToken staggered

"staggered"

Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()

Definition at line 235 of file tokens.h.

◆ string

const TfToken string

"string"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 239 of file tokens.h.

◆ tangential

const TfToken tangential

"tangential"

Possible value for UsdVolParticleField3DGaussianSplat::GetProjectionModeHintAttr()

Definition at line 243 of file tokens.h.

◆ uint

const TfToken uint

"uint"

Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()

Definition at line 247 of file tokens.h.

◆ unknown

const TfToken unknown

"unknown"

Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()

Definition at line 251 of file tokens.h.

◆ Vector

const TfToken Vector

"Vector"

Possible value for UsdVolVolumeFieldAsset::GetVectorDataRoleHintAttr()

Definition at line 255 of file tokens.h.

◆ vectorDataRoleHint

const TfToken vectorDataRoleHint

"vectorDataRoleHint"

UsdVolVolumeFieldAsset

Definition at line 259 of file tokens.h.

◆ Volume

const TfToken Volume

"Volume"

Schema identifer and family for UsdVolVolume

Definition at line 335 of file tokens.h.

◆ VolumeFieldAsset

const TfToken VolumeFieldAsset

"VolumeFieldAsset"

Schema identifer and family for UsdVolVolumeFieldAsset

Definition at line 339 of file tokens.h.

◆ VolumeFieldBase

const TfToken VolumeFieldBase

"VolumeFieldBase"

Schema identifer and family for UsdVolVolumeFieldBase

Definition at line 343 of file tokens.h.

◆ zDepth

const TfToken zDepth

"zDepth"

Fallback value for UsdVolParticleField3DGaussianSplat::GetSortingModeHintAttr()

Definition at line 263 of file tokens.h.


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