SingleElementSelectInteractor

Canonical path: ScriptObjectInteractors.SingleElementSelectInteractor.SingleElementSelectInteractor

Bases: BaseScriptObjectInteractor

implementation of the interactor for the single element selection

Methods:

• __init__ –

  initialize

• process_mouse_msg –

  Handles the process mouse message event

• start_input –

  start the input

__init__

__init__(
    interactor_result: SingleElementSelectResult,
    ele_filter: list[GUID] | BaseFilterObject | SelectionQuery | None = None,
    prompt_msg: str = "Select the element",
)

initialize

Parameters:

• interactor_result (SingleElementSelectResult) –

  result of the interactor

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

  element filter as a list of accepted element type GUIDs or a callable or a selection query returning True, when the element is valid for selection

• prompt_msg (str, default: 'Select the element' ) –

  prompt message shown to the user in the dialog line

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