File Controller

`export_3d_file(elements, file)`

Exports a 3d or 3dc file. Based on the extension in the file name.

Examples:

export_3d_file(elements, "example.3dc") export_3d_file(elements, "example.3d")

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required

Source code in file_controller/__init__.py

def export_3d_file(elements: List[int], file: str) -> None:
    """Exports a 3d or 3dc file. Based on the extension in the file name.

    Examples:
    >>> export_3d_file(elements, "example.3dc")
    >>> export_3d_file(elements, "example.3d")

    Args:
        elements (List[int]): element IDs
        file (str): file path
    """

`export_3dc_file(elements, file)`

Exports a 3D/3DC file

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required

Source code in file_controller/__init__.py

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

    Args:
        elements (List[int]): element IDs
        file (str): file path
    """

`export_btl_file_for_nesting(file)`

Exports a BTL file for nesting

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path
    """

`export_fbx_file(elements, file, number)`

Export fbx file

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required
`number`	`int`	fbx format 1 = "FBX binary(.fbx) ; 2 = "FBX ascii(.fbx)" ; 3 = "FBX encrypted(.fbx)" ; 4 = "FBX 6.0 binary(.fbx)" ; 5 = "FBX 6.0 ascii(.fbx)" ; 6 = "FBX 6.0 encrypted(.fbx)"	required

Source code in file_controller/__init__.py

def export_fbx_file(elements: List[int], file: str, number: int) -> None:
    """Export fbx file

    Args:
        elements (List[int]): element IDs
        file (str): file path
        number (int): fbx format  1 = "FBX binary(*.fbx) ; 2 = "FBX ascii(*.fbx)" ; 3 = "FBX encrypted(*.fbx)" ; 4 = "FBX 6.0 binary(*.fbx)" ; 5 = "FBX 6.0 ascii(*.fbx)" ; 6 = "FBX 6.0 encrypted(*.fbx)"
    """

`export_glb_file(elements, file)`

Exports a GLB file

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required

Source code in file_controller/__init__.py

def export_glb_file(elements: List[int], file: str) -> None:
    """Exports a GLB file

    Args:
        elements (List[int]): element IDs
        file (str): file path
    """

`export_obj_file(elements, file)`

Exports a OBJ file

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required

Source code in file_controller/__init__.py

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

    Args:
        elements (List[int]): element IDs
        file (str): file path
    """

`export_rhino_file(elements, file, version, user_default_assignment, write_standard_attributes)`

Exports a 3dm rhino file

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required
`version`	`int`	Rhino version V5.0 = 5, V6.0 = 6, V7.0 = 7	required
`user_default_assignment`	`bool`	true: default assignment is used; false: no attributes are exported	required
`write_standard_attributes`	`bool`	see checkbox in assignment dialog	required

Source code in file_controller/__init__.py

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

    Args:
        elements (List[int]): element IDs
        file (str): file path
        version (int): Rhino version V5.0 = 5, V6.0 = 6, V7.0 = 7
        user_default_assignment (bool): true: default assignment is used; false: no attributes are exported
        write_standard_attributes (bool): see checkbox in assignment dialog
    """

`export_rhino_file_with_options(elements, file, version, user_default_assignment, write_standard_attributes, rhino_options)`

export rh9ino file with options

Examples:

>>> rhino_options = rhino_options()
>>> rhino_options.set_cut_drillings(True)
>>> rhino_options.set_cut_end_types_counterparts(True)
>>> file_controller.export_rhino_file_with_options(elements, "yourFile.3dm", 7, True, True, rhino_options)

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required
`version`	`int`	Rhino Version V5.0 = 5, V6.0 = 6, V7.0 = 7	required
`user_default_assignment`	`bool`	true: default assignment is used; false: no attributes are exported	required
`write_standard_attributes`	`bool`	see checkbox in assignment dialog	required
`rhino_options`	`rhino_options`	rhino export options	required

Source code in file_controller/__init__.py

def export_rhino_file_with_options(elements: List[int], file: str, version: int, user_default_assignment: bool, write_standard_attributes: bool, rhino_options: rhino_options) -> None:
    """export rh9ino file with options

    Examples:
        >>> rhino_options = rhino_options()
        >>> rhino_options.set_cut_drillings(True)
        >>> rhino_options.set_cut_end_types_counterparts(True)
        >>> file_controller.export_rhino_file_with_options(elements, "yourFile.3dm", 7, True, True, rhino_options)

    Args:
        elements (List[int]): element IDs
        file (str): file path
        version (int): Rhino Version V5.0 = 5, V6.0 = 6, V7.0 = 7
        user_default_assignment (bool): true: default assignment is used; false: no attributes are exported
        write_standard_attributes (bool): see checkbox in assignment dialog
        rhino_options (rhino_options): rhino export options
    """

`export_sat_file(elements, file, scale, option, number)`

exports a SAT File

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required
`scale`	`float`	scale factor	required
`option`	`bool`	binary	required
`number`	`int`	version	required

Source code in file_controller/__init__.py

