Part RegularPolygon
This documentation is not finished. Please help and contribute documentation.
GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.
See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.
Part RegularPolygon |
Menu location |
---|
Part → Create primitives → Regular Polygon |
Workbenches |
Part |
Default shortcut |
None |
Introduced in version |
0.14 |
See also |
Part Primitives |
Description
A Part RegularPolygon is a parametric shape that can be created with the Part Primitives command. In the coordinate system defined by its DataPlacement property, the polygon lies on the XY plane with its center at the origin and one of its vertices on the X axis.
Usage
See Part Primitives.
Example
A Part RegularPolygon object created with the scripting example below is shown here.
Properties
See also: Property editor.
A Part RegularPolygon object is derived from a Part Feature object and inherits all its properties. It also has the following additional properties:
Data
Attachment
The object has the same attachment properties as a Part Part2DObject.
Regular Polygon
- DataPolygon (
IntegerConstraint
): The number of sides of the polygon. The default is6
. - DataCircumradius (
Length
): The radius of the circle that circumscribes the polygon, the distance from the center of the polygon to one of its vertices. The default is2mm
.
Scripting
A Part Regular polygon is created with the addObject()
method of the document.
regularPolygon = FreeCAD.ActiveDocument.addObject("Part::RegularPolygon", "myRegularPolygon")
- Where
myRegularPolygon
is the name for the object. The name must be unique for the entire document. - The function returns the newly created object.
The Label
is the user editable name for the object. It can be easily changed by
regularPolygon.Label = "new myRegularPolygonName"
You can access and modify attributes of the regularPolygon
object. For example, you may wish to modify the length, width and height parameters.
regularPolygon.Polygon = 5
regularPolygon.Circumradius = 8
You can change its placement and orientation with:
regularPolygon.Placement = FreeCAD.Placement(FreeCAD.Vector(1, 2, 3), FreeCAD.Rotation(60, 30, 15))
- Primitives: Box, Cylinder, Sphere, Cone, Torus, Tube, Create primitives, Shape builder
- Creation and modification: Extrude, Revolve, Mirror, Scale, Fillet, Chamfer, Make face from wires, Ruled Surface, Loft, Sweep, Section, Cross sections, 3D Offset, 2D Offset, Thickness, Projection on surface, Attachment
- Boolean: Make compound, Explode Compound, Compound Filter, Boolean, Cut, Fuse, Common, Connect, Embed, Cutout, Boolean fragments, Slice apart, Slice, XOR
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Assembly, BIM, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework
- Hubs: User hub, Power users hub, Developer hub