kindred/create
1
1
Fork 0
Code Issues 30 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Draft: add modules of draftviewproviders to the proper Doxygen group

Browse Source 
This includes `view_array`, `view_base`, `view_bezcurve`,
`view_bspline`, `view_circulararray`, `view_clone`, `view_dimension`,
`view_draft_annotation`, `view_draftlink`, `view_facebinder`,
`view_fillet`, `view_label`, `view_orthoarray`, `view_point`,
`view_polararray`, `view_rectangle`, `view_text`, `view_wire`,
`view_wpproxy`.

These are added to the `draftviewproviders` Doxygen group
so that the functions and classes contained in each module
are listed appropriately in the automatically generated
documentation.
This commit is contained in:
vocx-fc
2020-07-01 15:04:46 -05:00
committed by Yorik van Havre
parent 6a3de864e7
commit 08069a89eb
19 changed files with 170 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/Mod/Draft/draftviewproviders/view_array.py
View File

@@ -20,12 +20,13 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the view provider code for the Draft Array objects.
"""
"""Provides the viewprovider code for the Array object."""
## @package view_array
# \ingroup DRAFT
# \brief Provides the view provider code for the Draft Array objects.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the Array object.
## \addtogroup draftviewproviders
# @{
from draftviewproviders.view_base import ViewProviderDraft
@@ -72,4 +73,7 @@ class ViewProviderDraftArray(ViewProviderDraft):
vobj.DiffuseColor = colors
# Alias for compatibility with v0.18 and earlier
_ViewProviderDraftArray = ViewProviderDraftArray
## @}

32
src/Mod/Draft/draftviewproviders/view_base.py
View File

@@ -20,31 +20,30 @@
# * USA *
# * *
# ***************************************************************************
"""This module provides the view provider code for the base Draft object.
"""
"""Provides the viewprovider code for the base Draft object.
Many viewprovider classes may inherit this class in order to have
the same basic behavior."""
## @package view_base
# \ingroup DRAFT
# \brief This module provides the view provider code for the base Draft object.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the base Draft object.
## \addtogroup draftviewproviders
# @{
import PySide.QtCore as QtCore
from PySide.QtCore import QT_TRANSLATE_NOOP
import FreeCAD as App
import draftutils.utils as utils
import draftutils.gui_utils as gui_utils
if App.GuiUp:
from pivy import coin
import FreeCADGui as Gui
import Draft_rc
# The module is used to prevent complaints from code checkers (flake8)
bool(Draft_rc.__name__)
import draftutils.utils as utils
import draftutils.gui_utils as gui_utils
#import Draft_rc
# from DraftGui import translate
# from DraftGui import displayExternal
# So the resource file doesn't trigger errors from code checkers (flake8)
#True if Draft_rc.__name__ else False
class ViewProviderDraft(object):
"""The base class for Draft view providers.
@@ -491,6 +490,7 @@ class ViewProviderDraft(object):
return objs
# Alias for compatibility with v0.18 and earlier
_ViewProviderDraft = ViewProviderDraft
@@ -508,6 +508,7 @@ class ViewProviderDraftAlt(ViewProviderDraft):
return objs
# Alias for compatibility with v0.18 and earlier
_ViewProviderDraftAlt = ViewProviderDraftAlt
@@ -524,4 +525,7 @@ class ViewProviderDraftPart(ViewProviderDraftAlt):
return ":/icons/Tree_Part.svg"
# Alias for compatibility with v0.18 and earlier
_ViewProviderDraftPart = ViewProviderDraftPart
## @}

13
src/Mod/Draft/draftviewproviders/view_bezcurve.py
View File

@@ -18,16 +18,18 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the view provider code for Bezier curve objects.
"""Provides the viewprovider code for the BezCurve object.
At the moment this view provider subclasses the Wire view provider,
and behaves the same as it. In the future this could change
if another behavior is desired.
"""
## @package view_bezier
# \ingroup DRAFT
# \brief Provides the view provider code for Bezier curve objects.
## @package view_bezcurve
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the BezCurve object.
## \addtogroup draftviewproviders
# @{
from draftviewproviders.view_wire import ViewProviderWire
@@ -38,4 +40,7 @@ class ViewProviderBezCurve(ViewProviderWire):
super(ViewProviderBezCurve, self).__init__(vobj)
# Alias for compatibility with v0.18 and earlier
_ViewProviderBezCurve = ViewProviderBezCurve
## @}

9
src/Mod/Draft/draftviewproviders/view_bspline.py
View File

