getBooleanChildOperation

getBooleanChildOperation

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

Signature

getBooleanChildOperation(
  booleanNameOrId: string,
  childNameOrId: string
): Promise<string | null>

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

Returns

Promise<string | null> - the current operation as an uppercase string, or null if the child is not found in the operator.

Return value	Meaning
'UNION'	Objects are combined into one
'INTERSECTION'	Only the overlapping volume remains
'A_MINUS_B'	Child is subtracted from the base object
null	Child not found in this boolean operator

Note:

• the return values are uppercase internal identifiers. To set an operation, use the PascalCase values accepted by setBooleanChildOperation: 'Union', 'Intersection', 'Subtract'.

Examples

const op = await api.getBooleanChildOperation("Boolean 1", "Sphere");
console.log("Current operation:", op); // e.g., "A_MINUS_B"

// Returns null if child is not part of this boolean operator
const op = await api.getBooleanChildOperation("Boolean 1", "NonExistent");
console.log(op); // null