File Controller

clear_errors()

clear errors

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

export_3d_file(element_id_list, file_path)

Exports a 3D file

Parameters:

Name	Type	Description	Default
element_id_list	List[int]	element_id_list	required
file_path	str	file_path	required

Returns:

Type	Description
bool	did operation succeed

Source code in src/file_controller/__init__.pyi

def export_3d_file(element_id_list: List[int], file_path: str) -> bool:
    """Exports a 3D file

    Parameters:
        element_id_list: element_id_list
        file_path: file_path

    Returns:
        did operation succeed
    """

export_3dc_file(element_id_list, file_path)

Exports a 3D file

Parameters:

Name	Type	Description	Default
element_id_list	List[int]	element_id_list	required
file_path	str	file_path	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_3dc_file(element_id_list: List[int], file_path: str) -> None:
    """Exports a 3D file

    Parameters:
        element_id_list: element_id_list
        file_path: file_path

    Returns:
        None
    """

export_btl_file_for_nesting(file_path)

Exports a BTL file for nesting

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_btl_file_for_nesting(file_path: str) -> None:
    """Exports a BTL file for nesting

    Parameters:
        file_path: file_path

    Returns:
        None
    """

export_fbx_file(elements, file_path, fbx_format)

Exports a FBX file

Parameters:

Name	Type	Description	Default
elements	List[int]	elements	required
file_path	str	file_path	required
fbx_format	int	fbx_format	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_fbx_file(elements: List[int], file_path: str, fbx_format: int) -> None:
    """Exports a FBX file

    Parameters:
        elements: elements
        file_path: file_path
        fbx_format: fbx_format

    Returns:
        None
    """

export_glb_file(elements, file_path)

exports a GLB File

Parameters:

Name	Type	Description	Default
elements	List[int]	elements	required
file_path	str	file_path	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_glb_file(elements: List[int], file_path: str) -> None:
    """exports a GLB File

    Parameters:
        elements: elements
        file_path: file_path

    Returns:
        None
    """

export_obj_file(elements, file_path)

Exports a OBJ file

Parameters:

Name	Type	Description	Default
elements	List[int]	elements	required
file_path	str	file_path	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_obj_file(elements: List[int], file_path: str) -> None:
    """Exports a OBJ file

    Parameters:
        elements: elements
        file_path: file_path

    Returns:
        None
    """

export_rhino_file(element_id_list, file_path, version, use_default_assignment, write_standard_attributes)

Exports a 3dm rhino file

Parameters:

Name	Type	Description	Default
element_id_list	List[int]	element_id_list	required
file_path	str	file_path	required
version	int	version	required
use_default_assignment	bool	use_default_assignment	required
write_standard_attributes	bool	write_standard_attributes	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_rhino_file(element_id_list: List[int], file_path: str, version: int, use_default_assignment: bool, write_standard_attributes: bool) -> None:
    """Exports a 3dm rhino file

    Parameters:
        element_id_list: element_id_list
        file_path: file_path
        version: version
        use_default_assignment: use_default_assignment
        write_standard_attributes: write_standard_attributes

    Returns:
        None
    """

export_rhino_file_with_options(element_id_list, file_path, version, use_default_assignment, write_standard_attributes, rhino_options)

exports elements to a rhino 3dm file based on the export options

Parameters:

Name	Type	Description	Default
element_id_list	List[int]	element_id_list	required
file_path	str	file_path	required
version	int	version	required
use_default_assignment	bool	use_default_assignment	required
write_standard_attributes	bool	write_standard_attributes	required
rhino_options	None	rhino_options	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_rhino_file_with_options(element_id_list: List[int], file_path: str, version: int, use_default_assignment: bool, write_standard_attributes: bool, rhino_options: None) -> None:
    """exports elements to a rhino 3dm file based on the export options

    Parameters:
        element_id_list: element_id_list
        file_path: file_path
        version: version
        use_default_assignment: use_default_assignment
        write_standard_attributes: write_standard_attributes
        rhino_options: rhino_options

    Returns:
        None
    """

export_sat_file(elements, file_path, scale_factor, binary, version)

exports a SAT File

Parameters:

Name	Type	Description	Default
elements	List[int]	elements	required
file_path	str	file_path	required
scale_factor	float	scale_factor	required
binary	bool	binary	required
version	int	version	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_sat_file(elements: List[int], file_path: str, scale_factor: float, binary: bool, version: int) -> None:
    """exports a SAT File

    Parameters:
        elements: elements
        file_path: file_path
        scale_factor: scale_factor
        binary: binary
        version: version

    Returns:
        None
    """

export_step_file(element_list, file_path, scale_factor, version, text_mode)

Exports a STEP file

