Draft Upgrade: Difference between revisions

From FreeCAD Documentation
No edit summary
Line 1: Line 1:
<translate>
{{GuiCommand|Name=Draft Upgrade|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]|MenuLocation=Draft -> Upgrade|Shortcut=U P|SeeAlso=[[Draft Downgrade]]}}
{{GuiCommand|Name=Draft Upgrade|Workbenches=[[Draft Module|Draft]], [[Arch Module|Arch]]|MenuLocation=Draft -> Upgrade|Shortcut=U P|SeeAlso=[[Draft Downgrade]]}}


Line 5: Line 6:
This tool upgrades selected objects in different ways. If no object is selected, you will be invited to select one.
This tool upgrades selected objects in different ways. If no object is selected, you will be invited to select one.


</translate>
[[Image:Draft_Upgrade_example.jpg|400px]]
[[Image:Draft_Upgrade_example.jpg|400px]]
<translate>


==How to use==
==How to use==
Line 23: Line 26:
==Scripting==
==Scripting==


The upgrade tool can be used from python scripts and [[macros]] like this:
Inputs:


</translate>
<syntaxhighlight>
<syntaxhighlight>
Draft.upgrade(objects, delete=False, force=None)
Draft.upgrade(objects, delete=False, force=None)
upgrade(objects,delete=False,force=None): Upgrades the given object(s) (can be
an object or a list of objects). If delete is True, old objects are deleted.
The force attribute can be used to
force a certain way of upgrading. It can be: makeCompound, closeGroupWires,
makeSolid, closeWire, turnToParts, makeFusion, makeShell, makeFaces, draftify,
joinFaces, makeSketchFace, makeWires
Returns a dictionnary containing two lists, a list of new objects and a list
of objects to be deleted
</syntaxhighlight>
</syntaxhighlight>
<translate>


* Upgrades the given object(s) (can be an object or a list of objects).
You can also reproduce the separate operations of the Upgrade tool in the [[Part Fuse]] or [[Draft Wire]] pages.
* If delete is True, old objects are deleted.
* The force attribute can be used to force a certain way of upgrading. It can be: makeCompound, closeGroupWires, makeSolid, closeWire, turnToParts, makeFusion, makeShell, makeFaces, draftify, joinFaces, makeSketchFace, makeWires
* Returns a dictionnary containing two lists, a list of new objects and a list of objects to be deleted

Some of the operations of the Upgrade tool can also be made with the [[Part Fuse]] or [[Draft Wire]] tools.


Example:
Example:
Upgrades a circle into a filled circle face


</translate>
<syntaxhighlight>
<syntaxhighlight>
import Draft
import Draft
Line 48: Line 50:
</syntaxhighlight>
</syntaxhighlight>


<languages/>
{{languages | {{es|Draft Upgrade/es}} {{fr|Draft Upgrade/fr}} {{it|Draft Upgrade/it}} {{se|Draft Upgrade/se}} }}

Revision as of 16:17, 13 February 2014

Draft Upgrade

Menu location
Draft -> Upgrade
Workbenches
Draft, Arch
Default shortcut
U P
Introduced in version
-
See also
Draft Downgrade

Description

This tool upgrades selected objects in different ways. If no object is selected, you will be invited to select one.

How to use

  1. Select one or more objects you wish to upgrade
  2. Press the Draft Upgrade button or press U then P keys

Options

The selected objects are modified/upgraded according to the following conditions (in order):

  • if there are more than one face in the selection, the faces are merged (union)
  • if there is only one face in the selection, nothing is done
  • if there is only one open wire in the selection, it gets closed
  • if there are only edges in the selection, all edges are joined into a wire (closed if possible)
  • if none of the above is possible, a compound object is created

Scripting

The upgrade tool can be used from python scripts and macros like this:

 Draft.upgrade(objects, delete=False, force=None)
  • Upgrades the given object(s) (can be an object or a list of objects).
  • If delete is True, old objects are deleted.
  • The force attribute can be used to force a certain way of upgrading. It can be: makeCompound, closeGroupWires, makeSolid, closeWire, turnToParts, makeFusion, makeShell, makeFaces, draftify, joinFaces, makeSketchFace, makeWires
  • Returns a dictionnary containing two lists, a list of new objects and a list of objects to be deleted

Some of the operations of the Upgrade tool can also be made with the Part Fuse or Draft Wire tools.

Example:

import Draft
mycircle = Draft.makeCircle(2)
face1 = Draft.upgrade([mycircle],True)