.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.floatcanvas.FCObjects
.. highlight:: python
.. _wx.lib.floatcanvas.FCObjects.ArrowLine:
==========================================================================================================================================
|phoenix_title| **wx.lib.floatcanvas.FCObjects.ArrowLine**
==========================================================================================================================================
Draws an arrow line.
It will draw a set of arrows from point to point.
It takes a list of 2-tuples, or a NX2 NumPy Float array of point coordinates.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
ArrowLine:
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.floatcanvas.FCObjects.DrawObject`, :class:`wx.lib.floatcanvas.FCObjects.LineOnlyMixin`, :class:`wx.lib.floatcanvas.FCObjects.PointsObjectMixin`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.floatcanvas.FCObjects.ArrowLine.__init__` Default class constructor.
:meth:`~wx.lib.floatcanvas.FCObjects.ArrowLine.CalcArrowPoints` Calculate the arrow points.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ArrowLine(PointsObjectMixin, LineOnlyMixin, DrawObject)
Draws an arrow line.
It will draw a set of arrows from point to point.
It takes a list of 2-tuples, or a NX2 NumPy Float array of point coordinates.
.. method:: __init__(self, Points, LineColor = "Black", LineStyle = "Solid", LineWidth = 1, ArrowHeadSize = 8, ArrowHeadAngle = 30, InForeground = False)
Default class constructor.
:param `Points`: takes a 2-tuple, or a (2,)
`NumPy `_ array of point coordinates
:param `LineColor`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
:param `LineStyle`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetLineStyle`
:param `LineWidth`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetLineWidth`
:param `ArrowHeadSize`: size of arrow head in pixels
:param `ArrowHeadAngle`: angle of arrow head in degrees
:param boolean `InForeground`: should object be in foreground
.. method:: CalcArrowPoints(self)
Calculate the arrow points.