Volumes

Generated from the schema registry by ernie schema --markdown.

Volume

A volume, bounded by and rendered from the fields its field: relationships name.

Prim type · Inherits Gprim

{
  "$schema": "https://alexmaietta.github.io/ernie/schema/ernie-scene.schema.json",
  "prims": {
    "/World/Volume": {
      "typeName": "Volume"
    }
  }
}

FieldBase

A field's frame and grid, which volumes name.

Abstract base · Inherits Xformable

FieldAsset

A field read from a file.

Abstract base · Inherits FieldBase

Attribute	Type	Description	Fallback	Values	Source
filePath	asset	The grid's file: NanoVDB, uncompressed.	""		UsdVol
fieldName	token	The grid's name in the file; unset, any grid.	""		UsdVol
fieldIndex	int	Which of the file's grids of that name, or of all its grids without one; 0 the first.	0	≥ 0	UsdVol
fieldDataType	token	The grid's value type, for reference; Ernie reads it from the file.	""		UsdVol
vectorDataRoleHint	token	What a vector grid holds.	"None"	None, Point, Normal, Vector, Color	UsdVol

OpenVDBAsset

An OpenVDB grid, read once converted to NanoVDB.

Prim type · Inherits FieldAsset

Attribute	Type	Description	Fallback	Values	Source
fieldClass	token	The grid's class, for reference: Ernie renders fog volumes, not level sets.	""	levelSet, fogVolume, staggered, unknown	UsdVol

{
  "$schema": "https://alexmaietta.github.io/ernie/schema/ernie-scene.schema.json",
  "prims": {
    "/World/OpenVDBAsset": {
      "typeName": "OpenVDBAsset"
    }
  }
}

NanoVDBField

NanoVDB grids in memory, written each step by a simulation.

Prim type · Inherits FieldBase

Attribute	Type	Description	Fallback	Values	Source
ernie:buffer	uchar[]	NanoVDB grids back to back as NanoVDB keeps them in memory (Warp's Volume.array()), on the host or a device.			Ernie
fieldName	token	The grid's name in the buffer; unset, any grid.	""		Ernie
fieldIndex	int	Which of the buffer's grids of that name, or of all its grids without one; 0 the first.	0	≥ 0	Ernie

{
  "$schema": "https://alexmaietta.github.io/ernie/schema/ernie-scene.schema.json",
  "prims": {
    "/World/NanoVDBField": {
      "typeName": "NanoVDBField",
      "fieldIndex": 0
    }
  }
}

DenseField

A dense grid of values, as solvers write them.

Prim type · Inherits FieldBase

Attribute	Type	Description	Fallback	Values	Source
ernie:values	float tensor, rank 3	float32 (x, y, z) values, z fastest, on the host or a device; 0 is empty.			Ernie
ernie:voxelSize	double	Metres between values: value (i, j, k) lies at the voxel size times (i, j, k).	1.0	> 0	Ernie

{
  "$schema": "https://alexmaietta.github.io/ernie/schema/ernie-scene.schema.json",
  "prims": {
    "/World/DenseField": {
      "typeName": "DenseField",
      "ernie:voxelSize": 1.0
    }
  }
}