1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
|
Helix
=====
.. module:: ezdxf.entities
:noindex:
The HELIX entity (`DXF Reference`_).
The helix curve is represented by a cubic B-spline curve, therefore the HELIX
entity is also derived from the SPLINE entity.
.. seealso::
- `Wikipedia`_ article about the helix shape
======================== ==========================================
Subclass of :class:`ezdxf.entities.Spline`
DXF type ``'HELIX'``
Factory function :meth:`ezdxf.layouts.BaseLayout.add_helix`
Inherited DXF attributes :ref:`Common graphical DXF attributes`
Required DXF version DXF R2000 (``'AC1015'``)
======================== ==========================================
.. _DXF Reference: https://help.autodesk.com/view/OARX/2018/ENU/?guid=GUID-76DB3ABF-3C8C-47D1-8AFB-72942D9AE1FF
.. class:: Helix
All points in :ref:`WCS` as (x, y, z) tuples
.. attribute:: dxf.axis_base_point
The base point of the helix axis (Vec3).
.. attribute:: dxf.start_point
The starting point of the helix curve (Vec3).
This also defines the base radius as the distance from the start point
to the axis base point.
.. attribute:: dxf.axis_vector
Defines the direction of the helix axis (Vec3).
.. attribute:: dxf.radius
Defines the top radius of the helix (float).
.. attribute:: dxf.turn_height
Defines the pitch (height if one helix turn) of the helix (float).
.. attribute:: dxf.turns
The count of helix turns (float).
.. attribute:: dxf.handedness
Helix orientation (int).
=== ================================
0 clock wise (left handed)
1 counter clockwise (right handed)
=== ================================
.. attribute:: dxf.constrain
=== =========================
0 constrain turn height (pitch)
1 constrain count of turns
2 constrain total height
=== =========================
.. _Wikipedia: https://en.wikipedia.org/wiki/Helix
|