Matrix API/en: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Importing a new version from external source)
Line 8: Line 8:


{{APIFunction|A| | |all the matrix elements.}}
{{APIFunction|A| | |all the matrix elements.}}
{{APIFunction|A11| | |a matrix element.}}
{{APIFunction|A12| | |a matrix element.}}
{{APIFunction|A13| | |a matrix element.}}
{{APIFunction|A14| | |a matrix element.}}
{{APIFunction|A21| | |a matrix element.}}
{{APIFunction|A22| | |a matrix element.}}
{{APIFunction|A23| | |a matrix element.}}
{{APIFunction|A24| | |a matrix element.}}
{{APIFunction|A31| | |a matrix element.}}
{{APIFunction|A32| | |a matrix element.}}
{{APIFunction|A33| | |a matrix element.}}
{{APIFunction|A34| | |a matrix element.}}
{{APIFunction|A41| | |a matrix element.}}
{{APIFunction|A42| | |a matrix element.}}
{{APIFunction|A43| | |a matrix element.}}
{{APIFunction|A44| | |a matrix element.}}
{{APIFunction|determinant| |Computes the [http://en.wikipedia.org/wiki/Determinant determinant] of the matrix|a number.}}
{{APIFunction|inverse| |[http://en.wikipedia.org/wiki/Inverse_matrix Inverts] this matrix, if possible|nothing.}}
{{APIFunction|invert| |Returns the [http://en.wikipedia.org/wiki/Inverse_matrix inverse] of this matrix, if possible|a Matrix}}
{{APIFunction|move|Vector|Makes this matrix a [http://en.wikipedia.org/wiki/Translation_%28geometry%29 translation] matrix|nothing.}}
{{APIFunction|multiply|Matrix or Vector|Returns the [http://en.wikipedia.org/wiki/Cross_product cross product] of a matrix or vector with this matrix|a Matrix}}
{{APIFunction|rotateX|Float(radians)|Makes this matrix a [http://en.wikipedia.org/wiki/Rotation_%28mathematics%29 rotation] about X transform|nothing.}}
{{APIFunction|rotateY|Float(radians)|Makes this matrix a [http://en.wikipedia.org/wiki/Rotation_%28mathematics%29 rotation] about Y transform|nothing.}}
{{APIFunction|rotateZ|Float(radians)|Makes this matrix a [http://en.wikipedia.org/wiki/Rotation_%28mathematics%29 rotation] about Z transform|nothing.}}
{{APIFunction|scale|Vector|Makes this matrix a [http://en.wikipedia.org/wiki/Scaling_matrix scaling transform]|nothing.}}
{{APIFunction|transform|Vector, Matrix|Makes this matrix a [http://en.wikipedia.org/wiki/Transformation_matrix transformation matrix] based on Vector and Matrix|nothing. }}
{{APIFunction|unity| |Makes this matrix the [http://en.wikipedia.org/wiki/Identity_matrix identity matrix]|nothing.}}


[[Category:API]]
[[Category:API]]

Revision as of 23:00, 15 November 2014

4x4 Matrixes are used everywhere throughout FreeCAD and can be created by one of the following manners:

m=FreeCAD.Matrix()          # m = the [http://en.wikipedia.org/wiki/Identity_matrix identity matrix]
m=FreeCAD.Base.Matrix()
print m.A21()               # print m[1][0]


A( )

Description:

Returns: all the matrix elements.

A11( )

Description:

Returns: a matrix element.

A12( )

Description:

Returns: a matrix element.

A13( )

Description:

Returns: a matrix element.

A14( )

Description:

Returns: a matrix element.

A21( )

Description:

Returns: a matrix element.

A22( )

Description:

Returns: a matrix element.

A23( )

Description:

Returns: a matrix element.

A24( )

Description:

Returns: a matrix element.

A31( )

Description:

Returns: a matrix element.

A32( )

Description:

Returns: a matrix element.

A33( )

Description:

Returns: a matrix element.

A34( )

Description:

Returns: a matrix element.

A41( )

Description:

Returns: a matrix element.

A42( )

Description:

Returns: a matrix element.

A43( )

Description:

Returns: a matrix element.

A44( )

Description:

Returns: a matrix element.

determinant( )

Description: Computes the determinant of the matrix

Returns: a number.

inverse( )

Description: Inverts this matrix, if possible

Returns: nothing.

invert( )

Description: Returns the inverse of this matrix, if possible

Returns: a Matrix

move(Vector)

Description: Makes this matrix a translation matrix

Returns: nothing.

multiply(Matrix or Vector)

Description: Returns the cross product of a matrix or vector with this matrix

Returns: a Matrix

rotateX(Float(radians))

Description: Makes this matrix a rotation about X transform

Returns: nothing.

rotateY(Float(radians))

Description: Makes this matrix a rotation about Y transform

Returns: nothing.

rotateZ(Float(radians))

Description: Makes this matrix a rotation about Z transform

Returns: nothing.

scale(Vector)

Description: Makes this matrix a scaling transform

Returns: nothing.

transform(Vector, Matrix)

Description: Makes this matrix a transformation matrix based on Vector and Matrix

Returns: nothing.

unity( )

Description: Makes this matrix the identity matrix

Returns: nothing.