ArchOffsetPointInteractor

Canonical path: ScriptObjectInteractors.ArchOffsetPointInteractor.ArchOffsetPointInteractor

Bases: BaseScriptObjectInteractor

Implementation of the interactor for point input on an architectural element with an additional offset input after picking the point.

Only vertical architectural elements (i.e. walls, beams, columns, foundation) are valid for this interactor. The input result can be used e.g. for creation of openings in these elements.

__init__

__init__(
    interactor_result: ArchOffsetPointInteractorResult,
    request_text: str,
    preview_function: Callable[[], None] | None = None,
)

initialize

Parameters:

• interactor_result (ArchOffsetPointInteractorResult) –

  result of the interactor

• request_text (str) –

  request text

• preview_function (Callable[[], None] | None, default: None ) –

  preview function

on_mouse_leave

on_mouse_leave()

Handles the mouse leave event

on_preview_draw

on_preview_draw()

Handles the preview draw event

process_mouse_msg

process_mouse_msg(mouse_msg: int, pnt: Point2D, msg_info: AddMsgInfo) -> bool

Handles the process mouse message event

Parameters:

• mouse_msg (int) –

  mouse message ID

• pnt (Point2D) –

  input point in Allplan view coordinates

• msg_info (AddMsgInfo) –

  additional mouse message info

Returns:

• bool –

  True/False for success.

start_input

start_input(coord_input: CoordinateInput)

start the input

Parameters:

• coord_input (CoordinateInput) –

  API object for the coordinate input, element selection, ... in the Allplan view

Placeholder