Part Box/cs: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(One intermediate revision by the same user not shown)
Line 16: Line 16:
== Description ==
== Description ==


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.
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.


[[Image:Part_Box.jpg|400px|Part_Box]]
[[Image:Part_Box_Example.png|400px]]


== Usage ==
== Usage ==


<div class="mw-translate-fuzzy">
# Switch to the [[Image:Workbench_Part.svg|16px]] [[Part_Workbench|Part Workbench]]
V datové záložce boxu mohou být později upravovány vlastnosti objektu:
# There are several ways to invoke the command:
</div>
#* Press the {{Button|[[Image:Part_Box.svg|16px]] Cube}} button in the toolbar.
#* Select the {{MenuCommand|Part → Primitives → [[Image:Part_Box.svg|16px]] Cube}} from the menu bar.


== Example ==
'''Result:''' The default result is a box with an equal length, width and height of 10 mm. It is attached to the global xy-plane and one edge is coincident with the global z-axis.


[[Image:Part_Box_Scripting_Example.png|thumb|Part Box from the scripting example]]
The box properties can later be edited, either in the property editor or by double-clicking on the box in the model tree.

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

== Notes ==

* 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 ==
== Properties ==


See also: [[Property_editor|Property editor]].
{{Properties_Title|Box}}


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:
*{{PropertyData|Length}}: The length parameter is the Box's dimension in the x-direction.

*{{PropertyData|Width}}: The width parameter is the Box's dimension in the y-direction.
=== Data ===
*{{PropertyData|Height}}: The height parameter is the Box's dimension in the z-direction.

{{TitleProperty|Attachment}}

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

{{TitleProperty|Box}}

* {{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 ==
== Scripting ==


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

A Part Box can be created with the {{Incode|addObject()}} method of the document:


{{Code|code=
{{Code|code=
Line 50: Line 67:
* The function returns the newly created object.
* The function returns the newly created object.


Example:
You can access and modify attributes of the {{Incode|box}} object. For example, you may wish to modify the length, width and height parameters.


{{Code|code=
{{Code|code=
import FreeCAD as App
box.Length = 25
box.Width = 15
box.Height = 30
}}


doc = App.activeDocument()
You can change its placement with:


box = doc.addObject("Part::Box", "myBox")
{{Code|code=
box.Length = 4
box.Placement = FreeCAD.Placement(FreeCAD.Vector(4, 6, 3), FreeCAD.Rotation(30, 45, 10))
box.Width = 8
box.Height = 12
box.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(75, 60, 30))

doc.recompute()
}}
}}


Line 74: Line 93:
}}
}}


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

Latest revision as of 09:01, 4 March 2022

Part Box

Umístění Menu
Part → Box
Pracovní stoly
Part, Complete
Výchozí zástupce
Nikdo
Představen ve verzi
-
Viz také
Part CreatePrimitives

Description

The Part Box command creates a parametric box solid, a rectangular cuboid. In the coordinate system defined by its ÚdajePlacement 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

V datové záložce boxu mohou být později upravovány vlastnosti objektu:

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

  • ÚdajeLength (Length): The length of the box. This is the dimension in its X direction. The default is 10mm.
  • ÚdajeWidth (Length): The width of the box. This is the dimension in its Y direction. The default is 10mm.
  • ÚdajeHeight (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()