Draft Polygon: Difference between revisions

From FreeCAD Documentation
No edit summary
Line 32: Line 32:
==Scripting==
==Scripting==


The Polygon tool can by used in [[macros]] and from the python console the following way:
The Polygon tool can by used in [[macros]] and from the python console by using the following function:

'''makePolgon (nfaces,[radius],[inscribed],[placement],[face])''' : Creates a polygon object with the given
number of faces and the radius. If inscribed is False, the polygon is circumscribed around a circle with
the given radius, otherwise it is inscribed. If face is True, the resulting shape is displayed as a face,
otherwise as a wireframe. Returns the newly created object.

Example:


import Draft
import Draft
myPoly = Draft.makePolygon(5,radius=3)
Draft.makePolygon(5,radius=3)


{{Languages | {{es|Draft_Polygon/es}} {{fr|Draft_Polygon/fr}} {{it|Draft_Polygon/it}} {{se|Draft_Polygon/se}} }}
{{Languages | {{es|Draft_Polygon/es}} {{fr|Draft_Polygon/fr}} {{it|Draft_Polygon/it}} {{se|Draft_Polygon/se}} }}

Revision as of 21:12, 19 August 2012

Draft Polygon

Menu location
Draft -> Polygon
Workbenches
Draft, Arch
Default shortcut
P G
Introduced in version
-
See also
None

Description

The polygon tool creates a regular polygon by picking two points, the center and a second point defining a radius. It takes the linewidth and color previously set on the Tasks tab.

How to use

  1. Press the Draft Polygon button, or press P then G keys
  2. Click a first point on the 3D view, or type a coordinate to indicate the center
  3. Adjust the desired number of sides in the options dialog,
  4. Click another point on the 3D view, or type a radius value to define the polygon radius. The polygon will also be a face, even if it appears as wireframe.

Options

  • To enter coordinates manually, simply enter the numbers, then press ENTER between each X, Y and Z component.
  • Press T or click the checkbox to check/uncheck the Continue button. If continue mode is on, the Polygon tool will restart after you finish or close it, allowing you to draw another one without pressing the Polygon button again.
  • Press CTRL while drawing to force snapping your point to the nearest snap location, independently of the distance.
  • Press SHIFT while drawing to constrain your next point horizontally or vertically in relation to the last one.
  • Press I or the Filled button to have the polygon to appear as a face after it has been closed. This simply sets the View->Property of the Rectangle to "Flat lines" or "Wireframe", so it can easily be changed later.
  • Press ESC or the Cancel button to abort the current command.

Properties

  • DataRadius: The radius of the defining circle
  • DataDraw Mode: Specifies if the polygon is inscribed or circumscribed around the defining circle
  • DataFaces Number: The number of sides of the polygon
  • DataFillet Radius: Specifies a curvature radius to give to the corners of the rectangle

Scripting

The Polygon tool can by used in macros and from the python console by using the following function:

makePolgon (nfaces,[radius],[inscribed],[placement],[face]) : Creates a polygon object with the given 
number of faces and the radius. If inscribed is False, the polygon is circumscribed around a circle with 
the given radius, otherwise it is inscribed. If face is True, the resulting shape is displayed as a face, 
otherwise as a wireframe. Returns the newly created object.

Example:

import Draft
Draft.makePolygon(5,radius=3)
Available translations of this page: Template:Se