def export_sat_file(elements: List[int], file: str, scale: float, option: bool, number: int) -> None:
    """exports a SAT File

    Args:
        elements (List[int]): element IDs
        file (str): file path
        scale (float): scale factor
        option (bool): binary 
        number (int): version
    """

`export_step_file(elements, file, scale, number, option)`

Exports a STEP file

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required
`scale`	`float`	file scale factor	required
`number`	`int`	file version	required
`option`	`bool`	use text mode	required

Source code in file_controller/__init__.py

def export_step_file(elements: List[int], file: str, scale: float, number: int, option: bool) -> None:
    """Exports a STEP file

    Args:
        elements (List[int]): element IDs
        file (str): file path
        scale (float): file scale factor
        number (int): file version
        option (bool): use text mode
    """

`export_stl_file(elements, file)`

Exports an STL file

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required

Source code in file_controller/__init__.py

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

    Args:
        elements (List[int]): element IDs
        file (str): file path
    """

`export_webgl(elements, file)`

Exports a WebGL File

Parameters:

Name	Type	Description	Default
`elements`	`List[int]`	element IDs	required
`file`	`str`	file path	required

Source code in file_controller/__init__.py

def export_webgl(elements: List[int], file: str) -> None:
    """Exports a WebGL File

    Args:
        elements (List[int]): element IDs
        file (str): file path
    """

`get_blum_export_path()`

Get blum export path

Returns:

Type	Description
`str`	file path

Source code in file_controller/__init__.py

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

    Returns:
        str: file path
    """

`import_3dc_file(file)`

Imports a 3DC file

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required

Returns:

Type	Description
`List[int]`	element IDs

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path

    Returns:
        List[int]: element IDs
    """

`import_3dc_file_with_glide(file)`

Imports a 3DC file with glide

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required

Returns:

Type	Description
`List[int]`	element IDs

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path

    Returns:
        List[int]: element IDs
    """

`import_3dz_file(file)`

Imports a 3DZ file

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path
    """

`import_btl_file(file)`

Imports a BTL file

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path
    """

`import_btl_file_for_nesting(file)`

Imports a BTL file for nesting

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path
    """

`import_element_light(file_path, insert_position)`

Imports an element light allowed formats are OBJ, SKP

Examples:

import_element_light("C:\UserXY\Files\example.obj", point_3d(0,0,0))

Parameters:

Name	Type	Description	Default
`file_path`	`str`	file path	required
`insert_position`	`point_3d`	insert position	required

Returns:

Type	Description
`int`	element ID

Source code in file_controller/__init__.py

def import_element_light(file_path: str, insert_position: point_3d) -> int:
    """Imports an element light
        allowed formats are OBJ, SKP

    Examples:
    >>> import_element_light("C:\\UserXY\\Files\\example.obj", point_3d(0,0,0))

    Args:
        file_path (str): file path
        insert_position (point_3d): insert position

    Returns:
        int: element ID
    """

`import_rhino_file(file, option)`

Imports a Rhino file

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required
`option`	`bool`	import without dialog	required

Returns:

Type	Description
`List[int]`	element IDs

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path
        option (bool): import without dialog

    Returns:
        List[int]: element IDs
    """

`import_sat_file(file, scale, option)`

Imports an SAT file

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required
`scale`	`float`	file scale factor	required
`option`	`bool`	use binary mode	required

Returns:

Type	Description
`List[int]`	element IDs

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path
        scale (float): file scale factor
        option (bool): use binary mode

    Returns:
        List[int]: element IDs
    """

`import_sat_file_silently(file, scale, option)`

summary

Parameters:

Name	Type	Description	Default
`file`	`str`	description	required
`scale`	`float`	description	required
`option`	`bool`	description	required

Returns:

Type	Description
`List[int]`	description

Source code in file_controller/__init__.py

def import_sat_file_silently(file: str, scale: float, option: bool) -> List[int]:
    """_summary_

    Args:
        file (str): _description_
        scale (float): _description_
        option (bool): _description_

    Returns:
        List[int]: _description_
    """

`import_step_file(file, scale)`

Imports a STEP file

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required
`scale`	`float`	file scale factor	required

Returns:

Type	Description
`List[int]`	element IDs

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path
        scale (float): file scale factor

    Returns:
        List[int]: element IDs
    """

`import_step_file_with_message_option(file, scale, option)`

Imports a STEP file

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required
`scale`	`float`	file scale factor	required
`option`	`bool`	hide message	required

Returns:

Type	Description
`List[int]`	element IDs

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path
        scale (float): file scale factor
        option (bool): hide message

    Returns:
        List[int]: element IDs
    """

`import_variant_file(file, insert_point)`

imports a variant by .val-File

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required
`insert_point`	`point_3d`	insert point	required

Returns:

Type	Description
`List[int]`	element IDs

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path
        insert_point (point_3d): insert point

    Returns:
        List[int]: element IDs
    """

`set_blum_export_path(file)`

Set blum export path

Parameters:

Name	Type	Description	Default
`file`	`str`	file path	required

Source code in file_controller/__init__.py

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

    Args:
        file (str): file path
    """