File size: 6,386 Bytes
985c397
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# SPDX-License-Identifier: LGPL-2.1-or-later

# ***************************************************************************
# *   Copyright (c) 2009, 2010 Yorik van Havre <yorik@uncreated.net>        *
# *   Copyright (c) 2009, 2010 Ken Cline <cline@frii.com>                   *
# *   Copyright (c) 2020 FreeCAD Developers                                 *
# *                                                                         *
# *   This program is free software; you can redistribute it and/or modify  *
# *   it under the terms of the GNU Lesser General Public License (LGPL)    *
# *   as published by the Free Software Foundation; either version 2 of     *
# *   the License, or (at your option) any later version.                   *
# *   for detail see the LICENCE text file.                                 *
# *                                                                         *
# *   This program is distributed in the hope that it will be useful,       *
# *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
# *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
# *   GNU Library General Public License for more details.                  *
# *                                                                         *
# *   You should have received a copy of the GNU Library General Public     *
# *   License along with this program; if not, write to the Free Software   *
# *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
# *   USA                                                                   *
# *                                                                         *
# ***************************************************************************
"""Provides functions to create Circle objects."""
## @package make_circle
# \ingroup draftmake
# \brief Provides functions to create Circle objects.

## \addtogroup draftmake
# @{
import math

import FreeCAD as App
import Part
import DraftGeomUtils
import DraftVecUtils
import draftutils.utils as utils
import draftutils.gui_utils as gui_utils

from draftobjects.circle import Circle

if App.GuiUp:
    from draftviewproviders.view_base import ViewProviderDraft


def _get_normal(axis, ref_rot):
    local_axis = ref_rot.inverted().multVec(axis)
    x, y, z = [abs(coord) for coord in list(local_axis)]
    # Use local X, Y or Z axis for comparison:
    if z >= x and z >= y:
        local_comp_vec = App.Vector(0, 0, 1)
    elif y >= x and y >= z:
        local_comp_vec = App.Vector(0, -1, 0)  # -Y to match the Front view
    else:
        local_comp_vec = App.Vector(1, 0, 0)
    comp_vec = ref_rot.multVec(local_comp_vec)
    axis = App.Vector(axis)  # create independent copy
    if axis.getAngle(comp_vec) > math.pi / 2:
        axis = axis.negative()
    return axis


def make_circle(radius, placement=None, face=None, startangle=None, endangle=None, support=None):
    """make_circle(radius, [placement], [face], [startangle], [endangle])
    or make_circle(edge, [placement], [face]):

    Creates a circle object with given parameters.

    If startangle and endangle are provided and not equal, the object will be
    an arc instead of a full circle.

    Parameters
    ----------
    radius: the radius of the circle or the shape of a circular edge
        If it is an edge, startangle and endangle are ignored.
        edge.Curve must be a Part.Circle.

    placement: optional
        If radius is an edge, placement is adjusted to match the geometry
        of the edge. The Z axis of the adjusted placement will be parallel
        to the (negative) edge axis. Its Base will match the edge center.

    face: Bool
        If face is False, the circle is shown as a wireframe,
        otherwise as a face.

    startangle: start angle of the circle (in degrees)
        Recalculated if not in the -360 to 360 range.

    endangle: end angle of the circle (in degrees)
        Recalculated if not in the -360 to 360 range.

    support: App::PropertyLinkSubList, optional
        It defaults to `None`.
        It is a list containing tuples to define the attachment
        of the new object.

        This parameter sets the `Support` property but it only really
        affects the position of the new object if its `MapMode` is
        set to other than `'Deactivated'`.
    """

    if not App.ActiveDocument:
        App.Console.PrintError("No active document. Aborting\n")
        return

    if placement:
        utils.type_check([(placement, App.Placement)], "make_circle")

    if (isinstance(radius, Part.Edge) and len(radius.Vertexes) > 1) or startangle != endangle:
        name = "Arc"
    else:
        name = "Circle"

    obj = App.ActiveDocument.addObject("Part::Part2DObjectPython", name)

    Circle(obj)

    if face is not None:
        obj.MakeFace = face

    if isinstance(radius, Part.Edge) and DraftGeomUtils.geomType(radius) == "Circle":
        edge = radius
        obj.Radius = edge.Curve.Radius
        axis = edge.Curve.Axis
        ref_rot = App.Rotation() if placement is None else placement.Rotation
        normal = _get_normal(axis, ref_rot)
        ref_x_axis = ref_rot.multVec(App.Vector(1, 0, 0))
        ref_y_axis = ref_rot.multVec(App.Vector(0, 1, 0))
        rot = App.Rotation(ref_x_axis, ref_y_axis, normal, "ZXY")
        placement = App.Placement(edge.Curve.Center, rot)
        if len(edge.Vertexes) > 1:
            v1 = (edge.Vertexes[0].Point).sub(edge.Curve.Center)
            v2 = (edge.Vertexes[-1].Point).sub(edge.Curve.Center)
            if not axis.isEqual(normal, 1e-4):
                v1, v2 = v2, v1
            x_axis = rot.multVec(App.Vector(1, 0, 0))
            obj.FirstAngle = math.degrees(DraftVecUtils.angle(x_axis, v1, normal))
            obj.LastAngle = math.degrees(DraftVecUtils.angle(x_axis, v2, normal))
    else:
        obj.Radius = radius
        if (startangle is not None) and (endangle is not None):
            obj.FirstAngle = math.copysign(abs(startangle) % 360, startangle)
            obj.LastAngle = math.copysign(abs(endangle) % 360, endangle)

    obj.AttachmentSupport = support

    if placement:
        obj.Placement = placement

    if App.GuiUp:
        ViewProviderDraft(obj.ViewObject)
        gui_utils.format_object(obj)
        gui_utils.select(obj)

    return obj


makeCircle = make_circle

## @}