class VisualScriptService

class VisualScriptService.DefaultValue(element_id: str,
                                        name: str,
                                        value: str)

implementation of the data class for the default value

__eq__(other)

Return self==value.

__init__(element_id: str,
         name: str,
         value: str)

Initialize self. See help(type(self)) for accurate signature.

__repr__()

Return repr(self).

__hash__ = None

__module__ = 'VisualScriptService'

element_id: str

name: str

value: str

class VisualScriptService.VisualScriptService(coord_input: CoordinateInput,
                                               script_path: str,
                                               global_str_table_service: StringTableService,
                                               build_ele_list: List[BuildingElement],
                                               control_props_list: List[List[ControlProperties]],
                                               default_values: List[DefaultValue])

implementation of the VisualScript service

__init__(coord_input: CoordinateInput,
         script_path: str,
         global_str_table_service: StringTableService,
         build_ele_list: List[BuildingElement],
         control_props_list: List[List[ControlProperties]],
         default_values: List[DefaultValue])

Initialize the script

Parameters

• coord_input – coordinate input

• script_path – script path

• global_str_table_service – global string table service

• build_ele_list – building element list

• control_props_list – control properties list

• default_values – default values

close_all()

close the VS script

create_pythonpart(placement_matrix: Matrix3D,
                  local_placement_matrix: Matrix3D)

create the PythonPart

Parameters

• placement_matrix – placement matrix of the PythonPart (model placement)

• local_placement_matrix – local placement matrix of the PythonPart, used for the local geometry transformation

Returns

created PythonPart elements

execute_load_favorite(file_name)

load the favorite data

execute_save_favorite(file_name)

save the favorite data

get_preview_elements() → List[Any]

get the preview elements created by the script

Returns

preview elements of the script

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

Modify property of element

Parameters

• page – the page of the property

• name – the name of the property.

• value – new value for property.

on_cancel_function() → bool

Check for input function cancel in case of ESC

Returns

True/False for success.

on_control_event(event_id: int)

Handles on control event

Parameters

event_id – event id of control.

reset_param_values()

reset the parameter values

__module__ = 'VisualScriptService'