.. 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.Circle:
==========================================================================================================================================
|phoenix_title| **wx.lib.floatcanvas.FCObjects.Circle**
==========================================================================================================================================
Draws a circle
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
Circle:
|
|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.Circle.__init__` Default class constructor.
:meth:`~wx.lib.floatcanvas.FCObjects.Circle.CalcBoundingBox` Calculate the bounding box of the object.
:meth:`~wx.lib.floatcanvas.FCObjects.Circle.SetDiameter` Set the diameter of the object
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: Circle(XYObjectMixin, LineAndFillMixin, DrawObject)
Draws a circle
.. method:: __init__(self, XY, Diameter, LineColor = "Black", LineStyle = "Solid", LineWidth = 1, FillColor = None, FillStyle = "Solid", InForeground = False)
Default class constructor.
:param `XY`: the (x, y) coordinate of the center of the circle, or a 2-tuple,
or a (2,) `NumPy `_ array
:param integer `Diameter`: the diameter for the object
: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 of the object.
.. method:: SetDiameter(self, Diameter)
Set the diameter of the object
:param integer `Diameter`: the diameter for the object