wxGraphicsMatrix (wx v2.5.4)

Copy Markdown View Source

A wxGraphicsMatrix 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 wxGraphicsContext:createMatrix/2 or wxGraphicsRenderer:createMatrix/2.

This class is derived, and can use functions, from:

wxWidgets docs: wxGraphicsMatrix

Summary

Types

wxGraphicsMatrix()

Functions

concat(This, T)

Concatenates the matrix passed with the current matrix.

get(This)

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

invert(This)

Inverts the matrix.

isEqual(This, T)

Returns true if the elements of the transformation matrix are equal.

isIdentity(This)

Return true if this is the identity matrix.

rotate(This, Angle)

Rotates this matrix clockwise (in radians).

scale(This, XScale, YScale)

Scales this matrix.

set(This)
set/2

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

transformDistance(This)

Applies this matrix to a distance (ie.

transformPoint(This)

Applies this matrix to a point.

translate(This, Dx, Dy)

Translates this matrix.

Types

wxGraphicsMatrix()

-type wxGraphicsMatrix() :: wx:wx_object().

Functions

concat(This :: wxGraphicsMatrix(), T :: wxGraphicsMatrix()) -> ok

Types

This = T = wxGraphicsMatrix()

Concatenates the matrix passed with the current matrix.

The effect of the resulting transformation is to first apply the transformation in t to the coordinates and then apply the transformation in the current matrix to the coordinates.

get(This :: wxGraphicsMatrix()) -> Result

Types

Result = {A :: number(), B :: number(), C :: number(), D :: number(), Tx :: number(), Ty :: number()}

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

invert(This :: wxGraphicsMatrix()) -> ok

Inverts the matrix.

isEqual(This :: wxGraphicsMatrix(), T :: wxGraphicsMatrix()) -> boolean()

Types

This = T = wxGraphicsMatrix()

Returns true if the elements of the transformation matrix are equal.

isIdentity(This :: wxGraphicsMatrix()) -> boolean()

Return true if this is the identity matrix.

rotate(This :: wxGraphicsMatrix(), Angle :: number()) -> ok

Rotates this matrix clockwise (in radians).

scale(This :: wxGraphicsMatrix(), XScale :: number(), YScale :: number()) -> ok

Types

XScale = YScale = number()

Scales this matrix.

set(This) ≡ set(This, [])

set/2

-spec set(This) -> ok when This :: wxGraphicsMatrix().
-spec set(This, [Option]) -> ok
             when
                 This :: wxGraphicsMatrix(),
                 Option ::
                     {a, number()} |
                     {b, number()} |
                     {c, number()} |
                     {d, number()} |
                     {tx, number()} |
                     {ty, number()}.

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

transformDistance(This) -> Result

Types

This = wxGraphicsMatrix()
Result = {Dx :: number(), Dy :: number()}

Applies this matrix to a distance (ie.

performs all transforms except translations).

transformPoint(This :: wxGraphicsMatrix()) -> Result

Types

Result = {X :: number(), Y :: number()}

Applies this matrix to a point.

translate(This :: wxGraphicsMatrix(), Dx :: number(), Dy :: number()) -> ok

Types

Dx = Dy = number()

Translates this matrix.