Enumerations

Node symbols

cadwork.node_symbol (IntEnum)

Change node symbol.

Examples:

>>> point = cadwork.point_3d(0, 0, 0)
>>> node = element_controller.create_node(point)
>>> node.set_node_symbol(node, node_symbol.circle)

Parameters:

Name	Type	Description	Default
SmallCircle	int	1	required
Square	int	2	required
Cross	int	3	required
Circle	int	4	required
FilledCircle	int	5	required
ChessSquare	int	6	required
HalfFilledSquare	int	7	required
CrossSquare	int	8	required
FilledSquare	int	9	required

Source code in cadwork/__init__.py

@unique
class node_symbol(IntEnum):
    """Change node symbol. 

    Examples:
        >>> point = cadwork.point_3d(0, 0, 0)
        >>> node = element_controller.create_node(point)
        >>> node.set_node_symbol(node, node_symbol.circle)

    Args:
        SmallCircle (int): 1
        Square (int): 2
        Cross (int): 3
        Circle (int): 4
        FilledCircle (int): 5
        ChessSquare (int): 6
        HalfFilledSquare (int): 7
        CrossSquare (int): 8
        FilledSquare (int): 9  
    """
    SmallSquare = 1
    Square = 2
    Cross = 3
    Circle = 4
    FilledCircle = 5
    ChessSquare = 6
    HalfFilledSquare = 7
    CrossSquare = 8
    FilledSquare = 9

    def __int__(self) -> int:
        return self.value

Element module

cadwork.element_module_detail (IntEnum)

Add element situation to detail.

Examples:

>>> element_controller.add_elements_to_detail(element_ids, element_module_detail.cross)

Parameters:

Name	Type	Description	Default
no_detail	int	0	required
angle_detail	int	1	required
area_detail	int	2	required
cross_detail	int	3	required
edge_detail	int	4	required
end_detail	int	5	required
line_detail	int	6	required
open_detail	int	7	required
t_detail	int	8	required
floor_area_detail	int	9	required
floor_end_detail	int	10	required
floor_line_detail	int	11	required
floor_open_detail	int	12	required

Source code in cadwork/__init__.py

@unique
class element_module_detail(IntEnum):
    """Add element situation to detail. 

    Examples:
        >>> element_controller.add_elements_to_detail(element_ids, element_module_detail.cross)

    Args:
        no_detail (int): 0
        angle_detail (int): 1
        area_detail (int): 2
        cross_detail (int): 3
        edge_detail (int): 4
        end_detail (int): 5
        line_detail (int): 6
        open_detail (int): 7
        t_detail (int): 8
        floor_area_detail (int): 9
        floor_end_detail (int): 10
        floor_line_detail (int): 11
        floor_open_detail (int): 12

    """
    no_detail = 0,
    angle_detail = 1,
    area_detail = 2,
    cross_detail = 3,
    edge_detail = 4,
    end_detail = 5,
    line_detail = 6,
    open_detail = 7,
    t_detail = 8,
    floor_area_detail = 9,
    floor_end_detail = 10,
    floor_line_detail = 11,
    floor_open_detail = 12

    def __int__(self) -> int:
        return self.value

cadwork.division_zone_direction (IntEnum)

Add division zone direction.

Examples:

>>> point = cadwork.point_3d(0, 0, 0)
>>> geometry_controller.create_division_zone(123456, point, division_zone_direction.positive)

Parameters:

Name	Type	Description	Default
positive	int	1	required
negative	int	-1	required
none	int	0	required

Source code in cadwork/__init__.py

@unique
class division_zone_direction(IntEnum):
    """ Add division zone direction.

    Examples:
        >>> point = cadwork.point_3d(0, 0, 0)
        >>> geometry_controller.create_division_zone(123456, point, division_zone_direction.positive)

    Args:
        positive (int): 1
        negative (int): -1
        none (int): 0
    """
    positive = 1
    negative = -1
    no_direction = 0

    def __int__(self) -> int:
        return self.value

F-Keys

cadwork.shortcut_key (IntEnum)

Shortcut key.

Examples:

>>> utility_controller.execute_shortcut(shortcut_key.F1, shortcut_key_modifier.shift)

Parameters:

Name	Type	Description	Default
F1	int	1	required
F2	int	2	required
F3	int	3	required
F4	int	4	required
F5	int	5	required
F6	int	6	required
F7	int	7	required
F8	int	8	required
F9	int	9	required
F10	int	10	required
F11	int	11	required
F12	int	12	required

Source code in cadwork/__init__.py

@unique
class shortcut_key(IntEnum):
    """Shortcut key.

    Examples:
        >>> utility_controller.execute_shortcut(shortcut_key.F1, shortcut_key_modifier.shift)

    Args:
        F1 (int): 1
        F2 (int): 2
        F3 (int): 3
        F4 (int): 4
        F5 (int): 5
        F6 (int): 6
        F7 (int): 7
        F8 (int): 8
        F9 (int): 9
        F10 (int): 10
        F11 (int): 11
        F12 (int): 12
    """
    F1 = 1
    F2 = 2
    F3 = 3
    F4 = 4
    F5 = 5
    F6 = 6
    F7 = 7
    F8 = 8
    F9 = 9
    F10 = 10
    F11 = 11
    F12 = 12

    def __int__(self) -> int:
        return self.value

