vw_insert_soft_goods
Places a Spotlight Soft Goods run (curtain, truss border, or pipe-and-drape) along a polyline, adding optional opening, track, pipe, traveler, and hardware.
Instructions
Place a Spotlight Soft Goods run (curtain, truss border or pipe-and-drape) along a path of points.
Creates one Soft Goods object on the open polyline through points,
height tall, with the optional opening and hardware. One revertible step
removes it with its path. The geometry is read back after creation.
Returns {uuid, center: [x, y, z], size: [w, d, h], path_length, class?}.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"points": "<points>",
"height": "<height>"
},
"name": "vw_insert_soft_goods"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| layer | No | Design layer to place the new object(s) on, by name. Omitted: the user's active layer. | |
| height | Yes | Height of the curtain or border in document units. | |
| points | Yes | Path of the run as [[x, y], [x, y], ...] in document units; at least two points, an open polyline. | |
| purpose | No | Text for the object's Spotlight 'Purpose' field. Omitted: left empty. | |
| add_pipe | No | True draws the hanging pipe. | |
| document | No | Name of the document this call may change, as listed by vw_list_documents. If given and another document is in front, nothing changes and the call fails; use vw_switch_document first. Always pass it for writes. | |
| function | No | What the run is: 'Curtain', 'Truss Border' or 'Pipe-and-Drape'. | Curtain |
| position | No | Text for the object's Spotlight 'Position' field. Omitted: left empty. | |
| traveler | No | True marks the curtain as a traveler. | |
| add_track | No | True draws the curtain track. | |
| open_from | No | Curtains only: where the opening is, as the plug-in's popup text, for example 'Center'. Omitted: the plug-in default. | |
| class_name | No | Class to assign to the new object(s), by name; it must exist (vw_create_class or vw_apply_class_standard first). Applied in a second job after the insert. Omitted: the user's active class. | |
| opening_width | No | Curtains only: width of the opening in document units. Omitted: no opening. |