Parameters:

Name	Type	Description	Default
element_list	List[int]	element_list	required
file_path	str	file_path	required
scale_factor	float	scale_factor	required
version	int	version	required
text_mode	bool	text_mode	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_step_file(element_list: List[int], file_path: str, scale_factor: float, version: int, text_mode: bool) -> None:
    """Exports a STEP file

    Parameters:
        element_list: element_list
        file_path: file_path
        scale_factor: scale_factor
        version: version
        text_mode: text_mode

    Returns:
        None
    """

export_step_file_extrude_drillings(elements, file_path, scale_factor, version, text_mode, imperial_units)

Exports a STEP file with extruded drillings

Parameters:

Name	Type	Description	Default
elements	List[int]	elements	required
file_path	str	file_path	required
scale_factor	float	scale_factor	required
version	int	version	required
text_mode	bool	text_mode	required
imperial_units	bool	imperial_units	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_step_file_extrude_drillings(elements: List[int], file_path: str, scale_factor: float, version: int, text_mode: bool, imperial_units: bool) -> None:
    """Exports a STEP file with extruded drillings

    Parameters:
        elements: elements
        file_path: file_path
        scale_factor: scale_factor
        version: version
        text_mode: text_mode
        imperial_units: imperial_units

    Returns:
        None
    """

export_stl_file(element_id_list, file_path)

Exports an STL file

Parameters:

Name	Type	Description	Default
element_id_list	List[int]	element_id_list	required
file_path	str	file_path	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def export_stl_file(element_id_list: List[int], file_path: str) -> None:
    """Exports an STL file

    Parameters:
        element_id_list: element_id_list
        file_path: file_path

    Returns:
        None
    """

export_webgl(element_id_list, file_path)

Exports a WebGL file

Parameters:

Name	Type	Description	Default
element_id_list	List[int]	element_id_list	required
file_path	str	file_path	required

Returns:

Type	Description
bool	did operation succeed

Source code in src/file_controller/__init__.pyi

def export_webgl(element_id_list: List[int], file_path: str) -> bool:
    """Exports a WebGL file

    Parameters:
        element_id_list: element_id_list
        file_path: file_path

    Returns:
        did operation succeed
    """

get_blum_export_path()

get blum export path

Returns:

Type	Description
str	str

Source code in src/file_controller/__init__.pyi

def get_blum_export_path() -> str:
    """get blum export path

    Returns:
        str
    """

get_import_3dc_options()

get import 3dc options

Returns:

Type	Description
import_3dc_options	import_3dc_options

Source code in src/file_controller/__init__.pyi

def get_import_3dc_options() -> import_3dc_options:
    """get import 3dc options

    Returns:
        import_3dc_options
    """

get_last_error(error_code)

Gets the last error

Parameters:

Name	Type	Description	Default
error_code	int	error_code	required

Returns:

Type	Description
str	error string

Source code in src/file_controller/__init__.pyi

def get_last_error(error_code: int) -> str:
    """Gets the last error

    Parameters:
        error_code: error_code

    Returns:
        error string
    """

import_3dc_file(file_path)

Imports a 3DC file

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required

Returns:

Type	Description
List[int]	imported element ID list

Source code in src/file_controller/__init__.pyi

def import_3dc_file(file_path: str) -> List[int]:
    """Imports a 3DC file

    Parameters:
        file_path: file_path

    Returns:
        imported element ID list
    """

import_3dc_file_with_glide(file_path)

Imports a 3DC file with glide

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required

Returns:

Type	Description
List[int]	imported element ID list

Source code in src/file_controller/__init__.pyi

def import_3dc_file_with_glide(file_path: str) -> List[int]:
    """Imports a 3DC file with glide

    Parameters:
        file_path: file_path

    Returns:
        imported element ID list
    """

import_3dc_file_with_options(file_path, import3dc_options)

imports a 3d or a 3dc file depending on the import options

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required
import3dc_options	None	import3dc_options	required

Returns:

Type	Description
List[int]	imported element ID list

Source code in src/file_controller/__init__.pyi

def import_3dc_file_with_options(file_path: str, import3dc_options: None) -> List[int]:
    """imports a 3d or a 3dc file depending on the import options

    Parameters:
        file_path: file_path
        import3dc_options: import3dc_options

    Returns:
        imported element ID list
    """

import_3dz_file(file_path)

Imports a 3DZ file

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def import_3dz_file(file_path: str) -> None:
    """Imports a 3DZ file

    Parameters:
        file_path: file_path

    Returns:
        None
    """

import_btl_file(file_path)

Imports a BTL file

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def import_btl_file(file_path: str) -> None:
    """Imports a BTL file

    Parameters:
        file_path: file_path

    Returns:
        None
    """

