Skip to content

BuildingElementInput

Script for BuildingElementInput

BuildingElementInput

Canonical path: BuildingElementInput.BuildingElementInput

Bases: InputData

Definition of class BuildingElementInput

__init__ 

__init__(coord_input: CoordinateInput, path: str)

Initialization of class BuildingElementInput

Parameters:

  • coord_input (CoordinateInput) –

    Coordinate input class

  • path (str) –

    Python script path

close_palette 

close_palette()

Close the palette

execute_pre_element_delete 

execute_pre_element_delete() -> bool

execute the pre element delete

Returns:

  • bool –

    pre element delete handled state

get_point_from_insert_matrix 

get_point_from_insert_matrix() -> Point3D

Get input point from the insert matrix

Returns:

  • Point3D –

    point from the insert matrix

is_visualeditor_running 

is_visualeditor_running(
    _power_management: bool, cancel_by_menu_function: bool
) -> bool

check for running visual editor

Parameters:

  • _power_management (bool) –

    checking for power management

  • cancel_by_menu_function (bool) –

    cancel is execute due to menu function start

Returns:

  • bool –

    Visual Editor is running

modify_element_property 

modify_element_property(page: int, name: str, value: Any)

Modify property of element

Parameters:

  • page (int) –

    the page of the property

  • name (str) –

    the name of the property.

  • value (Any) –

    new value for property.

on_cancel_function 

on_cancel_function() -> bool

Cancel the input function

Returns:

  • bool –

    True/False for success.

on_control_event 

on_control_event(event_id: int)

On control event

Parameters:

  • event_id (int) –

    event id of control.

on_input_undo 

on_input_undo() -> bool

Process the input undo event

Returns:

  • bool –

    message was processed: True/False

on_mouse_leave 

on_mouse_leave()

Handles the mouse leave event

on_preview_draw 

on_preview_draw()

Handles the preview draw event

on_shortcut_control_input 

on_shortcut_control_input(value: int) -> bool

Handles the input inside the shortcut control

Parameters:

  • value (int) –

    shortcut value

Returns:

  • bool –

    message was processed: True/False

on_value_input_control_enter 

on_value_input_control_enter() -> bool

Process the enter inside the value input control

Returns:

  • bool –

    message was processed: True/False

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) –

    the mouse message.

  • pnt ( ) –

    the input point.

  • msg_info –

    additional message info.

Returns:

  • bool –

    True/False for success.

reset_param_values 

reset_param_values()

Reset to original parameter values from PYP file

save_load_favorite 

save_load_favorite(is_save: bool, file_name: str)

Save or load a favorite

Parameters:

  • is_save (bool) –

    True = save, False = load

  • file_name (str) –

    Name of the favorite file

start_input 

start_input(
    file_name: str,
    parameter_data: list[str],
    msg_info: AddMsgInfo,
    is_modification_mode: bool,
    modify_uuid_list: ModificationElementList,
    geo_matrix: Matrix3D,
    local_placement_matrix: Matrix3D,
    asso_ref_ele: BaseElementAdapter,
    only_update: bool,
    is_marked_for_delete: bool = False,
) -> tuple[bool, Any]

Start the input function

Parameters:

  • file_name (str) –

    file name of the pyp file

  • parameter_data (list[str]) –

    parameter data of the selected PythonPart

  • msg_info (AddMsgInfo) –

    additional mouse message info

  • is_modification_mode (bool) –

    is started in modification mode

  • modify_uuid_list (ModificationElementList) –

    list with the UUIDs of the modified elements

  • geo_matrix (Matrix3D) –

    placement matrix

  • local_placement_matrix (Matrix3D) –

    local placement matrix

  • asso_ref_ele (BaseElementAdapter) –

    reference element of the associative view

  • only_update (bool) –

    only update the PythonPart, no user interaction

  • is_marked_for_delete (bool, default: False ) –

    is marked for delete state

Returns:

  • tuple[bool, Any] –

    (successfully started, started script object)

start_interactor 

start_interactor() -> tuple[bool, object]

start the interactor

Returns:

  • tuple[bool, object] –

    created interactor state, interactor object

start_next_input 

start_next_input() -> bool

start the next input if multi placement is active

Returns:

  • bool –

    next input is started: True/False

start_standard_pythonpart 

start_standard_pythonpart(update_palette: bool) -> bool

start the standard PythonPart input

Parameters:

  • update_palette (bool) –

    update palette state

Returns:

  • bool –

    start state