Merge pull request #9687 from Roy-043/Arch-more-consistent-object-nam…

…ing-and-labelling

Arch: more consistent object naming and labelling

src/Mod/Arch/ArchAxis.py

@@ -55,16 +55,16 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 #  An axis is a collection of planar axes with a number/tag
 
 
-def makeAxis(num=5,size=1000,name="Axes"):
+def makeAxis(num=5,size=1000,name=None):
 
-    '''makeAxis(num,size): makes an Axis set
+    '''makeAxis([num],[size],[name]): makes an Axis set
     based on the given number of axes and interval distances'''
 
     if not FreeCAD.ActiveDocument:
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
     obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Axis")
-    obj.Label = translate("Arch",name)
+    obj.Label = name if name else translate("Arch","Axes")
     _Axis(obj)
     if FreeCAD.GuiUp:
         _ViewProviderAxis(obj.ViewObject)

src/Mod/Arch/ArchAxisSystem.py

@@ -48,14 +48,14 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 #  An axis system is a collection of multiple axes
 
 
-def makeAxisSystem(axes,name="Axis System"):
+def makeAxisSystem(axes,name=None):
 
-    '''makeAxisSystem(axes): makes a system from the given list of axes'''
+    '''makeAxisSystem(axes,[name]): makes a system from the given list of axes'''
 
     if not isinstance(axes,list):
         axes = [axes]
     obj = FreeCAD.ActiveDocument.addObject("App::FeaturePython","AxisSystem")
-    obj.Label = translate("Arch",name)
+    obj.Label = name if name else translate("Arch","Axis System")
     _AxisSystem(obj)
     obj.Axes = axes
     if FreeCAD.GuiUp:

src/Mod/Arch/ArchBuilding.py

@@ -190,21 +190,22 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 ]
 
 
-def makeBuilding(objectslist=None,baseobj=None,name="Building"):
+def makeBuilding(objectslist=None,name=None):
+    '''Obsolete, superseded by ArchBuildingPart.makeBuilding.
 
-    '''makeBuilding(objectslist): creates a building including the
+    makeBuilding([objectslist],[name]): creates a building including the
     objects from the given list.'''
 
     if not FreeCAD.ActiveDocument:
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
     obj = FreeCAD.ActiveDocument.addObject("App::DocumentObjectGroupPython","Building")
+    obj.Label = name if name else translate("Arch","Building")
     _Building(obj)
     if FreeCAD.GuiUp:
         _ViewProviderBuilding(obj.ViewObject)
     if objectslist:
         obj.Group = objectslist
-    obj.Label = translate("Arch",name)
     return obj
 
 

src/Mod/Arch/ArchBuildingPart.py

@@ -195,14 +195,14 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 ]
 
 
-def makeBuildingPart(objectslist=None,baseobj=None,name="BuildingPart"):
+def makeBuildingPart(objectslist=None,baseobj=None,name=None):
 
-    '''makeBuildingPart(objectslist): creates a buildingPart including the
+    '''makeBuildingPart([objectslist],[name]): creates a buildingPart including the
     objects from the given list.'''
 
     obj = FreeCAD.ActiveDocument.addObject("App::GeometryPython","BuildingPart")
     #obj = FreeCAD.ActiveDocument.addObject("App::FeaturePython","BuildingPart")
-    obj.Label = translate("Arch","BuildingPart")
+    obj.Label = name if name else translate("Arch","BuildingPart")
     BuildingPart(obj)
     obj.IfcType = "Building Element Part"
     if FreeCAD.GuiUp:
@@ -212,22 +212,22 @@ def makeBuildingPart(objectslist=None,baseobj=None,name="BuildingPart"):
     return obj
 
 
-def makeFloor(objectslist=None,baseobj=None,name="Floor"):
+def makeFloor(objectslist=None,baseobj=None,name=None):
 
     """overwrites ArchFloor.makeFloor"""
 
     obj = makeBuildingPart(objectslist)
-    obj.Label = name
+    obj.Label = name if name else translate("Arch","Floor")
     obj.IfcType = "Building Storey"
     return obj
 
 
-def makeBuilding(objectslist=None,baseobj=None,name="Building"):
+def makeBuilding(objectslist=None,baseobj=None,name=None):
 
     """overwrites ArchBuilding.makeBuilding"""
 
     obj = makeBuildingPart(objectslist)
-    obj.Label = name
+    obj.Label = name if name else translate("Arch","Building")
     obj.IfcType = "Building"
     obj.addProperty("App::PropertyEnumeration","BuildingType","Building",QT_TRANSLATE_NOOP("App::Property","The type of this building"))
     obj.BuildingType = BuildingTypes

src/Mod/Arch/ArchCommands.py

@@ -205,14 +205,14 @@ def removeComponents(objectsList,host=None):
                         a.remove(o)
                         h.Objects = a
 
-def makeComponent(baseobj=None,name="Component",delete=False):
-    '''makeComponent([baseobj]): creates an undefined, non-parametric Arch
+def makeComponent(baseobj=None,name=None,delete=False):
+    '''makeComponent([baseobj],[name],[delete]): creates an undefined, non-parametric Arch
     component from the given base object'''
     if not FreeCAD.ActiveDocument:
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
     obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Component")
