Draft PathArray: Difference between revisions
Wandererfan (talk | contribs) (First draft.) |
No edit summary |
||
Line 1: | Line 1: | ||
<translate> |
|||
{{GuiCommand|Name=Draft_PathArray|Workbenches=[[Draft Module|Draft]]|MenuLocation=Draft -> PathArray|Shortcut= }} |
{{GuiCommand|Name=Draft_PathArray|Workbenches=[[Draft Module|Draft]]|MenuLocation=Draft -> PathArray|Shortcut= }} |
||
⚫ | |||
⚫ | |||
<!--T:2--> |
|||
The PathArray tool places copies of a selected shape along a selected path. The path can be a Wire or one or more Edges. The shapes can optionally be aligned with the tangent of the path. If required, a translation Vector can be specified to shift the shapes so the centroid is on the path. If no objects are selected, you will be invited to select them. |
The PathArray tool places copies of a selected shape along a selected path. The path can be a Wire or one or more Edges. The shapes can optionally be aligned with the tangent of the path. If required, a translation Vector can be specified to shift the shapes so the centroid is on the path. If no objects are selected, you will be invited to select them. |
||
</translate> |
|||
[[Image:Draft_PathArray_Example.png|400px]] |
[[Image:Draft_PathArray_Example.png|400px]] |
||
<translate> |
|||
⚫ | |||
⚫ | |||
<!--T:4--> |
|||
# Select a shape object you wish to distribute. |
# Select a shape object you wish to distribute. |
||
# Select a path object along which the shapes will be distributed. -or- |
# Select a path object along which the shapes will be distributed. -or- |
||
# Select some edges of a path object. |
# Select some edges of a path object. |
||
# Press the {{KEY|[[Image:Draft_PathArray.png|16px]] [[Draft PathArray]]}} button. |
# Press the {{KEY|[[Image:Draft_PathArray.png|16px]] [[Draft PathArray]]}} button. |
||
⚫ | |||
⚫ | |||
<!--T:6--> |
|||
* The array starts with shape copies which are not aligned to the path, nor translated to a new position by default. You can then change the count, alignment and/or translation vector in the properties. |
* The array starts with shape copies which are not aligned to the path, nor translated to a new position by default. You can then change the count, alignment and/or translation vector in the properties. |
||
==Properties== |
==Properties== |
||
<!--T:8--> |
|||
* {{PropertyData|Base}}: The shape object |
* {{PropertyData|Base}}: The shape object |
||
* {{PropertyData|PathObj}}: The path object |
* {{PropertyData|PathObj}}: The path object |
||
Line 28: | Line 30: | ||
* {{PropertyData|Align}}: True to align the shapes to the path, False to leave shapes in their default orientation. |
* {{PropertyData|Align}}: True to align the shapes to the path, False to leave shapes in their default orientation. |
||
==Scripting== |
==Scripting== |
||
<!--T:10--> |
|||
The PathArray tool can by used in [[macros]] and from the python console by using the following function: |
The PathArray tool can by used in [[macros]] and from the python console by using the following function: |
||
</translate> |
|||
{{Code|code= |
|||
<syntaxhighlight> |
|||
makePathArray(shapeobject,pathobject,count,[translationvector],[alignment],[listofpathsubelements]) |
makePathArray(shapeobject,pathobject,count,[translationvector],[alignment],[listofpathsubelements]) |
||
}} |
|||
</syntaxhighlight> |
|||
<translate> |
|||
* Distribute count copies of a document shapeobject along a pathobject or subobjects of a pathobject. Optionally translates each copy by FreeCAD.Vector xlate direction and distance to adjust for difference in shape centre vs shape reference point. Optionally aligns baseobject to tangent/normal/binormal of path. |
* Distribute count copies of a document shapeobject along a pathobject or subobjects of a pathobject. Optionally translates each copy by FreeCAD.Vector xlate direction and distance to adjust for difference in shape centre vs shape reference point. Optionally aligns baseobject to tangent/normal/binormal of path. |
||
<!--T:11--> |
|||
Example: |
Example: |
||
</translate> |
|||
{{Code|code= |
|||
<syntaxhighlight> |
|||
import FreeCAD,Draft |
import FreeCAD,Draft |
||
Draft.makePathArray(base,path,items,centretrans,orient,pathsubs) |
Draft.makePathArray(base,path,items,centretrans,orient,pathsubs) |
||
</syntaxhighlight> |
|||
}} |
|||
<translate> |
|||
==Limitations== |
==Limitations== |
||
* This tool is not |
* This tool is not available before version 0.14 |
||
* The PathSubs Property does not yet appear in the properties list. |
* The PathSubs Property does not yet appear in the properties list. |
||
</translate> |
|||
<languages/> |
<languages/> |
Revision as of 15:10, 13 February 2014
Draft_PathArray |
Menu location |
---|
Draft -> PathArray |
Workbenches |
Draft |
Default shortcut |
None |
Introduced in version |
- |
See also |
None |
Description
The PathArray tool places copies of a selected shape along a selected path. The path can be a Wire or one or more Edges. The shapes can optionally be aligned with the tangent of the path. If required, a translation Vector can be specified to shift the shapes so the centroid is on the path. If no objects are selected, you will be invited to select them.
How to use
- Select a shape object you wish to distribute.
- Select a path object along which the shapes will be distributed. -or-
- Select some edges of a path object.
- Press the Draft PathArray button.
Options
- The array starts with shape copies which are not aligned to the path, nor translated to a new position by default. You can then change the count, alignment and/or translation vector in the properties.
Properties
- DataBase: The shape object
- DataPathObj: The path object
- DataPathSubs: The subelements(edges) of path object to be used as the path
- DataCount: The number of time to copy the shape
- DataXlate: The translation vector
- DataAlign: True to align the shapes to the path, False to leave shapes in their default orientation.
Scripting
The PathArray tool can by used in macros and from the python console by using the following function:
makePathArray(shapeobject,pathobject,count,[translationvector],[alignment],[listofpathsubelements])
- Distribute count copies of a document shapeobject along a pathobject or subobjects of a pathobject. Optionally translates each copy by FreeCAD.Vector xlate direction and distance to adjust for difference in shape centre vs shape reference point. Optionally aligns baseobject to tangent/normal/binormal of path.
Example:
import FreeCAD,Draft
Draft.makePathArray(base,path,items,centretrans,orient,pathsubs)
Limitations
- This tool is not available before version 0.14
- The PathSubs Property does not yet appear in the properties list.