Share

SketchCircle Object

Derived from: SketchEntity Object

Description

The SketchCircle object represents a circle within a sketch. See the article in the overviews section.

Methods

Name Description
Delete Method that deletes the sketch entity. This method will fail in the case where this object was created as a result of a derived part. The HasReferenceComponent property can be used to determine when this is the case.
GetCustomLineType Method that returns information regarding the custom line type in use. The method returns a failure if the return value of the LineType property is not kCustomLineType.
GetReferenceKey Method that generates and returns the reference key for this entity.
SetCustomLineType Method that sets a custom line type to the curve from the specified .lin file. The method automatically changes the value of LineType property to kCustomLineType.

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
Area Double property that returns the area of the entity in square centimeters.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
CenterSketchPoint Property that gets the sketch point that defines the position of the center of the circle.
Constraints Property that returns a collection of sketch constraints that are tied directly to this entity. This collection consists of both geometric and dimension constraints.
ConstraintStatus Read-only property that returns the constraint status of the sketch. Possible return values are kFullyConstrainedConstraintStatus, kOverConstrainedConstraintStatus, kUnderConstrainedConstraintStatus, and kUnknownConstraintStatus.
Construction Gets and sets whether the entity behaves as a construction entity or not.
ContainingSketchBlock Property that returns the sketch block that contains this object. This is the same SketchBlock returned as the last item in the SketchBlockPath property. This property returns Nothing if this object does not belong to a sketch block and lives directly under a sketch.
CurvatureDisplay Specifies whether curvature information is displayed for the circle.
DisabledActionTypes Gets and sets whether specific user actions are blocked on this sketch geometry.
Geometry Property that returns a Circle2d geometry object. The object returned represents a snapshot view of the current state of the sketch circle.
Geometry3d Read-only property that returns circle geometry that represents this circle in model space.
HasReferenceComponent Property that specifies if the object was created as the result of a derived part.
Layer Gets and sets the layer applied to this sketch entity.
Length Property that returns the length of the entity in centimeters.
LineDefinitionSpace Gets and sets the LineDefinitionSpace applied to this sketch circle.
LineScale Gets and sets the LineScale applied to this sketch circle.
LineType Gets and sets the LineType applied to this sketch circle.
LineWeight Gets and sets the LineWeight applied to this sketch circle.
OverrideColor Gets and sets the color applied to this sketch circl.
OwnedBy Indicates entity or entities that own this object.
Parent Property that returns the parent sketch of the entity.
Radius Gets and sets the radius of the circle.
RangeBox Property that returns a Box2D object which contains the lower-left and upper-right corners of a rectangle that is guaranteed to enclose this object.
Reference Gets and sets whether this entity is a reference entity or not. It is only valid to set this property to False.
ReferenceComponent Property that returns the ReferenceComponent that resulted in the creation of this feature.
ReferencedEntity Property that returns the object this entity is dependent on. When sketch entities are created by projecting model edges or intersecting the model, the resulting entities are driven by the original model entities and cannot be modified.
SketchBlockPath Property that returns the path of sketch blocks at the leaf of which this sketch object is found. The enumerator returns a count of 0 if the object lives directly under a sketch.
SketchOnly Gets and sets whether this entity is visible only when editing the sketch.
Type Returns an ObjectTypeEnum indicating this object's type.

Accessed From

SketchCircleProxy.NativeObject, SketchCircles.AddByCenterRadius, SketchCircles.AddByThreePoints, SketchCircles.Item

Derived Classes

SketchCircleProxy

Samples

Name Description
Add a decal feature This sample demonstrates the creation of a decal feature.
Edit profile of an extrude feature This sample demonstrates editing the profile of an extrude feature.
Create sheet metal lofted flange feature The following sample demonstrates the creation of a sheet metal lofted flange feature.
Sketch from Face Silhouette This sample creates a cylindrical solid, creates a new sketch plane and creates some new sketch lines from the actual edges and the apparent (silhouette) edges of the cylinder.
Sketch Edit Orientation This sample demonstrates modifying the orientation of a sketch.
Sketch Add Oriented This sample demonstrates the creation of a sketch using the Sketches.AddWithOrientation method.
Sketch Display Entities This sample demonstrates the query functionality available for sketch entities.

Version

Introduced in version 5

Was this information helpful?