X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0e5d4c38a3881ac290689af3ddf2a96623d97683..d3fa4bc22e84e3ca4d88cc1772f2d414140a1017:/interface/wx/affinematrix2d.h?ds=sidebyside diff --git a/interface/wx/affinematrix2d.h b/interface/wx/affinematrix2d.h index b5117d4ad5..99f84c4371 100644 --- a/interface/wx/affinematrix2d.h +++ b/interface/wx/affinematrix2d.h @@ -15,7 +15,7 @@ @since 2.9.2 */ -class wxAffineMatrix2D +class wxAffineMatrix2D : public wxAffineMatrix2DBase { public: /** @@ -51,7 +51,7 @@ public: The parameter matrix is the multiplicand. - @param wxAffineMatrix2DBase + @param t The multiplicand. @code @@ -85,7 +85,7 @@ public: /** Check that this matrix is identical with @t. - @param wxAffineMatrix2DBase + @param t The matrix compared with this. */ void IsEqual(const wxAffineMatrix2DBase& t); @@ -95,7 +95,7 @@ public: /** Check that this matrix differs from @t. - @param wxAffineMatrix2DBase + @param t The matrix compared with this. */ bool operator!=(const wxAffineMatrix2DBase& t) const; @@ -107,6 +107,12 @@ public: The translation in x direction. @param dy The translation in y direction. + + @code + // | 1 0 0 | | m_11 m_12 0 | + // matrix' = | 0 1 0 | x | m_21 m_22 0 | + // | dx dy 1 | | m_tx m_ty 1 | + @endcode */ void Translate(wxDouble dx, wxDouble dy); @@ -117,6 +123,12 @@ public: Scaling in x direction. @param yScale Scaling in y direction. + + @code + // | xScale 0 0 | | m_11 m_12 0 | + // matrix' = | 0 yScale 0 | x | m_21 m_22 0 | + // | 0 0 1 | | m_tx m_ty 1 | + @endcode */ void Scale(wxDouble xScale, wxDouble yScale); @@ -130,31 +142,49 @@ public: void Mirror(int direction = wxHORIZONTAL); /** - Add counter clockwise rotation to this matrix. + Add clockwise rotation to this matrix. - @param ccRadians - Rotation angle in radians. + @param cRadians + Rotation angle in radians, clockwise. + + @code + // | cos sin 0 | | m_11 m_12 0 | + // matrix' = | -sin cos 0 | x | m_21 m_22 0 | + // | 0 0 1 | | m_tx m_ty 1 | + @endcode */ - void Rotate(wxDouble ccRadians); + void Rotate(wxDouble cRadians); /** Applies this matrix to the point. - @param src + @param p The point receiving the transformations. @return The point with the transformations applied. + + @code + // | m_11 m_12 0 | + // point' = | src.m_x src._my 1 | x | m_21 m_22 0 | + // | m_tx m_ty 1 | + @endcode */ wxPoint2DDouble TransformPoint(const wxPoint2DDouble& p) const; void TransformPoint(wxDouble* x, wxDouble* y) const; /** - Applies the linear part of this matrix, i.e. without translation. + Applies the linear part of this matrix, i.e.\ without translation. - @param src + @param p The source receiving the transformations. @return The source with the transformations applied. + + @code + // | m_11 m_12 0 | + // dist' = | src.m_x src._my 0 | x | m_21 m_22 0 | + // | m_tx m_ty 1 | + @endcode */ wxPoint2DDouble TransformDistance(const wxPoint2DDouble& p) const; void TransformDistance(wxDouble* dx, wxDouble* dy) const;