selectObjects

selectObjects

Select one or more objects in the scene by name or ID.

Signature

selectObjects(
  objectNamesOrIds: string | string[],
  addToSelection?: boolean
): Promise<SceneObject[]>

Parameters

Parameter	Type	Required	Description
objectNamesOrIds	string | string[]	Yes	Name(s) or ID(s) of objects to select
addToSelection	boolean	No	If true, adds to existing selection. If false or omitted, replaces current selection.

Returns

Promise<SceneObject[]> — the resulting selected objects. Each object includes full scene data: transform, materials, primitive settings, and children.

Examples

// Select a single object (replaces current selection)
const selected = await api.selectObjects("MyCube");

// Select multiple objects
const selected = await api.selectObjects(["MyCube", "MySphere"]);

// Add to existing selection without clearing it
const selected = await api.selectObjects("AnotherObject", true);

// Select a child inside a boolean operator by ID
const selected = await api.selectObjects("a1b2c3d4-...");

Notes:

• Objects inside boolean operators are not directly clickable in the viewport. Use their ID to select them programmatically.