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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.floatcanvas.Utilities.BBox
.. highlight:: python
.. _wx.lib.floatcanvas.Utilities.BBox.BBox:
==========================================================================================================================================
|phoenix_title| **wx.lib.floatcanvas.Utilities.BBox.BBox**
==========================================================================================================================================
A Bounding Box object:
Takes Data as an array. Data is any python sequence that can be turned into a
2x2 numpy array of floats::
[
[MinX, MinY ],
[MaxX, MaxY ]
]
It is a subclass of numpy.ndarray, so for the most part it can be used as
an array, and arrays that fit the above description can be used in its place.
Usually created by the factory functions:
asBBox
and
fromPoints
|
|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>BBox</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.Utilities.BBox.BBox_inheritance.png" alt="Inheritance diagram of BBox" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" alt="" coords="75,5,191,35"/> <area shape="rect" id="node2" href="wx.lib.floatcanvas.Utilities.BBox.BBox.html" title="wx.lib.floatcanvas.Utilities.BBox.BBox" alt="" coords="4,83,261,112"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.floatcanvas.Utilities.BBox.RectBBox`
|
|super_classes| Known Superclasses
==================================
`numpy.ndarray <http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html#numpy.ndarray>`_
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.floatcanvas.Utilities.BBox.BBox.Inside` Inside(BB)
:meth:`~wx.lib.floatcanvas.Utilities.BBox.BBox.IsNull`
:meth:`~wx.lib.floatcanvas.Utilities.BBox.BBox.Merge` Joins this bounding box with the one passed in, maybe making this one bigger
:meth:`~wx.lib.floatcanvas.Utilities.BBox.BBox.Overlaps` Overlap(BB)
:meth:`~wx.lib.floatcanvas.Utilities.BBox.BBox.PointInside` Inside(BB)
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.lib.floatcanvas.Utilities.BBox.BBox.Bottom`
:attr:`~wx.lib.floatcanvas.Utilities.BBox.BBox.Center`
:attr:`~wx.lib.floatcanvas.Utilities.BBox.BBox.Height`
:attr:`~wx.lib.floatcanvas.Utilities.BBox.BBox.Left`
:attr:`~wx.lib.floatcanvas.Utilities.BBox.BBox.Right`
:attr:`~wx.lib.floatcanvas.Utilities.BBox.BBox.Top`
:attr:`~wx.lib.floatcanvas.Utilities.BBox.BBox.Width`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: BBox(N.ndarray)
A Bounding Box object:
Takes Data as an array. Data is any python sequence that can be turned into a
2x2 numpy array of floats::
[
[MinX, MinY ],
[MaxX, MaxY ]
]
It is a subclass of numpy.ndarray, so for the most part it can be used as
an array, and arrays that fit the above description can be used in its place.
Usually created by the factory functions:
asBBox
and
fromPoints
.. method:: Inside(self, BB)
Inside(BB):
Tests if the given Bounding Box is entirely inside this one.
Returns ``True`` if it is entirely inside, or touching the
border.
Returns ``False`` otherwise
.. method:: IsNull(self)
.. method:: Merge(self, BB)
Joins this bounding box with the one passed in, maybe making this one bigger
.. method:: Overlaps(self, BB)
Overlap(BB):
Tests if the given Bounding Box overlaps with this one.
Returns ``True`` is the Bounding boxes overlap, ``False`` otherwise
If they are just touching, returns True
.. method:: PointInside(self, Point)
Inside(BB):
Tests if the given Point is entirely inside this one.
Returns ``True`` if it is entirely inside, or touching the
border.
Returns ``False`` otherwise
Point is any length-2 sequence (tuple, list, array) or two numbers
|
