setBooleanChildOperation

setBooleanChildOperation

Change the boolean operation type applied to a specific child of a boolean operator.

Signature

setBooleanChildOperation(
  booleanNameOrId: string,
  childNameOrId: string,
  operation: 'Union' | 'Subtract' | 'Intersection'
): Promise<void>

Parameters

Parameter	Type	Required	Description
booleanNameOrId	string	Yes	Name or ID of the parent boolean operator
childNameOrId	string	Yes	Name or ID of the child object
operation	'Union' | 'Subtract' | 'Intersection'	Yes	The operation to apply

Returns

Promise<void>

Notes

• Operation values are case-sensitive - only 'Union', 'Subtract', and 'Intersection' are accepted. Other casing (e.g. 'union', 'UNION') will not work.

• The getter getBooleanChildOperation returns different uppercase values: 'Union' → 'UNION', 'Subtract' → 'A_MINUS_B', 'Intersection' → 'INTERSECTION'.

• In a boolean operator, one object acts as the base (the shape being operated on). Changing the operation of the base object has no visual effect — only non-base children produce a visible result.

Examples

// Subtract Sphere from the base object
await api.setBooleanChildOperation("Boolean 1", "Sphere", "Subtract");

// Keep only the overlapping volume with Tube
await api.setBooleanChildOperation("Boolean 1", "Tube", "Intersection");

// Combine Box into the base object
await api.setBooleanChildOperation("Boolean 1", "Box", "Union");

// Read back the result (returns uppercase internal value)
const op = await api.getBooleanChildOperation("Boolean 1", "Sphere");
console.log(op); // "A_MINUS_B"