VolumeGrids(bpy_struct)

base class — bpy_struct

class bpy.types.VolumeGrids(bpy_struct)

3D volume grids

active_index

Index of active volume grid

Type

int in [0, inf], default 0

error_message

If loading grids failed, error message with details

Type

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

frame

Frame number that volume grids will be loaded at, based on scene time and volume parameters

Type

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

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

Type

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

is_loaded

List of grids and metadata are loaded in memory

Type

boolean, default False, (readonly)

load()

Load list of grids and metadata from file

Returns

True if grid list was successfully loaded

Return type

boolean

unload()

Unload all grid and voxel data from memory

save(filepath)

Save grids and metadata to file

Parameters

filepath (string, (never None)) – File path to save to

Returns

True if grid list was successfully loaded

Return type

boolean

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