import_btl_file_for_nesting(file_path)

Imports a BTL file for nesting

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def import_btl_file_for_nesting(file_path: str) -> None:
    """Imports a BTL file for nesting

    Parameters:
        file_path: file_path

    Returns:
        None
    """

import_bxf_file(file_path, insert_position)

import bxf file

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required
insert_position	point_3d	insert_position	required

Returns:

Type	Description
List[int]	List[int]

Source code in src/file_controller/__init__.pyi

def import_bxf_file(file_path: str, insert_position: point_3d) -> List[int]:
    """import bxf file

    Parameters:
        file_path: file_path
        insert_position: insert_position

    Returns:
        List[int]
    """

import_element_light(a0, a1)

import element light

Parameters:

Name	Type	Description	Default
a0	str	a0	required
a1	point_3d	a1	required

Returns:

Type	Description
int	int

Source code in src/file_controller/__init__.pyi

def import_element_light(a0: str, a1: point_3d) -> int:
    """import element light

    Parameters:
        a0: a0
        a1: a1

    Returns:
        int
    """

import_rhino_file(file_path, without_dialog)

Imports a Rhino file

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required
without_dialog	bool	without_dialog	required

Returns:

Type	Description
List[int]	imported element ID list

Source code in src/file_controller/__init__.pyi

def import_rhino_file(file_path: str, without_dialog: bool) -> List[int]:
    """Imports a Rhino file

    Parameters:
        file_path: file_path
        without_dialog: without_dialog

    Returns:
        imported element ID list
    """

import_sat_file(file_path, scale_factor, binary)

Imports an SAT file

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required
scale_factor	float	scale_factor	required
binary	bool	binary	required

Returns:

Type	Description
List[int]	imported element ID list

Source code in src/file_controller/__init__.pyi

def import_sat_file(file_path: str, scale_factor: float, binary: bool) -> List[int]:
    """Imports an SAT file

    Parameters:
        file_path: file_path
        scale_factor: scale_factor
        binary: binary

    Returns:
        imported element ID list
    """

import_sat_file_silently(file_path, scale_factor, binary)

Imports a SAT File without messages

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required
scale_factor	float	scale_factor	required
binary	bool	binary	required

Returns:

Type	Description
List[int]	List[int]

Source code in src/file_controller/__init__.pyi

def import_sat_file_silently(file_path: str, scale_factor: float, binary: bool) -> List[int]:
    """Imports a SAT File without messages

    Parameters:
        file_path: file_path
        scale_factor: scale_factor
        binary: binary

    Returns:
        List[int]
    """

import_step_file(file_path, scale_factor)

Imports a STEP file

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required
scale_factor	float	scale_factor	required

Returns:

Type	Description
List[int]	imported element ID list

Source code in src/file_controller/__init__.pyi

def import_step_file(file_path: str, scale_factor: float) -> List[int]:
    """Imports a STEP file

    Parameters:
        file_path: file_path
        scale_factor: scale_factor

    Returns:
        imported element ID list
    """

import_step_file_with_message_option(file_path, scale_factor, hide_message)

Imports a STEP file

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required
scale_factor	float	scale_factor	required
hide_message	bool	hide_message	required

Returns:

Type	Description
List[int]	imported element ID list

Source code in src/file_controller/__init__.pyi

def import_step_file_with_message_option(file_path: str, scale_factor: float, hide_message: bool) -> List[int]:
    """Imports a STEP file

    Parameters:
        file_path: file_path
        scale_factor: scale_factor
        hide_message: hide_message

    Returns:
        imported element ID list
    """

import_variant_file(file_path, insert_position)

imports a variant by .val-File

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required
insert_position	point_3d	insert_position	required

Returns:

Type	Description
List[int]	imported element ID list

Source code in src/file_controller/__init__.pyi

def import_variant_file(file_path: str, insert_position: point_3d) -> List[int]:
    """imports a variant by .val-File

    Parameters:
        file_path: file_path
        insert_position: insert_position

    Returns:
        imported element ID list
    """

load_webgl_preset_file(file_path)

loads a preset file for the WebGl export

Parameters:

Name	Type	Description	Default
file_path	str	file_path	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def load_webgl_preset_file(file_path: str) -> None:
    """loads a preset file for the WebGl export

    Parameters:
        file_path: file_path

    Returns:
        None
    """

set_blum_export_path(path)

set blum export path

Parameters:

Name	Type	Description	Default
path	str	path	required

Returns:

Type	Description
None	None

Source code in src/file_controller/__init__.pyi

def set_blum_export_path(path: str) -> None:
    """set blum export path

    Parameters:
        path: path

    Returns:
        None
    """