Assembly CreateJointFixed: Difference between revisions

From FreeCAD Documentation
(→‎Usage: experimental joints and limits added)
mNo edit summary
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>

<!--T:1-->
{{VeryImportantMessage|Some joints are experimental features. To enable them see [[Fine-tuning#Assembly_Workbench|Fine-tuning]].}}

</translate>
{{UnfinishedDocu{{#translation:}}}}
{{UnfinishedDocu{{#translation:}}}}
<translate>
<translate>


<!--T:2-->
{{Docnav
{{Docnav
|[[Assembly_ToggleGrounded|ToggleGrounded]]
|[[Assembly_ToggleGrounded|ToggleGrounded]]
Line 12: Line 19:
}}
}}


<!--T:3-->
{{GuiCommand
{{GuiCommand
|Name=Assembly CreateJointFixed
|Name=Assembly CreateJointFixed
|MenuLocation=Assembly → Create a Fixed Joint
|MenuLocation=Assembly → Create a Fixed Joint
|Workbenches=[[Assembly_Workbench|Assembly]]
|Workbenches=[[Assembly_Workbench|Assembly]]
|Shortcut={{KEY|J}}
|Shortcut={{KEY|F}}
|Version=1.0
|Version=1.0
|SeeAlso=
|SeeAlso=
}}
}}


==Description==
==Description== <!--T:4-->


<!--T:5-->
The [[Image:Assembly_CreateJointFixed.svg|24px]] [[Assembly_CreateJointFixed|Assembly CreateJointFixed]] tool creates a joint locking two assembly parts together, preventing any movement or rotation.
The [[Image:Assembly_CreateJointFixed.svg|24px]] [[Assembly_CreateJointFixed|Assembly CreateJointFixed]] tool creates a joint locking two assembly parts together, preventing any movement or rotation.


==Usage==
==Usage== <!--T:6-->


<!--T:7-->
# Optionally select two geometric entities of two different shapes. (other numbers will result in an empty selection)
# Optionally select two geometric entities of two different parts. Other selections will be rejected.
# There are several ways to invoke the tool:
# There are several ways to invoke the tool:
#* Press the {{Button|[[Image:Assembly_CreateJointFixed.svg|16px]] [[Assembly_CreateJointFixed|Create a Fixed Joint]]}} button.
#* Press the {{Button|[[Image:Assembly_CreateJointFixed.svg|16px]] [[Assembly_CreateJointFixed|Create a Fixed Joint]]}} button.
#* Select the {{MenuCommand|Assembly → [[Image:Assembly_CreateJointFixed.svg|16px]] Create a Fixed Joint}} option from the menu.
#* Select the {{MenuCommand|Assembly → [[Image:Assembly_CreateJointFixed.svg|16px]] Create a Fixed Joint}} option from the menu.
#* Use the keyboard shortcut: {{KEY|J}}.
#* Use the keyboard shortcut: {{KEY|F}}.
# Pre-selected parts are moved to meet at their selected entities.
# The '''Create Joint''' dialog opens in the [[Task_panel|Task panel]] listing preselected entities.
# The '''Create Joint''' dialog opens in the [[Task_panel|Task panel]] listing the pre-selected entities.
# Optionally change the type of the joint from the dropdown list or use a keyboard shortcut:
#* {{KEY|J}} selects the '''Fixed''' option and empties the selection list.
# Optionally change the joint type in the dropdown list:
#* Select '''Fixed'''.
#*# If the selection list is empty: select two geometric entities.
#*# The parts are moved to meet at their selected entities.
#*# Optionally enter an ''Offset'' value.
#*# Optionally enter an ''Offset'' value.
#*# Optionally enter a ''Rotation'' value.
#*# Optionally enter a ''Rotation'' value.
#*# Optionally press {{Button|[[Image:Button_sort.svg|16px]]}} to change the direction of the joint.
#*# Optionally press {{Button|[[Image:Button_sort.svg|16px]]}} to change the direction of the joint.
#* {{KEY|R}} selects the '''Revolute''' option and empties the selection list.
#* Select '''Revolute'''.
#*# If the selection list is empty: select two geometric entities.
#*# The parts are moved to meet at their selected entities.
#*# Optionally enter an ''Offset'' value.
#*# Optionally enter an ''Offset'' value.
#*# Optionally press {{Button|[[Image:Button_sort.svg|16px]]}} to change the direction of the joint.
#*# Optionally press {{Button|[[Image:Button_sort.svg|16px]]}} to change the direction of the joint.
#*# Optionally check the '''Limits''' option.
#*# Optionally check the '''Limits''' option.
#*#* Optionally enter an ''Angle'' min value.
#*#* Optionally enter an ''Angle min'' value.
#*#* Optionally enter an ''Angle'' min value.
#*#* Optionally enter an ''Angle max'' value.
#* {{KEY|C}} selects the '''Cylindrical''' option and empties the selection list.
#* Select '''Cylindrical'''.
#*# If the selection list is empty: select two geometric entities.
#*# Optionally press {{Button|[[Image:Button_sort.svg|16px]]}} to change the direction of the joint.
#*# Optionally press {{Button|[[Image:Button_sort.svg|16px]]}} to change the direction of the joint.
#*# Optionally check the '''Limits''' option.
#*# Optionally check the '''Limits''' option.
Line 50: Line 66:
#*#* Optionally enter an ''Length max'' value.
#*#* Optionally enter an ''Length max'' value.
#*#* Optionally enter an ''Angle min'' value.
#*#* Optionally enter an ''Angle min'' value.
#*#* Optionally enter an ''Angle min'' value.
#*#* Optionally enter an ''Angle max'' value.
#* {{KEY|S}} selects the '''Slider''' option and empties the selection list.
#* Select '''Slider'''.
#*# If the selection list is empty: select two geometric entities.
#*# Optionally enter a ''Rotation'' value.
#*# Optionally enter a ''Rotation'' value.
#*# Optionally press {{Button|[[Image:Button_sort.svg|16px]]}} to change the direction of the joint.
#*# Optionally press {{Button|[[Image:Button_sort.svg|16px]]}} to change the direction of the joint.
Line 57: Line 74:
#*#* Optionally enter an ''Length min'' value.
#*#* Optionally enter an ''Length min'' value.
#*#* Optionally enter an ''Length max'' value.
#*#* Optionally enter an ''Length max'' value.
#* {{KEY|B}} selects the '''Ball''' option and empties the selection list.
#* Select '''Ball'''.
#*# If the selection list is empty: select two geometric entities.
#* {{KEY|D}} selects the '''Distance''' option and empties the selection list.
#* Select '''Distance'''.
#*# If the selection list is empty: select two geometric entities.
#*# Optionally enter a ''Distance'' value.
#*# Optionally enter a ''Distance'' value.
#*# Optionally press {{Button|[[Image:Button_sort.svg|16px]]}} to change the direction of the joint.
#*# Optionally press {{Button|[[Image:Button_sort.svg|16px]]}} to change the direction of the joint.
#* Select '''RackPinion'''. [[Fine-tuning#Assembly_Workbench|{{Emphasis|Experimental feature}}]].
#* {{KEY|not yet defied}} selects the '''RackPinion''' option and empties the selection list.
#*# If the selection list is empty: select two geometric entities of two different parts that have previously been used to define a Slider joint and a Revolute joint. (Slider direction and rotation axis must be perpendicular)
#*# Optionally enter a ''Pitch radius'' value.
#*# Optionally enter a ''Pitch radius'' value.
#* Select '''Screw'''. [[Fine-tuning#Assembly_Workbench|{{Emphasis|Experimental feature}}]].
#* {{KEY|not yet defied}} selects the '''Screw''' option and empties the selection list.
#*# If the selection list is empty: select two geometric entities of two different parts that have previously been used to define a Slider joint and a Revolute joint. (Slider direction and rotation axis must be parallel)
#*# Optionally enter a ''Pitch radius'' value.
#*# Optionally enter a ''Pitch radius'' value.
#* Select '''Gears'''. [[Fine-tuning#Assembly_Workbench|{{Emphasis|Experimental feature}}]].
#* {{KEY|not yet defied}} selects the '''Gears''' option and empties the selection list.
#*# If the selection list is empty: select two geometric entities of two different parts that have previously been used to define two different Revolute joints.
#*# Optionally enter a ''Radius 1'' value.
#*# Optionally enter a ''Radius 1'' value.
#*# Optionally enter a ''Radius 2'' value.
#*# Optionally enter a ''Radius 2'' value.
#*# Optionally check/uncheck the '''Reverse rotation''' option. (unchecking selects the '''Belt''' option)
#*# Optionally check/uncheck the '''Reverse rotation''' option. (unchecking selects the '''Belt''' option)
#* Select '''Belt'''. [[Fine-tuning#Assembly_Workbench|{{Emphasis|Experimental feature}}]].
#* {{KEY|not yet defied}} selects the '''Belt''' option and empties the selection list.
#*# If the selection list is empty: select two geometric entities of two different parts that have previously been used to define two different Revolute joints.
#*# Optionally enter a ''Radius 1'' value.
#*# Optionally enter a ''Radius 1'' value.
#*# Optionally enter a ''Radius 2'' value.
#*# Optionally enter a ''Radius 2'' value.
#*# Optionally check/uncheck the '''Reverse rotation''' option. (checking selects the '''Gears''' option)
#*# Optionally check/uncheck the '''Reverse rotation''' option. (checking selects the '''Gears''' option)
#*# Optionally enter a ''Rotation'' value.
#*# Optionally enter a ''Rotation'' value.
# If the selection list is empty: select two geometric entities.
# The Parts are moved to meet at their selected entities.
# The shapes are moved to meet at their selected entities.
# Press {{Button|OK}} to finish the tool.
# Press {{Button|OK}} to finish the tool.


==Notes== <!--T:8-->
==Properties==


<!--T:9-->
* A fixed joint can be used as an actuator to control the motion of a kinematic simulation. Mouse wheel action in the Task panel immediately rearranges the connected parts.
** Offset translates along its local Z axis, negative offsets are accepted.
** Rotation revolves around its local Z axis, angles > 360° and even negative angles are accepted.

==Properties== <!--T:10-->

<!--T:11-->
See also: [[Property_editor|Property editor]].
See also: [[Property_editor|Property editor]].


<!--T:12-->
A '''Fixed''' object is derived from a ??? object and inherits all its properties. It also has the following additional properties:
A '''Fixed''' object is derived from an [[App_FeaturePython|App FeaturePython]] object and inherits all its properties. It also has the following additional properties:


===Data===
===Data=== <!--T:13-->


<!--T:14-->
{{TitleProperty|Joint}}
{{TitleProperty|Joint}}


<!--T:15-->
* {{PropertyData|Activated|Bool}}: This indicates if the joint is active.
* {{PropertyData|Activated|Bool}}: This indicates if the joint is active.
* {{PropertyData|Distance|Float}}: This is the distance of the joint. It is used only by the distance joint.
* {{PropertyData|Distance|Float}}: This is the distance of the joint. It is used only by the distance joint and the RackPinion (pitch radius), Screw, Gear, and Belt (radius1).
* {{PropertyData|Joint Type|Ennumeration}}: The type of the joint.
* {{PropertyData|Distance2|Float}}: This is the second distance of the joint. It is used only by the gear joint to store the second radius.
* {{PropertyData|Joint Type|Ennumeration}}: The type of the joint. ({{Value|Fixed}}, {{Value|Revolute}}, {{Value|Cylindrical}}, {{Value|Slider}}, {{Value|Ball}}, {{Value|Distance}}, {{Value|RackPinion}}, {{Value|Screw}}, {{Value|Gears}}, {{Value|Belt}})
* {{PropertyData|Offset|Vector}}: This is the offset vector of the joint.
* {{PropertyData|Offset|Vector}}: This is the offset vector of the joint.
* {{PropertyData|Rotation|Float}}: This is the rotation of the joint.
* {{PropertyData|Rotation|Float}}: This is the rotation of the joint.


<!--T:16-->
{{TitleProperty|Joint Connector 1}}
{{TitleProperty|Joint Connector 1}}


<!--T:17-->
* {{PropertyData|Detach1|Bool}}: This prevents placement1 from recomputing, enabling custom positioning of the placement.
* {{PropertyData|Detach1|Bool}}: This prevents placement1 from recomputing, enabling custom positioning of the placement.
* {{PropertyData|Element1|String}}: The selected element of the first object.
* {{PropertyData|Element1|String}}: The selected element of the first object.
Line 103: Line 139:
* {{PropertyData|Vertex1|String}}: The selected Vertex of the first object.
* {{PropertyData|Vertex1|String}}: The selected Vertex of the first object.


<!--T:18-->
{{TitleProperty|Joint Connector 2}}
{{TitleProperty|Joint Connector 2}}


<!--T:19-->
* {{PropertyData|Detach2|Bool}}: This prevents placement2 from recomputing, enabling custom positioning of the placement.
* {{PropertyData|Detach2|Bool}}: This prevents placement2 from recomputing, enabling custom positioning of the placement.
* {{PropertyData|Elemen21|String}}: The selected element of the second object.
* {{PropertyData|Element2|String}}: The selected element of the second object.
* {{PropertyData|Object2|String}}: The second object of the joint.
* {{PropertyData|Object2|String}}: The second object of the joint.
* {{PropertyData|Part2|Link}}: The second Part of the joint.
* {{PropertyData|Part2|Link}}: The second Part of the joint.
Line 112: Line 150:
* {{PropertyData|Vertex2|String}}: The selected Vertex of the second object.
* {{PropertyData|Vertex2|String}}: The selected Vertex of the second object.


<!--T:20-->
==Notes==
{{TitleProperty|Limits}}

<!--T:21-->
* {{PropertyData|Angle Max|Float}}: This is the maximum limit for the angle between both coordinate systems (between their X axes).
* {{PropertyData|Angle Min|Float}}: This is the minimum limit for the angle between both coordinate systems (between their X axes).
* {{PropertyData|Enable Limits|Bool}}: Is this joint using limits?
* {{PropertyData|Length Max|Float}}: This is the maximum limit for the distance between both coordinate systems (along their Z axis).
* {{PropertyData|Length Min|Float}}: This is the minimum limit for the distance between both coordinate systems (along their Z axis).


* Never select the items in the selection list and hit the {{KEY|Del}} key! This also removes the connected features from the Tree! (weekly build 0.22.0-36807)
* This joint can be used as an actuator to control the motion of a kinematic simulation. Mouse wheel action in the Task dialog immediately rearranges the connected parts.
*:- Offset translates along its local Z axis, negativ offsets are accepted.
*:- Rotation revolves around its local Z axis, angles > 360° and even negativ angles are accepted.


<!--T:22-->
{{Docnav
{{Docnav
|[[Assembly_ToggleGrounded|ToggleGrounded]]
|[[Assembly_ToggleGrounded|ToggleGrounded]]

Latest revision as of 11:50, 25 May 2024

Other languages:
Some joints are experimental features. To enable them see Fine-tuning.

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Assembly CreateJointFixed

Menu location
Assembly → Create a Fixed Joint
Workbenches
Assembly
Default shortcut
F
Introduced in version
1.0
See also
None

Description

The Assembly CreateJointFixed tool creates a joint locking two assembly parts together, preventing any movement or rotation.

Usage

  1. Optionally select two geometric entities of two different parts. Other selections will be rejected.
  2. There are several ways to invoke the tool:
    • Press the Create a Fixed Joint button.
    • Select the Assembly → Create a Fixed Joint option from the menu.
    • Use the keyboard shortcut: F.
  3. Pre-selected parts are moved to meet at their selected entities.
  4. The Create Joint dialog opens in the Task panel listing the pre-selected entities.
  5. Optionally change the joint type in the dropdown list:
    • Select Fixed.
      1. If the selection list is empty: select two geometric entities.
      2. The parts are moved to meet at their selected entities.
      3. Optionally enter an Offset value.
      4. Optionally enter a Rotation value.
      5. Optionally press to change the direction of the joint.
    • Select Revolute.
      1. If the selection list is empty: select two geometric entities.
      2. The parts are moved to meet at their selected entities.
      3. Optionally enter an Offset value.
      4. Optionally press to change the direction of the joint.
      5. Optionally check the Limits option.
        • Optionally enter an Angle min value.
        • Optionally enter an Angle max value.
    • Select Cylindrical.
      1. If the selection list is empty: select two geometric entities.
      2. Optionally press to change the direction of the joint.
      3. Optionally check the Limits option.
        • Optionally enter an Length min value.
        • Optionally enter an Length max value.
        • Optionally enter an Angle min value.
        • Optionally enter an Angle max value.
    • Select Slider.
      1. If the selection list is empty: select two geometric entities.
      2. Optionally enter a Rotation value.
      3. Optionally press to change the direction of the joint.
      4. Optionally check the Limits option.
        • Optionally enter an Length min value.
        • Optionally enter an Length max value.
    • Select Ball.
      1. If the selection list is empty: select two geometric entities.
    • Select Distance.
      1. If the selection list is empty: select two geometric entities.
      2. Optionally enter a Distance value.
      3. Optionally press to change the direction of the joint.
    • Select RackPinion. Experimental feature.
      1. If the selection list is empty: select two geometric entities of two different parts that have previously been used to define a Slider joint and a Revolute joint. (Slider direction and rotation axis must be perpendicular)
      2. Optionally enter a Pitch radius value.
    • Select Screw. Experimental feature.
      1. If the selection list is empty: select two geometric entities of two different parts that have previously been used to define a Slider joint and a Revolute joint. (Slider direction and rotation axis must be parallel)
      2. Optionally enter a Pitch radius value.
    • Select Gears. Experimental feature.
      1. If the selection list is empty: select two geometric entities of two different parts that have previously been used to define two different Revolute joints.
      2. Optionally enter a Radius 1 value.
      3. Optionally enter a Radius 2 value.
      4. Optionally check/uncheck the Reverse rotation option. (unchecking selects the Belt option)
    • Select Belt. Experimental feature.
      1. If the selection list is empty: select two geometric entities of two different parts that have previously been used to define two different Revolute joints.
      2. Optionally enter a Radius 1 value.
      3. Optionally enter a Radius 2 value.
      4. Optionally check/uncheck the Reverse rotation option. (checking selects the Gears option)
      5. Optionally enter a Rotation value.
  6. The Parts are moved to meet at their selected entities.
  7. Press OK to finish the tool.

Notes

  • A fixed joint can be used as an actuator to control the motion of a kinematic simulation. Mouse wheel action in the Task panel immediately rearranges the connected parts.
    • Offset translates along its local Z axis, negative offsets are accepted.
    • Rotation revolves around its local Z axis, angles > 360° and even negative angles are accepted.

Properties

See also: Property editor.

A Fixed object is derived from an App FeaturePython object and inherits all its properties. It also has the following additional properties:

Data

Joint

  • DataActivated (Bool): This indicates if the joint is active.
  • DataDistance (Float): This is the distance of the joint. It is used only by the distance joint and the RackPinion (pitch radius), Screw, Gear, and Belt (radius1).
  • DataDistance2 (Float): This is the second distance of the joint. It is used only by the gear joint to store the second radius.
  • DataJoint Type (Ennumeration): The type of the joint. (Fixed, Revolute, Cylindrical, Slider, Ball, Distance, RackPinion, Screw, Gears, Belt)
  • DataOffset (Vector): This is the offset vector of the joint.
  • DataRotation (Float): This is the rotation of the joint.

Joint Connector 1

  • DataDetach1 (Bool): This prevents placement1 from recomputing, enabling custom positioning of the placement.
  • DataElement1 (String): The selected element of the first object.
  • DataObject1 (String): The first object of the joint.
  • DataPart1 (Link): The first Part of the joint.
  • DataPlacement1 (Placement): This is the local coordinate system within object1 that will be used for the joint.
  • DataVertex1 (String): The selected Vertex of the first object.

Joint Connector 2

  • DataDetach2 (Bool): This prevents placement2 from recomputing, enabling custom positioning of the placement.
  • DataElement2 (String): The selected element of the second object.
  • DataObject2 (String): The second object of the joint.
  • DataPart2 (Link): The second Part of the joint.
  • DataPlacement2 (Placement): This is the local coordinate system within object2 that will be used for the joint.
  • DataVertex2 (String): The selected Vertex of the second object.

Limits

  • DataAngle Max (Float): This is the maximum limit for the angle between both coordinate systems (between their X axes).
  • DataAngle Min (Float): This is the minimum limit for the angle between both coordinate systems (between their X axes).
  • DataEnable Limits (Bool): Is this joint using limits?
  • DataLength Max (Float): This is the maximum limit for the distance between both coordinate systems (along their Z axis).
  • DataLength Min (Float): This is the minimum limit for the distance between both coordinate systems (along their Z axis).