-    obj.Label = translate("Arch",name)
+    obj.Label = name if name else translate("Arch","Component")
     ArchComponent.Component(obj)
     if FreeCAD.GuiUp:
         ArchComponent.ViewProviderComponent(obj.ViewObject)

src/Mod/Arch/ArchCurtainWall.py

@@ -69,17 +69,17 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 """
 
 
-def makeCurtainWall(baseobj=None,name="Curtain Wall"):
+def makeCurtainWall(baseobj=None,name=None):
 
     """
-    makeCurtainWall([baseobj]): Creates a curtain wall in the active document
+    makeCurtainWall([baseobj],[name]): Creates a curtain wall in the active document
     """
 
     if not FreeCAD.ActiveDocument:
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
     obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","CurtainWall")
-    obj.Label = translate("Arch","Curtain Wall")
+    obj.Label = name if name else translate("Arch","Curtain Wall")
     CurtainWall(obj)
     if FreeCAD.GuiUp:
         ViewProviderCurtainWall(obj.ViewObject)

src/Mod/Arch/ArchEquipment.py

@@ -49,20 +49,20 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 #  or hydraulic appliances in a building
 
 
-def makeEquipment(baseobj=None,placement=None,name="Equipment"):
+def makeEquipment(baseobj=None,placement=None,name=None):
 
-    "makeEquipment([baseobj,placement,name]): creates an equipment object from the given base object."
+    "makeEquipment([baseobj],[placement],[name]): creates an equipment object from the given base object."
     if not FreeCAD.ActiveDocument:
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
     obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Equipment")
+    obj.Label = name if name else translate("Arch","Equipment")
     _Equipment(obj)
     if baseobj:
         if baseobj.isDerivedFrom("Mesh::Feature"):
             obj.Mesh = baseobj
         else:
             obj.Base = baseobj
-    obj.Label = translate("Arch",name)
     if placement:
         obj.Placement = placement
     if FreeCAD.GuiUp:

src/Mod/Arch/ArchFloor.py

@@ -57,7 +57,7 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 __author__ = "Yorik van Havre"
 __url__    = "https://www.freecad.org"
 
-def makeFloor(objectslist=None,baseobj=None,name="Floor"):
+def makeFloor(objectslist=None,baseobj=None,name=None):
     """Obsolete, superseded by ArchBuildingPart.makeFloor.
 
     Create a floor.
@@ -84,8 +84,8 @@ def makeFloor(objectslist=None,baseobj=None,name="Floor"):
     if not FreeCAD.ActiveDocument:
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
-    obj = FreeCAD.ActiveDocument.addObject("App::DocumentObjectGroupPython",name)
-    obj.Label = translate("Arch",name)
+    obj = FreeCAD.ActiveDocument.addObject("App::DocumentObjectGroupPython","Floor")
+    obj.Label = name if name else translate("Arch","Floor")
     _Floor(obj)
     if FreeCAD.GuiUp:
         _ViewProviderFloor(obj.ViewObject)

src/Mod/Arch/ArchFrame.py

@@ -48,7 +48,7 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 __url__    = "https://www.freecad.org"
 
 
-def makeFrame(baseobj,profile,name=translate("Arch","Frame")):
+def makeFrame(baseobj,profile,name=None):
 
     """makeFrame(baseobj,profile,[name]): creates a frame object from a base sketch (or any other object
     containing wires) and a profile object (an extrudable 2D object containing faces or closed wires)"""
