FitCurveBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FitCurveBuilder Class

class `NXOpen.Features.``FitCurveBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.FitCurve` builder

  To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateFitCurveBuilder()`

  Default values.

  Property | Value
  --- | ---
  Extender.EndExtensionOption | None
  Extender.EndValue.Value | 0 (millimeters part), 0 (inches part)
  Extender.StartExtensionOption | None
  Extender.StartValue.Value | 0 (millimeters part), 0 (inches part)
  IsClosedCurve | true
  ProjectionDirectionOption | Normal
  Radius.Value | 50.0 (millimeters part), 2.0 (inches part)
  RejectionThreshold.Value | 10.0 (millimeters part), 0.5 (inches part)

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
CanKeepTemplateSelected | Returns or sets the flag indicating if template curve should be kept selected
CanRejectPointsAutomatically | Returns or sets the flag indicating if points beyond a threshold value should be ignored during fitting
CanUseAllPointsInPart | Returns or sets the flag indicating if all points in the part can be used for chaining
ConstraintManager | Returns the constraint manager
Degree | Returns or sets the degree
Extender | Returns the extension option
FittingParameters | Returns or sets the fitting parameters
HasRadius | Returns or sets the has radius
HasReversedDirection | Returns or sets the flag indicating if fitted curve direction should be reversed
HasUniformSegments | Returns or sets the flag indicating if uniform segments should be created
IsAssociative | Returns or sets the flag indicating if a feature should be created
IsClosedBSpline | Returns or sets the flag indicating if a closed b-spline is to be fitted
IsClosedCurve | Returns or sets the flag indicating if a full circle or ellipse is to be fitted
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
ProjectionDirection | Returns or sets the projection direction
ProjectionDirectionOption | Returns or sets the projection direction option
Radius | Returns the circle radius
RejectionThreshold | Returns the rejection threshold
Segments | Returns or sets the segments
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Target | Returns the target objects.
TargetSourceType | Returns or sets the target type
TemplateCurve | Returns the template curve
Tolerance | Returns or sets the tolerance
Type | Returns or sets the type

# Methods

Method | Description
--- | ---
ChainAllPoints | Chains all the points in work part based on one selected point and evaluates the curve.
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
DeleteTargetPoints | Deletes target points
Destroy | Deletes the builder, and cleans up any objects created by the builder.
Evaluate | Evaluates the curve
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature | Returns the feature currently being edited by this builder.
GetFinalTargetPoint | Returns the target point that are finally used for fitting
GetFinalTargetPointsSize | Returns the number of target points that are finally used for fitting
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
MakeConstraint | In case of point targets, makes a target point a positional constraint.
RemoveConstraint | Makes existing positional constraint a free target point
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
UpdateTargetSelectionOnPointEditing | Updates target selection by replacing original point by edited point.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

FitCurveBuilderFittingParametersOptions Enumeration | Fitting parameters options
FitCurveBuilderProjectionDirectionOptions Enumeration | Auxiliary curve projection direction options
FitCurveBuilderTargetSourceTypes Enumeration | Fitting target types
FitCurveBuilderTypes Enumeration | Fitting types

# Property Detail

## CanKeepTemplateSelected

`FitCurveBuilder.``CanKeepTemplateSelected`

  Returns or sets the flag indicating if template curve should be kept selected

  `-------------------------------------`

  Getter Method

  Signature `CanKeepTemplateSelected`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CanKeepTemplateSelected`

  Parameters: | canKeepTemplateSelected (bool) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## CanRejectPointsAutomatically

`FitCurveBuilder.``CanRejectPointsAutomatically`

  Returns or sets the flag indicating if points beyond a threshold value should be ignored during fitting

  `-------------------------------------`

  Getter Method

  Signature `CanRejectPointsAutomatically`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CanRejectPointsAutomatically`

  Parameters: | rejectPoints (bool) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## CanUseAllPointsInPart

`FitCurveBuilder.``CanUseAllPointsInPart`

  Returns or sets the flag indicating if all points in the part can be used for chaining

  `-------------------------------------`

  Getter Method

  Signature `CanUseAllPointsInPart`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CanUseAllPointsInPart`

  Parameters: | canUseAllPointsInPart (bool) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ConstraintManager

