Part Part2DObject

From FreeCAD Documentation
Revision as of 20:17, 1 October 2019 by Vocx (talk | contribs) (New page to describe the base Part::Part2DObject, which can be used to derive many planar scripted objects.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Other languages:
English • ‎français • ‎italiano

Introduction

A Part Part2DObject, or formally a Part::Part2DObject, is a simple element with a topological Shape associated that can be displayed in the 3D view.

The Part::Part2DObject is derived from Part::Feature, but it is specialized to be used for 2D geometry, given that its shape will lie of a plane. This plane can be changed by its DATAPlacement; moreover, it also allows attaching to a face in order to define the new position of this plane.

The Part::Part2DObject is defined in the Part Workbench but can be used as the base class for scripted objects in all workbenches that produce 2D geometrical shapes, for example, the Sketcher, and the Draft Workbench.

Workbenches can add more properties to this basic element to produce an object with complex behavior.

Tree Part.svg

Properties

See Property for all property types that scripted objects can have.

In addition to the properties described in Part Feature, the Part Part2DObject has the following properties in the property editor.

Data

  • DATAMap Mode: "Deactivated" by default. This determines a plane to which the object can be attached. Clicking on the ellipsis (three dots), to the right of the entry field opens the Part Attachment task panel that allows selecting the supporting plane by picking different elements in the 3D view. The different modes are: Deactivated, Translate Origin, Object's XY, Object's XZ, Object's YZ, Plane face, Tangent to surface, Normal to edge, Frenet NB, Frenet TN, Frenet TB, Concentric, Revolution section, Plane by 3 points, Normal to 3 points, Folding, Inertia 2-3, Align O-N-X, Align O-N-Y, Align O-X-Y, Align O-X-N, Align O-Y-N, Align O-Y-X. See Part Attachment for more information on all mapping modes.

View

  • VIEWGrid Size: a float that determines the size of a grid in the 3D view.
  • VIEWGrid Snap: if True the grid can be used to snap points.
  • VIEWGrid Style: Dashed or Light; the style of the grid lines.
  • VIEWShow Grid: if True a local grid to the object will be displayed in the 3D view.
  • VIEWTight Grid: if True the local grid will be compact, otherwise it will extend itself more.