Share

SketchSpline Object

Derived from: SketchEntity Object

Description

The SketchSpline object represents a spline 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.
GetHandle Method that returns the fit point handle at the given fit point. The method returns Nothing if the handle is not enabled at the input fit point.
GetHandleStatus Method that returns whether the handle at a given fit point is enabled or disabled.
GetReferenceKey Method that generates and returns the reference key for this entity.
InsertFitPoint Method that inserts a new fit point into the spline.
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.
SetHandleStatus Method that sets whether the handle at a given fit point is enabled or disabled.

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.
Closed Specifies whether the curve is closed. Setting a curve to be closed will cause it to close and be periodic.
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 spline.
DisabledActionTypes Gets and sets whether specific user actions are blocked on this sketch geometry.
EndSketchPoint Property that gets the that defines the position of the end of the spline.
FitMethod Specifies the fit method for the spline.
FitPoint Property that returns the SketchPoint at the specified index. The indices correspond to the fit points in order from the start to the end of the spline. An Index of 1 returns the first SketchPoint. The FitPointCount property returns the total number of fits points for the spline.
FitPointCount Property that returns the number of fit points for the spline.
Geometry Property that returns a geometry object. The object returned represents a snapshot view of the current state of the sketch spline.
Geometry3d Read-only property that returns the BSplineCurve geometry that represents this sketch spline 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 Double property that returns the length of the entity in centimeters.
LineDefinitionSpace Gets and sets the LineDefinitionSpace applied to this sketch spline.
LineScale Gets and sets the LineScale applied to this sketch spline.
LineType Gets and sets the LineType applied to this sketch spline.
LineWeight Gets and sets the LineWeight applied to this sketch spline.
OverrideColor Gets and sets the color applied to this sketch spline.
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.
StartSketchPoint Property that returns the that defines the position of the start of the line.
Tension Gets and sets the tension for the spline.
Type Returns an ObjectTypeEnum indicating this object's type.

Accessed From

OffsetSplineDimConstraint.Spline, OffsetSplineDimConstraintProxy.Spline, SketchControlPointSpline.ConvertToSpline, SketchControlPointSplineProxy.ConvertToSpline, SketchFixedSpline.ConvertToSpline, SketchFixedSplineProxy.ConvertToSpline, SketchOffsetSpline.ConvertToSpline, SketchOffsetSpline.OriginalSpline, SketchOffsetSplineProxy.ConvertToSpline, SketchOffsetSplineProxy.OriginalSpline, SketchSplineHandle.Spline, SketchSplineHandleProxy.Spline, SketchSplineProxy.NativeObject, SketchSplines.Add, SketchSplines.Item, SplineFitPointConstraint.Spline, SplineFitPointConstraintProxy.Spline

Derived Classes

SketchSplineProxy

Samples

Name Description
Sketch Display Entities This sample demonstrates the query functionality available for sketch entities.
Spline - create NURBS This sample demonstrates the creation of a sketch spline using a geometry definition (a NURB). The API also supports creation of 3D sketch splines in a similar way.
Sketch Spline This sample demonstrates creating and manipulating a sketch spline.

Version

Introduced in version 5

Was this information helpful?