`FitCurveBuilder.``ConstraintManager`

  Returns the constraint manager

  `-------------------------------------`

  Getter Method

  Signature `ConstraintManager`

  Returns: |
  Return type: | `NXOpen.Features.GeometricConstraintDataManager`

  New in version NX8.5.0.

  License requirements: None.

## Degree

`FitCurveBuilder.``Degree`

  Returns or sets the degree

  `-------------------------------------`

  Getter Method

  Signature `Degree`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Degree`

  Parameters: | degree (int) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Extender

`FitCurveBuilder.``Extender`

  Returns the extension option

  `-------------------------------------`

  Getter Method

  Signature `Extender`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.CurveExtensionBuilder`

  New in version NX8.5.0.

  License requirements: None.

## FittingParameters

`FitCurveBuilder.``FittingParameters`

  Returns or sets the fitting parameters

  `-------------------------------------`

  Getter Method

  Signature `FittingParameters`

  Returns: |
  Return type: | `NXOpen.Features.FitCurveBuilderFittingParametersOptions`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FittingParameters`

  Parameters: | fittingParameters (`NXOpen.Features.FitCurveBuilderFittingParametersOptions`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## HasRadius

`FitCurveBuilder.``HasRadius`

  Returns or sets the has radius

  `-------------------------------------`

  Getter Method

  Signature `HasRadius`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `HasRadius`

  Parameters: | hasRadius (bool) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## HasReversedDirection

`FitCurveBuilder.``HasReversedDirection`

  Returns or sets the flag indicating if fitted curve direction should be reversed

  `-------------------------------------`

  Getter Method

  Signature `HasReversedDirection`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `HasReversedDirection`

  Parameters: | hasReversedDirection (bool) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## HasUniformSegments

`FitCurveBuilder.``HasUniformSegments`

  Returns or sets the flag indicating if uniform segments should be created

  `-------------------------------------`

  Getter Method

  Signature `HasUniformSegments`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `HasUniformSegments`

  Parameters: | hasUniformSegments (bool) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## IsAssociative

`FitCurveBuilder.``IsAssociative`

  Returns or sets the flag indicating if a feature should be created

  `-------------------------------------`

  Getter Method

  Signature `IsAssociative`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IsAssociative`

  Parameters: | associative (bool) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## IsClosedBSpline

`FitCurveBuilder.``IsClosedBSpline`

  Returns or sets the flag indicating if a closed b-spline is to be fitted

  `-------------------------------------`

  Getter Method

  Signature `IsClosedBSpline`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IsClosedBSpline`

  Parameters: | isClosed (bool) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## IsClosedCurve

`FitCurveBuilder.``IsClosedCurve`

  Returns or sets the flag indicating if a full circle or ellipse is to be fitted

  `-------------------------------------`

  Getter Method

  Signature `IsClosedCurve`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IsClosedCurve`

  Parameters: | isClosed (bool) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ProjectionDirection

