Rocket CenteringRing: Difference between revisions

From FreeCAD Documentation
Line 47: Line 47:
== Properties ==
== Properties ==


{{TitleProperty|Rocket Component}}
=== Data ===


These parameters are provided for information and have no effect on the design of the component.
{{TitleProperty|Property Group}}


* {{PropertyData|Property Name 1}}: Description of the property
* {{PropertyData|Manufacturer}}: Manufacturer when known
* {{PropertyData|Part Number}}: Manufacturer part number
* {{PropertyData|Description}}: Description of the component
* {{PropertyData|Material}}: Material when known


{{TitleProperty|Bulkhead}}
=== View ===


These properties are inherited from the '''Bulkhead''', see [[Rocket_Bulkhead|Bulkhead]] for more information.
{{TitleProperty|Property Group}}


* {{PropertyView|Property Name 2}}: Description of the property
* {{PropertyData|Diameter}}: The outer diameter of the bulkhead
* {{PropertyData|Thickness}}: The thickness, not including any step, of the bulkhead
* {{PropertyData|Step}}: True when the bulkhead includes a step, see [[Rocket_Bulkhead#Options|Bulkhead Options]]
* {{PropertyData|Step Diameter}}: The outer diameter of the step
* {{PropertyData|Step Thickness}}: The thickness, not including the bulkhead thickness, of the step
* {{PropertyData|Holes}}: True when the the bulkhead has one or more holes, see [[Rocket_Bulkhead#Options|Bulkhead Options]]
* {{PropertyData|Hole Diameter}}: The diameter of the hole
* {{PropertyData|Hole Center}}: The distance from the center of the hole to the center of the bulkhead
* {{PropertyData|Hole Count}}: The number of holes applied in a radial pattern around the center of the bulkhead
* {{PropertyData|Hole Offset}}: Offset from 0 degrees of the first hole

{{TitleProperty|Centering Ring}}

* {{PropertyData|Center Diameter}}: The diameter of the inner hole
* {{PropertyData|Notched}}: True when the center hole includes a notch, see [[#Options|Options]]
* {{PropertyData|Notch Height}}: The notch height
* {{PropertyData|Notch Width}}: The notch width


== Scripting ==
== Scripting ==

Revision as of 17:41, 18 February 2021

Other languages:

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.

Centering Ring

Menu location
Rocket → Centering Ring
Workbenches
Rocket Workbench
Default shortcut
None
Introduced in version
0.19
See also
None

Description

A Centering Ring is a solid object used to hold one or more body tubes inside another.

Usage

  1. There are several ways to invoke the command:
    • Press the Centering Ring button.
    • Select the Rocket → Centering Ring option from the menu.
    • Double click on a Centering Ring object in the model view.
  2. Set options and press OK.

Options

Example

Optional.

Notes

  • Optional. Use a bullet list if there are multiple items. You can also mention limitations here.

Properties

Rocket Component

These parameters are provided for information and have no effect on the design of the component.

  • DataManufacturer: Manufacturer when known
  • DataPart Number: Manufacturer part number
  • DataDescription: Description of the component
  • DataMaterial: Material when known

Bulkhead

These properties are inherited from the Bulkhead, see Bulkhead for more information.

  • DataDiameter: The outer diameter of the bulkhead
  • DataThickness: The thickness, not including any step, of the bulkhead
  • DataStep: True when the bulkhead includes a step, see Bulkhead Options
  • DataStep Diameter: The outer diameter of the step
  • DataStep Thickness: The thickness, not including the bulkhead thickness, of the step
  • DataHoles: True when the the bulkhead has one or more holes, see Bulkhead Options
  • DataHole Diameter: The diameter of the hole
  • DataHole Center: The distance from the center of the hole to the center of the bulkhead
  • DataHole Count: The number of holes applied in a radial pattern around the center of the bulkhead
  • DataHole Offset: Offset from 0 degrees of the first hole

Centering Ring

  • DataCenter Diameter: The diameter of the inner hole
  • DataNotched: True when the center hole includes a notch, see Options
  • DataNotch Height: The notch height
  • DataNotch Width: The notch width

Scripting

See also: Category:API and FreeCAD Scripting Basics.

The ExampleCommandModel tool can be used in macros and from the Python console by using the following function:

Object = makeExampleCommandModel(Data1, Data2)
  • Creates an Object using Data1 and Data2.

Example:

import FreeCAD, Base

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)

Tutorials and Learning

Rocket Workbench Body Tubes, Bulkheads, and Centering Rings Tutorial on YouTube