Blender V5.3
blender::geometry::boolean Namespace Reference

Classes

struct  BooleanError
struct  BooleanOpParameters
struct  MeshOffsets

Enumerations

enum class  Solver { MeshArr = 0 , Float = 1 , Manifold = 2 }
enum class  Operation { Intersect = 0 , Union = 1 , Difference = 2 }
enum class  BooleanErrorType {
  NoError = 0 , NonManifold = 1 , ResultTooBig = 2 , SolverNotAvailable = 3 ,
  UnknownError = 4
}

Functions

Mesh * mesh_boolean (Span< const Mesh * > meshes, Span< float4x4 > transforms, Span< Array< short > > material_remaps, BooleanOpParameters op_params, Solver solver, Vector< int > *r_intersecting_edges, BooleanError *r_error)
void interpolate_corner_attributes (bke::MutableAttributeAccessor output_attrs, bke::AttributeAccessor input_attrs, Mesh *output_mesh, const Mesh *input_mesh, Span< int > out_to_in_corner_map, Span< int > out_to_in_face_map)
void copy_attribute_using_map (GSpan src, Span< int > out_to_in_map, GMutableSpan dst)
void set_material_from_map (Span< int > out_to_in_map, Span< Array< short > > material_remaps, Span< const Mesh * > meshes, const MeshOffsets &mesh_offsets, MutableSpan< int > dst)
bke::GeometrySet join_meshes_with_transforms (Span< const Mesh * > meshes, Span< float4x4 > transforms)
int mesh_id_for_face (int face_id, const MeshOffsets &mesh_offsets)
IndexRange vertex_range_for_face (int face_id, const MeshOffsets &mesh_offsets)
Mesh * mesh_boolean_manifold (Span< const Mesh * > meshes, Span< float4x4 > transforms, Span< Array< short > > material_remaps, BooleanOpParameters op_params, Vector< int > *r_intersecting_edges, BooleanError *r_error)
Float Boolean
static int face_boolean_operand (BMFace *f, void *)
static BMesh * mesh_bm_concat (Span< const Mesh * > meshes, Span< float4x4 > transforms, Span< Array< short > > material_remaps, Array< std::array< BMLoop *, 3 > > &r_looptris)
static int operation_to_float_mode (const Operation operation)
static Mesh * mesh_boolean_float (Span< const Mesh * > meshes, Span< float4x4 > transforms, Span< Array< short > > material_remaps, const int boolean_mode, Vector< int > *)

Enumeration Type Documentation

◆ BooleanErrorType

Enumerator
NoError 
NonManifold 
ResultTooBig 
SolverNotAvailable 
UnknownError 

Definition at line 41 of file GEO_mesh_boolean.hh.

◆ Operation

Enumerator
Intersect 
Union 
Difference 

Definition at line 35 of file GEO_mesh_boolean.hh.

◆ Solver

Specifies which solver to use.

Enumerator
MeshArr 

The exact solver based on the Mesh Arrangements for Solid Geometry paper, by Zhou, Grinspun, Zorin, and Jacobson.

Float 

The original BMesh floating point solver.

Manifold 

The Manifold library fast robust floating point solver.

Definition at line 23 of file GEO_mesh_boolean.hh.

Function Documentation

◆ copy_attribute_using_map()

void blender::geometry::boolean::copy_attribute_using_map ( GSpan src,
Span< int > out_to_in_map,
GMutableSpan dst )

Similar to #attribute_math::gather, but for -1 values in the map, store the default value.

References copy_attribute_using_map().

Referenced by copy_attribute_using_map().

◆ face_boolean_operand()

int blender::geometry::boolean::face_boolean_operand ( BMFace * f,
void *  )
static

Function use to say what operand a face is part of, based on the BM_FACE_TAG which is set in bm_mesh_create.

Definition at line 955 of file geometry/intern/mesh_boolean.cc.

References BM_elem_flag_test, BM_FACE_TAG, and face_boolean_operand().

Referenced by face_boolean_operand(), and mesh_boolean_float().

◆ interpolate_corner_attributes()

void blender::geometry::boolean::interpolate_corner_attributes ( bke::MutableAttributeAccessor output_attrs,
bke::AttributeAccessor input_attrs,
Mesh * output_mesh,
const Mesh * input_mesh,
Span< int > out_to_in_corner_map,
Span< int > out_to_in_face_map )

Copy attributes on the face corner domain to the output mesh, and for output corners that values that don't have an explicit mapping defined (the maps contain -1 for that element), interpolate the values across the face .