`FitCurveBuilder.``ProjectionDirection`

  Returns or sets the projection direction

  `-------------------------------------`

  Getter Method

  Signature `ProjectionDirection`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProjectionDirection`

  Parameters: | projectionDirection (`NXOpen.Direction`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ProjectionDirectionOption

`FitCurveBuilder.``ProjectionDirectionOption`

  Returns or sets the projection direction option

  `-------------------------------------`

  Getter Method

  Signature `ProjectionDirectionOption`

  Returns: |
  Return type: | `NXOpen.Features.FitCurveBuilderProjectionDirectionOptions`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProjectionDirectionOption`

  Parameters: | projectionDirectionOption (`NXOpen.Features.FitCurveBuilderProjectionDirectionOptions`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Radius

`FitCurveBuilder.``Radius`

  Returns the circle radius

  `-------------------------------------`

  Getter Method

  Signature `Radius`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.5.0.

  License requirements: None.

## RejectionThreshold

`FitCurveBuilder.``RejectionThreshold`

  Returns the rejection threshold

  `-------------------------------------`

  Getter Method

  Signature `RejectionThreshold`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX8.5.0.

  License requirements: None.

## Segments

`FitCurveBuilder.``Segments`

  Returns or sets the segments

  `-------------------------------------`

  Getter Method

  Signature `Segments`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Segments`

  Parameters: | segments (int) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Target

`FitCurveBuilder.``Target`

  Returns the target objects.

  Inputs to this command can be convergent objects.

  `-------------------------------------`

  Getter Method

  Signature `Target`

  Returns: |
  Return type: | `NXOpen.SelectTaggedObjectList`

  New in version NX8.5.0.

  License requirements: None.

## TargetSourceType

`FitCurveBuilder.``TargetSourceType`

  Returns or sets the target type

  `-------------------------------------`

  Getter Method

  Signature `TargetSourceType`

  Returns: |
  Return type: | `NXOpen.Features.FitCurveBuilderTargetSourceTypes`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TargetSourceType`

  Parameters: | targetSourceType (`NXOpen.Features.FitCurveBuilderTargetSourceTypes`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## TemplateCurve

`FitCurveBuilder.``TemplateCurve`

  Returns the template curve

  `-------------------------------------`

  Getter Method

  Signature `TemplateCurve`

  Returns: |
  Return type: | `NXOpen.SelectSpline`

  New in version NX8.5.0.

  License requirements: None.

## Tolerance

`FitCurveBuilder.``Tolerance`

  Returns or sets the tolerance

  `-------------------------------------`

  Getter Method

  Signature `Tolerance`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Tolerance`

  Parameters: | tolerance (float) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Type

`FitCurveBuilder.``Type`

  Returns or sets the type

  `-------------------------------------`

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Features.FitCurveBuilderTypes`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.FitCurveBuilderTypes`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## ChainAllPoints

`FitCurveBuilder.``ChainAllPoints`

  Chains all the points in work part based on one selected point and evaluates the curve.

  Operation is valid for `NXOpen.Features.FitCurveBuilderTargetSourceTypes.Infer` only.

  Signature `ChainAllPoints()`

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## DeleteTargetPoints

`FitCurveBuilder.``DeleteTargetPoints`

  Deletes target points

  Signature `DeleteTargetPoints(points)`

  Parameters: | points (list of `NXOpen.Point`) – One of the original target points or one of the constraint manager points to remove a constraint of

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Evaluate

`FitCurveBuilder.``Evaluate`

  Evaluates the curve

  Signature `Evaluate()`

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## GetFinalTargetPoint

`FitCurveBuilder.``GetFinalTargetPoint`

  Returns the target point that are finally used for fitting

  Signature `GetFinalTargetPoint(index)`

  Parameters: | index (int) –
  Returns: |
  Return type: | `NXOpen.Point`

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## GetFinalTargetPointsSize

`FitCurveBuilder.``GetFinalTargetPointsSize`

  Returns the number of target points that are finally used for fitting

  Signature `GetFinalTargetPointsSize()`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## MakeConstraint

`FitCurveBuilder.``MakeConstraint`

  In case of point targets, makes a target point a positional constraint.

  In case of other targets, makes one of the specified points a positional constraint

  Signature `MakeConstraint(point)`

  Parameters: | point (`NXOpen.Point`) – One of the original target points to make a constraint of

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## RemoveConstraint

`FitCurveBuilder.``RemoveConstraint`

  Makes existing positional constraint a free target point

  Signature `RemoveConstraint(point)`

  Parameters: | point (`NXOpen.Point`) – One of the original target points or one of the constraint manager points to remove a constraint of

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## UpdateTargetSelectionOnPointEditing

`FitCurveBuilder.``UpdateTargetSelectionOnPointEditing`

  Updates target selection by replacing original point by edited point.

  When a target point is edited by dragging, the originally selected target point gets replaced by another point representing edited location. Thus it is no longer necessary for original point to remain selected.

  Signature `UpdateTargetSelectionOnPointEditing()`

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

`FitCurveBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.