UsdVolumeCreate

The UsdVolumeCreate node creates a USD volume prim. A volume is a framework that represents volumetric data, such as smoke or fire. This node is derived from the UsdPrimCreate node, but specialised with volumeProperties and assetProperties for setting up a volume in your scene.

Note: For more information on prims, see Native USD Prims in the user guide, and Pixar's USD Glossary.

Inputs

Connection Type	Connection Name	Function
Input	in	The incoming scene graph data that the node will operate on or modify.

Controls

Control (UI)	Default Value	Function
primPath	N/A	Specify location where volume prim is to be created. Prims are generated at each specified path, in the order listed.
primSpec	define	Choose the specifier for the prim. This is the role or function of the prim in the scene description. • define - defines a new, complete specification for a prim and its properties within a layer. • class - defines a prim meant to act as a template for other prims. It ensures uniformity and reusability throughout the scene by allowing other prims to adopt or specialize it, inheriting its characteristics. • over - indicates that the prim is an override. It's used to non-destructively modify prims defined in lower-priority layers. A prim with an "over" specifier is meant to modify or extend the properties or hierarchy of existing prims, without redefining them entirely. For more information, refer to the USD Glossary under specifier.
primSpecHierarchy	enabled	Determines whether to create all prims in the provided hierarchy with the primSpec. If disabled, all but the final Prim will be "over" primSpec to avoid writing over primSpecs in lower order layers.
volumeProperties
proxyPrim	N/A	A list of paths to use as a proxy prim.
doubleSided	disabled	For renderers that distinguish between single-sided and double-sided surfaces, controls whether this prim is double-sided.
> extent	0 x 3	The extent of the volume.
orientation	rightHanded	The orientation of the volume.
> primvars
purpose	default	Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals. • default - the object has no particular purpose and is rendered by default. • render - the object is the full resolution version for use when rendering the scene. • proxy - the object is a proxy version used for test purposes, which can be a lower resolution to decrease render times. • guide - the object is not rendered, but is visible in the Viewer for reference.
visibility	inherited	Controls whether the object and its descendants are visible in the scene: • inherited - the object's visibility is controlled by its parent. • invisible - the object and its descendants are invisible in the scene. Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC apps. Visibility is animatable, allowing a sub-tree of geometry to be present for some segment of a shot, and absent from others; unlike the action of deactivating geometry prims, invisible geometry is still available for inspection, for positioning, for defining volumes, etc.
> xformOpOrder	0 x 1	xformOpOrder describes a series of transformations to apply.
assetProperties
proxyPrim	N/A	A list of paths to use as a proxy prim.
fieldClass		Specifies the class of an individual grid within the volume.
fieldDataType		The data type of a field.
fieldIndex	0	The index of a field within a FieldAsset asset file.
fieldName	N/A	The name of an individual field within a FieldAsset asset file.
filePath	N/A	File path location of the volume data.
purpose	default	Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals. • default - the object has no particular purpose and is rendered by default. • render - the object is the full resolution version for use when rendering the scene. • proxy - the object is a proxy version used for test purposes, which can be a lower resolution to decrease render times. • guide - the object is not rendered, but is visible in the Viewer for reference.
vectorDataRoleHint	None	Specifies the role of a vector valued field. This affects the data type in which fields are made available in a renderer or whether the vector values are to be transformed.
visibility	inherited	Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC apps. Visibility is animatable, allowing a sub-tree of geometry to be present for some segment of a shot, and absent from others; unlike the action of deactivating geometry prims, invisible geometry is still available for inspection, for positioning, for defining volumes, etc.
> xformOpOrder	0 x 1	xformOpOrder describes a series of transformations to apply.