Share

Sketch Object


Description

The generic Sketch object. All types of Sketch objects derive from this object. See the article in the overviews section.

Methods

Name Description
AddArcSlotByCenterPointArc Method that creates an arc slot. The sketch entities represent the sketch slot are returned.
AddArcSlotByThreePointArc Method that creates an arc slot. The sketch entities represent the sketch slot are returned.
AddByProjectingEntity Method that creates a new sketch entity by projecting other entities onto the sketch plane. This method performs the same function as the Project Geometry or Project DWG Geometry command according to the Entity you specified.
AddStraightSlotByCenterToCenter Method that creates a straight slot. The sketch entities represent the sketch slot are returned.
AddStraightSlotByOverall Method that creates a straight slot. The sketch entities represent the sketch slot are returned.
AddStraightSlotBySlotCenter Method that creates a straight slot. The sketch entities represent the sketch slot are returned.
CopyContentsTo Method that copies all the contents of the sketch to the \input target sketch.
CopyEntitiesTo Method that copies sketch entities of the sketch to the input target sketch.
Delete Method that deletes the sketch. This method is only valid for sketches that are not used by a feature.
Edit Method that causes the Sketch environment to be invoked with this sketch available for interactive edit.
ExitEdit Causes the Sketch environment to be closed and the user interface to return to the previous environment. This is equivalent to the Return command. This method is only valid in the case where this sketch is open for edit within the user interface.
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.
MoveSketchObjects Method that moves a collection of sketch objects by a specified vector. If the Copy argument is set to True, the newly created objects are returned.
OffsetSketchEntitiesUsingDistance Method that offsets a sketch entity or a group of connected sketch entities. In both cases, the base sketch entity is first offset by the specified distance and along the specified direction. The base sketch entity is determined as follows: * If only one sketch entity needs to be offset, it will be treated as the base sketch entity. * If a group of end-to-end connected entities need to be offset, the first entity in the group will be treated as the base sketch entity. If this method successfully offsets the specified input sketch entities, the newly created sketch entities are returned.
OffsetSketchEntitiesUsingPoint Method that offsets a sketch entity or a group of end-to-end connected sketch entities. In both cases, the offset is first applied to the base sketch entity such that the offset of the base sketch entity passes through the specified offset point on the sketch. The shortest distance of this offset point from the original base sketch entity determines the offset distance.
RotateSketchObjects Method that rotates a collection of sketch objects by a specified angle. If the Copy argument is set to True, the newly created objects are returned.
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.
Solve Method that causes the sketch to solve.

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.
CircularPatterns Gets the SketchCircularPatterns collection object.
Color Gets and Sets the color for the sketch.
ConstraintStatus Property that returns an enum indicating the constraint status of the sketch entity, signifying whether it is fully constrained, over constrained, or under constrained.
DataIO Gets the object through which this sketch's data content can be persisted.
DeferUpdates Gets and Sets whether to defer the solving of the sketch or not.
DimensionConstraints Gets the collection of all dimension constraints on the sketch.
DisabledActionTypes Gets and sets the action types valid for this sketch.
GeometricConstraints Property that returns the collection of all geometric constraints on the sketch.
LineType Gets and Sets the line type override for the sketch.
LineWeight Gets and Sets the line weight override for the sketch.
Name Gets and sets name of the sketch.
Parent Property that gets the parent object from whom this object can logically be reached.
RectangularPatterns Gets the SketchRectangularPatterns collection object.
SketchArcs Property that returns the SketchArcs collection object.
SketchCircles Property that returns the SketchArcs collection object.
SketchControlPointSplines Read-only property that returns the SketchControlPointSplines collection object. This collection provides access to the existing control point splines in the sketch and provides functionality to create new control point splines.
SketchEllipses Property that returns the SketchEllipses collection object.
SketchEllipticalArcs Property that returns the SketchEllipticalArcs collection object.
SketchEntities Property that returns the collection of all entities on the sketch, regardless of their type.
SketchEquationCurves Read-only property that returns the SketchEquationCurves collection object. This collection provides access to the existing equation curves in the sketch and provides functionality to create new equation curves.
SketchFixedSplines Property that gets the collection object.
SketchImages Property that returns a collection of all images on the sketch.
SketchLines Property that returns the SketchLines collection object. This collection provides access to the existing lines in the sketch and provides functionality to create new lines.
SketchOffsetSplines Property that returns the collection object. This collection provides access to the existing offset splines in the sketch.
SketchPoints Property that returns the SketchPoints collection object.
SketchSplines Property that returns the SketchSplines collection object.
TextBoxes Gets the TextBoxes collection associated with this Sketch.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible Gets and sets the visibility of the sketch.

Accessed From

