.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.graphics
.. highlight:: python
.. _wx.lib.graphics.GraphicsMatrix:
==========================================================================================================================================
|phoenix_title| **wx.lib.graphics.GraphicsMatrix**
==========================================================================================================================================
A matrix holds an affine transformations, such as a scale,
rotation, shear, or a combination of these, and is used to convert
between different coordinate spaces.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
GraphicsMatrix:
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.graphics.GraphicsObject`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.graphics.GraphicsMatrix.__init__` Initialize self. See help(type(self)) for accurate signature.
:meth:`~wx.lib.graphics.GraphicsMatrix.Clone`
:meth:`~wx.lib.graphics.GraphicsMatrix.Concat` Concatenates the matrix passed with the current matrix.
:meth:`~wx.lib.graphics.GraphicsMatrix.Get` Return the component values of the matrix as a tuple.
:meth:`~wx.lib.graphics.GraphicsMatrix.GetNativeMatrix`
:meth:`~wx.lib.graphics.GraphicsMatrix.Invert` Inverts the matrix.
:meth:`~wx.lib.graphics.GraphicsMatrix.IsEqual` Returns ``True`` if the elements of the transformation matrices are equal.
:meth:`~wx.lib.graphics.GraphicsMatrix.IsIdentity` Returns ``True`` if this is the identity matrix.
:meth:`~wx.lib.graphics.GraphicsMatrix.Rotate` Rotates the matrix in radians
:meth:`~wx.lib.graphics.GraphicsMatrix.Scale` Scale the matrix
:meth:`~wx.lib.graphics.GraphicsMatrix.Set` Set the components of the matrix by value, default values
:meth:`~wx.lib.graphics.GraphicsMatrix.TransformDistance` Applies this matrix to a distance (ie. performs all transforms
:meth:`~wx.lib.graphics.GraphicsMatrix.TransformPoint` Applies this matrix to a point and returns the result
:meth:`~wx.lib.graphics.GraphicsMatrix.Translate` Translate the matrix. This shifts the origin.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: GraphicsMatrix(GraphicsObject)
A matrix holds an affine transformations, such as a scale,
rotation, shear, or a combination of these, and is used to convert
between different coordinate spaces.
.. method:: __init__(self)
Initialize self. See help(type(self)) for accurate signature.
.. method:: Clone(self)
.. method:: Concat(self, matrix) -> Self
Concatenates the matrix passed with the current matrix.
.. method:: Get(self)
Return the component values of the matrix as a tuple.
.. method:: GetNativeMatrix(self)
.. method:: Invert(self) -> Self
Inverts the matrix.
.. method:: IsEqual(self, matrix)
Returns ``True`` if the elements of the transformation matrices are equal.
.. method:: IsIdentity(self)
Returns ``True`` if this is the identity matrix.
.. method:: Rotate(self, angle) -> Self
Rotates the matrix in radians
.. method:: Scale(self, xScale, yScale) -> Self
Scale the matrix
.. method:: Set(self, a=1.0, b=0.0, c=0.0, d=1.0, tx=0.0, ty=0.0)
Set the components of the matrix by value, default values
are the identity matrix.
.. method:: TransformDistance(self, dx, dy)
Applies this matrix to a distance (ie. performs all transforms
except translations.)
.. method:: TransformPoint(self, x, y)
Applies this matrix to a point and returns the result
.. method:: Translate(self, dx, dy) -> Self
Translate the matrix. This shifts the origin.