Handle Modification Service
Class full path: HandleModificationService.HandleModificationService
Implementation of the handle modification service
Attributes
handle_prop: HandleProperties
property
get the handle property
Functions
__init__(coord_input, build_ele_list, control_props_list, asso_ref_ele=None)
initialize
Args:
coord_input: coordinate input
build_ele_list: building element list
asso_ref_ele: reference element of the associative view
get_local_handle_point(input_pnt)
get the local handle point
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_pnt
|
Point3D
|
new handle point |
required |
Returns:
Type | Description |
---|---|
Optional[Point3D]
|
handle point in the local element coordinate system, None if not exist |
new_handle_point_input(mouse_msg, pnt, msg_info)
Input the new handle point
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 |
---|---|
Point3D
|
new handle point |
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. |
reset_value()
reset the handle value
start(handle_list, placement_mat, input_doc, view_world_proj, create_view_input_controls)
start the handle modification
Parameters:
Name | Type | Description | Default |
---|---|---|---|
handle_list
|
List[HandleProperties]
|
list with the handles |
required |
placement_mat
|
Matrix3D
|
placement matrix of the PythonPart |
required |
create_view_input_controls
|
bool
|
create the input controls in the view |
required |
start_new_handle_point_input(str_table_service)
start the new handle point input
stop()
stop the handle modification