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

Type

int in [0, inf], default 0, (readonly)

data_type

Data type of voxel values

  • BOOLEAN Boolean, Boolean.

  • FLOAT Float, Single precision float.

  • DOUBLE Double, Double precision.

  • INT Integer, 32 bit integer.

  • INT64 Integer 64 bit, 64 bit integer.

  • MASK Mask, No data, boolean mask of active voxels.

  • STRING String, Text string.

  • VECTOR_FLOAT Float Vector, 3D float vector.

  • VECTOR_DOUBLE Double Vector, 3D double vector.

  • VECTOR_INT Integer Vector, 3D integer vector.

  • POINTS Points (Unsupported), Points grid, currently unsupported by volume objects.

  • UNKNOWN Unknown, Unsupported data type.

Type

enum in [‘BOOLEAN’, ‘FLOAT’, ‘DOUBLE’, ‘INT’, ‘INT64’, ‘MASK’, ‘STRING’, ‘VECTOR_FLOAT’, ‘VECTOR_DOUBLE’, ‘VECTOR_INT’, ‘POINTS’, ‘UNKNOWN’], default ‘UNKNOWN’, (readonly)

is_loaded

Grid tree is loaded in memory

Type

boolean, default False, (readonly)

matrix_object

Transformation matrix from voxel index to object space

Type

float 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)

name

Volume grid name

Type

string, default “”, (readonly, never None)

load()

Load grid tree from file

Returns

True if grid tree was successfully loaded

Return type

boolean

unload()

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

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

Inherited Functions

References