Std Placement: Difference between revisions

From FreeCAD Documentation
(A placement is internally defined by a matrix; in many cases it is simpler to represent it by means of two components, a Base point, and a Rotation value. More information to scripting.)
(Marked this version for translation)
 
(13 intermediate revisions by 4 users not shown)
Line 4: Line 4:
<!--T:9-->
<!--T:9-->
{{Docnav
{{Docnav
|[[Std_SendToPythonConsole|Std SendToPythonConsole]]
|[[Std_SendToPythonConsole|SendToPythonConsole]]
|[[Std_TransformManip|TransformManip]]
|[[Std_Alignment|Std Alignment]]
|[[Std_Edit_Menu|Std Edit Menu]]
|[[Std_Edit_Menu|Std Edit Menu]]
|IconL=Std_SendToPythonConsole.svg
|IconL=Std_SendToPythonConsole.svg
|IconR=
|IconR=Std_TransformManip.svg
|IconC=Freecad.svg
|IconC=Freecad.svg
}}
}}
Line 17: Line 17:
|MenuLocation=Edit → Placement...
|MenuLocation=Edit → Placement...
|Workbenches=All
|Workbenches=All
|SeeAlso=[[Std_Alignment|Std Alignment]], [[Tasks_Placement|Tasks Placement]], [[Placement|Placement]]
|SeeAlso=[[Std_Alignment|Std Alignment]], [[Placement|Placement]]
}}
}}


Line 42: Line 42:
# Press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the operation. This will undo any changes that have not been applied.
# Press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the operation. This will undo any changes that have not been applied.


<!--T:21-->
The dialog can also be launched by clicking on the ellipsis button {{Button|...}} that appears in the [[Property_editor|property editor]] when you click on the {{PropertyData|Placement}} property.
The dialog can also be launched by clicking on the ellipsis button {{Button|...}} that appears in the [[Property_editor|property editor]] when you click on the {{PropertyData|Placement}} property.


Line 47: Line 48:


<!--T:18-->
<!--T:18-->
* For more information about the placement parameters see the [[Tasks_Placement|Tasks Placement]] and [[Placement|Placement]] pages, and the [[Aeroplane|Aeroplane]] tutorial.
* For more information about the placement parameters see the [[Placement|Placement]] page, and the [[Aeroplane|Aeroplane]] tutorial.
* The rotation angle can be set in degrees in the GUI but is stored in radians internally so that angles usually have to be converted when used in scripts.


