Draft Downgrade: Difference between revisions

From FreeCAD Documentation
(Button text.)
 
(61 intermediate revisions by 10 users not shown)
Line 1: Line 1:
<languages/>
{{GuiCommand|Name=Draft_Downgrade|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]|MenuLocation=Draft -> Downgrade|Shortcut=D N|SeeAlso=[[Draft Upgrade]]}}
<translate>


<!--T:19-->
==Description==
{{Docnav
|[[Draft_Upgrade|Upgrade]]
|[[Draft_WireToBSpline|WireToBSpline]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Upgrade.svg
|IconR=Draft_WireToBSpline.svg
|IconC=Workbench_Draft.svg
}}


<!--T:1-->
This tool downgrades selected objects in different ways. If no object is selected, you will be invited to select one.
{{GuiCommand
|Name=Draft Downgrade
|MenuLocation=Modification → Downgrade
|Workbenches=[[Draft_Workbench|Draft]], [[Arch_Workbench|Arch]]
|Shortcut={{KEY|D}} {{KEY|N}}
|SeeAlso=[[Draft_Upgrade|Draft Upgrade]], [[Part_Cut|Part Cut]]
}}


==Description== <!--T:2-->

<!--T:3-->
The [[Image:Draft_Downgrade.svg|24px]] '''Draft Downgrade''' command downgrades selected objects. The result depends on the number of selected objects and their type. The command can for example deconstruct a 3D solid into separate faces and a wire into separate edges. If two face are selected a [[Part_Cut|Part Cut]] object is created from them. Note that not all objects can be downgraded. This command is the counterpart of the [[Draft_Upgrade|Draft Upgrade]] command.

</translate>
[[Image:Draft_Downgrade_example.jpg|400px]]
[[Image:Draft_Downgrade_example.jpg|400px]]
<translate>
<!--T:16-->
{{Caption|Two overlapping faces are downgraded to a Part Cut object, which is downgraded to a face. That face is then downgraded to a closed wire, which is finally downgraded to separate edges.}}

==Usage== <!--T:4-->

<!--T:5-->
# Optionally select one or more objects.
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Draft_Downgrade.svg|16px]] [[Draft_Downgrade|Downgrade]]}} button.
#* Select the {{MenuCommand|Modification → [[Image:Draft_Downgrade.svg|16px]] Downgrade}} option from the menu.
#* Use the keyboard shortcut: {{KEY|D}} then {{KEY|N}}.
# If you have not yet selected an object: select an object in the [[3D_view|3D view]].

==Scripting== <!--T:22-->

<!--T:10-->
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].

<!--T:11-->
To downgrade objects use the {{incode|downgrade}} method of the Draft module.

</translate>
{{Code|code=
downgrade_list = downgrade(objects, delete=False, force=None)
}}
<translate>

<!--T:12-->
* {{incode|objects}} contains the objects to be downgraded. It is either a single object or a list of objects.
* If {{incode|delete}} is {{incode|True}} the source objects are deleted.
* {{incode|force}} forces a certain way of downgrading by calling a specific internal function. It can be: {{incode|"explode"}}, {{incode|"shapify"}}, {{incode|"subtr"}}, {{incode|"splitFaces"}}, {{incode|"cut2"}}, {{incode|"getWire"}}, {{incode|"splitWires"}} or {{incode|"splitCompounds"}}.
* {{incode|downgrade_list}} is returned. It is a list containing two lists: a list of new objects and a list of objects to be deleted. If {{incode|delete}} is {{incode|True}} the second list is empty.

<!--T:13-->
Example:

