]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/graphicsmatrix.tex
Add wxOverlay
[wxWidgets.git] / docs / latex / wx / graphicsmatrix.tex
CommitLineData
f43af7fe
SC
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: graphicsmatrix.tex
3%% Purpose: wxGraphicsMatrix class documentation
4%% Author: Stefan Csomor
5%% Modified by:
6%% Created: 08.06.2004
7%% RCS-ID: $Id$
8%% Copyright: (c) Stefan Csomor
9%% License: wxWindows license
10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12\section{\class{wxGraphicsMatrix}}\label{wxgraphicsmatrix}
13
14A wxGraphicsMatrix is a native representation of an affine matrix. The contents are specific an 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 a CreateMatrix call on the graphics context or the renderer instance.
15
16\wxheading{Derived from}
17
18\helpref{wxGraphicsObject}{wxgraphicsobject}
19
20\wxheading{Include files}
21
22<wx/graphics.h>
23
24\latexignore{\rtfignore{\wxheading{Members}}}
25
26\membersection{wxGraphicsMatrix::Concat}\label{wxgraphicsmatrixconcat}
27
28\func{void}{Concat}{\param{const wxGraphicsMatrix* }{t}}
29
30Concatenates the matrix passed with the current matrix.
31
32\func{void}{Concat}{\param{const wxGraphicsMatrix\& }{t}}
33
34
35\membersection{wxGraphicsMatrix::GetNativeMatrix}\label{wxgraphicsmatrixgetnativematrix}
36
37\constfunc{void *}{GetNativeMatrix}{\void}
38
39Returns 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.
40
41\membersection{wxGraphicsMatrix::Invert}\label{wxgraphicsmatrixinvert}
42
43\func{void}{Invert}{\void}
44
45Inverts the matrix.
46
47\membersection{wxGraphicsMatrix::IsEqual}\label{wxgraphicsmatrixisequal}
48
49\constfunc{bool}{IsEqual}{\param{const wxGraphicsMatrix\& }{t}}
50
51Returns true if the elements of the transformation matrix are equal.
52
53\membersection{wxGraphicsMatrix::IsIdentity}\label{wxgraphicsmatrixisidentity}
54
55\constfunc{bool}{IsIdentity}{\void}
56
57Return true if this is the identity matrix.
58
59\membersection{wxGraphicsMatrix::Rotate}\label{wxgraphicsmatrixrotate}
60
61\func{void}{Rotate}{\param{wxDouble }{angle}}
62
63Rotates this matrix (radians).
64
65\membersection{wxGraphicsMatrix::Scale}\label{wxgraphicsmatrixscale}
66
67\func{void}{Scale}{\param{wxDouble }{xScale}, \param{wxDouble }{yScale}}
68
69Scales this matrix.
70
71\membersection{wxGraphicsMatrix::Translate}\label{wxgraphicsmatrixtranslate}
72
73\func{void}{Translate}{\param{wxDouble }{dx}, \param{wxDouble }{dy}}
74
75Translates this matrix.
76
77\membersection{wxGraphicsMatrix::Set}\label{wxgraphicsmatrixset}
78
79\func{void}{Set}{\param{wxDouble }{a = 1.0}, \param{wxDouble }{b = 0.0}, \param{wxDouble }{c = 0.0}, \param{wxDouble }{d = 1.0}, \param{wxDouble }{tx = 0.0}, \param{wxDouble }{ty = 0.0}}
80
81Sets the matrix to the respective values (default values are the identity matrix)
82
83\membersection{wxGraphicsMatrix::TransformPoint}\label{wxgraphicsmatrixtransformpoint}
84
85\constfunc{void}{TransformPoint}{\param{wxDouble* }{x}, \param{wxDouble* }{y}}
86
87Applies this matrix to a point.
88
89\membersection{wxGraphicsMatrix::TransformDistance}\label{wxgraphicsmatrixtransformdistance}
90
91\constfunc{void}{TransformDistance}{\param{wxDouble* }{dx}, \param{wxDouble* }{dy}}
92
93Applies this matrix to a distance (ie. performs all transforms except translations)
94
95
96