DockingPointInteractor

implementation of the interactor for the point takeover

DockingPointInteractor

Canonical path: ScriptObjectInteractors.DockingPointInteractor.DockingPointInteractor

Bases: BaseScriptObjectInteractor

implementation of the interactor for the point takeover

__init__

__init__(
    parameter: ParameterProperty,
    preview_function: Callable[[], None] | None = None,
)

initialize

Parameters:

• parameter (ParameterProperty) –

  parameter for the docking point

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

  preview function

assign_selected_value

assign_selected_value()

assign the selected value to the take over parameter

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