Skip to content

ArchPointInteractor

Canonical path: ScriptObjectInteractors.ArchPointInteractor.ArchPointInteractor

Bases: BaseScriptObjectInteractor

Implementation of the interactor for point input on an architectural element

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: ArchPointInteractorResult,
    ele_filter: list[GUID] | BaseFilterObject | SelectionQuery | None = None,
    request_text: str = "Select the element",
    preview_function: Callable[[], None] | None = None,
)

initialize

Parameters:

  • interactor_result (ArchPointInteractorResult) –

    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

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

    request text

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

    preview function

get_outline_segment_and_point 

get_outline_segment_and_point(sel_ele: BaseElementAdapter, input_pnt: Point3D)

get the outline segment and point related to the input point (maybe an inner tier segment was selected)

Parameters:

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