Macro MatrixTransform: Difference between revisions

From FreeCAD Documentation
(Created page with "<translate> {{Macro|Icon=Text-x-python|Name=MatrixTransform|Description=Transforms a shape using a 3x3 matrix (parametric)|Author=DeepSOIC}} Applies linear transformation to...")
 
(Marked this version for translation)
Line 1: Line 1:
<translate>
<translate>
<!--T:1-->
{{Macro|Icon=Text-x-python|Name=MatrixTransform|Description=Transforms a shape using a 3x3 matrix (parametric)|Author=DeepSOIC}}
{{Macro|Icon=Text-x-python|Name=MatrixTransform|Description=Transforms a shape using a 3x3 matrix (parametric)|Author=DeepSOIC}}


<!--T:2-->
Applies linear transformation to a shape, defined by a 3x3 matrix. It is possible to:
Applies linear transformation to a shape, defined by a 3x3 matrix. It is possible to:
* apply non-linear scaling to a shape
* apply non-linear scaling to a shape
Line 7: Line 9:
* rotate a shape
* rotate a shape


==Installation: ==
==Installation: == <!--T:3-->
download these two files and save them in macro directory:
download these two files and save them in macro directory:


<!--T:4-->
https://github.com/DeepSOIC/FreeCAD-Macros/raw/master/MatrixTransform/MatrixTransform.FCMacro
https://github.com/DeepSOIC/FreeCAD-Macros/raw/master/MatrixTransform/MatrixTransform.FCMacro


<!--T:5-->
https://github.com/DeepSOIC/FreeCAD-Macros/raw/master/MatrixTransform/MatrixTransform.py
https://github.com/DeepSOIC/FreeCAD-Macros/raw/master/MatrixTransform/MatrixTransform.py


==How to use:==
==How to use:== <!--T:6-->
# Select the shape to be transformed
# Select the shape to be transformed
# In FreeCAD menu: Macro -> Macros... -> double-click MatrixTransform.FCMacro . A new object will be created.
# In FreeCAD menu: Macro -> Macros... -> double-click MatrixTransform.FCMacro . A new object will be created.
# Select the new object, and edit v1,v2,v3 properties on data tab to set the transformation matrix.
# Select the new object, and edit v1,v2,v3 properties on data tab to set the transformation matrix.


<!--T:7-->
Matrix is defined by three vectors:
Matrix is defined by three vectors:


v1x v2x v3x
<!--T:8-->
v1x v2x v3x
M = ( v1y v2y v3y )
M = ( v1y v2y v3y )
v1z v2z v3z
v1z v2z v3z
Line 27: Line 33:
to new directions of what was originally X,Y,Z axes.
to new directions of what was originally X,Y,Z axes.


===example matrices===
===example matrices=== <!--T:9-->


====No transformation====
====No transformation==== <!--T:10-->
1 0 0
1 0 0
0 1 0
0 1 0
0 0 1
0 0 1


====non-uniform scaling====
====non-uniform scaling==== <!--T:11-->
scaleX 0 0
scaleX 0 0
0 scaleY 0
0 scaleY 0
0 0 scaleZ
0 0 scaleZ


====shearing====
====shearing==== <!--T:12-->
(operation that makes regular text into italic; assuming text is in XY plane)
(operation that makes regular text into italic; assuming text is in XY plane)
1 shear 0
1 shear 0
Line 48: Line 54:




<!--T:13-->
Warning. All geometry is converted to B-splines, even if it doesn't have to.
Warning. All geometry is converted to B-splines, even if it doesn't have to.
This can cause all sorts of trouble. Use only if absolutely necessary.
This can cause all sorts of trouble. Use only if absolutely necessary.

Revision as of 21:06, 25 May 2016

File:Text-x-python MatrixTransform

Description
Transforms a shape using a 3x3 matrix (parametric)

Author: DeepSOIC
Author
DeepSOIC
Download
None
Links
Macro Version
1.0
Date last modified
None
FreeCAD Version(s)
None
Default shortcut
None
See also
None

Applies linear transformation to a shape, defined by a 3x3 matrix. It is possible to:

  • apply non-linear scaling to a shape
  • shear a shape
  • rotate a shape

Installation:

download these two files and save them in macro directory:

https://github.com/DeepSOIC/FreeCAD-Macros/raw/master/MatrixTransform/MatrixTransform.FCMacro

https://github.com/DeepSOIC/FreeCAD-Macros/raw/master/MatrixTransform/MatrixTransform.py

How to use:

  1. Select the shape to be transformed
  2. In FreeCAD menu: Macro -> Macros... -> double-click MatrixTransform.FCMacro . A new object will be created.
  3. Select the new object, and edit v1,v2,v3 properties on data tab to set the transformation matrix.

Matrix is defined by three vectors:

          v1x   v2x   v3x                  
   M = (  v1y   v2y   v3y )                  
          v1z   v2z   v3z                  

Here, v1,v2,v3 are vectors that can be defined in properties. They correspond to new directions of what was originally X,Y,Z axes.

example matrices

No transformation

   1  0  0
   0  1  0
   0  0  1

non-uniform scaling

   scaleX    0      0
      0   scaleY    0
      0      0   scaleZ

shearing

(operation that makes regular text into italic; assuming text is in XY plane)

   1  shear  0
   0    1    0
   0    0    1