ArcLengthDimConstraint.Parent, ArcLengthDimConstraintProxy.Parent, CoincidentConstraint.Parent, CoincidentConstraintProxy.Parent, CollinearConstraint.Parent, CollinearConstraintProxy.Parent, ConcentricConstraint.Parent, ConcentricConstraintProxy.Parent, DiameterDimConstraint.Parent, DiameterDimConstraintProxy.Parent, DimensionConstraint.Parent, EllipseRadiusDimConstraint.Parent, EllipseRadiusDimConstraintProxy.Parent, EqualLengthConstraint.Parent, EqualLengthConstraintProxy.Parent, EqualRadiusConstraint.Parent, EqualRadiusConstraintProxy.Parent, GeometricConstraint.Parent, GroundConstraint.Parent, GroundConstraintProxy.Parent, HorizontalAlignConstraint.Parent, HorizontalAlignConstraintProxy.Parent, HorizontalConstraint.Parent, HorizontalConstraintProxy.Parent, MidpointConstraint.Parent, MidpointConstraintProxy.Parent, OffsetConstraint.Parent, OffsetConstraintProxy.Parent, OffsetDimConstraint.Parent, OffsetDimConstraintProxy.Parent, OffsetSplineDimConstraint.Parent, OffsetSplineDimConstraintProxy.Parent, ParallelConstraint.Parent, ParallelConstraintProxy.Parent, PatternConstraint.Parent, PatternConstraintProxy.Parent, PerpendicularConstraint.Parent, PerpendicularConstraintProxy.Parent, Profile.Parent, ProfileProxy.Parent, RadiusDimConstraint.Parent, RadiusDimConstraintProxy.Parent, SketchArc.Parent, SketchArcProxy.Parent, SketchBlock.Parent, SketchBlockProxy.Parent, SketchCircle.Parent, SketchCircleProxy.Parent, SketchCircularPattern.Parent, SketchControlPointSpline.Parent, SketchControlPointSplineProxy.Parent, SketchEllipse.Parent, SketchEllipseProxy.Parent, SketchEllipticalArc.Parent, SketchEllipticalArcProxy.Parent, SketchEntity.Parent, SketchEquationCurve.Parent, SketchEquationCurveProxy.Parent, SketchesEnumerator.Item, SketchFillRegion.Parent, SketchFixedSpline.Parent, SketchFixedSplineProxy.Parent, SketchLine.Parent, SketchLineProxy.Parent, SketchOffsetSpline.Parent, SketchOffsetSplineProxy.Parent, SketchPoint.Parent, SketchPointProxy.Parent, SketchRectangularPattern.Parent, SketchSpline.Parent, SketchSplineHandle.Parent, SketchSplineHandleProxy.Parent, SketchSplineProxy.Parent, SmoothConstraint.Parent, SmoothConstraintProxy.Parent, SplineFitPointConstraint.Parent, SplineFitPointConstraintProxy.Parent, SymmetryConstraint.Parent, SymmetryConstraintProxy.Parent, TangentDistanceDimConstraint.Parent, TangentDistanceDimConstraintProxy.Parent, TangentSketchConstraint.Parent, TangentSketchConstraintProxy.Parent, TextBox.Parent, TextBoxConstraint.Parent, TextBoxConstraintProxy.Parent, TextBoxProxy.Parent, ThreePointAngleDimConstraint.Parent, ThreePointAngleDimConstraintProxy.Parent, TwoLineAngleDimConstraint.Parent, TwoLineAngleDimConstraintProxy.Parent, TwoPointDistanceDimConstraint.Parent, TwoPointDistanceDimConstraintProxy.Parent, VerticalAlignConstraint.Parent, VerticalAlignConstraintProxy.Parent, VerticalConstraint.Parent, VerticalConstraintProxy.Parent

Derived Classes

DrawingSketch, PlanarSketch

Samples

Name Description
Copy a sketch This sample demonstrates copying the contents of a sketch into another sketch via the API.
Sketch profile control This sample demonstrates the usage of the Profiles API to control the shape of the profile. The sample creates three concntric circles and creates an extrusion of the region between the inner circles.
Copy sketch contents This sample shows how to copy the contents of one sketch to another.
Defer sketch updates This sample demonstrates the sketch defer update functionality.
Move sketch entities This sample demonstrates the translation of all the objects on the active sketch by a certain distance.
Create SketchedSymbol Definition This sample illustrates creating a new sketched symbol definition object and inserting it into the active sheet.
Create slots in sketch. This sample demonstrates several new methods to create sketch entities that represent slots. These are the equivalent to new sketch commands that were added in Inventor 2014.
Sketch Text Add This sample illustrates creating text in a sketch.

Version

Introduced in version 4

Was this information helpful?