% WARNING: THIS FILE IS GENERATED BY genSchemaDocs. DO NOT EDIT. % Generated: 03:26PM on February 19, 2026

(Field3DAsset)=

Field3DAsset

A Field representing a Field3D volume field. See the Field3D github repo for more information on Field3D.

An example Field3DAsset referencing a single density field in a .f3d file:

def Field3DAsset "densityField3D"
{
    token fieldDataType = "float"
    token fieldName = "density"
    token fieldPurpose = "cluster_0"
    asset filePath.timeSamples = {
        1: @/f3ddata/Volumes_Cumulus01_Puff01M.1.f3d@,
    }
}

The FieldAsset filePath attribute must specify a file in the Field3D (.f3d) format on disk.

:depth: 2
:local:
:backlinks: none

(Field3DAsset_properties)=

Properties

(Field3DAsset_fieldPurpose)=

fieldPurpose

USD type: token

Specifies the purpose or grouping of an individual field. Clients which consume Field3D files should treat this as the Field3D field name. This attribute is optional.

(Field3DAsset_inheritedproperties_VolumeFieldAsset)=

Inherited Properties ({ref}VolumeFieldAsset)

(Field3DAsset_fieldDataType)=

fieldDataType

USD type: token

The data type of a field, such as "float".

Use this attribute to tell consumers more about the field without requiring the consumer access the asset file directly. The list of allowed tokens reflects the available choices for Field3D.

(Field3DAsset_fieldIndex)=

fieldIndex

USD type: int

The index of a field within a VolumeFieldAsset asset file. This attribute is optional.

An asset file can contain multiple fields with the same name. This optional attribute is an index used to disambiguate between multiple fields with the same name. For example, in an OpenVDB file asset, there might be two Grids named "density". A fieldIndex of 0 would specify that this Field refers to the first "density" Grid.

(Field3DAsset_fieldName)=

fieldName

USD type: token

Represents the name of an individual field within a VolumeFieldAsset asset file.

A VolumeFieldAsset file asset may contain multiple fields in a single asset file. This attribute specifies the name of field within the asset file. For example, an OpenVDB file asset might have multiple named Grids, such as "density", "temperature", etc. fieldName would specify one of the named Grids in the OpenVDB file asset.

Note that a Volume also provides a way to specify the "name" for a field, via the field relationship. This name is not associated with asset data and is used by the Volume for organizing fields for the rendering pipeline. See {ref}usdVol_understanding_fieldname for more details on how the field's relationship name differs from fieldName.

(Field3DAsset_filePath)=

filePath

USD type: asset

An asset path attribute that points to a file on disk.

The asset pointed to by filePath must be a file type that the VolumeFieldAsset-derived schema supports. For example, for OpenVDBAsset, the file type must be an OpenVDB (.vdb) file. For Field3DAsset, the file type must be a Field3D (.f3d) file.

This attribute's value can be animated over time, as most volume asset formats represent just a single timeSample of a volume. However, it does not, at this time, support any pattern substitutions like "$F".

See {ref}usdVol_using_animated_field_data for an example of using filePath to refer to animated volumetric data.

(Field3DAsset_vectorDataRoleHint)=

vectorDataRoleHint

USD type: token

Fallback value: None

Specifies the role of a vector valued field, such as "Color". This can drive the data type in which fields are made available in a renderer or whether the vector values are to be transformed. This attribute is optional.

This token can drive the data type in which fields are made available in a renderer or whether the vector values are to be transformed. Allowed tokens include None, Point, Normal, Vector, and Color.

(Field3DAsset_inheritedproperties_Xformable)=

Inherited Properties ({ref}Xformable)

(Field3DAsset_xformOpOrder)=

xformOpOrder

USD type: token[]

(Field3DAsset_inheritedproperties_Imageable)=

Inherited Properties ({ref}Imageable)

(Field3DAsset_proxyPrim)=

proxyPrim

USD type: rel (relationship)

(Field3DAsset_purpose)=

purpose

USD type: token

Fallback value: default

(Field3DAsset_visibility)=

visibility

USD type: token

Fallback value: inherited