Hide Table of Contents
ICreateCircleByRadius2 Method (IModelDoc2)

Creates a circle based on a center point and a specified radius.

.NET Syntax

Visual Basic (Declaration) 
Function ICreateCircleByRadius2( _
   ByVal XC As System.Double, _
   ByVal YC As System.Double, _
   ByVal Zc As System.Double, _
   ByVal Radius As System.Double _
) As SketchSegment
Visual Basic (Usage) 
Dim instance As IModelDoc2
Dim XC As System.Double
Dim YC As System.Double
Dim Zc As System.Double
Dim Radius As System.Double
Dim value As SketchSegment
value = instance.ICreateCircleByRadius2(XC, YC, Zc, Radius)
SketchSegment ICreateCircleByRadius2( 
   System.double XC,
   System.double YC,
   System.double Zc,
   System.double Radius
SketchSegment^ ICreateCircleByRadius2( 
&   System.double XC,
&   System.double YC,
&   System.double Zc,
&   System.double Radius


X value of the circle center point in meters
Y value of the circle center point in meters
Z value of the circle center point in meters
Radius of the circle in meters

Return Value

Newly created circle


This method creates a partial arc in the active 2D sketch. If a sketch is not active, then a new sketch is created. You can check for an active sketch using IModelDoc2::GetActiveSketch2 or IModelDoc2::IGetActiveSketch2.

For COM applications, the object pointer returned from this method can be used to call any APIs on the ISketchSegment interface. The underlying ISketchArc object can be obtained using QueryInterface on the returned ISketchSegment object.

OLE applications can define a new ISketchSegment or ISketchArc object using the returned Dispatch pointer. Visual Basic applications interpret the pointer for you automatically, so you can use the returned object to call ISketchSegment or ISketchArc functions.

IModelDoc2::SetAddToDB and IModelDoc2::SetDisplayWhenAdded increase performance during entity creation by adding entities directly to the SOLIDWORKS database.

  • IModelDoc2::SetAddToDB also avoids some of the peculiarities involved with creating entities via the user interface, such as inferencing, automatic relations, and snapping to the grid. Adding entities directly to the database also increases the performance of this API. When you are done creating entities, it is important to call IModelDoc2::SetAddToDB(false), to restore SOLIDWORKS to its normal operating mode.
  • This method also works with IModelDoc2::SetDisplayWhenAdded. If you have called IModelDoc2::SetAddToDB(True), additional performance can be gained by calling IModelDoc2::SetDisplayWhenAdded(false) to disable immediate display of entities as they are added to the database. When you are done creating all of your sketch entities, you must redraw your document window (see IModelDoc2::GraphicsRedraw2) to see the entities that you added. You should also restore the original display settings by calling IModelDoc2::SetDisplayWhenAdded(True).

To create a circle using a center point and a point on the circle, see IModelDoc2::CreateCircle2 or IModelDoc2::ICreateCircle2. To create a partial arc, see IModelDoc2::CreateArc2 or IModelDoc2::ICreateArc2.


See Also


SOLIDWORKS 2001Plus FCS, Revision Number 10.0

Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

Subject:   Feedback on Help Topics
Page:   ICreateCircleByRadius2 Method (IModelDoc2)
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:


We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again

Web Help Content Version: API Help (English only) 2019 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.