Sketcher SketchObject

Introduction


A Sketcher SketchObject, or formally a, is the base element to create 2D objects with the Sketcher Workbench.

The is derived from Part Part2DObject, which means it is a Part Feature object specialized for 2D geometry. Like Part2DObject, the SketchObject can be attached to planes and faces. In addition, the SketchObject can handle geometrical constraints of the lines and curves that are drawn within it.



How to use

 * 1) Switch to the Sketcher Workbench.
 * 2) Press.
 * 3) Select a : XY-plane, XZ-plane, or YZ-plane. Optionally also choose, and give an  value.
 * 4) Press.

Although the SketchObject can be used by itself to draw on a plane, it is most commonly used in conjunction with the PartDesign Workbench to create extruded solids.


 * 1) Switch to the PartDesign Workbench.
 * 2) Press.
 * 3) Press.
 * : XY_Plane (Base plane), XZ_Plane (Base plane), or YZ_Plane (Base plane).
 * 1) Press.

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

A Sketcher SketchObject ( class) is derived from a Part Part2DObject ( class), therefore it shares all the latter's properties.

In addition to the properties described in Part Part2DObject, the basic Sketcher SketchObject has the following properties in the property editor. Hidden properties can be shown by using the command in the context menu of the property editor.

Data

 * ,, : same as Part Part2DObject. See Part Attachment for more information on all attachment mapping modes.


 * : named constraints, if they exist; otherwise it is an empty list.

Hidden properties Data
See Part Part2DObject for the rest of the hidden properties.


 * : a custom class associated with this object. This only exists for the Python version. See Scripting.


 * : a list of Part geometries that exist inside the sketch.
 * : a list of Part geometries outside this Sketch that are used for reference.

View

 * : if it will try setting constraints when the geometry is drawn.


 * : name of the workbench to activate when editing the sketch; it defaults to.
 * : if all objects that depend on the sketch are hidden when opening the sketch.
 * : if the camera position is saved before opening the sketch, and is restored after closing it.
 * : if all objects used in links to external geometry are shown when opening the sketch.
 * : if all objects this sketch is attached to are shown when opening the sketch.

Hidden properties View

 * : a custom view provider class associated with this object. This only exists for the Python version. See Scripting.


 * : a custom class associated with this object, that handles hiding and showing other objects when opening and closing the sketch.

All other view properties, including hidden properties, are those of the base Part Feature object.

Scripting
FreeCAD Scripting Basics, and scripted objects.

See Part Feature for the general information on adding objects to the document.

A SketchObject is created with the method of the document.

This basic doesn't have a Proxy object so it can't be fully used for sub-classing.

Therefore, for Python subclassing, you should create the object.