.. 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.Point:
==========================================================================================================================================
|phoenix_title| **wx.lib.floatcanvas.FCObjects.Point**
==========================================================================================================================================
A point DrawObject
.. note::
The Bounding box is just the point, and doesn't include the Diameter.
The HitLineWidth is used as diameter for the Hit Test.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
Point:
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.floatcanvas.FCObjects.ColorOnlyMixin`, :class:`wx.lib.floatcanvas.FCObjects.DrawObject`, :class:`wx.lib.floatcanvas.FCObjects.XYObjectMixin`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.floatcanvas.FCObjects.Point.__init__` Default class constructor.
:meth:`~wx.lib.floatcanvas.FCObjects.Point.SetDiameter` Set the diameter of the object.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: Point(XYObjectMixin, ColorOnlyMixin, DrawObject)
A point DrawObject
.. note::
The Bounding box is just the point, and doesn't include the Diameter.
The HitLineWidth is used as diameter for the Hit Test.
.. method:: __init__(self, XY, Color="Black", Diameter=1, InForeground=False)
Default class constructor.
:param `XY`: the (x, y) coordinate of the center of the point, or a
2-tuple, or a (2,) `NumPy `_ array
:param `Color`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
:param integer `Diameter`: in screen points
:param `InForeground`: define if object is in foreground
.. method:: SetDiameter(self, Diameter)
Set the diameter of the object.
:param integer `Diameter`: in screen points