Class: Wx::AffineMatrix2DBase

Inherits:

Object

• Object
• Wx::AffineMatrix2DBase

Defined in:

lib/wx/doc/gen/affine_matrix2d.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

A 2x3 matrix representing an affine 2D transformation.

This is an abstract base class implemented by AffineMatrix2D only so far, but in the future we also plan to derive GraphicsMatrix from it.

Category: Miscellaneous

Requires:

• USE_GEOMETRY

Direct Known Subclasses

AffineMatrix2D

Instance Method Summary

• #==(t) ⇒ Boolean

  Check that this matrix is identical with t.

• #concat(t) ⇒ void

  Concatenate this matrix with another one.

• #get ⇒ Array(Wx::Matrix2D,Wx::Point2DDouble)

  Get the component values of the matrix.

• #initialize ⇒ Wx::AffineMatrix2DBase constructor

  Default constructor.

• #invert ⇒ Boolean

  Invert this matrix.

• #is_equal(t) ⇒ Boolean (also: #equal?)

  Check that this matrix is identical with t.

• #is_identity ⇒ Boolean (also: #identity?)

  Check if this is the identity matrix.

• #mirror(direction = Wx::Orientation::HORIZONTAL) ⇒ void

  Add mirroring to this matrix.

• #rotate(cRadians) ⇒ void

  Add clockwise rotation to this matrix.

• #scale(xScale, yScale) ⇒ void

  Add scaling to this matrix.

• #set(mat2D, tr) ⇒ void

  Set all elements of this matrix.

• #transform_distance(p) ⇒ Wx::Point2DDouble

  Applies the linear part of this matrix, i.e.

• #transform_point(p) ⇒ Wx::Point2DDouble

  Applies this matrix to the point.

• #translate(dx, dy) ⇒ void

  Add the translation to this matrix.

Constructor Details

#initialize ⇒ Wx::AffineMatrix2DBase

Default constructor.

The matrix elements are initialize to the identity matrix.

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 35

def initialize; end

Instance Method Details

#==(t) ⇒ Boolean

Check that this matrix is identical with t.

Parameters:

• t (Wx::AffineMatrix2DBase) —

  The matrix compared with this.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 29

def ==(t) end

#concat(t) ⇒ void

This method returns an undefined value.

Concatenate this matrix with another one.

The parameter matrix is the multiplicand.

//           | t.m_11  t.m_12  0 |   | m_11  m_12   0 |
  // matrix' = | t.m_21  t.m_22  0 | x | m_21  m_22   0 |
  //           | t.m_tx  t.m_ty  1 |   | m_tx  m_ty   1 |

Parameters:

• t (Wx::AffineMatrix2DBase) —

  The multiplicand.

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 58

def concat(t) end

#get ⇒ Array(Wx::Matrix2D,Wx::Point2DDouble)

Get the component values of the matrix.

Returns:

• (Array(Wx::Matrix2D,Wx::Point2DDouble))

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 45

def get; end

#invert ⇒ Boolean

Invert this matrix.

If the matrix is not invertible, i.e. if its determinant is 0, returns false and doesn’t modify it.

//           | m_11  m_12  0 |
  // Invert    | m_21  m_22  0 |
  //           | m_tx  m_ty  1 |

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 70

def invert; end

#is_equal(t) ⇒ Boolean Also known as: equal?

Check that this matrix is identical with t.

Parameters:

• t (Wx::AffineMatrix2DBase) —

  The matrix compared with this.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 23

def is_equal(t) end

#is_identity ⇒ Boolean Also known as: identity?

Check if this is the identity matrix.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 74

def is_identity; end

#mirror(direction = Wx::Orientation::HORIZONTAL) ⇒ void

This method returns an undefined value.

Add mirroring to this matrix.

Parameters:

• direction (Integer) (defaults to: Wx::Orientation::HORIZONTAL) —

  The direction(s) used for mirroring. One of Orientation::HORIZONTAL, Orientation::VERTICAL or their combination Orientation::BOTH.

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 97

def mirror(direction=Wx::Orientation::HORIZONTAL) end

#rotate(cRadians) ⇒ void

This method returns an undefined value.

Add clockwise rotation to this matrix.

Parameters:

• cRadians (Float) —

  Rotation angle in radians, clockwise.

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 92

def rotate(cRadians) end

#scale(xScale, yScale) ⇒ void

This method returns an undefined value.

Add scaling to this matrix.

Parameters:

• xScale (Float) —

  Scaling in x direction.

• yScale (Float) —

  Scaling in y direction.

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 87

def scale(xScale, yScale) end

#set(mat2D, tr) ⇒ void

This method returns an undefined value.

Set all elements of this matrix.

Parameters:

• mat2D (Wx::Matrix2D) —

  The rotational components of the matrix (upper 2 x 2).

• tr (Array(Float, Float), Wx::Point2DDouble) —

  The translational components of the matrix.

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 41

def set(mat2D, tr) end

#transform_distance(p) ⇒ Wx::Point2DDouble

Applies the linear part of this matrix, i.e. without translation.

The source with the transformations applied.

Parameters:

• p (Array(Float, Float), Wx::Point2DDouble) —

  The source receiving the transformations.

Returns:

• (Wx::Point2DDouble)

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 111

def transform_distance(p) end

#transform_point(p) ⇒ Wx::Point2DDouble

Applies this matrix to the point.

The point with the transformations applied.

Parameters:

• p (Array(Float, Float), Wx::Point2DDouble) —

  The point receiving the transformations.

Returns:

• (Wx::Point2DDouble)

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 104

def transform_point(p) end

#translate(dx, dy) ⇒ void

This method returns an undefined value.

Add the translation to this matrix.

Parameters:

• dx (Float) —

  The translation in x direction.

• dy (Float) —

  The translation in y direction.

# File 'lib/wx/doc/gen/affine_matrix2d.rb', line 81

def translate(dx, dy) end