'Shear' coefficient defines the amount of shearing. 0 is no shearing. 1 makes the text italic by 45 degrees. -1 shears in backslash-like fashion.


Warning. All geometry is converted to B-splines, even if it doesn't have to. This can cause all sorts of trouble. Use only if absolutely necessary.


MatrixTransform.py:

#***************************************************************************
#*                                                                         *
#*   Copyright (c) 2015 - Victor Titov (DeepSOIC)                          *
#*                                               <vv.titov@gmail.com>      *  
#*                                                                         *
#*   This program is free software; you can redistribute it and/or modify  *
#*   it under the terms of the GNU Lesser General Public License (LGPL)    *
#*   as published by the Free Software Foundation; either version 2 of     *
#*   the License, or (at your option) any later version.                   *
#*   for detail see the LICENCE text file.                                 *
#*                                                                         *
#*   This program is distributed in the hope that it will be useful,       *
#*   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
#*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
#*   GNU Library General Public License for more details.                  *
#*                                                                         *
#*   You should have received a copy of the GNU Library General Public     *
#*   License along with this program; if not, write to the Free Software   *
#*   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
#*   USA                                                                   *
#*                                                                         *
#***************************************************************************

__title__="Macro MatrixTransform"
__author__ = "DeepSOIC"
__doc__ = '''
Macro MatrixTransform.
Distorts geometry according to vector transformation defined by the matrix.

Matrix is defined by three vectors:
       v1x   v2x   v3x                  
M = (  v1y   v2y   v3y )                  
       v1z   v2z   v3z                  
Here, v1,v2,v3 are vectors that can be defined in properties. They correspond
to new directions of what was originally X,Y,Z axes.

exmaple matrices:

No transformation:
1  0  0
0  1  0
0  0  1

non-uniform scaling:
scaleX    0      0
   0   scaleY    0
   0      0   scaleZ

shearing (operation that makes regular text into italic; assuming text is in XY
plane):
1  shear  0
0    1    0
0    0    1
('shear' coefficient defines the amount of shearing. 0 is no shearing. 1 makes
the text italic by 45 degrees. -1 shears in backslash-like fashion.)


Warning. All geometry is converted to B-splines, even if it doesn't have to.
This can cause all sorts of trouble. Use only if absolutely necessary.
'''

import FreeCAD as App
if App.GuiUp:
    import FreeCADGui as Gui
import Part

def makeMatrixTransformFeature():
    '''makeMatrixTransformFeature(): makes a MatrixTransform parametric feature object. Returns the new object.'''
    obj = App.ActiveDocument.addObject("Part::FeaturePython","Transform")
    MatrixTransform(obj)
    ViewProviderMatrixTransform(obj.ViewObject)
    return obj

class MatrixTransform:
    "The FuseCompound object"
    def __init__(self,obj):
        obj.addProperty("App::PropertyLink","Base","MatrixTransform","Input shape")
        obj.addProperty("App::PropertyVector","v1","MatrixTransform","Vector for new X axis; first column of transform matrix.")
        obj.addProperty("App::PropertyVector","v2","MatrixTransform","Vector for new Y axis; second column of transform matrix.")
        obj.addProperty("App::PropertyVector","v3","MatrixTransform","Vector for new Z axis; third column of transform matrix.")
        obj.v1 = App.Vector(1,0,0)
        obj.v2 = App.Vector(1,1,0)
        obj.v3 = App.Vector(0,0,1)
        obj.Proxy = self
        

    def execute(self,obj):
        v1 = obj.v1
        v2 = obj.v2
        v3 = obj.v3
        m = App.Matrix(  v1.x, v2.x, v3.x, 0,
                         v1.y, v2.y, v3.y, 0,
                         v1.z, v2.z, v3.z, 0,
                         0,    0,    0,    1   )
        obj.Shape = obj.Base.Shape.transformGeometry(m)

class ViewProviderMatrixTransform:
    
    def __init__(self,vobj):
        vobj.Proxy = self
       
    def getIcon(self):
        return ""

    def attach(self, vobj):
        self.ViewObject = vobj
        self.Object = vobj.Object
  
    def setEdit(self,vobj,mode):
        return False
    
    def unsetEdit(self,vobj,mode):
        return

    def __getstate__(self):
        return None

    def __setstate__(self,state):
        return None

    def claimChildren(self):
        return [self.Object.Base]
        
    def onDelete(self, feature, subelements): # subelements is a tuple of strings
        try:
            self.Object.Base.ViewObject.show()
        except Exception as err:
            App.Console.PrintError("Error in onDelete: " + err.message)
        return True

def run():
    sel = Gui.Selection.getSelection()
    try:
        if len(sel) != 1:
            raise Exception("Select a shape to transform, first! Then run this macro.")
        obj = makeMatrixTransformFeature()
        obj.Base = sel[0]
        obj.Proxy.execute(obj)
    except Exception as err:
        from PySide import QtGui
        mb = QtGui.QMessageBox()
        mb.setIcon(mb.Icon.Warning)
        mb.setText(err.message)
        mb.setWindowTitle("Macro MatrixTransform")
        mb.exec_()

MatrixTransform.FCMacro:

import MatrixTransform
MatrixTransform.run()
Other languages: