Learn a library part
learn_library_partLearns a library part's footprint by placing temporary samples, measuring them, and storing the result so the part can later be placed without samples.
Instructions
Learn a library part once, before placing it by placement; a learned part is then placed with no samples. Places samples of the part named name (kind: object, lamp, door or window) in a row just past the right edge of the model, on the story the floor plan shows, measures their footprints, shows them in one floor plan image, deletes every sample again in the same call and stores the measurement. The reply lists 'samples' left to right as the image shows them, the first sample's GDL parameters, warnings, and 'next', the fields still to give record_library_part. variants: optional sets of GDL parameter values (parameter name to value), each placed as one more sample, such as a leaf or one of a window's sashes opened. On Tapir 1.7.2 a door or window placed by part name, as its samples are, has GDL parameters that can be neither read nor written, and the Door or Window tool keeps that fault for later openings, so a door's or window's samples show no parameters and a placement's leaves end in placed_not_set; the same part placed from a favourite has them. When a window's capture shows no opening lines, the view settings hide them: ask the user to show them, then learn the window again, before recording hinge and swing. A part whose plan size does not follow its own A and B gets no footprint (the reply's note says so) and is placed by coordinates. Lengths are metres. The floor plan must be the active window, with its view not rotated. It zooms the plan to the samples and leaves it zoomed, since Tapir cannot set the zoom back; a door or window learned may leave the Door or Window tool holding the part. Needs Tapir 1.7.2.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| name | Yes | ||
| port | No | ||
| variants | No |