@@ -57,7 +57,7 @@ def makeFrame(baseobj,profile,name=translate("Arch","Frame")):
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
     obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Frame")
-    obj.Label = translate("Arch",name)
+    obj.Label = name if name else translate("Arch","Frame")
     _Frame(obj)
     if FreeCAD.GuiUp:
         _ViewProviderFrame(obj.ViewObject)

src/Mod/Arch/ArchGrid.py

@@ -47,12 +47,12 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 #  This module provides tools to build grid systems
 
 
-def makeGrid(name="Grid"):
+def makeGrid(name=None):
 
-    '''makeGrid(): makes a grid object'''
+    '''makeGrid([name]): makes a grid object'''
 
     obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Grid")
-    obj.Label = translate("Arch",name)
+    obj.Label = name if name else translate("Arch","Grid")
     ArchGrid(obj)
     if FreeCAD.GuiUp:
         ViewProviderArchGrid(obj.ViewObject)

src/Mod/Arch/ArchMaterial.py

@@ -45,14 +45,14 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 #  This module provides tools to add materials to
 #  Arch objects
 
-def makeMaterial(name="Material",color=None,transparency=None):
+def makeMaterial(name=None,color=None,transparency=None):
 
-    '''makeMaterial(name): makes an Material object'''
+    '''makeMaterial([name],[color],[transparency]): makes an Material object'''
     if not FreeCAD.ActiveDocument:
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
     obj = FreeCAD.ActiveDocument.addObject("App::MaterialObjectPython","Material")
-    obj.Label = name
+    obj.Label = name if name else translate("Arch","Material")
     _ArchMaterial(obj)
     if FreeCAD.GuiUp:
         _ViewProviderArchMaterial(obj.ViewObject)
@@ -80,11 +80,11 @@ def getMaterialContainer():
     return obj
 
 
-def makeMultiMaterial(name="MultiMaterial"):
+def makeMultiMaterial(name=None):
 
-    '''makeMultiMaterial(name): makes an Material object'''
+    '''makeMultiMaterial([name]): makes an MultiMaterial object'''
     obj = FreeCAD.ActiveDocument.addObject("App::FeaturePython","MultiMaterial")
-    obj.Label = name
+    obj.Label = name if name else translate("Arch","MultiMaterial")
     _ArchMultiMaterial(obj)
     if FreeCAD.GuiUp:
         _ViewProviderArchMultiMaterial(obj.ViewObject)

src/Mod/Arch/ArchPanel.py

@@ -68,9 +68,9 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 
 
 
-def makePanel(baseobj=None,length=0,width=0,thickness=0,placement=None,name="Panel"):
+def makePanel(baseobj=None,length=0,width=0,thickness=0,placement=None,name=None):
 
