1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
.. 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
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>PointsObjectMixin</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.floatcanvas.FCObjects.PointsObjectMixin_inheritance.png" alt="Inheritance diagram of PointsObjectMixin" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.floatcanvas.FCObjects.PointsObjectMixin.html" title="wx.lib.floatcanvas.FCObjects.PointsObjectMixin" alt="" coords="5,5,336,35"/> </map>
</p>
</div>
|
|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 <http://www.numpy.org/>`_
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 <http://www.numpy.org/>`_ 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)
|
