Sketches Object

Derived from: Base Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Sketch/Sketches.h>

Description

Provides access to the sketches within a design and provides methods to create new sketches.

Methods

Name Description
add Creates a new sketch on the specified planar entity.
addToBaseOrFormFeature Creates a parametric sketch that is associated with a base feature.

Because of a current limitation, if you want to create a sketch associated with a base feature, you must first call the edit method of the base feature, use this method to create the sketch, and then call the finishEdit method of the base feature. The base feature must be in an "edit" state to be able to add any additional items to it.
addWithoutEdges Creates a new sketch on the specified planar entity. If a BRepFace is provided, the edges of the face are not projected into the sketch so the result of creating a new sketch with this method will always be a new empty sketch.
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
item Function that returns the specified sketch using an index into the collection.
itemByName Returns the sketch with the specified name.

Properties

Name Description
count Returns the number of sketches in a component
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():

Accessed From

Component.sketches, FlatPatternComponent.sketches

Samples

Name Description
API Sample that demonstrates creating sketch lines in various ways. Demonstrates several ways to create sketch lines, including as the result of creating a rectangle.
Loft Feature API Sample Demonstrates creating a new loft feature.
Patch Feature API Sample Demonstrates creating a new patch feature.

Version

Introduced in version August 2014