EM FHSegment: Difference between revisions

From FreeCAD Documentation
No edit summary
(Marked this version for translation)
 
(12 intermediate revisions by 5 users not shown)
Line 2: Line 2:
<translate>
<translate>


<!--T:27-->
{{Docnav
|[[EM_FHNode|FHNode]]
|[[EM_FHPath|FHPath]]
|[[EM_Workbench|EM]]
|IconL=EM_FHNode.svg
|IconR=EM_FHPath.svg
|IconC=EMWorkbench.svg
}}

<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=EM FHSegment
|Name=EM FHSegment
|MenuLocation=EM → FHSegment
|MenuLocation=EM → FHSegment
|Workbenches=[[EM Workbench|EM]]
|Workbenches=[[EM_Workbench|EM]]
|Shortcut=E S
|Shortcut={{KEY|E}} {{KEY|S}}
⚫
|Version=0.17
|SeeAlso=[[EM FHNode|EM FHNode]], [[EM FHPath|EM FHPath]]
|SeeAlso=[[EM_FHNode|EM FHNode]], [[EM_FHPath|EM FHPath]]
⚫
|Version=0.17 (Add-on)
}}
}}


==Description==
==Description== <!--T:2-->


<!--T:3-->
The FHSegment tool inserts a FastHenry segment object.
The FHSegment tool inserts a FastHenry segment object.
⚫
</translate>


⚫
</translate>
[[Image:EM_FHSegment_Example.png]]
[[Image:EM_FHSegment_Example.png]]
<translate>
<translate>

<!--T:4-->
{{Caption|FastHenry FHSegment}}
{{Caption|FastHenry FHSegment}}


==Usage== <!--T:5-->
==How to use==


<!--T:6-->
The FHSegment object can be based on the position of a [[Draft_Line|Draft Line]] object, or on two existing FHNodes that will be the FHSegment end points, or you can select the 3D location of the two end points, where two additional FHNodes will be created.
The FHSegment object can be based on the position of a [[Image:Draft_Line.svg|16px]] [[Draft_Line|Draft Line]] object, or on two existing [[Image:EM_FHNode.svg|16px]] [[EM FHNode|FHNodes]] that will be the FHSegment end points, or you can select the 3D location of the two end points, where two additional FHNodes will be created.


<!--T:7-->
# Press the {{Button|[[Image:EM_FHSegment.svg|16px]] [[EM_FHSegment|EM FHSegment]]}} button, or press {{KEY|E}} then {{KEY|S}} keys.
# Press the {{Button|[[Image:EM_FHSegment.svg|16px]] [[EM_FHSegment|EM FHSegment]]}} button, or press {{KEY|E}} then {{KEY|S}} keys.
# Click a first point on the 3D view, or type a [[Draft_Coordinates|coordinate]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button.
# Click a first point on the 3D view, or type coordinates and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] add point}} button.
# Click a second point on the 3D view, or type a [[Draft_Coordinates|coordinate]] and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button.
# Click a second point on the 3D view, or type coordinates and press the {{Button|[[Image:Draft_AddPoint.svg|16px]] add point}} button.


<!--T:8-->
Alternatively, you can also:
Alternatively, you can also:


<!--T:9-->
# Select two [[EM_FHNode|FHNode]] objects
# Select two [[EM_FHNode|FHNode]] objects
# Press the {{Button|[[Image:EM_FHSegment.svg|16px]] [[EM_FHSegment|EM FHSegment]]}} button, or press {{KEY|E}} then {{KEY|S}} keys.
# Press the {{Button|[[Image:EM_FHSegment.svg|16px]] [[EM_FHSegment|EM FHSegment]]}} button, or press {{KEY|E}} then {{KEY|S}} keys.


<!--T:10-->
Or:
Or:


<!--T:11-->
# Select one or multiple [[Draft_Line|Draft Line]] object(s)
# Select one or multiple [[Draft_Line|Draft Line]] object(s)
# Press the {{Button|[[Image:EM_FHSegment.svg|16px]] [[EM_FHSegment|EM FHSegment]]}} button, or press {{KEY|E}} then {{KEY|S}} keys. As many FHSegment objects will be created as the Draft Line objects.
# Press the {{Button|[[Image:EM_FHSegment.svg|16px]] [[EM_FHSegment|EM FHSegment]]}} button, or press {{KEY|E}} then {{KEY|S}} keys. As many FHSegment objects will be created as the Draft Line objects.