==Scripting== <!--T:11-->
==Scripting== <!--T:11-->
Line 57: Line 59:
See the [[Python_scripting_tutorial#Vectors_and_placements|Python scripting tutorial]].
See the [[Python_scripting_tutorial#Vectors_and_placements|Python scripting tutorial]].


<!--T:22-->
A placement is internally defined by a matrix; in many cases it is simpler to represent it by means of two components, a {{incode|Base}} point (vector), and a {{incode|Rotation}} value. The {{incode|Rotation}} itself has different representations; it can be entirely defined by the value of a "[https://en.wikipedia.org/wiki/Quaternion quaternion]" {{incode|(xi + yj + zk + w)}}, but it can also be described by a rotation {{incode|Axis}} (unit vector) and a rotation {{incode|Angle}} (radians).
A placement is internally defined by a matrix; in many cases it is simpler to represent it by means of two components, a {{incode|Base}} point (vector), and a {{incode|Rotation}} value. The {{incode|Rotation}} itself has different representations; it can be entirely defined by the value of a "[https://en.wikipedia.org/wiki/Quaternion quaternion]" {{incode|(xi + yj + zk + w)}}, but it can also be described by a rotation {{incode|Axis}} (unit vector) and a rotation {{incode|Angle}} (radians).


Line 82: Line 85:
<translate>
<translate>


<!--T:23-->
Move the base point of the object, then rotate the object 45 degrees around the X axis.
Move the base point of the object, then rotate the object 45 degrees around the X axis.

<!--T:24-->
The math module supplies a method {{incode|radians()}} to easily convert degrees to radians and has to be imported at first.

</translate>
</translate>
{{Code|code=
{{Code|code=
Line 99: Line 107:
}}
}}
<translate>
<translate>



<!--T:10-->
<!--T:10-->
{{Docnav
{{Docnav
|[[Std_SendToPythonConsole|Std SendToPythonConsole]]
|[[Std_SendToPythonConsole|SendToPythonConsole]]
|[[Std_TransformManip|TransformManip]]
|[[Std_Alignment|Std Alignment]]
|[[Std_Edit_Menu|Std Edit Menu]]
|[[Std_Edit_Menu|Std Edit Menu]]
|IconL=Std_SendToPythonConsole.svg
|IconL=Std_SendToPythonConsole.svg
|IconR=
|IconR=Std_TransformManip.svg
|IconC=Freecad.svg
|IconC=Freecad.svg
}}
}}
Line 113: Line 122:
{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 10:01, 20 September 2023

Std Placement

Menu location
Edit → Placement...
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
Std Alignment, Placement

Description

The Std Placement command displays the Placement task panel for a selected object.

The Placement task panel

Usage

  1. Select a single object that has a DataPlacement property in the property editor.
  2. Select the Edit → Placement... option from the menu.
  3. Change one or more of the translation and rotation parameters.
  4. Do one of the following:
    • Press the OK button to apply the changes and close the task panel.
    • Press the Apply button to apply the changes, but keep the task panel open for further changes.
  5. Press Esc or the Cancel button to abort the operation. This will undo any changes that have not been applied.

The dialog can also be launched by clicking on the ellipsis button ... that appears in the property editor when you click on the DataPlacement property.

Notes

  • For more information about the placement parameters see the Placement page, and the Aeroplane tutorial.
  • The rotation angle can be set in degrees in the GUI but is stored in radians internally so that angles usually have to be converted when used in scripts.

Scripting

See also: FreeCAD Scripting Basics.

See the Python scripting tutorial.

A placement is internally defined by a matrix; in many cases it is simpler to represent it by means of two components, a Base point (vector), and a Rotation value. The Rotation itself has different representations; it can be entirely defined by the value of a "quaternion" (xi + yj + zk + w), but it can also be described by a rotation Axis (unit vector) and a rotation Angle (radians).

import FreeCAD as App

doc = App.newDocument()
obj = doc.addObject("Part::Cylinder", "Cylinder")

print(obj.Placement)
# Placement [Pos=(0,0,0), Yaw-Pitch-Roll=(0,0,0)]
print(obj.Placement.Base)
# Vector (0.0, 0.0, 0.0)
print(obj.Placement.Rotation)
# Rotation (0.0, 0.0, 0.0, 1.0)

print(obj.Placement.Rotation.Angle)
# 0.0
print(obj.Placement.Rotation.Axis)
# Vector (0.0, 0.0, 1.0)
print(obj.Placement.Rotation.Q)
# (0.0, 0.0, 0.0, 1.0)

Move the base point of the object, then rotate the object 45 degrees around the X axis.

The math module supplies a method radians() to easily convert degrees to radians and has to be imported at first.

import math

obj.Placement.Base = App.Vector(5, 3, 1)
obj.Placement.Rotation.Axis = App.Vector(1, 0, 0)
obj.Placement.Rotation.Angle = math.radians(45)

print(obj.Placement)
# Placement [Pos=(5,3,1), Yaw-Pitch-Roll=(0,0,45)]
print(obj.Placement.Rotation.Q)
# (0.3826834323650898, 0.0, 0.0, 0.9238795325112867)
print(obj.Placement.Matrix)
# Matrix ((1,0,0,5),(0,0.707107,-0.707107,3),(0,0.707107,0.707107,1),(0,0,0,1))