VolumeGrids(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.VolumeGrids(bpy_prop_collection)

3D volume grids

active_index

Index of active volume grid (in [0, inf], default 0)

Type:

int

error_message

If loading grids failed, error message with details (default “”, readonly, never None)

Type:

str

frame

Frame number that volume grids will be loaded at, based on scene time and volume parameters (in [-inf, inf], default 0, readonly)

Type:

int

frame_filepath

Volume file used for loading the volume at the current frame. Empty if the volume has not be loaded or the frame only exists in memory. (default “”, readonly, never None, blend relative // prefix supported)

Type:

str

is_loaded

List of grids and metadata are loaded in memory (default False, readonly)

Type:

bool

load()

Load list of grids and metadata from file

Returns:

True if grid list was successfully loaded

Return type:

bool

unload()

Unload all grid and voxel data from memory

save(filepath)

Save grids and metadata to file

Parameters:

filepath (str) – File path to save to (never None)

Returns:

True if grid list was successfully loaded

Return type:

bool

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References