-    '''makePanel([obj],[length],[width],[thickness],[placement]): creates a
+    '''makePanel([baseobj],[length],[width],[thickness],[placement],[name]): creates a
     panel element based on the given profile object and the given
     extrusion thickness. If no base object is given, you can also specify
     length and width for a simple cubic object.'''
@@ -79,7 +79,7 @@ def makePanel(baseobj=None,length=0,width=0,thickness=0,placement=None,name="Pan
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
     obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Panel")
-    obj.Label = translate("Arch",name)
+    obj.Label = name if name else translate("Arch","Panel")
     _Panel(obj)
     if FreeCAD.GuiUp:
         _ViewProviderPanel(obj.ViewObject)
@@ -96,26 +96,27 @@ def makePanel(baseobj=None,length=0,width=0,thickness=0,placement=None,name="Pan
     return obj
 
 
-def makePanelCut(panel,name="PanelCut"):
+def makePanelCut(panel,name=None):
 
-    """makePanelCut(panel) : Creates a 2D view of the given panel
+    """makePanelCut(panel,[name]) : Creates a 2D view of the given panel
     in the 3D space, positioned at the origin."""
 
-    view = FreeCAD.ActiveDocument.addObject("Part::FeaturePython",name)
+    view = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","PanelCut")
+    view.Label = name if name else translate("Arch","View of")+" "+panel.Label
     PanelCut(view)
     view.Source = panel
-    view.Label = translate("Arch","View of")+" "+panel.Label
     if FreeCAD.GuiUp:
         ViewProviderPanelCut(view.ViewObject)
     return view
 
 
-def makePanelSheet(panels=[],name="PanelSheet"):
+def makePanelSheet(panels=[],name=None):
 
-    """makePanelSheet([panels]) : Creates a sheet with the given panel cuts
+    """makePanelSheet([panels],[name]) : Creates a sheet with the given panel cuts
     in the 3D space, positioned at the origin."""
 
-    sheet = FreeCAD.ActiveDocument.addObject("Part::FeaturePython",name)
+    sheet = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","PanelSheet")
+    sheet.Label = name if name else translate("Arch","PanelSheet")
     PanelSheet(sheet)
     if panels:
         sheet.Group = panels

src/Mod/Arch/ArchPipe.py

@@ -47,15 +47,15 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 __url__    = "https://www.freecad.org"
 
 
-def makePipe(baseobj=None,diameter=0,length=0,placement=None,name="Pipe"):
+def makePipe(baseobj=None,diameter=0,length=0,placement=None,name=None):
 
-    "makePipe([baseobj,diamerter,length,placement,name]): creates an pipe object from the given base object"
+    "makePipe([baseobj],[diameter],[length],[placement],[name]): creates an pipe object from the given base object"
 
     if not FreeCAD.ActiveDocument:
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
-    obj= FreeCAD.ActiveDocument.addObject("Part::FeaturePython",name)
-    obj.Label = name
+    obj= FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Pipe")
+    obj.Label = name if name else translate("Arch","Pipe")
     _ArchPipe(obj)
     if FreeCAD.GuiUp:
         _ViewProviderPipe(obj.ViewObject)
@@ -78,15 +78,15 @@ def makePipe(baseobj=None,diameter=0,length=0,placement=None,name="Pipe"):
     return obj
 
 
-def makePipeConnector(pipes,radius=0,name="Connector"):
+def makePipeConnector(pipes,radius=0,name=None):
 
-    "makePipeConnector(pipes,[radius,name]): creates a connector between the given pipes"
+    "makePipeConnector(pipes,[radius],[name]): creates a connector between the given pipes"
 
     if not FreeCAD.ActiveDocument:
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
-    obj= FreeCAD.ActiveDocument.addObject("Part::FeaturePython",name)
-    obj.Label = name
+    obj= FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Connector")
+    obj.Label = name if name else translate("Arch","Connector")
     _ArchPipeConnector(obj)
     obj.Pipes = pipes
     if not radius:

src/Mod/Arch/ArchProject.py

@@ -48,7 +48,7 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 __author__ = "Yorik van Havre"
 __url__    = "https://www.freecad.org"
 
-def makeProject(sites=None, name="Project"):
+def makeProject(sites=None, name=None):
     """Create an Arch project.
 
     If sites are provided, add them as children of the new project.
@@ -72,7 +72,7 @@ def makeProject(sites=None, name="Project"):
 
     import Part
     obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython", "Project")
-    obj.Label = translate("Arch", name)
+    obj.Label = name if name else translate("Arch", "Project")
     _Project(obj)
     if FreeCAD.GuiUp:
         _ViewProviderProject(obj.ViewObject)

src/Mod/Arch/ArchRebar.py

@@ -50,17 +50,17 @@ def QT_TRANSLATE_NOOP(ctxt,txt):
 __url__    = "https://www.freecad.org"
 
 
-def makeRebar(baseobj=None,sketch=None,diameter=None,amount=1,offset=None,name="Rebar"):
+def makeRebar(baseobj=None,sketch=None,diameter=None,amount=1,offset=None,name=None):
 
-    """makeRebar([baseobj,sketch,diameter,amount,offset,name]): adds a Reinforcement Bar object
+    """makeRebar([baseobj],[sketch],[diameter],[amount],[offset],[name]): adds a Reinforcement Bar object
     to the given structural object, using the given sketch as profile."""
 
     if not FreeCAD.ActiveDocument:
         FreeCAD.Console.PrintError("No active document. Aborting\n")
         return
     p = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Mod/Arch")
     obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","Rebar")
-    obj.Label = translate("Arch",name)
+    obj.Label = name if name else translate("Arch","Rebar")
     _Rebar(obj)
     if FreeCAD.GuiUp:
         _ViewProviderRebar(obj.ViewObject)