Jump to content

Part Plane

From FreeCAD Documentation

Part Plane

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

Description[edit | edit source]

A Part Plane is a parametric rectangular plane that can be created with the Part Primitives command. In the coordinate system defined by its DataPlacement property, the plane lies on the XY-plane with its front left corner at the origin, and its front edge parallel to the X-axis.

Usage[edit | edit source]

See Part Primitives.

Example[edit | edit source]

Part Plane from the scripting example

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

Properties[edit | edit source]

See also: Property View.

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

Data[edit | edit source]

Attachment

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

Plane

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

Scripting[edit | edit source]

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

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

plane = FreeCAD.ActiveDocument.addObject("Part::Plane", "myPlane")
  • Where "myPlane" is the name for the object.
  • The function returns the newly created object.

Example:

import FreeCAD as App

doc = App.activeDocument()

plane = doc.addObject("Part::Plane", "myPlane")
plane.Length = 4
plane.Width = 8
plane.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(20, 75, 60))

doc.recompute()