.. 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.PointsObjectMixin:
==========================================================================================================================================
|phoenix_title| **wx.lib.floatcanvas.FCObjects.PointsObjectMixin**
==========================================================================================================================================
A mixin class that provides some methods suitable for use
with objects that have a set of (x, y) coordinate pairs.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
PointsObjectMixin:
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.floatcanvas.FCObjects.ArrowLine`, :class:`wx.lib.floatcanvas.FCObjects.Line`, :class:`wx.lib.floatcanvas.FCObjects.PointSet`, :class:`wx.lib.floatcanvas.FCObjects.Polygon`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.floatcanvas.FCObjects.PointsObjectMixin.CalcBoundingBox` Calculate the bounding box.
:meth:`~wx.lib.floatcanvas.FCObjects.PointsObjectMixin.Move` Moves the object by delta, where delta is a (dx, dy) pair.
:meth:`~wx.lib.floatcanvas.FCObjects.PointsObjectMixin.SetPoints` Sets the coordinates of the points of the object to Points (NX2 array).
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: PointsObjectMixin
A mixin class that provides some methods suitable for use
with objects that have a set of (x, y) coordinate pairs.
.. method:: CalcBoundingBox(self)
Calculate the bounding box.
.. method:: Move(self, Delta)
Moves the object by delta, where delta is a (dx, dy) pair.
:param `Delta`: is a (dx, dy) pair ideally a `NumPy `_
array of shape (2, )
.. method:: SetPoints(self, Points, copy=True)
Sets the coordinates of the points of the object to Points (NX2 array).
:param `Points`: takes a 2-tuple, or a (2,)
`NumPy `_ array of point coordinates
:param boolean `copy`: By default, a copy is made, if copy is set to
``False``, a reference is used, if Points is a NumPy array of Floats.
This allows you to change some or all of the points without making
any copies.
For example::
Points = Object.Points
# shifts the points 5 in the x dir, and 10 in the y dir.
Points += (5, 10)
# Sets the points to the same array as it was
Object.SetPoints(Points, False)