Building Element Input
Class full path: BuildingElementInput.BuildingElementInput
Bases: BuildingElementInputData
Definition of class BuildingElementInput
Functions
__init__(coord_input, path)
Initialization of class BuildingElementInput
Parameters:
Name | Type | Description | Default |
---|---|---|---|
coord_input
|
CoordinateInput
|
Coordinate input class |
required |
path
|
str
|
Python script path |
required |
calculate_update_matrix(geo_matrix, local_placement_matrix)
staticmethod
Calculate matrix for update
Parameters:
Name | Type | Description | Default |
---|---|---|---|
geo_matrix
|
Matrix3D
|
geometry matrix |
required |
local_placement_matrix
|
Matrix3D
|
local placement matrix |
required |
Returns:
Type | Description |
---|---|
Matrix3D
|
original insert matrix of the PythonPart |
close_palette()
Close the palette
get_point_from_insert_matrix()
Get input point from the insert matrix
Returns:
Type | Description |
---|---|
Point3D
|
point from the insert matrix |
initialize_geometry_expand(msg_info)
initialize the geometry expand
Parameters:
Name | Type | Description | Default |
---|---|---|---|
msg_info
|
AddMsgInfo
|
message info |
required |
is_visualeditor_running(power_management, cancel_by_menu_function)
check for running visual editor
Parameters:
Name | Type | Description | Default |
---|---|---|---|
power_management
|
bool
|
checking for power management |
required |
cancel_by_menu_function
|
bool
|
cancel is execute due to menu function start |
required |
Returns:
Type | Description |
---|---|
bool
|
Visual Editor is running |
modify_element_property(page, name, value)
Modify property of element
Parameters:
Name | Type | Description | Default |
---|---|---|---|
page
|
int
|
the page of the property |
required |
name
|
str
|
the name of the property. |
required |
value
|
Any
|
new value for property. |
required |
on_cancel_function()
Cancel the input function
Returns:
Type | Description |
---|---|
bool
|
True/False for success. |
on_control_event(event_id)
On control event
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event_id
|
int
|
event id of control. |
required |
on_mouse_leave()
Handles the mouse leave event
on_preview_draw()
Handles the preview draw event
on_value_input_control_enter()
Process the enter inside the value input control
Returns:
Type | Description |
---|---|
bool
|
message was processed: True/False |
process_mouse_msg(mouse_msg, pnt, msg_info)
Handles the process mouse message event
Parameters:
Name | Type | Description | Default |
---|---|---|---|
mouse_msg
|
int
|
the mouse message. |
required |
pnt
|
|
the input point. |
required |
msg_info
|
additional message info. |
required |
Returns:
Type | Description |
---|---|
bool
|
True/False for success. |
save_load_favorite(is_save, file_name)
Save or load a favorite
Parameters:
Name | Type | Description | Default |
---|---|---|---|
is_save
|
bool
|
True = save, False = load |
required |
file_name
|
str
|
Name of the favorite file |
required |
start_input(file_name, parameter_data, msg_info, is_modification_mode, modify_uuid_list, geo_matrix, local_placement_matrix, asso_ref_ele, only_update)
Start the input function
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_name
|
|
file name of the pyp file |
required |
parameter_data
|
|
parameter data of the selected PythonPart |
required |
msg_info
|
|
message info |
required |
is_modification_mode
|
|
is started in modification mode |
required |
modify_uuid_list
|
|
list with the UUIDs of the modification elements |
required |
geo_matrix
|
|
placement matrix |
required |
local_placement_matrix
|
Matrix3D
|
local placement matrix |
required |
asso_ref_ele
|
|
reference element of the associative view |
required |
only_update
|
|
only update the PythonPart, no user interaction |
required |
Returns:
Type | Description |
---|---|
Tuple[bool, Any]
|
(successfully started, started script object) |
start_interactor()
start the interactor
Returns:
Type | Description |
---|---|
Tuple[bool, object]
|
created interactor state, interactor object |
start_next_input()
start the next input if multi placement is active
Returns:
Type | Description |
---|---|
bool
|
next input is started: True/False |