</translate>
{{Code|code=
import FreeCAD as App
import Draft

doc = App.newDocument()

circle = Draft.make_circle(1000)
rectangle = Draft.make_rectangle(2000, 800)
doc.recompute()

add_list1, delete_list1 = Draft.upgrade([circle, rectangle], delete=True)


compound = add_list1[0]
==How to use==
add_list2, delete_list2 = Draft.downgrade(compound, delete=False)
face = add_list2[0]
add_list3, delete_list3 = Draft.downgrade(face, delete=False)


box = doc.addObject("Part::Box", "Box")
# Select one or more objects you widh to downgrade
box.Length = 2300
# Press the {{KEY|[[Image:Draft Downgrade.png|16px]] [[Draft Downgrade]]}} button or press {{KEY|D}} then {{KEY|N}} keys
box.Width = 800
box.Height = 1000


add_list4, delete_list4 = Draft.downgrade(box, delete=True)
==Options==


doc.recompute()
The selected objects are modified/downgraded, according to the following conditions (in order):
}}
* if only one object is selected and it contains more than one face, each face becomes a separate object
<translate>
* if there are more than one face in the selection, the subsequent objects are subtracted from the first one
* if there is only one face in the selection, it gets converted into a wire
* otherwise all wires found in the selection are exploded into single edges


==Scripting==


<!--T:18-->
The Downgrade tool cannot be scripted directly, but it is easy to reproduce its different operations. See the [[Part Cut]] page.
{{Docnav
|[[Draft_Upgrade|Upgrade]]
|[[Draft_WireToBSpline|WireToBSpline]]
|[[Draft_Workbench|Draft]]
|IconL=Draft_Upgrade.svg
|IconR=Draft_WireToBSpline.svg
|IconC=Workbench_Draft.svg
}}


</translate>
{{languages | {{es|Draft Downgrade/es}} {{fr|Draft Downgrade/fr}} {{it|Draft Downgrade/it}} {{se|Draft Downgrade/se}} }}
{{Draft Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 17:11, 3 December 2023

Draft Downgrade

Menu location
Modification → Downgrade
Workbenches
Draft, Arch
Default shortcut
D N
Introduced in version
-
See also
Draft Upgrade, Part Cut

Description

The Draft Downgrade command downgrades selected objects. The result depends on the number of selected objects and their type. The command can for example deconstruct a 3D solid into separate faces and a wire into separate edges. If two face are selected a Part Cut object is created from them. Note that not all objects can be downgraded. This command is the counterpart of the Draft Upgrade command.

Two overlapping faces are downgraded to a Part Cut object, which is downgraded to a face. That face is then downgraded to a closed wire, which is finally downgraded to separate edges.

Usage

  1. Optionally select one or more objects.
  2. There are several ways to invoke the command:
    • Press the Downgrade button.
    • Select the Modification → Downgrade option from the menu.
    • Use the keyboard shortcut: D then N.
  3. If you have not yet selected an object: select an object in the 3D view.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

To downgrade objects use the downgrade method of the Draft module.

downgrade_list = downgrade(objects, delete=False, force=None)
  • objects contains the objects to be downgraded. It is either a single object or a list of objects.
  • If delete is True the source objects are deleted.
  • force forces a certain way of downgrading by calling a specific internal function. It can be: "explode", "shapify", "subtr", "splitFaces", "cut2", "getWire", "splitWires" or "splitCompounds".
  • downgrade_list is returned. It is a list containing two lists: a list of new objects and a list of objects to be deleted. If delete is True the second list is empty.

Example:

import FreeCAD as App
import Draft

doc = App.newDocument()

circle = Draft.make_circle(1000)
rectangle = Draft.make_rectangle(2000, 800)
doc.recompute()

add_list1, delete_list1 = Draft.upgrade([circle, rectangle], delete=True)

compound = add_list1[0]
add_list2, delete_list2 = Draft.downgrade(compound, delete=False)
face = add_list2[0]
add_list3, delete_list3 = Draft.downgrade(face, delete=False)

box = doc.addObject("Part::Box", "Box")
box.Length = 2300
box.Width = 800
box.Height = 1000

add_list4, delete_list4 = Draft.downgrade(box, delete=True)

doc.recompute()