BaseScriptObjectInteractor

implementation of the base script object interactor

BaseScriptObjectInteractor

Canonical path: ScriptObjectInteractors.BaseScriptObjectInteractor.BaseScriptObjectInteractor

Bases: ABC

implementation of the base script object interactor

create_selection_query staticmethod

create_selection_query(
    ele_filter: list[GUID] | BaseFilterObject | SelectionQuery | None,
) -> SelectionQuery

create the selection query

Parameters:

• ele_filter (list[GUID] | BaseFilterObject | SelectionQuery | None) –

  element filter as a list of accepted element type GUIDs or a callable or a selection query

Returns:

• SelectionQuery –

  selection query or None

on_cancel_function

on_cancel_function() -> OnCancelFunctionResult

Handles the cancel function event (e.g. by ESC, ...)

Returns:

• True ( OnCancelFunctionResult ) –

  cancel the input

• False ( OnCancelFunctionResult ) –

  continue the input

• None ( OnCancelFunctionResult ) –

  in case of not implemented

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 abstractmethod

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 abstractmethod

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