Skip to content

Latest commit

 

History

History
140 lines (72 loc) · 5.83 KB

Sketcher_SketchObject.md

File metadata and controls

140 lines (72 loc) · 5.83 KB
Raw

Sketcher SketchObject

Introduction

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

The Sketcher::SketchObject is derived from the Part Part2DObject, which means it is a Part Feature object specialized for 2D geometry. Like the Part2DObject, the SketchObject can be attached to planes and faces. In addition, the SketchObject can handle geometrical constraints.

Simplified diagram of the relationships between the core objects in FreeCAD

Usage

  1. Switch to the Sketcher Workbench.
  2. Press [ Sketcher NewSketch.
  3. Select a Sketch orientation: XY-plane, XZ-plane, or YZ-plane. Optionally also choose Reverse direction, and give an Offset value.
  4. Press OK.

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 [ PartDesign Body.

  3. Press [ PartDesign NewSketch.

  4. Select feature: XY_Plane (Base plane), XZ_Plane (Base plane), or YZ_Plane (Base plane).

  5. Press OK.

Properties

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

The Sketcher SketchObject (Sketcher::SketchObject class) is derived from the Part Part2DObject (Part::Part2DObject class) and inherits all its properties.

The Sketcher SketchObject also has the following additional properties in the property editor. Hidden properties can be shown by using the Show all command in the context menu of the property editor.

Data

{{TitleProperty|Sketch}}

  • Geometry|GeometryList|Hidden: a list of Part geometries that exist inside the sketch.

  • Constraints|: named constraints, if they exist; otherwise it is an empty list [].

  • External Geometry|LinkSubList: a list of Part geometries outside this Sketch that are used for reference.

  • Fully Constrained|Bool|Hidden: (read-only) if True the sketch is fully constrained.

View

{{TitleProperty|Auto Constraints}}

  • Autoconstraints|Bool: if True constraints are automatically added when geometry is drawn.

  • Avoid Redundant|Bool: if True redundant auto-constraints are avoided.

{{TitleProperty|Grid}}

  • Grid Auto Size|Bool|Hidden: if True the grid is resized based on the boundingbox of the geometry of the sketch.

  • Grid Size|Length: the size of the spacing of the local grid lines in the 3D view; it defaults to {{value|10 mm}}.

  • Grid Snap|Bool: if True the grid can be used to snap points.

  • Grid Style|Enumeration: the style of the grid lines; {{value|Dashed}} (default) or {{value|Light}}.

  • Show Grid|Bool: if True a grid local to the object will be displayed in the 3D view. This grid is independent of the Draft Grid.

  • Show Only In Edit Mode|Bool: if True the grid is only displayed while the sketch is being edited.

  • Tight Grid|Bool: if True the local grid will be localized around the origin of the shape, otherwise it will extend itself more.

  • max Number Of Lines|Integer: the maximum number of lines in the grid.

{{TitleProperty|Visibility automation}}

  • Editing Workbench|String: name of the workbench to activate when editing the sketch; it defaults to {{value|SketcherWorkbench}}.

  • Force Ortho|Bool: if True the camera will be forced to orthographic view mode when the sketch is opened.

  • Hide Dependent|Bool: if True all objects that depend on the sketch are hidden when the sketch is opened.

  • Restore Camera|Bool: if True the camera position is saved before opening the sketch, and is restored after closing it.

  • Section View|Bool: if True only (parts of) objects behind the sketch plane are visible while the sketch is being edited.

  • Show Links|Bool: if True all objects used in links to external geometry are shown when the sketch is opened.

  • Show Support|Bool: if True all objects this sketch is attached to are shown when the sketch is opened.

  • Tempo Vis|PythonObject|Hidden: a custom class associated with this object, that handles hiding and showing other objects when opening and closing the sketch.

Scripting

See also:

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 addObject() method of the document.

import FreeCAD as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("Sketcher::SketchObject", "Sketch")
obj.Label = "Custom label"

For Python subclassing you should create the Sketcher::SketchObjectPython object.

import FreeCAD as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("Sketcher::SketchObjectPython", "CustomSketch")
obj.Label = "Custom label"

{{Sketcher_Tools_navi}} {{Document_objects_navi}}

⏵ documentation index > Sketcher > Sketcher SketchObject