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
execute_pre_element_delete
execute the pre element delete
Returns:
-
bool
–pre element delete handled state
get_point_from_insert_matrix
get_point_from_insert_matrix() -> Point3D
is_visualeditor_running
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 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
Cancel the input function
Returns:
-
bool
–True/False for success.
on_control_event
On control event
Parameters:
-
event_id
(int
) –event id of control.
on_input_undo
Process the input undo event
Returns:
-
bool
–message was processed: True/False
on_shortcut_control_input
Handles the input inside the shortcut control
Parameters:
-
value
(int
) –shortcut value
Returns:
-
bool
–message was processed: True/False
on_value_input_control_enter
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.
save_load_favorite
Save or load a favorite
Parameters:
-
is_save
(bool
) –True = save, False = load
-
file_name
(str
) –Name of the favorite file
set_is_only_update_locks
staticmethod
set the is only update locks
Parameters:
-
is_only_update
(bool
) –only update the PythonPart, no user interaction
start_input
start_input(
file_name: str,
parameter_data: list[str],
msg_info: AddMsgInfo | None,
is_modification_mode: bool,
modify_uuid_list: ModificationElementList,
geo_matrix: Matrix3D,
local_placement_matrix: Matrix3D,
asso_ref_ele: BaseElementAdapter,
is_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 | None
) –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
-
is_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_next_input
start the next input if multi placement is active
Returns:
-
bool
–next input is started: True/False