@@ -18,16 +18,18 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the view provider code for BSpline objects.
"""Provides the viewprovider code for the BSpline object.
At the moment this view provider subclasses the Wire view provider,
and behaves the same as it. In the future this could change
if another behavior is desired.
"""
## @package view_bspline
# \ingroup DRAFT
# \ingroup draftviewproviders
# \brief Provides the view provider code for BSpline objects.
## \addtogroup draftviewproviders
# @{
from draftviewproviders.view_wire import ViewProviderWire
@@ -38,4 +40,7 @@ class ViewProviderBSpline(ViewProviderWire):
super(ViewProviderBSpline, self).__init__(vobj)
# Alias for compatibility with v0.18 and earlier
_ViewProviderBSpline = ViewProviderBSpline
## @}

13
src/Mod/Draft/draftviewproviders/view_circulararray.py
View File

@@ -20,16 +20,19 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the view provider code for the circular array object.
"""Provides the viewprovider code for the circular Array object.
Currently unused.
"""
## @package view_circulararray
# \ingroup DRAFT
# \brief Provides the view provider code for the circular array object.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the circular Array object.
## \addtogroup draftviewproviders
# @{
import Draft_rc
from Draft import _ViewProviderDraftArray as ViewProviderDraftArray
from draftviewproviders.view_array import ViewProviderDraftArray
# The module is used to prevent complaints from code checkers (flake8)
True if Draft_rc.__name__ else False
@@ -44,3 +47,5 @@ class ViewProviderCircularArray(ViewProviderDraftArray):
def getIcon(self):
"""Set the icon in the tree view."""
return ":/icons/Draft_CircularArray"
## @}

12
src/Mod/Draft/draftviewproviders/view_clone.py
View File

@@ -20,12 +20,13 @@
# * USA *
# * *
# ***************************************************************************
"""This module provides the view provider code for the Draft Clone object.
"""
"""Provides the viewprovider code for the Clone object."""
## @package view_clone
# \ingroup DRAFT
# \brief This module provides the view provider code for the Draft Clone object.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the Clone object.
## \addtogroup draftviewproviders
# @{
import draftutils.groups as groups
@@ -77,4 +78,7 @@ class ViewProviderClone:
vobj.DiffuseColor = colors
# Alias for compatibility with v0.18 and earlier
_ViewProviderClone = ViewProviderClone
## @}

11
src/Mod/Draft/draftviewproviders/view_dimension.py
View File

