EM FHEquiv: Difference between revisions

From FreeCAD Documentation
(Initial creation - work in progress)
(Initial creation)
Line 30: Line 30:


* {{PropertyData|Node1}}: the first [[EM_FHNode|FHNode]] to short-circuit
* {{PropertyData|Node1}}: the first [[EM_FHNode|FHNode]] to short-circuit
* {{PropertyData|Node2}}: the second[[EM_FHNode|FHNode]] to short-circuit
* {{PropertyData|Node2}}: the second [[EM_FHNode|FHNode]] to short-circuit


==Scripting==
==Scripting==
Line 42: Line 42:
}}
}}


* Creates a {{incode|FHSegment}} object.
* Creates a {{incode|FHEquiv}} object.
* {{incode|node1}} is the first node [[EM_FHNode|FHNode]] object to short-circuit.
* {{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|nodeStart}} is the segment starting node [[EM_FHNode|FHNode]] object.
* {{incode|node2}} is the second node [[EM_FHNode|FHNode]] object to short-circuit.
* {{incode|nodeEnd}} is the segment ending node [[EM_FHNode|FHNode]] object.
* {{incode|width}} is the segment width. Defaults to {{incode|EMFHSEGMENT_DEF_SEGWIDTH}}.
* {{incode|height}} is the segment height. Defaults to {{incode|EMFHSEGMENT_DEF_SEGHEIGHT}}.
* {{incode|name}} is the name of the object
* {{incode|name}} is the name of the object


Line 58: Line 55:
fhnode2 = EM.makeFHNode(X=0,Y=1.0,Z=0)
fhnode2 = EM.makeFHNode(X=0,Y=1.0,Z=0)


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



Revision as of 18:42, 9 January 2019

EM FHEquiv

Menu location
EM → FHEquiv
Workbenches
EM
Default shortcut
E E
Introduced in version
0.17 (Add-on)
See also
EM FHNode, EM FHSegment, EM FHPath, EM FHPlane, EM FHPort,

Description

The FHEquiv tool short-circuits two FHNode objects.

FastHenry FHEquiv

How to use

The FHEquiv object is based on the two existing FHNodes that it will short-circuit.

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

Remarks:

  • If you need to short-circuit multiple nodes, just create multiple FHEquiv nodes. You don't need a full mesh of FHEquiv nodes, as of course if node1 is shorted with node2, and node2 is shorted with node3, also node1 will result shorted with node3.

Properties

  • DataNode1: the first FHNode to short-circuit
  • DataNode2: the second FHNode to short-circuit

Scripting

See also: FreeCAD Scripting Basics.

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

equiv = makeFHEquiv(node1=None,node2=None,name='FHEquiv')
  • Creates a FHEquiv object.
  • node1 is the first node FHNode object to short-circuit.
  • node2 is the second node FHNode object to short-circuit.
  • 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)

fhequiv = makeFHEquiv(fhnode1, fhnode2)