Sketch3D Object

Description

The Sketch3D object provides access to the current contents of a specific 3D sketch and its related properties and methods. See the article in the overviews section.

Methods

Name	Description
Delete	Method that deletes the 3D sketch. This method will fail in the cases where the sketch is active, and when there are dependents on the sketch. In the cases where other geometry, besides a feature, is dependent on the sketch, the dependent geometry will be deleted or modified.
Edit	Method that causes the Sketch environment to be invoked with this sketch available for interactive edit.
ExitEdit	Method that 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. Calling this method in other cases will not do anything.
GetReferenceKey	Method that generates and returns the reference key for this entity.
Include	Method that creates a new sketch entity by copying other entities into the sketch.
SetEndOfPart	Method that repositions the end-of-part marker relative to the object this method is called from. The argument defines if the end-of-part marker will be positioned just before or just after the object. If the object is contained within another object and is not in the top level of the browser, the positioning of the marker will be relative to the top-level object the calling object is contained within. An example of this case is a sketch that has not been shared and has been consumed by a feature. Another example is a nested work feature.
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.
CheckSumValue	Gets sketch checksum value.
Consumed	Gets whether the 3D Sketch is consumed or not.
DeferUpdates	Gets and sets whether to defer the solving of the sketch.
Dependents	Property that returns a collection of the objects that are dependent on the 3D sketch. Examples of objects that can be returned are profiles, features, work features, other sketches, and assembly constraints.
DimensionConstraints3D	Property that returns a collection of all dimension constraints on the 3D sketch.
DimensionsVisible	Gets and sets whether the dimensions on the sketch are visible.
DisabledActionTypes	Gets and sets the action types valid for this sketch.
Exported	Read-write property that gets and sets whether the object is exported. Objects must be marked for export in order for them to be derived.
GeometricConstraints3D	Property that returns a collection of all geometric constraints on the 3D sketch.
HasReferenceComponent	Property that specifies if the object was created as the result of a derived part.
HealthStatus	Property that returns an enum indicating the current state of the object.
HelicalCurves	Gets the HelicalCurves collection object.
IntersectionCurves	Read-only property that returns the IntersectionCurves collection object. This collection provides access to the existing intersection curves in the sketch and provides functionality to create new intersection curves.
IsOwnedByFeature	Property that returns whether this object is owned by a feature. If True, the OwnedBy property returns the owning feature.
Name	Gets and sets name of the 3D sketch.
OnFaceCurves	Gets the 3D Sketch OnFaceCurves collection Object.
OverrideColor	Specifies the override color, if any, for this sketch.
OwnedBy	Read-only property that returns the client feature that owns this object. This property returns Nothing if the IsOwnedByFeature property returns False.
Parent	Property that returns the parent of the object. This will return the parent PartComponentDefinition.
Profiles3D	Property that returns the Profiles3D collection object.
ProjectToSurfaceCurves	Read-only property that returns the ProjectToSurfaceCurves collection object. This object provides access to all the existing ProjectToSurfaceCurve objects in the sketch and also provides methods to create new ProjectToSurfaceCurve objects.
ReferenceComponent	Property that returns the ReferenceComponent that resulted in the creation of this feature.
ReferencedEntity	Property that returns the referenced 3D sketch, if there is one. Currently this property always returns 'Nothing'; it was implemented to support future functionality.
Shared	Gets and sets whether the sketch is shared or not.
SilhouetteCurves	Gets the SilhouetteCurve collection Object.
SketchArcs3D	Property that returns the SketchArcs3D collection object. This collection provides access to the existing arcs and bends in the sketch and provides functionality to create new bends.
SketchCircles3D	Property that returns the SketchCircles3D collection object. This collection provides access to the existing circles in the sketch.
SketchControlPointSplines3D	Read-only property that returns the SketchControlPointSplines3D collection object. This collection provides access to the existing control point splines in the sketch and provides functionality to create new control point curves.
SketchEllipses3D	Property that returns the SketchEllipses3D collection object. This collection provides access to the existing ellipses in the sketch.
SketchEllipticalArcs3D	Property that returns the SketchEllipticalArcs3D collection object. This collection provides access to the existing elliptical arcs in the sketch.
SketchEntities3D	Property that returns a collection of all geometric entities on the sketch, regardless of their type.
SketchEquationCurves3D	Read-only property that returns the SketchEquationCurves3D collection object. This collection provides access to the existing equation curves in the sketch and provides functionality to create new equation curves.
SketchFixedSplines3D	Property that gets the collection object.
SketchLines3D	Property that returns the SketchLines3D collection object. This collection provides access to the existing lines in the sketch and provides functionality to create new lines.
SketchPoints3D	Property that returns the SketchPoints3D collection object. This collection provides access to the existing points in the sketch.
SketchSplines3D	Property that returns the SketchSplines3D collection object. This collection provides access to the existing splines in the sketch.
Type	Returns an ObjectTypeEnum indicating this object's type.
Visible	Gets and sets the visibility of the sketch.

Accessed From

Derived Classes

Sketch3DProxy

Samples

Name	Description
Control point, equation, and intersection curve creation.	This sample demonstrates several new curve creation techniques introduced in Inventor 2014. It creates a new part and then create a 2d control point spline and a 2d equation curve. Surfaces are created from these two curves by extruding them. A 3d intersection curve is created between the extrusions. A 3d control point spline and 3d equation curve are also created.
Loft Feature With Non-Planar Section	This sample demonstrates the creation of a loft feature. It uses two sections for the loft, one is from a 2d sketch and the other is a non-planar section from a 3d sketch. Because one of the sketches isn't planar, a surface is created instead of a solid.
Sweep Feature Add	This sample demonstrates the creation of a sweep feature. The profile is a circle, but the path is made up of a 3D sketch and a 2D sketch.

Version

Introduced in version 6

Sketch3D Object

Description

Methods

Properties

Accessed From

Derived Classes

Samples

Version

Was this information helpful?