summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxGraphicsMatrix.xml
blob: 60b0d5be4358971043bda529a0960705399c7771 (plain)
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
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxGraphicsMatrix</title>
</header>
<module>wxGraphicsMatrix</module>
<modulesummary>Functions for wxGraphicsMatrix class</modulesummary>
<description><p>A <seeerl marker="wxGraphicsMatrix"><c>wxGraphicsMatrix</c></seeerl> 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 <seemfa marker="wxGraphicsContext#createMatrix/2"><c>wxGraphicsContext:createMatrix/2</c></seemfa> or <seemfa marker="wxGraphicsRenderer#createMatrix/2"><c>wxGraphicsRenderer:createMatrix/2</c></seemfa>.
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxGraphicsObject"><c>wxGraphicsObject</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_graphics_matrix.html">wxGraphicsMatrix</url></p>
  </description>
<datatypes><datatype><name name="wxGraphicsMatrix"/></datatype></datatypes>

<funcs>
  <func>
    <name name="concat" arity="2" clause_i="1" since=""/>
    <fsummary>Concatenates the matrix passed with the current matrix. </fsummary>
    <desc><p>Concatenates the matrix passed with the current matrix. 
      </p><p>The effect of the resulting transformation is to first apply the transformation in <c>t</c> to the coordinates and then apply the transformation in the current matrix to the coordinates.
      </p></desc>
  </func>
  
  <func>
    <name name="get" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the component values of the matrix via the argument pointers. </fsummary>
    <desc><p>Returns the component values of the matrix via the argument pointers. 
      </p></desc>
  </func>
  
  <func>
    <name name="invert" arity="1" clause_i="1" since=""/>
    <fsummary>Inverts the matrix. </fsummary>
    <desc><p>Inverts the matrix. 
      </p></desc>
  </func>
  
  <func>
    <name name="isEqual" arity="2" clause_i="1" since=""/>
    <fsummary>Returns true if the elements of the transformation matrix are equal. </fsummary>
    <desc><p>Returns true if the elements of the transformation matrix are equal. 
      </p></desc>
  </func>
  
  <func>
    <name name="isIdentity" arity="1" clause_i="1" since=""/>
    <fsummary>Return true if this is the identity matrix. </fsummary>
    <desc><p>Return true if this is the identity matrix. 
      </p></desc>
  </func>
  
  <func>
    <name name="rotate" arity="2" clause_i="1" since=""/>
    <fsummary>Rotates this matrix clockwise (in radians). </fsummary>
    <desc><p>Rotates this matrix clockwise (in radians). 
      </p></desc>
  </func>
  
  <func>
    <name name="scale" arity="3" clause_i="1" since=""/>
    <fsummary>Scales this matrix. </fsummary>
    <desc><p>Scales this matrix. 
      </p></desc>
  </func>
  
  <func>
    <name name="translate" arity="3" clause_i="1" since=""/>
    <fsummary>Translates this matrix. </fsummary>
    <desc><p>Translates this matrix. 
      </p></desc>
  </func>
  
  <func>
    <name name="set" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>set/2</c></fsummary>
  </func>
  
  <func>
    <name name="set" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the matrix to the respective values (default values are the identity matrix). </fsummary>
    <desc><p>Sets the matrix to the respective values (default values are the identity matrix). 
      </p></desc>
  </func>
  
  <func>
    <name name="transformPoint" arity="1" clause_i="1" since=""/>
    <fsummary>Applies this matrix to a point. </fsummary>
    <desc><p>Applies this matrix to a point. 
      </p></desc>
  </func>
  
  <func>
    <name name="transformDistance" arity="1" clause_i="1" since=""/>
    <fsummary>Applies this matrix to a distance (ie. </fsummary>
    <desc><p>Applies this matrix to a distance (ie. 
      </p><p>performs all transforms except translations). 
      </p></desc>
  </func>
  </funcs>
</erlref>