@@ -22,15 +22,15 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the Draft Dimension viewprovider classes.
"""Provides the viewprovider code for the Dimension objects.
These include linear dimensions, including radius and diameter,
as well as angular dimensions.
They inherit their behavior from the base Annotation viewprovider.
"""
## @package view_dimension
# \ingroup DRAFT
# \brief Provides the Draft Dimension viewprovider classes.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the Dimension objects.
import pivy.coin as coin
import lazy_loader.lazy_loader as lz
@@ -49,6 +49,9 @@ from draftviewproviders.view_draft_annotation \
Part = lz.LazyLoader("Part", globals(), "Part")
DraftGeomUtils = lz.LazyLoader("DraftGeomUtils", globals(), "DraftGeomUtils")
## \addtogroup draftviewproviders
# @{
class ViewProviderDimensionBase(ViewProviderDraftAnnotation):
"""The base viewprovider for the Draft Dimensions object.
@@ -1273,3 +1276,5 @@ class ViewProviderAngularDimension(ViewProviderDimensionBase):
# Alias for compatibility with v0.18 and earlier
_ViewProviderAngularDimension = ViewProviderAngularDimension
## @}

10
src/Mod/Draft/draftviewproviders/view_draft_annotation.py
View File

@@ -21,7 +21,7 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the base class for many annotation viewproviders.
"""Provides the viewprovider code for all annotation type objects.
This is inherited and used by many viewproviders that show dimensions
and text created on screen through Coin (pivy).
@@ -34,9 +34,11 @@ and text created on screen through Coin (pivy).
Its edit mode launches the `Draft_Edit` command.
"""
## @package view_draft_annotation
# \ingroup DRAFT
# \brief Provides the base class for many annotation viewproviders.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for all annotation type objects.
## \addtogroup draftviewproviders
# @{
import json
from PySide.QtCore import QT_TRANSLATE_NOOP
@@ -233,3 +235,5 @@ class ViewProviderDraftAnnotation(object):
objs.extend(self.Object.Group)
return objs
## @}

15
src/Mod/Draft/draftviewproviders/view_draftlink.py
View File

@@ -20,11 +20,13 @@
# * USA *
# * *
# ***************************************************************************
"""This module provides the view provider code for the Draft Link object.
"""
"""Provides the base viewprovider code for the Link objects."""
## @package view_draftlink
# \ingroup DRAFT
# \brief This module provides the view provider code for the Draft Link object.
# \ingroup draftviewproviders
# \brief Provides the base viewprovider code for the Link objects.
## \addtogroup draftviewproviders
# @{
class ViewProviderDraftLink:
@@ -66,6 +68,9 @@ class ViewProviderDraftLink:
return [obj.Base]
else:
return obj.ElementList
# Alias for compatibility with old versions of v0.19
_ViewProviderDraftLink = ViewProviderDraftLink
## @}

12
src/Mod/Draft/draftviewproviders/view_facebinder.py
View File

@@ -20,12 +20,13 @@
# * USA *
# * *
# ***************************************************************************
"""This module provides the view provider code for Draft Facebinder object.
"""
"""Provides the viewprovider code for the Facebinder object."""
## @package view_facebinder
# \ingroup DRAFT
# \brief This module provides the view provider code for Draft Facebinder
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the Facebinder object.
## \addtogroup draftviewproviders
# @{
import FreeCAD as App
import FreeCADGui as Gui
@@ -53,4 +54,7 @@ class ViewProviderFacebinder(ViewProviderDraft):
return False
# Alias for compatibility with v0.18 and earlier
_ViewProviderFacebinder = ViewProviderFacebinder
## @}

10
src/Mod/Draft/draftviewproviders/view_fillet.py
View File

@@ -18,16 +18,18 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the view provider code for Fillet objects.
"""Provides the viewprovider code for the Fillet object.
At the moment this view provider subclasses the Wire view provider,
and behaves the same as it. In the future this could change
if another behavior is desired.
"""
## @package view_fillet
# \ingroup DRAFT
# \brief Provides the view provider code for Fillet objects.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the Fillet object.
## \addtogroup draftviewproviders
# @{
from draftviewproviders.view_wire import ViewProviderWire
@@ -36,3 +38,5 @@ class ViewProviderFillet(ViewProviderWire):
def __init__(self, vobj):
super(ViewProviderFillet, self).__init__(vobj)
## @}

10
src/Mod/Draft/draftviewproviders/view_label.py
View File

@@ -22,11 +22,13 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the viewprovider class for the Draft Label object."""
"""Provides the viewprovider code for the Label object."""
## @package view_label
# \ingroup DRAFT
# \brief Provides the viewprovider class for the Draft Label object.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the Label object.
## \addtogroup draftviewproviders
# @{
import math
import sys
import pivy.coin as coin
@@ -527,3 +529,5 @@ class ViewProviderLabel(ViewProviderDraftAnnotation):
# Alias for compatibility with v0.18 and earlier
ViewProviderDraftLabel = ViewProviderLabel
## @}

13
src/Mod/Draft/draftviewproviders/view_orthoarray.py
View File

@@ -20,16 +20,19 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the view provider code for the ortho array object.
"""Provides the viewprovider code for the orthogonal Array object.
Currently unused.
"""
## @package view_orthoarray
# \ingroup DRAFT
# \brief Provides the view provider code for the ortho array object.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the orthogonal Array object.
## \addtogroup draftviewproviders
# @{
import Draft_rc
from Draft import _ViewProviderDraftArray as ViewProviderDraftArray
from draftviewproviders.view_array import ViewProviderDraftArray
# The module is used to prevent complaints from code checkers (flake8)
True if Draft_rc.__name__ else False
@@ -44,3 +47,5 @@ class ViewProviderOrthoArray(ViewProviderDraftArray):
def getIcon(self):
"""Set the icon in the tree view."""
return ":/icons/Draft_Array"
## @}

12
src/Mod/Draft/draftviewproviders/view_point.py
View File

@@ -20,12 +20,13 @@
# * USA *
# * *
# ***************************************************************************
"""This module provides the view provider code for Draft Point.
"""
"""Provides the viewprovider code for the Point object."""
## @package view_point
# \ingroup DRAFT
# \brief This module provides the view provider code for Draft Point.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the Point object.
## \addtogroup draftviewproviders
# @{
from draftviewproviders.view_base import ViewProviderDraft
@@ -52,4 +53,7 @@ class ViewProviderPoint(ViewProviderDraft):
return ":/icons/Draft_Dot.svg"
# Alias for compatibility with v0.18 and earlier
_ViewProviderPoint = ViewProviderPoint
## @}

13
src/Mod/Draft/draftviewproviders/view_polararray.py
View File

@@ -20,16 +20,19 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the view provider code for the polar array object.
"""Provides the viewprovider code for the polar Array object.
Currently unused.
"""
## @package view_polararray
# \ingroup DRAFT
# \brief Provides the view provider code for the polar array object.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the polar Array object.
## \addtogroup draftviewproviders
# @{
import Draft_rc
from Draft import _ViewProviderDraftArray as ViewProviderDraftArray
from draftviewproviders.view_array import ViewProviderDraftArray
# The module is used to prevent complaints from code checkers (flake8)
True if Draft_rc.__name__ else False
@@ -44,3 +47,5 @@ class ViewProviderPolarArray(ViewProviderDraftArray):
def getIcon(self):
"""Set the icon in the tree view."""
return ":/icons/Draft_PolarArray"
## @}

