VolumeDisplay(bpy_struct)

base class — bpy_struct

class bpy.types.VolumeDisplay(bpy_struct)

Volume object display settings for 3D viewport

density

Thickness of volume display in the viewport (in [1e-05, inf], default 1.0)

Type:

float

interpolation_method

Interpolation method to use for volumes in solid mode (default 'LINEAR')

  • LINEAR Linear – Good smoothness and speed.

  • CUBIC Cubic – Smoothed high quality interpolation, but slower.

  • CLOSEST Closest – No interpolation.

Type:

Literal[‘LINEAR’, ‘CUBIC’, ‘CLOSEST’]

slice_axis

(default 'AUTO')

  • AUTO Auto – Adjust slice direction according to the view direction.

  • X X – Slice along the X axis.

  • Y Y – Slice along the Y axis.

  • Z Z – Slice along the Z axis.

Type:

Literal[‘AUTO’, ‘X’, ‘Y’, ‘Z’]

slice_depth

Position of the slice (in [0, 1], default 0.5)

Type:

float

use_slice

Perform a single slice of the domain object (default False)

Type:

bool

wireframe_detail

Amount of detail for wireframe display (default 'COARSE')

  • COARSE Coarse – Display one box or point for each intermediate tree node.

  • FINE Fine – Display box for each leaf node containing 8×8 voxels.

Type:

Literal[‘COARSE’, ‘FINE’]

wireframe_type

Type of wireframe display (default 'BOXES')

  • NONE None – Don’t display volume in wireframe mode.

  • BOUNDS Bounds – Display single bounding box for the entire grid.

  • BOXES Boxes – Display bounding boxes for nodes in the volume tree.

  • POINTS Points – Display points for nodes in the volume tree.

Type:

Literal[‘NONE’, ‘BOUNDS’, ‘BOXES’, ‘POINTS’]

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