File size: 3,617 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 | # 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 Point objects."""
## @package make_point
# \ingroup draftmake
# \brief Provides functions to create Point objects.
## \addtogroup draftmake
# @{
import FreeCAD as App
import draftutils.gui_utils as gui_utils
from draftobjects.point import Point
if App.GuiUp:
import FreeCADGui as Gui
from draftviewproviders.view_point import ViewProviderPoint
def make_point(X=0, Y=0, Z=0, color=None, name="Point", point_size=5):
"""make_point(x, y, z, [color(r, g, b), point_size]) or
make_point(Vector, color(r, g, b), point_size])
Creates a Draft Point in the current document.
Parameters
----------
X :
float -> X coordinate of the point
Base.Vector -> Ignore Y and Z coordinates and create the point
from the vector.
Y : float
Y coordinate of the point
Z : float
Z coordinate of the point
color : (R, G, B)
Point color as RGB
example to create a colored point:
make_point(0, 0, 0, (1, 0, 0)) # color = red
example to change the color, make sure values are floats:
p1.ViewObject.PointColor = (0.0, 0.0, 1.0)
"""
if not App.ActiveDocument:
App.Console.PrintError("No active document. Aborting\n")
return
obj = App.ActiveDocument.addObject("Part::FeaturePython", name)
if isinstance(X, App.Vector):
Z = X.z
Y = X.y
X = X.x
Point(obj, X, Y, Z)
obj.Placement.Base = App.Vector(X, Y, Z)
if App.GuiUp:
ViewProviderPoint(obj.ViewObject)
gui_utils.formatObject(obj)
if color is not None:
obj.ViewObject.PointColor = (float(color[0]), float(color[1]), float(color[2]))
obj.ViewObject.PointSize = point_size
gui_utils.select(obj)
return obj
makePoint = make_point
## @}
|