Arch Axis/en: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{GuiCommand|Name=Arch Axis|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch → Axis|Shortcut=A X|SeeAlso=[[Arch AxisSystem|Axis System]], [[Arch Grid|Grid]]}}
{{Docnav
|[[Arch_CompAxis|CompAxis]]
|[[Arch_AxisSystem|AxisSystem]]
|[[Arch_Workbench|Arch]]
|IconL=Arch_CompAxis.png
|IconR=Arch_AxisSystem.svg
|IconC=Workbench_Arch.svg
}}

{{GuiCommand
|Name=Arch Axis
|MenuLocation=Arch → Axis tools → Axis
|Workbenches=[[Arch_Workbench|Arch]]
|Shortcut={{KEY|A}} {{KEY|X}}
|SeeAlso=[[Arch_AxisSystem|Arch AxisSystem]], [[Arch_Grid|Arch Grid]]
}}


==Description==
==Description==


The Axis tool allows you to places a series of axes in the current document. The distance and the angle between axes is customizable, as well as the numbering style. The axes serve mainly as references to snap objects onto, but can also be used together with [[Arch AxisSystem|Axes Systems]], and can also be referenced by other Arch objects to create parametric arrays, for example of beams or columns. [[Arch Grid|Grids]] can also be used in places of axes.
The {{Button|[[Image:Arch Axis.svg|16px]] [[Arch Axis|Arch Axis]]}} tool allows you to place a series of axes in the current document. The distance and the angle between axes is customizable, as well as the numbering style. The axes serve mainly as references to snap objects onto, but can also be used together with {{Button|[[Image:Arch_AxisSystem.svg|16px]] [[Arch AxisSystem|Arch AxisSystems]]}}. They can also be referenced by other Arch objects to create parametric arrays, for example of beams or columns. {{Button|[[Image:Arch Grid.svg|16px]] [[Arch Grid|Arch Grids]]}} can also be used in places of axes.


[[Image:Arch Axis example.jpg|600px]]
[[Image:Arch Axis example.jpg|600px]]
{{Caption|Two axes objects positioned perpendicularly to each other to create a grid}}


==Usage==
''The image above shows two different axis objects positioned perpendicularly to each other''


# Press the {{Button|[[Image:Arch Axis.svg|16px]] [[Arch Axis|Arch Axis]]}} button, or press {{KEY|A}} then {{KEY|X}} keys.
==How to use==
# [[Draft Move|Move]]/[[Draft Rotate|rotate]] the axes system to the desired position.

# Press the {{KEY|[[Image:Arch Axis.png|16px]] [[Arch Axis]]}} button, or press {{KEY|A}} then {{KEY|X}} keys
# [[Draft Move|Move]]/[[Draft Rotate|rotate]] the axes system to the desired position
# Enter edit mode by double-clicking the axes system in the tree view to adjust its settings like number of axes, distances and angles between axes.
# Enter edit mode by double-clicking the axes system in the tree view to adjust its settings like number of axes, distances and angles between axes.


==Options==
==Options==


* Each axis in the series has its own distance and angle in relation to the previous axis. This allows to do very complex systems such as non-orthogonal systems, polar systems or any kind of non-uniform system
* Each axis in the series has its own distance and angle in relation to the previous axis. This allows to do very complex systems such as non-orthogonal systems, polar systems or any kind of non-uniform system.
* Double-clicking the axis in the tree view allows to edit the distances, angles and labels of each axis
* Double-clicking the axis in the tree view allows to edit the distances, angles and labels of each axis.
* Axes length, size of the bubbles and numbering styles are customizable directly via the axes system's properties
* Axes length, size of the bubbles and numbering styles are customizable directly via the axes system's properties.
* Each axis can also display a label, also editable via the task panel dialog
* Each axis can also display a label, which is editable via the task panel dialog.


==Properties==
==Properties==


* {{PropertyData|Length}}: The length of the axes
* {{PropertyData|Length}}: The length of the axes
* {{PropertyData|Limit}}: If greater than zero, each axis will be represented as two lines of the given length instead of one continuous line {{Version|0.20}}
* {{PropertyView|Bubble Size}}: The size of the axis bubbles
* {{PropertyView|Bubble Size}}: The size of the axis bubbles
* {{PropertyView|Numeration style}}: How the axes are numbered: 1,2,3, A,B,C, etc...
* {{PropertyView|Numeration style}}: How the axes are numbered: 1,2,3, A,B,C, etc...
Line 32: Line 48:
* {{PropertyView|Font Size}}: The size of the label text only (bubble text is controlled by the bubble size)
* {{PropertyView|Font Size}}: The size of the label text only (bubble text is controlled by the bubble size)
* {{PropertyView|Show Labels}}: Turns the display of the label texts on/off
* {{PropertyView|Show Labels}}: Turns the display of the label texts on/off

==Use as section mark==

By setting the '''Bubble Position''' property to '''Arrow left/right''' or '''Bar left/right''', the axis will display a
filled arrow or bar instead of the bubble, so it can be used as a section mark. {{Version|0.20}}