References interpolate_corner_attributes().

Referenced by interpolate_corner_attributes().

◆ join_meshes_with_transforms()

bke::GeometrySet blender::geometry::boolean::join_meshes_with_transforms ( Span< const Mesh * > meshes,
Span< float4x4 > transforms )

◆ mesh_bm_concat()

BMesh * blender::geometry::boolean::mesh_bm_concat ( Span< const Mesh * > meshes,
Span< float4x4 > transforms,
Span< Array< short > > material_remaps,
Array< std::array< BMLoop *, 3 > > & r_looptris )
static

◆ mesh_boolean()

Mesh * blender::geometry::boolean::mesh_boolean ( Span< const Mesh * > meshes,
Span< float4x4 > transforms,
Span< Array< short > > material_remaps,
BooleanOpParameters op_params,
Solver solver,
Vector< int > * r_intersecting_edges,
BooleanError * r_error )

Do a mesh boolean operation directly on meshes. Boolean operations operate on the volumes enclosed by the operands. If is only one operand, the non-float versions will do self-intersection and remove internal faces. If there are more than two meshes, the first mesh is operand 0 and the rest of the meshes are operand 1 (i.e., as if all of operands 1, ... are joined into one mesh). The exact solvers assume that the meshes are PWN (piecewise winding number, which approximately means that the meshes are enclosed watertight volumes, and all edges are manifold, though there are allowable exceptions to that last condition). If the meshes don't satisfy those conditions, all solvers will try to use ray-shooting to determine whether particular faces survive or not. This may or may not work in the way the user hopes.

Parameters
meshesThe meshes that are operands of the boolean operation.
transformsAn array of transform matrices used to transform the input meshes to bring them into the transform space of the result.
material_remapsAn array of maps from material slot numbers in the corresponding mesh to the material slot in the first mesh. It is OK for material_remaps or any of its constituent arrays to be empty. A -1 value means that the original index should be used with no mapping.
op_paramsSpecifies the boolean operation and assumptions we can make.
solverwhich solver to use
r_intersecting_edgesVector to store indices of edges on the resulting mesh in. These 'new' edges are the result of the intersections.
r_errorReturn place for error to be stored.
Returns
the resulting mesh or null on failure.

Definition at line 1230 of file geometry/intern/mesh_boolean.cc.

References BLI_assert_unreachable, blender::geometry::boolean::BooleanOpParameters::boolean_mode, Float, Intersect, Manifold, mesh_boolean(), mesh_boolean_float(), mesh_boolean_manifold(), MeshArr, blender::geometry::boolean::BooleanOpParameters::no_self_intersections, NoError, operation_to_float_mode(), blender::Span< T >::size(), SolverNotAvailable, blender::geometry::boolean::BooleanError::type, Union, and blender::geometry::boolean::BooleanOpParameters::watertight.

Referenced by blender::ed::sculpt_paint::trim::apply_trim(), mesh_boolean(), and blender::nodes::node_geo_boolean_cc::node_geo_exec().

◆ mesh_boolean_float()

◆ mesh_boolean_manifold()

Mesh * blender::geometry::boolean::mesh_boolean_manifold ( Span< const Mesh * > meshes,
Span< float4x4 > transforms,
Span< Array< short > > material_remaps,
BooleanOpParameters op_params,
Vector< int > * r_intersecting_edges,
BooleanError * r_error )

◆ mesh_id_for_face()

int blender::geometry::boolean::mesh_id_for_face ( int face_id,
const MeshOffsets & mesh_offsets )

What mesh_id corresponds to a given face_id, assuming that the face_id is in one of the ranges of mesh_offsets.face_offsets.

References mesh_id_for_face().

Referenced by mesh_id_for_face().

◆ operation_to_float_mode()

◆ set_material_from_map()

void blender::geometry::boolean::set_material_from_map ( Span< int > out_to_in_map,
Span< Array< short > > material_remaps,
Span< const Mesh * > meshes,
const MeshOffsets & mesh_offsets,
MutableSpan< int > dst )

The dst span should be the material_index property of the result. Rather than using the attribute from the joined mesh, we want to take the original face and map it using material_remaps.

References set_material_from_map().

Referenced by set_material_from_map().

◆ vertex_range_for_face()

IndexRange blender::geometry::boolean::vertex_range_for_face ( int face_id,
const MeshOffsets & mesh_offsets )

What is the vertex index range for the face face_id, assuming that face_id is one of the ranges of mesh_offsets.face_offsets.

References vertex_range_for_face().

Referenced by vertex_range_for_face().