12
src/Mod/Draft/draftviewproviders/view_rectangle.py
View File

@@ -20,12 +20,13 @@
# * USA *
# * *
# ***************************************************************************
"""This module provides the view provider code for the Draft Rectangle object.
"""
"""Provides the viewprovider code for the Rectangle object."""
## @package view_rectangle
# \ingroup DRAFT
# \brief This module provides the view provider code for the Draft Rectangle object.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the Rectangle object.
## \addtogroup draftviewproviders
# @{
from PySide.QtCore import QT_TRANSLATE_NOOP
from draftviewproviders.view_base import ViewProviderDraft
@@ -41,4 +42,7 @@ class ViewProviderRectangle(ViewProviderDraft):
"Draft", QT_TRANSLATE_NOOP("App::Property", _tip))
# Alias for compatibility with v0.18 and earlier
_ViewProviderRectangle = ViewProviderRectangle
## @}

15
src/Mod/Draft/draftviewproviders/view_text.py
View File

@@ -22,23 +22,22 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the Draft Text viewprovider class."""
"""Provides the viewprovider code for the Text object."""
## @package view_text
# \ingroup DRAFT
# \brief Provides the Draft Text viewprovider class.
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the Text object.
## \addtogroup draftviewproviders
# @{
import pivy.coin as coin
import sys
from PySide.QtCore import QT_TRANSLATE_NOOP
import FreeCAD as App
import draftutils.utils as utils
from draftviewproviders.view_draft_annotation \
import ViewProviderDraftAnnotation
param = App.ParamGet("User parameter:BaseApp/Preferences/Mod/Draft")
class ViewProviderText(ViewProviderDraftAnnotation):
"""Viewprovider for the Draft Text annotation."""
@@ -226,3 +225,5 @@ class ViewProviderText(ViewProviderDraftAnnotation):
# Alias for compatibility with v0.18 and earlier
ViewProviderDraftText = ViewProviderText
## @}

20
src/Mod/Draft/draftviewproviders/view_wire.py
View File

@@ -20,15 +20,17 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the viewprovider code for polyline and similar objects.
"""Provides the viewprovider code for the Wire (polyline) object.
This viewprovider is also used by simple lines, B-splines, bezier curves,
and similar objects.
"""
## @package view_base
# \ingroup DRAFT
# \brief Provides the viewprovider code for polyline and similar objects.
## @package view_wire
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the Wire (polyline) object.
## \addtogroup draftviewproviders
# @{
import pivy.coin as coin
import PySide.QtCore as QtCore
import PySide.QtGui as QtGui
@@ -36,13 +38,12 @@ from PySide.QtCore import QT_TRANSLATE_NOOP
import FreeCAD as App
import FreeCADGui as Gui
import draftutils.utils as utils
import draftutils.gui_utils as gui_utils
import DraftVecUtils
import DraftGeomUtils
from draftutils.messages import _msg
import draftutils.utils as utils
import draftutils.gui_utils as gui_utils
from draftutils.messages import _msg
from draftviewproviders.view_base import ViewProviderDraft
@@ -173,4 +174,7 @@ class ViewProviderWire(ViewProviderDraft):
_msg(QT_TRANSLATE_NOOP("Draft", _flat))
# Alias for compatibility with v0.18 and earlier
_ViewProviderWire = ViewProviderWire
## @}

19
src/Mod/Draft/draftviewproviders/view_wpproxy.py
View File

@@ -20,17 +20,16 @@
# * USA *
# * *
# ***************************************************************************
"""This module provides the view provider code for Draft WorkingPlaneProxy
object.
"""
"""Provides the viewprovider code for the WorkingPlaneProxy object."""
## @package view_wpproxy
# \ingroup DRAFT
# \brief This module provides the view provider code for Draft WorkingPlaneProxy.
from pivy import coin
from PySide import QtCore
from PySide import QtGui
# \ingroup draftviewproviders
# \brief Provides the viewprovider code for the WorkingPlaneProxy object.
## \addtogroup draftviewproviders
# @{
import pivy.coin as coin
import PySide.QtCore as QtCore
import PySide.QtGui as QtGui
from PySide.QtCore import QT_TRANSLATE_NOOP
import FreeCAD as App
@@ -232,3 +231,5 @@ class ViewProviderWorkingPlaneProxy:
def __setstate__(self,state):
return None
## @}