File: wx.GraphicsMatrix.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 (329 lines) | stat: -rw-r--r-- 7,643 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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
.. 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



.. _wx.GraphicsMatrix:

==========================================================================================================================================
|phoenix_title|  **wx.GraphicsMatrix**
==========================================================================================================================================

A :ref:`wx.GraphicsMatrix`  is a native representation of an affine matrix.          

The contents are specific and private to the respective renderer. Instances are ref counted and can therefore be assigned as usual. The only way to get a valid instance is via :meth:`wx.GraphicsContext.CreateMatrix`   or :meth:`wx.GraphicsRenderer.CreateMatrix` . 









|

|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>GraphicsMatrix</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.GraphicsMatrix_inheritance.png" alt="Inheritance diagram of GraphicsMatrix" 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.GraphicsObject.html" title="wx.GraphicsObject" alt="" coords="5,83,144,112"/> <area shape="rect" id="node3" href="wx.GraphicsMatrix.html" title="wx.GraphicsMatrix" alt="" coords="6,160,143,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="33,5,115,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~wx.GraphicsMatrix.Concat`                                                Concatenates the matrix passed with the current matrix.
:meth:`~wx.GraphicsMatrix.Get`                                                   Returns the component values of the matrix via the argument pointers.
:meth:`~wx.GraphicsMatrix.GetNativeMatrix`                                       Returns the native representation of the matrix.
:meth:`~wx.GraphicsMatrix.Invert`                                                Inverts the matrix.
:meth:`~wx.GraphicsMatrix.IsEqual`                                               Returns ``True`` if the elements of the transformation matrix are equal.
:meth:`~wx.GraphicsMatrix.IsIdentity`                                            Return ``True`` if this is the identity matrix.
:meth:`~wx.GraphicsMatrix.Rotate`                                                Rotates this matrix clockwise (in radians).
:meth:`~wx.GraphicsMatrix.Scale`                                                 Scales this matrix.
:meth:`~wx.GraphicsMatrix.Set`                                                   Sets the matrix to the respective values (default values are the identity matrix).
:meth:`~wx.GraphicsMatrix.TransformDistance`                                     Applies this matrix to a distance (ie.
:meth:`~wx.GraphicsMatrix.TransformPoint`                                        Applies this matrix to a point.
:meth:`~wx.GraphicsMatrix.Translate`                                             Translates this matrix.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.GraphicsMatrix.NativeMatrix`                                          See :meth:`~wx.GraphicsMatrix.GetNativeMatrix`
================================================================================ ================================================================================


|


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


.. class:: wx.GraphicsMatrix(GraphicsObject)

   A GraphicsMatrix is a native representation of an affine matrix.



   .. method:: Concat(self, t)

      Concatenates the matrix passed with the current matrix.                  


      :param `t`: 
      :type `t`: wx.GraphicsMatrix







   .. method:: Get(self)

      Returns the component values of the matrix via the argument pointers.                  

      :rtype: `tuple`







      :returns: 

         ( `a`, `b`, `c`, `d`, `tx`, `ty` ) 








   .. method:: GetNativeMatrix(self)

      Returns the native representation of the matrix.                  

      For CoreGraphics this is a CFAffineMatrix pointer, for GDIPlus a Matrix Pointer, and for Cairo a cairo_matrix_t pointer.                   





   .. method:: Invert(self)

      Inverts the matrix.                   





   .. method:: IsEqual(self, t)

      Returns ``True`` if the elements of the transformation matrix are equal.                  


      :param `t`: 
      :type `t`: wx.GraphicsMatrix




      :rtype: `bool`








   .. method:: IsIdentity(self)

      Return ``True`` if this is the identity matrix.                  

      :rtype: `bool`








   .. method:: Rotate(self, angle)

      Rotates this matrix clockwise (in radians).                  




      :param `angle`: Rotation angle in radians, clockwise.   
      :type `angle`: wx.Double




                  





   .. method:: Scale(self, xScale, yScale)

      Scales this matrix.                  


      :param `xScale`: 
      :type `xScale`: wx.Double
      :param `yScale`: 
      :type `yScale`: wx.Double







   .. method:: Set(self, a=1.0, b=0.0, c=0.0, d=1.0, tx=0.0, ty=0.0)

      Sets the matrix to the respective values (default values are the identity matrix).                  


      :param `a`: 
      :type `a`: wx.Double
      :param `b`: 
      :type `b`: wx.Double
      :param `c`: 
      :type `c`: wx.Double
      :param `d`: 
      :type `d`: wx.Double
      :param `tx`: 
      :type `tx`: wx.Double
      :param `ty`: 
      :type `ty`: wx.Double







   .. method:: TransformDistance(self, dx, dy)

      Applies this matrix to a distance (ie.                  

      performs all transforms except translations).                  


      :param `dx`: 
      :type `dx`: wx.Double
      :param `dy`: 
      :type `dy`: wx.Double




      :rtype: `tuple`







      :returns: 

         ( `dx`, `dy` ) 








   .. method:: TransformPoint(self, x, y)

      Applies this matrix to a point.                  


      :param `x`: 
      :type `x`: wx.Double
      :param `y`: 
      :type `y`: wx.Double




      :rtype: `tuple`







      :returns: 

         ( `x`, `y` ) 








   .. method:: Translate(self, dx, dy)

      Translates this matrix.                  


      :param `dx`: 
      :type `dx`: wx.Double
      :param `dy`: 
      :type `dy`: wx.Double







   .. attribute:: NativeMatrix

      See :meth:`~wx.GraphicsMatrix.GetNativeMatrix`