==Scripting==
==Scripting==
{{Emphasis|See also:}} [[Arch API|Arch API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].


The Axis tool can by used in [[macros]] and from the python console by using the following function:
The Axis tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:
{{Code|code=
{{Code|code=
Axes = makeAxis(num=5, size=1000, name="Axes")
makeAxis ([number],[interval])
}}
}}

:makes an axes series based on the given number of axes and interval distance
* Creates an {{incode|Axes}} object from the given number ({{incode|num}}) of axes, and {{incode|size}}, the interval between each axis.


Example:
Example:

{{Code|code=
{{Code|code=
import Arch
import Draft, Arch

Arch.makeAxis(5,2)
Axes = Arch.makeAxis(5, 1000)

Axes.ViewObject.LineWidth = 3
Axes.ViewObject.BubbleSize = 200
Axes.ViewObject.FontSize = 150

Axes2 = Arch.makeAxis(6, 500)

Axes2.ViewObject.LineWidth = 2
Axes2.ViewObject.BubbleSize = 200
Axes2.ViewObject.FontSize = 150
Axes2.ViewObject.NumberingStyle = "A,B,C"
FreeCAD.ActiveDocument.recompute()

Axes2.Length = 6000
Draft.rotate(Axes2, -90)
Draft.move(Axes2, FreeCAD.Vector(-1000, 2500, 0))
FreeCAD.ActiveDocument.recompute()
}}


{{Docnav
|[[Arch_CompAxis|CompAxis]]
|[[Arch_AxisSystem|AxisSystem]]
|[[Arch_Workbench|Arch]]
|IconL=Arch_CompAxis.png
|IconR=Arch_AxisSystem.svg
|IconC=Workbench_Arch.svg
}}
}}


{{Arch Tools navi{{#translation:}}}}
[[Category:Arch]]
{{Userdocnavi{{#translation:}}}}

Revision as of 08:42, 5 November 2021

Arch Axis

Menu location
Arch → Axis tools → Axis
Workbenches
Arch
Default shortcut
A X
Introduced in version
-
See also
Arch AxisSystem, Arch Grid

Description

The Arch Axis tool allows you to place a series of axes in the current document. The distance and the angle between axes is customizable, as well as the numbering style. The axes serve mainly as references to snap objects onto, but can also be used together with Arch AxisSystems. They can also be referenced by other Arch objects to create parametric arrays, for example of beams or columns. Arch Grids can also be used in places of axes.

Two axes objects positioned perpendicularly to each other to create a grid

Usage

  1. Press the Arch Axis button, or press A then X keys.
  2. Move/rotate the axes system to the desired position.
  3. Enter edit mode by double-clicking the axes system in the tree view to adjust its settings like number of axes, distances and angles between axes.

Options

  • Each axis in the series has its own distance and angle in relation to the previous axis. This allows to do very complex systems such as non-orthogonal systems, polar systems or any kind of non-uniform system.
  • Double-clicking the axis in the tree view allows to edit the distances, angles and labels of each axis.
  • Axes length, size of the bubbles and numbering styles are customizable directly via the axes system's properties.
  • Each axis can also display a label, which is editable via the task panel dialog.

Properties

  • DataLength: The length of the axes
  • DataLimit: If greater than zero, each axis will be represented as two lines of the given length instead of one continuous line introduced in version 0.20
  • ViewBubble Size: The size of the axis bubbles
  • ViewNumeration style: How the axes are numbered: 1,2,3, A,B,C, etc...
  • ViewBubble Position: Where the bubble is placed on the axis: At start point, endpoint, both or none.
  • ViewFont Name: A font to draw the bubble number and/or labels
  • ViewFont Size: The size of the label text only (bubble text is controlled by the bubble size)
  • ViewShow Labels: Turns the display of the label texts on/off

Use as section mark

By setting the Bubble Position property to Arrow left/right or Bar left/right, the axis will display a filled arrow or bar instead of the bubble, so it can be used as a section mark. introduced in version 0.20

Scripting

See also: Arch API and FreeCAD Scripting Basics.

The Axis tool can be used in macros and from the Python console by using the following function:

Axes = makeAxis(num=5, size=1000, name="Axes")
  • Creates an Axes object from the given number (num) of axes, and size, the interval between each axis.

Example:

import Draft, Arch

Axes = Arch.makeAxis(5, 1000)

Axes.ViewObject.LineWidth = 3
Axes.ViewObject.BubbleSize = 200
Axes.ViewObject.FontSize = 150

Axes2 = Arch.makeAxis(6, 500)

Axes2.ViewObject.LineWidth = 2
Axes2.ViewObject.BubbleSize = 200
Axes2.ViewObject.FontSize = 150
Axes2.ViewObject.NumberingStyle = "A,B,C"
FreeCAD.ActiveDocument.recompute()

Axes2.Length = 6000
Draft.rotate(Axes2, -90)
Draft.move(Axes2, FreeCAD.Vector(-1000, 2500, 0))
FreeCAD.ActiveDocument.recompute()