===Remarks:===
===Remarks:=== <!--T:12-->


<!--T:13-->
* If you create a FHSegment object based on a Draft Line object, you can NOT freely move the FHSegment or the end point FHNodes. The FHSegment will always be constrained to the base object. To change the position of the FHSegment, or of its end point, apply the change to the underlying Draft Line object (the base object is hidden by default, you can show it again by selecting the object in the tree and pressing {{KEY|Space}}.
* If you create a FHSegment object based on a Draft Line object, you can NOT freely move the FHSegment or the end point FHNodes. The FHSegment will always be constrained to the base object. To change the position of the FHSegment, or of its end point, apply the change to the underlying Draft Line object (the base object is hidden by default, you can show it again by selecting the object in the tree and pressing {{KEY|Space}}.


<!--T:14-->
* If the FHSegment object has no base object {{incode|baseobj}}, its position is controlled by the starting and ending FHNodes. You cannot change a FHSegment position by changing its Placement.
* If the FHSegment object has no base object {{incode|baseobj}}, its position is controlled by the starting and ending FHNodes. You cannot change a FHSegment position by changing its Placement.


==Options==
==Options== <!--T:15-->


<!--T:16-->
* To enter coordinates manually, simply enter the numbers, then press {{KEY|Enter}} between each X, Y and Z component. You can press the {{Button|[[Image:Draft_AddPoint.svg|16px]] [[Draft_AddPoint|add point]]}} button when you have the desired values to insert the point.
* To enter coordinates manually, simply enter the numbers, then press {{KEY|Enter}} between each X, Y and Z component. You can press the {{Button|[[Image:Draft_AddPoint.svg|16px]] add point}} button when you have the desired values to insert the point.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the current command.
* Press {{KEY|Esc}} or the {{Button|Close}} button to abort the current command.


==Properties==
==Properties== <!--T:17-->


<!--T:18-->
* {{PropertyData|Base}}: The base object this component is built upon (a [[Draft_Line|Draft Line]])
* {{PropertyData|Base}}: The base object this component is built upon (a [[Draft_Line|Draft Line]])
* {{PropertyData|NodeStart}}: the starting [[EM_FHNode|FHNode]]
* {{PropertyData|NodeStart}}: the starting [[EM_FHNode|FHNode]]
Line 63: Line 87:
* {{PropertyData|rw}}: the ratio of adjacent filaments in the width direction ('rw' segment parameter in FastHenry)
* {{PropertyData|rw}}: the ratio of adjacent filaments in the width direction ('rw' segment parameter in FastHenry)


==Scripting==
==Scripting== <!--T:19-->


<!--T:20-->
{{Emphasis|See also:}} [[FreeCAD Scripting Basics]].
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].

<!--T:21-->
⚫
The FHSegment object can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the following function:


⚫
The FHSegment object can be used in [[macros]] and from the [[Python]] console by using the following function:
</translate>
</translate>
{{Code|code=
{{Code|code=
Line 73: Line 100:
}}
}}
<translate>
<translate>

<!--T:22-->
* Creates a {{incode|FHSegment}} object.
* Creates a {{incode|FHSegment}} object.
* {{incode|baseobj}} is the Draft Line object that can be used as base for the FHSegment. If {{incode|nodeStart}} and {{incode|nodeEnd}} are specified, they have priority over the {{incode|baseobj}}, and {{incode|baseobj}} is ignored.
* {{incode|baseobj}} is the Draft Line object that can be used as base for the FHSegment. If {{incode|nodeStart}} and {{incode|nodeEnd}} are specified, they have priority over the {{incode|baseobj}}, and {{incode|baseobj}} is ignored.
Line 81: Line 110:
* {{incode|name}} is the name of the object
* {{incode|name}} is the name of the object


<!--T:23-->
Example:
Example:

</translate>
</translate>
{{Code|code=
{{Code|code=
Line 91: Line 122:
fhsegment = EM.makeFHSegment(nodeStart=fhnode1, nodeEnd=fhnode2)
fhsegment = EM.makeFHSegment(nodeStart=fhnode1, nodeEnd=fhnode2)
}}
}}

{{clear}}
<translate>
<translate>
[[Category:User Documentation]]


[[Category:Addons]]


<!--T:28-->
[[Category:External Workbenches]]
{{Docnav
|[[EM_FHNode|FHNode]]
|[[EM_FHPath|FHPath]]
|[[EM_Workbench|EM]]
|IconL=EM_FHNode.svg
|IconR=EM_FHPath.svg
|IconC=EMWorkbench.svg
}}

</translate>
</translate>
{{EM Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 09:24, 19 November 2021

Other languages:

EM FHSegment

Menu location
EM → FHSegment
Workbenches
EM
Default shortcut
E S
Introduced in version
0.17
See also
EM FHNode, EM FHPath

Description

The FHSegment tool inserts a FastHenry segment object.

FastHenry FHSegment

Usage

The FHSegment object can be based on the position of a Draft Line object, or on two existing FHNodes that will be the FHSegment end points, or you can select the 3D location of the two end points, where two additional FHNodes will be created.

  1. Press the EM FHSegment button, or press E then S keys.
  2. Click a first point on the 3D view, or type coordinates and press the add point button.
  3. Click a second point on the 3D view, or type coordinates and press the add point button.

Alternatively, you can also:

  1. Select two FHNode objects
  2. Press the EM FHSegment button, or press E then S keys.

Or:

  1. Select one or multiple Draft Line object(s)
  2. Press the EM FHSegment button, or press E then S keys. As many FHSegment objects will be created as the Draft Line objects.

Remarks:

  • If you create a FHSegment object based on a Draft Line object, you can NOT freely move the FHSegment or the end point FHNodes. The FHSegment will always be constrained to the base object. To change the position of the FHSegment, or of its end point, apply the change to the underlying Draft Line object (the base object is hidden by default, you can show it again by selecting the object in the tree and pressing Space.
  • If the FHSegment object has no base object baseobj, its position is controlled by the starting and ending FHNodes. You cannot change a FHSegment position by changing its Placement.

Options

  • To enter coordinates manually, simply enter the numbers, then press Enter between each X, Y and Z component. You can press the add point button when you have the desired values to insert the point.
  • Press Esc or the Close button to abort the current command.

Properties

  • DataBase: The base object this component is built upon (a Draft Line)
  • DataNodeStart: the starting FHNode
  • DataNodeEnd: the ending FHNode
  • DataWidth: the FHSegment width ('w' segment parameter in FastHenry)
  • DataHeight: the FHSegment height ('h' segment parameter in FastHenry)
  • DataSigma: the FHSegment conductivity ('sigma' segment parameter in FastHenry)
  • Dataww: the FHSegment cross-section direction along the width ('wx', 'wy', 'wz' segment parameter in FastHenry)
  • Datanhinc: the Number of filaments in the height direction ('nhinc' segment parameter in FastHenry)
  • Datanwinc: the Number of filaments in the width direction ('nwinc' segment parameter in FastHenry)
  • Datarh: the ratio of adjacent filaments in the height direction ('rh' segment parameter in FastHenry)
  • Datarw: the ratio of adjacent filaments in the width direction ('rw' segment parameter in FastHenry)

Scripting

See also: FreeCAD Scripting Basics.

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

segment = makeFHSegment(baseobj=None, nodeStart=None, nodeEnd=None, width=None, height=None, name='FHSegment')
  • Creates a FHSegment object.
  • baseobj is the Draft Line object that can be used as base for the FHSegment. If nodeStart and nodeEnd are specified, they have priority over the baseobj, and baseobj is ignored.
  • nodeStart is the segment starting node FHNode object.
  • nodeEnd is the segment ending node FHNode object.
  • width is the segment width. Defaults to EMFHSEGMENT_DEF_SEGWIDTH.
  • height is the segment height. Defaults to EMFHSEGMENT_DEF_SEGHEIGHT.
  • name is the name of the object

Example: 

import FreeCAD, EM

fhnode1 = EM.makeFHNode(X=1.0,Y=0,Z=0)
fhnode2 = EM.makeFHNode(X=0,Y=1.0,Z=0)

fhsegment = EM.makeFHSegment(nodeStart=fhnode1, nodeEnd=fhnode2)


Electromagnetics
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=EM_FHSegment&oldid=1077959"