cadwork.shortcut_key_modifier (IntEnum)

Shortcut key.

Examples:

>>> utility_controller.execute_shortcut(shortcut_key.F1, shortcut_key_modifier.shift)

Parameters:

Name	Type	Description	Default
no_modifier	int	0	required
shift	int	1	required
ctrl	int	2	required
alt	int	3	required

Source code in cadwork/__init__.py

@unique
class shortcut_key_modifier(IntEnum):
    """Shortcut key.

    Examples:
        >>> utility_controller.execute_shortcut(shortcut_key.F1, shortcut_key_modifier.shift)

    Args:
        no_modifier (int): 0
        shift (int): 1
        ctrl (int): 2
        alt (int): 3
    """
    no_modifier = 0
    shift = 1
    ctrl = 2
    alt = 3

    def __int__(self) -> int:
        return self.value

Machines

cadwork.btl_version (IntEnum)

BTL version.

Examples:

>>> machine_controller.export_btl(btl_version.btl_1_6, "C:\temp\test.btl")

Parameters:

Name	Type	Description	Default
btl_1_0	int	110	required
btl_1_1	int	111	required
btl_1_2	int	112	required
btl_1_3	int	113	required
btl_1_4	int	114	required
btl_1_5	int	115	required
btl_1_6	int	116	required

Source code in cadwork/__init__.py

@unique
class btl_version(IntEnum):
    """BTL version.

    Examples:
        >>> machine_controller.export_btl(btl_version.btl_1_6, "C:\\temp\\test.btl")

    Args:
        btl_1_0 (int): 110
        btl_1_1 (int): 111
        btl_1_2 (int): 112
        btl_1_3 (int): 113
        btl_1_4 (int): 114
        btl_1_5 (int): 115
        btl_1_6 (int): 116

    """
    btl_1_0 = 110
    btl_1_1 = 111
    btl_1_2 = 112
    btl_1_3 = 113
    btl_1_4 = 114
    btl_1_5 = 115
    btl_1_6 = 116

    def __int__(self) -> int:
        return self.value

cadwork.hundegger_machine_type (IntEnum)

Hundegger machine type.

Examples:

>>> machine_controller.export_hundegger(hundegger_machine_type.k2)

Parameters:

Name	Type	Description	Default
p8_10	int	1	required
k1	int	2	required
k2	int	3	required
k2_cambium	int	4	required
k2_uf_5	int	5	required
k2_uf_5_cambium	int	6	required
speedcut	int	7	required
pba	int	8	required
pba_bvx	int	9	required
pba_bvx_cambium	int	10	required
spm	int	12	required
spm_cambium	int	13	required
robot_drive	int	14	required
turbo_drive	int	15	required

Source code in cadwork/__init__.py

@unique
class hundegger_machine_type(IntEnum):
    """Hundegger machine type.

    Examples:
        >>> machine_controller.export_hundegger(hundegger_machine_type.k2)

    Args:
        p8_10 (int): 1
        k1 (int): 2
        k2 (int): 3
        k2_cambium (int): 4
        k2_uf_5 (int): 5
        k2_uf_5_cambium (int): 6
        speedcut (int): 7
        pba (int): 8
        pba_bvx (int): 9
        pba_bvx_cambium (int): 10
        spm (int): 12
        spm_cambium (int): 13
        robot_drive (int): 14
        turbo_drive (int): 15

    """

    p8_10 = 1
    k1 = 2
    k2 = 3
    k2_cambium = 4
    k2_uf_5 = 5
    k2_uf_5_cambium = 6
    speedcut = 7
    pba = 8
    pba_bvx = 9
    pba_bvx_cambium = 10
    spm = 12
    spm_cambium = 13
    robot_drive = 14
    turbo_drive = 15

    def __int__(self) -> int:
        return self.value

cadwork.weinmann_mfb_version (IntEnum)

Weinmann MFB version.

Examples:

>>> machine_controller.export_weinmann_mfb(weinmann_mfb_version.wup_2_0)

Parameters:

Name	Type	Description	Default
wup_2_0	int	20	required
wup_3_1	int	31	required
wup_3_2	int	32	required
wup_3_3	int	33	required
wup_3_4	int	34	required

Source code in cadwork/__init__.py

@unique
class weinmann_mfb_version(IntEnum):
    """Weinmann MFB version.

    Examples:
        >>> machine_controller.export_weinmann_mfb(weinmann_mfb_version.wup_2_0)

    Args:
        wup_2_0 (int): 20
        wup_3_1 (int): 31
        wup_3_2 (int): 32
        wup_3_3 (int): 33
        wup_3_4 (int): 34

    """

    wup_2_0 = 20
    wup_3_1 = 31
    wup_3_2 = 32
    wup_3_3 = 33
    wup_3_4 = 34

    def __int__(self) -> int:
        return self.value