BooleanModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.BooleanModifier(Modifier)

Boolean operations modifier

collection

Use mesh objects in this collection for Boolean operation

Type:

Collection

debug_options

Debugging options, only when started with ‘-d’ (default set())

Type:

set[Literal[‘SEPARATE’, ‘NO_DISSOLVE’, ‘NO_CONNECT_REGIONS’]]

double_threshold

Threshold for checking overlapping geometry (in [0, 1], default 1e-06)

Type:

float

material_mode

Method for setting materials on the new faces (default 'INDEX')

  • INDEX Index Based – Set the material on new faces based on the order of the material slot lists. If a material does not exist on the modifier object, the face will use the same material slot or the first if the object does not have enough slots..

  • TRANSFER Transfer – Transfer materials from non-empty slots to the result mesh, adding new materials as necessary. For empty slots, fall back to using the same material index as the operand mesh..

Type:

Literal[‘INDEX’, ‘TRANSFER’]

object

Mesh object to use for Boolean operation

Type:

Object

operand_type

(default 'OBJECT')

  • OBJECT Object – Use a mesh object as the operand for the Boolean operation.

  • COLLECTION Collection – Use a collection of mesh objects as the operand for the Boolean operation.

Type:

Literal[‘OBJECT’, ‘COLLECTION’]

operation

(default 'DIFFERENCE')

  • INTERSECT Intersect – Keep the part of the mesh that is common between all operands.

  • UNION Union – Combine meshes in an additive way.

  • DIFFERENCE Difference – Combine meshes in a subtractive way.

Type:

Literal[‘INTERSECT’, ‘UNION’, ‘DIFFERENCE’]

solver

Method for calculating booleans (default 'EXACT')

  • FLOAT Float – Simple solver with good performance, without support for overlapping geometry.

  • EXACT Exact – Slower solver with the best results for coplanar faces.

  • MANIFOLD Manifold – Fastest solver that works only on manifold meshes but gives better results.

Type:

Literal[‘FLOAT’, ‘EXACT’, ‘MANIFOLD’]

use_hole_tolerant

Better results when there are holes (slower) (default False)

Type:

bool

use_self

Allow self-intersection in operands (default False)

Type:

bool

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