EM FHPlaneHole

From FreeCAD Documentation
Revision as of 12:59, 5 January 2019 by Ediloren (talk | contribs) (Initial creation - work in progress)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

EM FHPlaneHole

Menu location
EM → FHPlaneHole
Workbenches
EM
Default shortcut
E H
Introduced in version
0.17 (Add-on)
See also
EM FHPlane, EM FHNode, EM FHPlaneAddRemoveNodeHole

Description

The FHPlaneHole tool inserts a plane hole object, that represents a FastHenry uniform conductive plane hole.

File:EM point FHPlaneNode Example.png

FastHenry Point FHPlaneHole

File:EM rect FHPlaneNode Example.png

FastHenry Rect FHPlaneHole

File:EM circle FHPlaneNode Example.png

FastHenry Circle FHPlaneHole

How to use

The FHPlaneHole object can be based on the position of a Draft Point object, or you can select the 3D location of the FHPlaneHole.

  1. Press the EM FHNode button, or press E then N keys.
  2. Click a point on the 3D view, or type a coordinate and press the add point button.

Alternatively, you can also:

  1. Select one or multiple Draft Point object(s)
  2. Press the EM FHNode button, or press E then N keys. As many FHNodes will be created as the Draft Point objects, at the same coordinates of the Draft Points.

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

  • DataX: the X coordinate of the node
  • DataY: the Y coordinate of the node
  • DataZ: the Z coordinate of the node

Scripting

See also: FreeCAD Scripting Basics.

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

node = makeFHNode(baseobj=None, X=0.0, Y=0.0, Z=0.0, color=None, size=None, name='FHNode')
  • Creates a FHNode object.
  • baseobj is the Draft Point object whose position can be used as base for the FHNode. It has priority over X, Y, Z. If no baseobj is given, X,Y,Z are used as coordinates.
  • X x coordinate of the node, in absolute coordinate system.
  • Y y coordinate of the node, in absolute coordinate system.
  • Z z coordinate of the node, in absolute coordinate system.
  • color is the node color, e.g. a tuple (1.0,0.0,0.0). Defaults to EMFHNODE_DEF_NODECOLOR.
  • size is the node size. Defaults to EMFHNODE_DEF_NODESIZE.
  • name is the name of the object

The placement of the FHNode can be changed by modifying its Placement property, or changing the X,Y,Z properties individually. Changing X,Y,Z modifies the node position in the relative coordinate system of the Placement.

Additionally, the _FHNode class exposes these methods. The _FHNode class can be accessed through the FHNode object Proxy (e.g. fhnode.Proxy).

pos = getAbsCoord()
  • Get a FreeCAD.Vector containing the node coordinates in the absolute reference system
pos = getRelCoord()
  • Get a FreeCAD.Vector containing the node coordinates relative to the FHNode Placement
pos = setRelCoord(rel_coord, placement=None)
  • Sets the node position relative to the placement
  • rel_coord is a FreeCAD.Vector containing the node coordinates relative to the FHNode Placement
  • placement is a new FHNode placement. If None, the placement is not changed
pos = setAbsCoord(abs_coord, placement=None)
  • Sets the absolute node position, considering the object placement, and in case forcing a new placement
  • abs_coord is a FreeCAD.Vector containing the node coordinates in the absolute reference system
  • placement is a new FHNode placement. If None, the placement is not changed


Example:

import FreeCAD, EM

fhnode = EM.makeFHNode(X=1.0,Y=2.0,Z=0.0)