VolumeGrid(bpy_struct)

base class — bpy_struct

class bpy.types.VolumeGrid(bpy_struct)

3D volume grid

channels

Number of dimensions of the grid data type (in [0, inf], default 0, readonly)

Type:

int

data_type

Data type of voxel values (default 'UNKNOWN', readonly)

Type:

Literal[Volume Grid Data Type Items]

is_loaded

Grid tree is loaded in memory (default False, readonly)

Type:

bool

matrix_object

Transformation matrix from voxel index to object space (multi-dimensional array of 4 * 4 items, in [-inf, inf], default ((0.0, 0.0, 0.0, 0.0), (0.0, 0.0, 0.0, 0.0), (0.0, 0.0, 0.0, 0.0), (0.0, 0.0, 0.0, 0.0)), readonly)

Type:

mathutils.Matrix

name

Volume grid name (default “”, readonly, never None)

Type:

str

load()

Load grid tree from file

Returns:

True if grid tree was successfully loaded

Return type:

bool

unload()

Unload grid tree and voxel data from memory, leaving only metadata

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