SketchCircles Object

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

Description

The collection of circles in a sketch. This provides access to the existing circles and supports the methods to create new circles.

Methods

Name Description
addByCenterRadius

Creates a sketch circle that is always parallel to the x-y plane of the sketch and is centered at the specified point.

addByThreePoints

Creates a sketch circle that passes through the three points. The three points must lie on the x-y plane of the sketch.

addByThreeTangents

Creates a sketch circle that is tangent to the three input lines. The three lines must lie on the x-y plane of the sketch.

addByTwoPoints

Creates a sketch circle where the circle passes through the two points and the distance between the two points is the diameter of the circle.

addByTwoTangents

Creates a sketch circle that is tangent to the two input lines. The two lines must lie on the x-y plane of the 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 circle using an index into the collection.

Properties

Name Description
count Returns the number of circles in the sketch.
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

SketchCurves.sketchCircles

Samples

Name Description
Create circle by center and radius API Sample

Demonstrates creating a sketch circle by the center and radius.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.

Create Circle By 3 Tangents API Sample

Demonstrates creates three lines and then draws a circle that is tangent to the lines. It then creates tangent constraints to maintain that relationship.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.

Loft Feature API Sample

Demonstrates creating a new loft feature.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.

Patch Feature API Sample

Demonstrates creating a new patch feature.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.

Simple Extrusion Sample

Demonstrates creates a new extrusion feature, resulting in a new component.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.

Simple Revolve Feature Sample

Demonstrates creates a new revolve feature, resulting in a new component.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.

Version

Introduced in version August 2014