Skip to content

Commit d3904f2

Browse files
pixar-osspixar-oss
committed
DOC update usdVol userdoc for schema updates (for Gaussian splat schemas, etc)
(Internal change: 2396777)
1 parent a4053d7 commit d3904f2

25 files changed

Lines changed: 1926 additions & 214 deletions

‎docs/user_guides/schemas/usdVol/Field3DAsset.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
% WARNING: THIS FILE IS GENERATED BY genSchemaDocs. DO NOT EDIT.
2-
% Generated: 04:05PM on May 16, 2024
2+
% Generated: 03:26PM on February 19, 2026
33

44

55
(Field3DAsset)=
@@ -47,9 +47,9 @@ individual field. Clients which consume Field3D files should treat this as the
4747
Field3D field *name*. This attribute is optional.
4848

4949

50-
(Field3DAsset_inheritedproperties_FieldAsset)=
50+
(Field3DAsset_inheritedproperties_VolumeFieldAsset)=
5151

52-
## Inherited Properties ({ref}`FieldAsset`)
52+
## Inherited Properties ({ref}`VolumeFieldAsset`)
5353

5454
(Field3DAsset_fieldDataType)=
5555

@@ -70,8 +70,8 @@ available choices for Field3D.
7070

7171
**USD type**: `int`
7272

73-
The index of a field within a FieldAsset asset
74-
file. This attribute is optional.
73+
The index of a field within a VolumeFieldAsset
74+
asset file. This attribute is optional.
7575

7676
An asset file can contain multiple fields with the same name. This optional
7777
attribute is an index used to disambiguate between multiple fields with the same
@@ -87,13 +87,13 @@ name. For example, in an OpenVDB file asset, there might be two Grids named
8787
**USD type**: `token`
8888

8989
Represents the name of an individual field within
90-
a FieldAsset asset file.
90+
a VolumeFieldAsset asset file.
9191

92-
A FieldAsset file asset may contain multiple fields in a single asset file. This
93-
attribute specifies the name of field **within** the asset file. For example, an
94-
OpenVDB file asset might have multiple named Grids, such as "density",
95-
"temperature", etc. `fieldName` would specify one of the named Grids in the
96-
OpenVDB file asset.
92+
A VolumeFieldAsset file asset may contain multiple fields in a single asset
93+
file. This attribute specifies the name of field **within** the asset file. For
94+
example, an OpenVDB file asset might have multiple named Grids, such as
95+
"density", "temperature", etc. `fieldName` would specify one of the named Grids
96+
in the OpenVDB file asset.
9797

9898
Note that a Volume also provides a way to specify the "name" for a field, via
9999
the field relationship. This name is not associated with asset data and is used
@@ -110,10 +110,10 @@ relationship name differs from `fieldName`.
110110

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

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

118118
This attribute's value can be animated over time, as most
119119
volume asset formats represent just a single timeSample of

‎docs/user_guides/schemas/usdVol/FieldAsset.md‎

Lines changed: 19 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,12 @@
11
% WARNING: THIS FILE IS GENERATED BY genSchemaDocs. DO NOT EDIT.
2-
% Generated: 04:05PM on May 16, 2024
2+
% Generated: 03:26PM on February 19, 2026
33

44

55
(FieldAsset)=
66
# FieldAsset
77

8-
FieldAsset is an abstract schema (that inherits
9-
from {ref}`FieldBase`) that represents a volumetric field
10-
where the volumetric data is stored outside the layer, e.g. in a file asset.
11-
It is used as a base class for schemas that reference specific volume data
12-
asset types, such as OpenVDB data.
13-
14-
If you need to extend UsdVol with your own custom file-based field schemas,
15-
your custom schemas should inherit from FieldAsset.
16-
17-
```{admonition} Create Prims Using FieldAsset-derived Schemas
18-
:class: note
19-
20-
Like FieldBase, FieldAsset is an abstract schema. In practice you will most
21-
likely create prims using one of the field schemas that inherit from FieldAsset,
22-
such as OpenVDBAsset or Field3DAsset.
23-
```
8+
This schema is deprecated, and VolumeFieldAsset
9+
should be used instead. See {ref}`VolumeFieldAsset` for more details.
2410

