Volume(ID)

base classes — bpy_struct, ID

class bpy.types.Volume(ID)

Volume data-block for 3D volume grids

animation_data

Animation data for this data-block (readonly)

Type:

AnimData

display

Volume display settings for 3D viewport (readonly)

Type:

VolumeDisplay

filepath

Volume file used by this Volume data-block (default “”, never None, blend relative // prefix supported)

Type:

str

frame_duration

Number of frames of the sequence to use (in [0, 1048574], default 0)

Type:

int

frame_offset

Offset the number of the frame to use in the animation (in [-inf, inf], default 0)

Type:

int

frame_start

Global starting frame of the sequence, assuming first has a #1 (in [-1048574, 1048574], default 1)

Type:

int

grids

3D volume grids (default None, readonly)

Type:

VolumeGrids[VolumeGrid]

is_sequence

Whether the cache is separated in a series of files (default False)

Type:

bool

materials

(default None, readonly)

Type:

IDMaterials[Material]

packed_file

(readonly)

Type:

PackedFile

render

Volume render settings for 3D viewport (readonly)

Type:

VolumeRender

sequence_mode

Sequence playback mode (default 'CLIP')

  • CLIP Clip – Hide frames outside the specified frame range.

  • EXTEND Extend – Repeat the start frame before, and the end frame after the frame range.

  • REPEAT Repeat – Cycle the frames in the sequence.

  • PING_PONG Ping-Pong – Repeat the frames, reversing the playback direction every other cycle.

Type:

Literal[‘CLIP’, ‘EXTEND’, ‘REPEAT’, ‘PING_PONG’]

velocity_grid

Name of the velocity field, or the base name if the velocity is split into multiple grids (default “”, never None)

Type:

str

velocity_scale

Factor to control the amount of motion blur (in [0, inf], default 1.0)

Type:

float

velocity_unit

Define how the velocity vectors are interpreted with regard to time, ‘frame’ means the delta time is 1 frame, ‘second’ means the delta time is 1 / FPS (default 'FRAME')

Type:

Literal[Velocity Unit Items]

velocity_x_grid

Name of the grid for the X axis component of the velocity field if it was split into multiple grids (default “”, readonly, never None)

Type:

str

velocity_y_grid

Name of the grid for the Y axis component of the velocity field if it was split into multiple grids (default “”, readonly, never None)

Type:

str

velocity_z_grid

Name of the grid for the Z axis component of the velocity field if it was split into multiple grids (default “”, readonly, never None)

Type:

str

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