PointInteractor
Canonical path: ScriptObjectInteractors.PointInteractor.PointInteractor
Bases: BaseScriptObjectInteractor
implementation of the interactor for the point input
__init__
__init__(
interactor_result: PointInteractorResult,
is_first_input: bool,
request_text: str,
preview_function: Callable[[], None] | None = None,
default_input_value: float | None = None,
abscissa_element: CURVES = None,
)
initialize
Parameters:
-
interactor_result
(PointInteractorResult
) –result of the interactor
-
is_first_input
(bool
) –first input in a input sequence state
-
request_text
(str
) –request text
-
preview_function
(Callable[[], None] | None
, default:None
) –preview function
-
default_input_value
(float | None
, default:None
) –default input value if value input is activated
-
abscissa_element
(CURVES
, default:None
) –abscissa element for the point projection
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