Part Prism: Difference between revisions
No edit summary |
(Removed references to V0.19.) |
||
(8 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{UnfinishedDocu{{#translation:}}}} |
|||
<translate> |
<translate> |
||
Line 17: | Line 16: | ||
|Name=Part Prism |
|Name=Part Prism |
||
|MenuLocation=Part → [[Part_Primitives|Create primitives]] → Prism |
|MenuLocation=Part → [[Part_Primitives|Create primitives]] → Prism |
||
|Workbenches=[[Part_Workbench|Part]] |
|Workbenches=[[Part_Workbench|Part]], [[OpenSCAD_Workbench|OpenSCAD]] |
||
|Version=0.14 |
|Version=0.14 |
||
|SeeAlso=[[Part_Primitives|Part Primitives |
|SeeAlso=[[Part_Primitives|Part Primitives]] |
||
}} |
}} |
||
Line 25: | Line 24: | ||
<!--T:2--> |
<!--T:2--> |
||
A [[Image:Part_Prism.svg|24px]] '''Part Prism''' is a parametric solid that can be created with the [[Image:Part_Primitives.svg|24px]] [[Part_Primitives|Part Primitives]] command. It is the result of extruding a regular polygon along a straight path. In the coordinate system defined by its {{PropertyData|Placement}} property, the bottom face of the prism lies on the XY plane with its center at the origin and one of its vertices on the X axis. |
|||
The [[Image:Part_Prism.svg|24px]] [[Part_Prism|Part Prism]] command creates a parametric prism solid. |
|||
⚫ | |||
[[File:Part Prism Example.png|Screenshot of a Part Prism]] |
|||
[[Image:Part_Prism_Example.png|400px]] |
|||
⚫ | |||
⚫ | |||
FreeCAD creates a uniform hexagonal prism with a six-side polygon of equal edge length base with a circumradius of 2 millimetre and a height of 10 millimetre. |
|||
⚫ | |||
By default, the prism is positioned with the center of the base polygon at the origin (0,0,0). The bottom of the prism is on the xy-plane. Its extension in z-direction follows the positive axis value. |
|||
See [[Part_Primitives#Usage|Part Primitives]]. |
|||
== Example == |
== Example == <!--T:15--> |
||
<!--T:16--> |
|||
⚫ | |||
⚫ | |||
<!--T:17--> |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
# There are several ways to invoke the command: |
|||
#* Press the {{Button|[[Image:Part_Primitives.svg|16px]] [[Part Primitives|Create Primitives...]]}} button. |
|||
#* Select the {{MenuCommand|Part → Create Primitives → [[Image:Part_Primitives.svg|16px]] Create Primitives...}} option from the menu. |
|||
#* Select the {{MenuCommand|[[Image:Part_Prism.svg|16px]] Prism}} option from the menu. |
|||
# Set options and press {{Button|Create}}. |
|||
# To close the dialog press {{Button|Close}}. |
|||
== Properties == <!--T:4--> |
== Properties == <!--T:4--> |
||
<!--T:18--> |
|||
See also: [[Property_editor|Property editor]]. |
See also: [[Property_editor|Property editor]]. |
||
<!--T:19--> |
|||
A Part Prism object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties: |
A Part Prism object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties: |
||
=== Data === |
=== Data === <!--T:20--> |
||
<!--T:21--> |
|||
{{TitleProperty|Attachment}} |
|||
<!--T:22--> |
|||
The object has the same attachment properties as a [[Part_Part2DObject#Data|Part Part2DObject]]. |
|||
<!--T:23--> |
|||
{{TitleProperty|Prism}} |
{{TitleProperty|Prism}} |
||
<!--T:13--> |
<!--T:13--> |
||
* {{PropertyData|Polygon| |
* {{PropertyData|Polygon|IntegerConstraint}}: The number of sides of the polygon. The default is {{Value|6}}. |
||
* {{PropertyData|Circumradius|Length}}: The distance from the center of the polygon to |
* {{PropertyData|Circumradius|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 is {{Value|2mm}}. |
||
* {{PropertyData|Height|Length}}: The height |
* {{PropertyData|Height|Length}}: The height of the prism. The default is {{Value|10mm}}. |
||
* {{PropertyData|First Angle|Angle}}: |
* {{PropertyData|First Angle|Angle}}: The angle between the extrusion direction of the prism and its positive Z axis, measured around its Y axis. The angle is positive towards its positive X axis. Valid range: {{Value|0° <= value < 90°}}. The default is {{Value|0°}}. |
||
* {{PropertyData|Second Angle|Angle}}: |
* {{PropertyData|Second Angle|Angle}}: The angle between the extrusion direction of the prism and its positive Z axis, measured around its X axis. The angle is positive towards its positive Y axis. Valid range: {{Value|0° <= value < 90°}}. The default is {{Value|0°}}. |
||
⚫ | |||
==Limitations== |
|||
<!--T:25--> |
|||
⚫ | |||
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]]. |
|||
<!--T:26--> |
|||
A Part Prism |
A Part Prism can be created with the {{Incode|addObject()}} method of the document: |
||
</translate> |
</translate> |
||
Line 78: | Line 83: | ||
<translate> |
<translate> |
||
<!--T:27--> |
|||
* Where {{Incode|myPrism}} is the name for the object |
* Where {{Incode|"myPrism"}} is the name for the object. |
||
* The function returns the newly created object. |
* The function returns the newly created object. |
||
<!--T:28--> |
|||
The {{Incode|Label}} is the user editable name for the object. It can be easily changed by |
|||
Example: |
|||
</translate> |
</translate> |
||
{{Code|code= |
{{Code|code= |
||
import FreeCAD as App |
|||
prism.Label = "new myPrismName" |
|||
}} |
|||
⚫ | |||
doc = App.activeDocument() |
|||
You can access and modify attributes of the {{Incode|prism}} object. For example, you may wish to modify the number of sides of the base polygon, the circumferential radius or one of the two angles. |
|||
prism = doc.addObject("Part::Prism", "myPrism") |
|||
⚫ | |||
{{Code|code= |
|||
prism.Polygon = 5 |
prism.Polygon = 5 |
||
prism.Circumradius = 10 |
prism.Circumradius = 10 |
||
Line 98: | Line 102: | ||
prism.FirstAngle = 22.5 |
prism.FirstAngle = 22.5 |
||
prism.SecondAngle = 45 |
prism.SecondAngle = 45 |
||
⚫ | |||
doc.recompute() |
|||
}} |
}} |
||
<translate> |
<translate> |
||
The result will be a new prism with the given attributes. |
|||
You can change its placement and orientation with: |
|||
</translate> |
|||
{{Code|code= |
|||
⚫ | |||
}} |
|||
<translate> |
|||
<!--T:11--> |
<!--T:11--> |
||
Line 122: | Line 120: | ||
</translate> |
</translate> |
||
{{ |
{{Part_Tools_navi{{#translation:}}}} |
||
{{Userdocnavi{{#translation:}}}} |
{{Userdocnavi{{#translation:}}}} |
Latest revision as of 15:41, 20 May 2023
Part Prism |
Menu location |
---|
Part → Create primitives → Prism |
Workbenches |
Part, OpenSCAD |
Default shortcut |
None |
Introduced in version |
0.14 |
See also |
Part Primitives |
Description
A Part Prism is a parametric solid that can be created with the Part Primitives command. It is the result of extruding a regular polygon along a straight path. In the coordinate system defined by its DataPlacement property, the bottom face of the prism 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 Prism object created with the scripting example below is shown here.
Properties
See also: Property editor.
A Part Prism 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.
Prism
- 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
. - DataHeight (
Length
): The height of the prism. The default is10mm
. - DataFirst Angle (
Angle
): The angle between the extrusion direction of the prism and its positive Z axis, measured around its Y axis. The angle is positive towards its positive X axis. Valid range:0° <= value < 90°
. The default is0°
. - DataSecond Angle (
Angle
): The angle between the extrusion direction of the prism and its positive Z axis, measured around its X axis. The angle is positive towards its positive Y axis. Valid range:0° <= value < 90°
. The default is0°
.
Scripting
See also: Autogenerated API documentation, Part scripting and FreeCAD Scripting Basics.
A Part Prism can be created with the addObject()
method of the document:
prism = FreeCAD.ActiveDocument.addObject("Part::Prism", "myPrism")
- Where
"myPrism"
is the name for the object. - The function returns the newly created object.
Example:
import FreeCAD as App
doc = App.activeDocument()
prism = doc.addObject("Part::Prism", "myPrism")
prism.Polygon = 5
prism.Circumradius = 10
prism.Height = 50
prism.FirstAngle = 22.5
prism.SecondAngle = 45
prism.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(60, 75, 30))
doc.recompute()
- Primitives: Box, Cylinder, Sphere, Cone, Torus, Tube, Create primitives, Shape builder
- Creation and modification: Extrude, Revolve, Mirror, 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
- Measure: Measure Linear, Measure Angular, Measure Refresh, Clear All, Toggle All, Toggle 3D, Toggle Delta
- 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, Arch, Assembly, 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