2511
```{contents}
2612
:depth: 2
@@ -32,6 +18,10 @@ such as OpenVDBAsset or Field3DAsset.
3218

3319
## Properties
3420

21+
(FieldAsset_inheritedproperties_VolumeFieldAsset)=
22+
23+
## Inherited Properties ({ref}`VolumeFieldAsset`)
24+
3525
(FieldAsset_fieldDataType)=
3626

3727
### fieldDataType
@@ -50,8 +40,8 @@ with the specific asset type. A missing value is considered an error.
5040

5141
**USD type**: `int`
5242

53-
The index of a field within a FieldAsset asset
54-
file. This attribute is optional.
43+
The index of a field within a VolumeFieldAsset
44+
asset file. This attribute is optional.
5545

5646
An asset file can contain multiple fields with the same name. This optional
5747
attribute is an index used to disambiguate between multiple fields with the same
@@ -67,13 +57,13 @@ name. For example, in an OpenVDB file asset, there might be two Grids named
6757
**USD type**: `token`
6858

6959
Represents the name of an individual field within
70-
a FieldAsset asset file.
60+
a VolumeFieldAsset asset file.
7161

72-
A FieldAsset file asset may contain multiple fields in a single asset file. This
73-
attribute specifies the name of field **within** the asset file. For example, an
74-
OpenVDB file asset might have multiple named Grids, such as "density",
75-
"temperature", etc. `fieldName` would specify one of the named Grids in the
76-
OpenVDB file asset.
62+
A VolumeFieldAsset file asset may contain multiple fields in a single asset
63+
file. This attribute specifies the name of field **within** the asset file. For
64+
example, an OpenVDB file asset might have multiple named Grids, such as
65+
"density", "temperature", etc. `fieldName` would specify one of the named Grids
66+
in the OpenVDB file asset.
7767

7868
Note that a Volume also provides a way to specify the "name" for a field, via
7969
the field relationship. This name is not associated with asset data and is used
@@ -90,10 +80,10 @@ relationship name differs from `fieldName`.
9080

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

93-
The asset pointed to by filePath must be a file type that the FieldAsset-derived
94-
schema supports. For example, for OpenVDBAsset, the file type must be an
95-
OpenVDB (.vdb) file. For Field3DAsset, the file type must be a Field3D (.f3d)
96-
file.
83+
The asset pointed to by filePath must be a file type that the
84+
VolumeFieldAsset-derived schema supports. For example, for OpenVDBAsset, the
85+
file type must be an OpenVDB (.vdb) file. For Field3DAsset, the file type must
86+
be a Field3D (.f3d) file.
9787

9888
This attribute's value can be animated over time, as most
9989
volume asset formats represent just a single timeSample of

‎docs/user_guides/schemas/usdVol/FieldBase.md‎

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,12 @@
11
% WARNING: THIS FILE IS GENERATED BY genSchemaDocs. DO NOT EDIT.
2-
% Generated: 04:05PM on May 16, 2024
2+
% Generated: 03:26PM on February 19, 2026
33

44

55
(FieldBase)=
66
# FieldBase
77

8-
FieldBase is an abstract schema that acts as the
9-
base class for all UsdVol field schemas. If you need to extend UsdVol with your
10-
own custom Field schemas, your Field schemas should directly or indirectly
11-
inherit from FieldBase.
12-
13-
```{admonition} Don't Create FieldBase Prims Directly
14-
:class: note
15-
16-
As FieldBase is an abstract schema, in practice you will most likely use one
17-
of the various derived field schemas when creating new field prims, such as
18-
OpenVDBAsset or Field3DAsset.
19-
```
8+
This schema is deprecated, and VolumeFieldBase
9+
should be used instead. See {ref}`VolumeFieldBase` for more details.
2010

2111
```{contents}
2212
:depth: 2

‎docs/user_guides/schemas/usdVol/OpenVDBAsset.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
% WARNING: THIS FILE IS GENERATED BY genSchemaDocs. DO NOT EDIT.
2-
% Generated: 04:05PM on May 16, 2024
2+
% Generated: 03:26PM on February 19, 2026
33

44

55
(OpenVDBAsset)=
@@ -26,8 +26,8 @@ def OpenVDBAsset "densityVDB"
2626
2727
```
2828

29-
The FieldAsset `filePath` attribute must specify a file in the OpenVDB (.vdb)
30-
format on disk.
29+
The `filePath` attribute must specify a file in the OpenVDB (.vdb) format on
30+
disk.
3131

3232
```{contents}
3333
:depth: 2
@@ -45,16 +45,16 @@ format on disk.
4545

4646
**USD type**: `token`
4747

48-
Represents the class of an indivdual grid.
48+
Represents the class of an individual grid.
4949
This attribute is optional.
5050

5151
This is a mapping to OpenVDB's openvdb::GridClass where the values are
5252
`GRID_LEVEL_SET`, `GRID_FOG_VOLUME`, `GRID_STAGGERED`, and `GRID_UNKNOWN`.
5353

5454

55-
(OpenVDBAsset_inheritedproperties_FieldAsset)=
55+
(OpenVDBAsset_inheritedproperties_VolumeFieldAsset)=
5656

57-
## Inherited Properties ({ref}`FieldAsset`)
57+
## Inherited Properties ({ref}`VolumeFieldAsset`)
5858

5959
(OpenVDBAsset_fieldDataType)=
6060

@@ -75,8 +75,8 @@ available choices for OpenVDB volumes.
7575

7676
**USD type**: `int`
7777

78-
The index of a field within a FieldAsset asset
79-
file. This attribute is optional.
78+
The index of a field within a VolumeFieldAsset
79+
asset file. This attribute is optional.
8080

8181
An asset file can contain multiple fields with the same name. This optional
8282
attribute is an index used to disambiguate between multiple fields with the same
@@ -92,13 +92,13 @@ name. For example, in an OpenVDB file asset, there might be two Grids named
9292
**USD type**: `token`
9393

9494
Represents the name of an individual field within
95-
a FieldAsset asset file.
95+
a VolumeFieldAsset asset file.
9696

97-
A FieldAsset file asset may contain multiple fields in a single asset file. This
98-
attribute specifies the name of field **within** the asset file. For example, an
99-
OpenVDB file asset might have multiple named Grids, such as "density",
100-
"temperature", etc. `fieldName` would specify one of the named Grids in the
101-
OpenVDB file asset.
97+
A VolumeFieldAsset file asset may contain multiple fields in a single asset
98+
file. This attribute specifies the name of field **within** the asset file. For
99+
example, an OpenVDB file asset might have multiple named Grids, such as
100+
"density", "temperature", etc. `fieldName` would specify one of the named Grids
101+
in the OpenVDB file asset.
102102

103103
Note that a Volume also provides a way to specify the "name" for a field, via
104104
the field relationship. This name is not associated with asset data and is used
@@ -115,10 +115,10 @@ relationship name differs from `fieldName`.
115115

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

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

123123
This attribute's value can be animated over time, as most
124124
volume asset formats represent just a single timeSample of

0 commit comments

Comments
 (0)