Part Box: Difference between revisions

From FreeCAD Documentation
(Made many changes to try to better conform to the GUI_Command page model.)
No edit summary
 
(118 intermediate revisions by 12 users not shown)
Line 1: Line 1:
<languages/>
==Description==
<translate>
The Box command from the [[Part_Workbench|Part Workbench]] inserts a parametric, [http://en.wikipedia.org/wiki/Cuboid#Rectangular_cuboid rectangular cuboid], geometric primitive into the active document. By default, the Box command will insert a 10x10x10 mm cube, positioned at the origin, with the label "cube". These parameters may be modified after the object has been added.


<!--T:32-->
[[Image:Part_Box.jpg|400px|Part_Box]]
{{Docnav
|
|[[Part_Cylinder|Cylinder]]
|[[Part_Workbench|Part]]
|IconL=
|IconR=Part_Cylinder.svg
|IconC=Workbench_Part.svg
}}


<!--T:18-->
==How to Use==
{{GuiCommand
* Click the cube icon {{KEY|[[Image:Part Box.svg|30px]]}} from the Part Workbench.
|Name=Part Box
* Alternatively, you can select {{MenuCommand|Part → Primitives → Cube}} from the menu bar.
|MenuLocation=Part → Primitives → Cube
|Workbenches=[[Part_Workbench|Part]]
|SeeAlso=[[Part_Primitives|Part Primitives]]
}}


== Description == <!--T:38-->
==Options==
* N/A


<!--T:19-->
==Properties==
The [[Image:Part_Box.svg|24px]] '''Part Box''' command creates a parametric box solid, a [https://en.wikipedia.org/wiki/Cuboid#Rectangular_cuboid rectangular cuboid]. In the coordinate system defined by its {{PropertyData|Placement}} property, the bottom face of the box lies on the XY plane with its front left corner at the origin, and its front edge parallel to the X axis.
{{Properties_Title|Base}}
*{{PropertyData|Placement}}: Specifies the orientation and position of the shape in the 3D space.
*{{PropertyData|Label}}: Label given to the object. Change to suit your needs.


</translate>
{{Properties_Title|Box}}
[[Image:Part_Box_Example.png|400px]]
*{{PropertyData|Length}}: The length parameter is the rectangular cuboid's dimension in the x-direction.
<translate>
*{{PropertyData|Width}}: The width parameter is the rectangular cuboid's dimension in the y-direction.
*{{PropertyData|Height}}: The height parameter is the rectangular cuboid's dimension in the z-direction.


== Usage == <!--T:39-->
[[Image:Part_Box-Properties.jpg|Part_Box-Properties]]


<!--T:4-->
==Scripting==
# There are several ways to invoke the command:
The Box command can by used in [[macros]] and from the python console using the following function:
#* Press the {{Button|[[Image:Part_Box.svg|16px]] [[Part_Box|Part Box]]}} button.
<syntaxhighlight>
#* Select the {{MenuCommand|Part → Primitives → [[Image:Part_Box.svg|16px]] Cube}} option from the menu.
FreeCAD.ActiveDocument.addObject("Part::Box", "myBox")
# The box is created.
</syntaxhighlight>
# Optionally change the dimensions and {{PropertyData|Placement}} of the box by doing one of the following:
* Where "myBox" is the label for the Box object.
#* Double-click the object in the [[Tree_view|Tree view]]:
* Returns newly created object of type Box.
#*# The {{MenuCommand|Geometric Primitives}} task panel opens.
#*# Change one or more properties.
#*# The object is dynamically updated in the [[3D_view|3D view]].
#*# Press the {{Button|OK}} button.
#* Change the properties in the [[Property_editor|Property editor]].
#* Change the {{PropertyData|Placement}} with the [[Image:Std_TransformManip.svg|16px]] [[Std_TransformManip|Std TransformManip]] command.


== Example == <!--T:43-->
You can access and modify attributes of the Box object. For example, you may wish to modify the length, width and height parameters.
<syntaxhighlight>
FreeCAD.ActiveDocument.myBox.length = 25
FreeCAD.ActiveDocument.myBox.width = 15
FreeCAD.ActiveDocument.myBox.height = 30
</syntaxhighlight>


<!--T:44-->
==FreeCAD - Version==
[[Image:Part_Box_Scripting_Example.png|thumb|Part Box from the scripting example]]


<!--T:45-->
A Part Box object created with the [[#Scripting|scripting example]] below is shown here.


== Notes == <!--T:46-->
*{{Version|0.14}}

Beginning in FreeCAD version 0.14, a Part Box is referred to in the GUI elements as a Cube and the default label is "Cube".
<!--T:47-->
* A Part Box can also be created with the [[Image:Part_Primitives.svg|16px]] [[Part_Primitives|Part Primitives]] command. With that command you can specify the dimensions and placement at creation time.

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

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

<!--T:49-->
A Part Box object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties:

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

<!--T:51-->
{{TitleProperty|Attachment}}

<!--T:52-->
The object has the same attachment properties as a [[Part_Part2DObject#Data|Part Part2DObject]].

<!--T:41-->
{{TitleProperty|Box}}

<!--T:24-->
* {{PropertyData|Length|Length}}: The length of the box. This is the dimension in its X direction. The default is {{Value|10mm}}.
* {{PropertyData|Width|Length}}: The width of the box. This is the dimension in its Y direction. The default is {{Value|10mm}}.
* {{PropertyData|Height|Length}}: The height of the box. This is dimension in its Z direction. The default is {{Value|10mm}}.

== Scripting == <!--T:42-->

<!--T:53-->
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].

<!--T:26-->
A Part Box can be created with the {{Incode|addObject()}} method of the document:

</translate>
{{Code|code=
box = FreeCAD.ActiveDocument.addObject("Part::Box", "myBox")
}}
<translate>

<!--T:27-->
* Where {{Incode|"myBox"}} is the name for the object.
* The function returns the newly created object.

<!--T:54-->
Example:

</translate>
{{Code|code=
import FreeCAD as App

doc = App.activeDocument()

box = doc.addObject("Part::Box", "myBox")
box.Length = 4
box.Width = 8
box.Height = 12
box.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(75, 60, 30))

doc.recompute()
}}
<translate>


<!--T:33-->
{{Docnav
|
|[[Part_Cylinder|Cylinder]]
|[[Part_Workbench|Part]]
|IconL=
|IconR=Part_Cylinder.svg
|IconC=Workbench_Part.svg
}}

</translate>
{{Part_Tools_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 20:53, 3 March 2022

Part Box

Menu location
Part → Primitives → Cube
Workbenches
Part
Default shortcut
None
Introduced in version
-
See also
Part Primitives

Description

The Part Box command creates a parametric box solid, a rectangular cuboid. In the coordinate system defined by its DataPlacement property, the bottom face of the box lies on the XY plane with its front left corner at the origin, and its front edge parallel to the X axis.

Usage

  1. There are several ways to invoke the command:
    • Press the Part Box button.
    • Select the Part → Primitives → Cube option from the menu.
  2. The box is created.
  3. Optionally change the dimensions and DataPlacement of the box by doing one of the following:
    • Double-click the object in the Tree view:
      1. The Geometric Primitives task panel opens.
      2. Change one or more properties.
      3. The object is dynamically updated in the 3D view.
      4. Press the OK button.
    • Change the properties in the Property editor.
    • Change the DataPlacement with the Std TransformManip command.

Example

Part Box from the scripting example

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

Notes

  • A Part Box can also be created with the Part Primitives command. With that command you can specify the dimensions and placement at creation time.

Properties

See also: Property editor.

A Part Box 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.

Box

  • DataLength (Length): The length of the box. This is the dimension in its X direction. The default is 10mm.
  • DataWidth (Length): The width of the box. This is the dimension in its Y direction. The default is 10mm.
  • DataHeight (Length): The height of the box. This is dimension in its Z direction. The default is 10mm.

Scripting

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

A Part Box can be created with the addObject() method of the document:

box = FreeCAD.ActiveDocument.addObject("Part::Box", "myBox")
  • Where "myBox" is the name for the object.
  • The function returns the newly created object.

Example:

import FreeCAD as App

doc = App.activeDocument()

box = doc.addObject("Part::Box", "myBox")
box.Length = 4
box.Width = 8
box.Height = 12
box.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(75, 60, 30))

doc.recompute()