Share

SketchEntity Object


Description

The SketchEntity object is the base class for all geometric sketch entities. 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.
GetReferenceKey Method that generates and returns the reference key for this entity.

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.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
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.
DisabledActionTypes Gets and sets whether specific user actions are blocked on this sketch geometry.
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.
OwnedBy Indicates entity or entities that own this object.
Parent Property that returns the parent sketch of the entity.
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

ArcLengthDimConstraint.Entity, ArcLengthDimConstraintProxy.Entity, CoincidentConstraint.EntityOne, CoincidentConstraint.EntityTwo, CoincidentConstraintProxy.EntityOne, CoincidentConstraintProxy.EntityTwo, CollinearConstraint.EntityOne, CollinearConstraint.EntityTwo, CollinearConstraintProxy.EntityOne, CollinearConstraintProxy.EntityTwo, ConcentricConstraint.EntityOne, ConcentricConstraint.EntityTwo, ConcentricConstraintProxy.EntityOne, ConcentricConstraintProxy.EntityTwo, DiameterDimConstraint.Entity, DiameterDimConstraintProxy.Entity, DrawingSketch.AddByProjectingEntity, EllipseRadiusDimConstraint.Entity, EllipseRadiusDimConstraintProxy.Entity, EqualRadiusConstraint.EntityOne, EqualRadiusConstraint.EntityTwo, EqualRadiusConstraintProxy.EntityOne, EqualRadiusConstraintProxy.EntityTwo, GroundConstraint.Entity, GroundConstraintProxy.Entity, HorizontalConstraint.Entity, HorizontalConstraintProxy.Entity, OffsetConstraint.EntityFour, OffsetConstraint.EntityOne, OffsetConstraint.EntityThree, OffsetConstraint.EntityTwo, OffsetConstraintProxy.EntityFour, OffsetConstraintProxy.EntityOne, OffsetConstraintProxy.EntityThree, OffsetConstraintProxy.EntityTwo, OffsetDimConstraint.Entity, OffsetDimConstraintProxy.Entity, ParallelConstraint.EntityOne, ParallelConstraint.EntityTwo, ParallelConstraintProxy.EntityOne, ParallelConstraintProxy.EntityTwo, PerpendicularConstraint.EntityOne, PerpendicularConstraint.EntityTwo, PerpendicularConstraintProxy.EntityOne, PerpendicularConstraintProxy.EntityTwo, PlanarSketch.AddByProjectingEntity, PlanarSketch.AddBySilhouette, PlanarSketchProxy.AddByProjectingEntity, PlanarSketchProxy.AddBySilhouette, ProfileEntity.SketchEntity, ProfileEntityProxy.SketchEntity, RadiusDimConstraint.Entity, RadiusDimConstraintProxy.Entity, Sketch.AddByProjectingEntity, SketchBlockDefinition.AddByProjectingEntity, SketchBlockDefinition.AddBySilhouette, SketchBlockDefinitionProxy.AddByProjectingEntity, SketchBlockDefinitionProxy.AddBySilhouette, SketchEntitiesEnumerator.Item, SmoothConstraint.EntityOne, SmoothConstraint.EntityTwo, SmoothConstraintProxy.EntityOne, SmoothConstraintProxy.EntityTwo, SymmetryConstraint.EntityOne, SymmetryConstraint.EntityTwo, SymmetryConstraintProxy.EntityOne, SymmetryConstraintProxy.EntityTwo, TangentDistanceDimConstraint.EntityOne, TangentDistanceDimConstraint.EntityTwo, TangentDistanceDimConstraintProxy.EntityOne, TangentDistanceDimConstraintProxy.EntityTwo, TangentSketchConstraint.EntityOne, TangentSketchConstraint.EntityTwo, TangentSketchConstraintProxy.EntityOne, TangentSketchConstraintProxy.EntityTwo, VerticalConstraint.Entity, VerticalConstraintProxy.Entity

Derived Classes

SketchArc, SketchCircle, SketchControlPointSpline, SketchEllipse, SketchEllipticalArc, SketchEquationCurve, SketchFixedSpline, SketchLine, SketchOffsetSpline, SketchPoint, SketchSpline

Samples

Name Description
Edit profile of an extrude feature This sample demonstrates editing the profile of an extrude 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.
Move sketch entities This sample demonstrates the translation of all the objects on the active sketch by a certain distance.
Create sketch block from an existing sketch This sample demonstrates creating a sketch block from an existing sketch.
Sketch Display Entities This sample demonstrates the query functionality available for sketch entities.

Version

Introduced in version 5

Was this information helpful?