compas_cgal.booleans ¤

Functions¤

boolean_difference_mesh_mesh(A: VerticesFaces, B: VerticesFaces) -> VerticesFacesNumpy

Boolean difference of two meshes.

Parameters:

Name	Type	Description	Default
`A`	`VerticesFaces`	Mesh A.	required
`B`	`VerticesFaces`	Mesh B.	required

Returns:

Type	Description
`VerticesFacesNumpy`

Examples:

>>> from compas.geometry import Box, Sphere, Polyhedron
>>> from compas_cgal.booleans import boolean_difference_mesh_mesh

>>> box = Box(1)
>>> sphere = Sphere(0.5, point=[1, 1, 1])

>>> A = box.to_vertices_and_faces(triangulated=True)
>>> B = sphere.to_vertices_and_faces(u=32, v=32, triangulated=True)

>>> C = boolean_difference_mesh_mesh(A, B)
>>> shape = Polyhedron(*C)

boolean_intersection_mesh_mesh(
    A: VerticesFaces, B: VerticesFaces
) -> VerticesFacesNumpy

Boolean intersection of two meshes.

Parameters:

Name	Type	Description	Default
`A`	`VerticesFaces`	Mesh A.	required
`B`	`VerticesFaces`	Mesh B.	required

Returns:

Type	Description
`VerticesFacesNumpy`

Examples:

>>> from compas.geometry import Box, Sphere, Polyhedron
>>> from compas_cgal.booleans import boolean_intersection_mesh_mesh

>>> box = Box(1)
>>> sphere = Sphere(0.5, point=[1, 1, 1])

>>> A = box.to_vertices_and_faces(triangulated=True)
>>> B = sphere.to_vertices_and_faces(u=32, v=32, triangulated=True)

>>> C = boolean_intersection_mesh_mesh(A, B)
>>> shape = Polyhedron(*C)

boolean_union_mesh_mesh(A: VerticesFaces, B: VerticesFaces) -> VerticesFacesNumpy

Boolean union of two meshes.

Parameters:

Name	Type	Description	Default
`A`	`VerticesFaces`	Mesh A.	required
`B`	`VerticesFaces`	Mesh B.	required

Returns:

Type	Description
`VerticesFacesNumpy`

Examples:

>>> from compas.geometry import Box, Sphere, Polyhedron
>>> from compas_cgal.booleans import boolean_union_mesh_mesh

>>> box = Box(1)
>>> sphere = Sphere(0.5, point=[1, 1, 1])

>>> A = box.to_vertices_and_faces(triangulated=True)
>>> B = sphere.to_vertices_and_faces(u=32, v=32, triangulated=True)

>>> C = boolean_union_mesh_mesh(A, B)
>>> shape = Polyhedron(*C)

split_mesh_mesh(A: VerticesFaces, B: VerticesFaces) -> VerticesFacesNumpy

Split one mesh with another.

Parameters:

Name	Type	Description	Default
`A`	`VerticesFaces`	Mesh A.	required
`B`	`VerticesFaces`	Mesh B.	required

Returns:

Type	Description
`VerticesFacesNumpy`

Examples:

>>> from compas.geometry import Box, Sphere, Polyhedron
>>> from compas_cgal.booleans import split_mesh_mesh

>>> box = Box(1)
>>> sphere = Sphere(0.5, point=[1, 1, 1])

>>> A = box.to_vertices_and_faces(triangulated=True)
>>> B = sphere.to_vertices_and_faces(u=32, v=32, triangulated=True)

>>> V, F = split_mesh_mesh(A, B)
>>> shape = Polyhedron(V.tolist(), F.tolist())