BooleanApi

Artisan booleans, headless. Unlike plain rs.Boolean*, these bake the Artisan boolean group: the result breps live in a group carrying RaObjectUserData (“Boolean” + the operation parameters), the originals are HIDDEN (not deleted), and ArtisanEdit / ArtisanBooleanUpdate can dismantle and recompute the operation later. Same engine as the ArtisanBooleanUnion/Difference/Intersection/Split commands.

from ArtisanPlugin.Scripting import BooleanApi

See also the guide, API Reference › Booleans, and the Python package, ra.boolean.

Methods

Method
Difference	Subtracts cutterIds from targetIds.
Intersection	Intersection of the two sets.
Split	Splits targetIds with cutterIds.
Union	Union of two or more solids.

Difference

IReadOnlyList<Guid> BooleanApi.Difference(
    IEnumerable<Guid> targetIds,
    IEnumerable<Guid> cutterIds)

Subtracts cutterIds from targetIds. Returns the result brep ids.

Parameter	Type	Default
targetIds	IEnumerable<Guid>	required
cutterIds	IEnumerable<Guid>	required

Returns IReadOnlyList<Guid>.

Intersection

IReadOnlyList<Guid> BooleanApi.Intersection(
    IEnumerable<Guid> targetIds,
    IEnumerable<Guid> cutterIds)

Intersection of the two sets. Returns the result brep ids.

Parameter	Type	Default
targetIds	IEnumerable<Guid>	required
cutterIds	IEnumerable<Guid>	required

Returns IReadOnlyList<Guid>.

Split

IReadOnlyList<Guid> BooleanApi.Split(
    IEnumerable<Guid> targetIds,
    IEnumerable<Guid> cutterIds)

Splits targetIds with cutterIds. Returns the result brep ids.

Parameter	Type	Default
targetIds	IEnumerable<Guid>	required
cutterIds	IEnumerable<Guid>	required

Returns IReadOnlyList<Guid>.

Union

IReadOnlyList<Guid> BooleanApi.Union(IEnumerable<Guid> objectIds)

Union of two or more solids. Returns the ids of the result breps.

Parameter	Type	Default
objectIds	IEnumerable<Guid>	required

Returns IReadOnlyList<Guid>.