Part Tube

From FreeCAD Documentation
Revision as of 18:34, 22 February 2022 by C4e (talk | contribs)

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.

Part Tube

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

Description

The Part Tube command creates a parametric tube solid.

FreeCAD creates a tube, with a inner radius of 2 millimetre, an outer radius of 5 millimetre and a height of 10 millimetre.

By default, the tube is positioned with the center of the bottom circles at the origin (0,0,0). The bottom of the tube is on the xy-plane. Its extension in z-direction follows the positive axis value.

Screenshot of a Part Tube

Usage

  1. There are several ways to invoke the command:
    • Press the Tube button.
    • Select the Part → Primitives → Tube option from the menu.

Example

Part Tube scripting example.

A Part Tube object with the values of the bottom scripting example are shown here.

Notes

The tube is geometrically treated as a cut of a smaller cylinder into a larger one.

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:

Tube

  • DataHeight (Length): Sets the height (default is 10 mm).
  • DataInner Radius (Length): Set the inner radius (default is 2 mm).
  • DataOuter Radius (Length): Set the outer radius (default is 5 mm).

Scripting

A Part Tube can be created with the following code from the CommandShapes.py file:

from BasicShapes import Shapes
from BasicShapes import ViewProviderShapes

tube = FreeCAD.ActiveDocument.addObject("Part::FeaturePython", "myTube")

Shapes.TubeFeature(tube)
ViewProviderShapes.ViewProviderTube(tube.ViewObject)
  • Where myTube is the name for the object. The name must be unique for the entire document.
  • The function returns the newly created object.

You have to recompute the current document with

App.activeDocument().recompute(None,True,True)

to see the tube.

The Label is the user editable name for the object. It can be easily changed by

tube.Label = "new myTubeName"

You can access and modify attributes of the tube object. For example, you may wish to modify the length, width and height parameters.

tube.Height = 20
tube.InnerRadius = 2
tube.OuterRadius = 3

You can change its placement with:

tube.Placement = FreeCAD.Placement(FreeCAD.Vector(1, 2, 3), FreeCAD.Rotation(60, 60, 30))