Placement API/en: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 1: Line 1:
<languages/>
<languages/>
{{VeryImportantMessage|(November 2018) This information may be incomplete and outdated. For the latest API, see the [https://www.freecadweb.org/api autogenerated API documentation].}}

In FreeCAD, Placement defines an object's position and rotation. The Placement concept is explained in detail here: [[Placement|Placement]].
In FreeCAD, Placement defines an object's position and rotation. The Placement concept is explained in detail here: [[Placement|Placement]].


Line 9: Line 11:
myObj.Placement = pl
myObj.Placement = pl
}}
}}



{{APIClass|Placement| ) or (Placement) or (Matrix) or (Base, Rotation) or (Base,Rotation,Center) or (Base,Axis,Angle|Constructs a placement, empty or with the given arguments, or as a copy of the given placement.}}
{{APIClass|Placement| ) or (Placement) or (Matrix) or (Base, Rotation) or (Base,Rotation,Center) or (Base,Axis,Angle|Constructs a placement, empty or with the given arguments, or as a copy of the given placement.}}

Revision as of 10:20, 27 February 2019

(November 2018) This information may be incomplete and outdated. For the latest API, see the autogenerated API documentation.

In FreeCAD, Placement defines an object's position and rotation. The Placement concept is explained in detail here: Placement.

Example of setting a document object's Placement:

myObj = FreeCAD.ActiveDocument.ActiveObject
pl = FreeCAD.Placement()
pl.move(FreeCAD.Vector(2,0,0))
myObj.Placement = pl
Placement( ) or (Placement) or (Matrix) or (Base, Rotation) or (Base,Rotation,Center) or (Base,Axis,Angle)

Description: Constructs a placement, empty or with the given arguments, or as a copy of the given placement.

Base

Returns: a vector representing the Placement's position.

Rotation

Returns: a quaternion representing the Placement's rotation.

inverse( )

Description: computes the inverse placement

Returns: a placement.

move(Vector)

Description: moves the Placement along the given vector

Returns: nothing

multVec(Vector)

Description: applies the Placement to the given vector

Returns: the resulting vector.

multiply(Placement)

Description: multiplies this placement with another one

Returns: the resulting placement.

toMatrix( )

Description:

Returns: a matrix representing the Placement's transformation.