File: wx.lib.ogl.basic.EllipseShape.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (172 lines) | stat: -rw-r--r-- 5,255 bytes parent folder | download
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
.. 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.ogl.basic

.. highlight:: python



.. _wx.lib.ogl.basic.EllipseShape:

==========================================================================================================================================
|phoenix_title|  **wx.lib.ogl.basic.EllipseShape**
==========================================================================================================================================

The :class:`EllipseShape` class behaves similarly to the
:class`RectangleShape` but is elliptical.



|

|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>EllipseShape</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.ogl.basic.EllipseShape_inheritance.png" alt="Inheritance diagram of EllipseShape" 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="wx.lib.ogl.basic.Shape.html" title="wx.lib.ogl.basic.Shape" alt="" coords="39,83,200,112"/> <area shape="rect" id="node3" href="wx.lib.ogl.basic.EllipseShape.html" title="wx.lib.ogl.basic.EllipseShape" alt="" coords="19,160,220,189"/> <area shape="rect" id="node2" href="wx.lib.ogl.basic.ShapeEvtHandler.html" title="wx.lib.ogl.basic.ShapeEvtHandler" alt="" coords="5,5,235,35"/> </map> 
   </p>

|


|sub_classes| Known Subclasses
==============================

:class:`wx.lib.ogl.basic.CircleShape`

|


|super_classes| Known Superclasses
==================================

:class:`wx.lib.ogl.basic.Shape`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.ogl.basic.EllipseShape.__init__`                                  Default class constructor
:meth:`~wx.lib.ogl.basic.EllipseShape.GetAttachmentPosition`                     Get attachment position.
:meth:`~wx.lib.ogl.basic.EllipseShape.GetBoundingBoxMin`                         Get the minimum bounding box.
:meth:`~wx.lib.ogl.basic.EllipseShape.GetHeight`                                 Get the height.
:meth:`~wx.lib.ogl.basic.EllipseShape.GetNumberOfAttachments`                    Get number of attachments.
:meth:`~wx.lib.ogl.basic.EllipseShape.GetPerimeterPoint`                         Get the perimeter point.
:meth:`~wx.lib.ogl.basic.EllipseShape.GetWidth`                                  Get the width.
:meth:`~wx.lib.ogl.basic.EllipseShape.OnDraw`                                    The draw handler.
:meth:`~wx.lib.ogl.basic.EllipseShape.SetHeight`                                 Set the height.
:meth:`~wx.lib.ogl.basic.EllipseShape.SetSize`                                   Set the size.
:meth:`~wx.lib.ogl.basic.EllipseShape.SetWidth`                                  Set the width.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: EllipseShape(Shape)

   The :class:`EllipseShape` class behaves similarly to the
   :class`RectangleShape` but is elliptical.

   .. method:: __init__(self, w, h)

      Default class constructor
      
      :param `w`: the width
      :param `h`: the height


   .. method:: GetAttachmentPosition(self, attachment, nth = 0, no_arcs = 1, line = None)

      Get attachment position.
      
      :param `attachment`: the attachment ???
      :param `nth`: get nth attachment ???
      :param `no_arcs`: ???
      :param `line`: ???


   .. method:: GetBoundingBoxMin(self)

      Get the minimum bounding box.


   .. method:: GetHeight(self)

      Get the height.


   .. method:: GetNumberOfAttachments(self)

      Get number of attachments.


   .. method:: GetPerimeterPoint(self, x1, y1, x2, y2)

      Get the perimeter point.
      
      :param `x1`: the x1 position
      :param `y1`: the y1 position
      :param `x2`: the x2 position
      :param `y2`: the y2 position


   .. method:: GetWidth(self)

      Get the width.


   .. method:: OnDraw(self, dc)

      The draw handler.


   .. method:: SetHeight(self, h)

      Set the height.
      
      :param `h`: the height


   .. method:: SetSize(self, x, y, recursive = True)

      Set the size.
      
      :param `x`: the width
      :param `y`: the height
      :recursive: not used


   .. method:: SetWidth(self, w)

      Set the width.
      
      :param `w`: the width