Part Tube/it: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 15: Line 15:
|Workbenches=[[Part_Workbench|Part]]
|Workbenches=[[Part_Workbench|Part]]
|Version=0.19
|Version=0.19
|SeeAlso=[[Part_CreatePrimitives|Part CreatePrimitives]]
|SeeAlso=[[Part_Primitives|Part Primitives]]
}}
}}


==Description==
==Description==


The [[Image:Part_Tube.svg|24px]] '''Part Tube''' command creates a parametric tube solid. In the coordinate system defined by its {{PropertyData|Placement}} property, the bottom face of the tube lies on the XY plane with its center at the origin.
The Tube command inserts a tube into the active document. The tube is geometrically treated as a cut of a smaller cylinder into a larger one. By default, the command will insert a 10 mm high tube with an outer radius of 5 mm and an inner radius of 2 mm. These parameters can be modified after the object has been added.


[[Image:Part_Tube-screenshot.png|Screenshot of a Tube]]
[[Image:Part_Tube_Example.png|400px]]


==Usage==
==Usage==


=== Create ===
To create a tube either:
⚫
* press the {{Button|[[Image:Part_Tube.svg|16px]] Tube}} button in the toolbar
⚫
* use the menu {{MenuCommand|Part → Primitives → Create tube}}


# There are several ways to invoke the command:
To edit the tube:
⚫
#* Press the {{Button|[[Image:Part_Tube.svg|16px]] [[Part_Tube|Part Tube]]}} button.
* either
⚫
#* Select the {{MenuCommand|Part → Primitives → [[Image:Part_Tube.svg|16px]] Create tube}} option from the menu.
** select it in the tree and double-click on it
# The {{MenuCommand|Tube}} task panel opens and a preview of the tube is displayed in the [[3D_view|3D view]].
** edit the parameters in the appearing dialog
# Specify the dimensions.
* or use the the [[Property_editor|property editor]] to edit the parameters
# The preview is dynamically updated.
# Press the {{Button|OK}} button.
# The tube is created.
# Optionally change the {{PropertyData|Placement}} of the tube in the [[Property_editor|Property editor]], or with the [[Image:Std_TransformManip.svg|16px]] [[Std_TransformManip|Std TransformManip]] command.

=== Edit ===

# Double-click the tube in the [[Tree_view|Tree view]]
# The {{MenuCommand|Tube}} task panel opens.
# Change one or more dimensions.
# The tube is dynamically updated in the [[3D_view|3D view]].
# Press the {{Button|OK}} button.

== Example ==

[[Image:Part_Tube_Scripting_Example.png|thumb|Part Tube from the scripting example]]

A Part Tube object created with the [[#Scripting|scripting example]] below is shown here.


==Properties==
==Properties==


* Via the [[Property_editor|Property Editor]]:
See also: [[Property_editor|Property editor]].

** {{PropertyData|Placement}}: Specifies the orientation and position of the Box in the 3D space. See [[Placement|Placement]]. The reference point is the left front lower corner of the box.
A Part Tube object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties:
** {{PropertyData|Label}}: The Label is the name given to the operation. This name can be changed at your convenience.

⚫
** {{PropertyData|Height}}: Sets the height (default is 10 mm).
=== Data ===
** {{PropertyData|Inner Radius}}: Set the inner radius (default is 2 mm).

** {{PropertyData|Outer Radius}}: Set the outer radius (default is 5 mm).
{{TitleProperty|Attachment}}

The object has the same attachment properties as a [[Part_Part2DObject#Data|Part Part2DObject]].

{{TitleProperty|Tube}}

⚫
* {{PropertyData|Height|Length}}: The height of the tube. The default is {{Value|10mm}}.
* {{PropertyData|Inner Radius|Length}}: The inner radius of the tube. Must be smaller than {{PropertyData|Outer Radius}}. Can be {{Value|0}}. The default is {{Value|2mm}}.
* {{PropertyData|Outer Radius|Length}}: The outer radius of the tube. Must be larger than {{PropertyData|Inner Radius}}. The default is {{Value|5mm}}.


== Scripting ==
== Scripting ==


See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
A Part Tube can be created using the following function:

A Part Tube can be created with the {{Incode|addTube()}} method ({{Version|0.20}}) of the Shapes module:


{{Code|code=
{{Code|code=
tube = FreeCAD.ActiveDocument.addObject("Part::Tube", "myTube")
tube = Shapes.addTube(FreeCAD.ActiveDocument, "myTube")
}}
}}


* Where {{Incode|"myTube"}} is the name for the object.
* Where {{Incode|"myTube"}} is the name for the object.
* The function returns the newly created object.
* The function returns the newly created object.

Example:

{{Code|code=
import FreeCAD as App
from BasicShapes import Shapes

doc = App.activeDocument()

tube = Shapes.addTube(FreeCAD.ActiveDocument, "myTube")
tube.Height = 20
tube.InnerRadius = 2
tube.OuterRadius = 3
tube.Placement = App.Placement(App.Vector(2, 4, 5), App.Rotation(60, 60, 30))

doc.recompute()
}}




Line 66: Line 110:
}}
}}


{{Part Tools navi{{#translation:}}}}
{{Part_Tools_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Revision as of 10:01, 3 March 2022

Other languages:

Part Tube

Menu location
Part → Primitives → Create tube
Workbenches
Part
Default shortcut
None
Introduced in version
0.19
See also
Part Primitives

Description

The Part Tube command creates a parametric tube solid. In the coordinate system defined by its DatiPlacement property, the bottom face of the tube lies on the XY plane with its center at the origin.

Usage

Create

  1. There are several ways to invoke the command:
    • Press the Part Tube button.
    • Select the Part → Primitives → Create tube option from the menu.
  2. The Tube task panel opens and a preview of the tube is displayed in the 3D view.
  3. Specify the dimensions.
  4. The preview is dynamically updated.
  5. Press the OK button.
  6. The tube is created.
  7. Optionally change the DatiPlacement of the tube in the Property editor, or with the Std TransformManip command.

Edit

  1. Double-click the tube in the Tree view
  2. The Tube task panel opens.
  3. Change one or more dimensions.
  4. The tube is dynamically updated in the 3D view.
  5. Press the OK button.

Example

Part Tube from the scripting example

A Part Tube object created with the scripting example below is shown here.

Properties

See also: Property editor.

A Part Tube object is derived from a Part Feature object and inherits all its properties. It also has the following additional properties:

Data

Attachment

The object has the same attachment properties as a Part Part2DObject.

Tube

  • DatiHeight (Length): The height of the tube. The default is 10mm.
  • DatiInner Radius (Length): The inner radius of the tube. Must be smaller than DatiOuter Radius. Can be 0. The default is 2mm.
  • DatiOuter Radius (Length): The outer radius of the tube. Must be larger than DatiInner Radius. The default is 5mm.

Scripting

See also: Autogenerated API documentation, Part scripting and FreeCAD Scripting Basics.

A Part Tube can be created with the addTube() method (introduced in version 0.20) of the Shapes module: 

tube = Shapes.addTube(FreeCAD.ActiveDocument, "myTube")
  • Where "myTube" is the name for the object.
  • The function returns the newly created object.

Example: 

import FreeCAD as App
from BasicShapes import Shapes

doc = App.activeDocument()

tube = Shapes.addTube(FreeCAD.ActiveDocument, "myTube")
tube.Height = 20
tube.InnerRadius = 2
tube.OuterRadius = 3
tube.Placement = App.Placement(App.Vector(2, 4, 5), App.Rotation(60, 60, 30))

doc.recompute()


Part
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Part_Tube/it&oldid=1106416"