.. 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.Arc:
==========================================================================================================================================
|phoenix_title| **wx.lib.floatcanvas.FCObjects.Arc**
==========================================================================================================================================
Draws an arc of a circle, centered on point ``CenterXY``, from
the first point ``StartXY`` to the second ``EndXY``.
The arc is drawn in an anticlockwise direction from the start point to
the end point.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
Arc:
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.floatcanvas.FCObjects.DrawObject`, :class:`wx.lib.floatcanvas.FCObjects.LineAndFillMixin`, :class:`wx.lib.floatcanvas.FCObjects.XYObjectMixin`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.floatcanvas.FCObjects.Arc.__init__` Default class constructor.
:meth:`~wx.lib.floatcanvas.FCObjects.Arc.CalcBoundingBox` Calculate the bounding box.
:meth:`~wx.lib.floatcanvas.FCObjects.Arc.Move` Move the object by delta
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: Arc(XYObjectMixin, LineAndFillMixin, DrawObject)
Draws an arc of a circle, centered on point ``CenterXY``, from
the first point ``StartXY`` to the second ``EndXY``.
The arc is drawn in an anticlockwise direction from the start point to
the end point.
.. method:: __init__(self, StartXY, EndXY, CenterXY, LineColor = "Black", LineStyle = "Solid", LineWidth = 1, FillColor = None, FillStyle = "Solid", InForeground = False)
Default class constructor.
:param `StartXY`: start point, takes a 2-tuple, or a (2,)
`NumPy `_ array of point coordinates
:param `EndXY`: end point, takes a 2-tuple, or a (2,)
`NumPy `_ array of point coordinates
:param `CenterXY`: center point, 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 `FillColor`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
:param `FillStyle`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetFillStyle`
:param boolean `InForeground`: should object be in foreground
.. method:: CalcBoundingBox(self)
Calculate the bounding box.
.. method:: Move(self, Delta)
Move the object by delta
:param `Delta`: delta is a (dx, dy) pair. Ideally a `NumPy `_
array of shape (2,)