OffsetMoveCurveBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# OffsetMoveCurveBuilder Class

class `NXOpen.Features.``OffsetMoveCurveBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.OffsetMoveCurve` builder

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

  Default values.

  Property | Value
  --- | ---
  CurveFinder.ChamferEnabled | 0
  CurveFinder.CoincidentVertex2dComponentEnabled | 0
  CurveFinder.CoincidentVertexEnabled | 0
  CurveFinder.CoincidentVertexSketchGroupEnabled | 0
  CurveFinder.Collinear2dComponentEnabled | 0
  CurveFinder.CollinearEnabled | 0
  CurveFinder.CollinearSketchGroupEnabled | 0
  CurveFinder.Concentric2dComponentEnabled | 0
  CurveFinder.ConcentricEnabled | 0
  CurveFinder.ConcentricSketchGroupEnabled | 0
  CurveFinder.EqualRadius2dComponentEnabled | 0
  CurveFinder.EqualRadiusEnabled | 0
  CurveFinder.EqualRadiusSketchGroupEnabled | 0
  CurveFinder.Offset2dComponentEnabled | 0
  CurveFinder.OffsetEnabled | 0
  CurveFinder.OffsetSketchGroupEnabled | 0
  CurveFinder.Parallel2dComponentEnabled | 0
  CurveFinder.ParallelEnabled | 0
  CurveFinder.ParallelSketchGroupEnabled | 0
  CurveFinder.SymmetricEnabled | 0
  CurveFinder.Tangent2dComponentEnabled | 0
  CurveFinder.TangentEnabled | 0
  CurveFinder.TangentSketchGroupEnabled | 0
  CurveFinder.UseCurveFinder | 1
  CurveFinder.VertexOnCurve2dComponentEnabled | 0
  CurveFinder.VertexOnCurveEnabled | 0
  CurveFinder.VertexOnCurveSketchGroupEnabled | 0
  Distance.Value | 0 (millimeters part), 0 (inches part)

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
CurveFinder | Returns the curve finder
Distance | Returns the offset distance
DistanceTolerance | Returns or sets the distance tolerance
KeepOrthogonal | Returns or sets a value that indicates whether keep orthogonal is enabled
KeepTangent | Returns or sets a value that indicates which keep tangent support is selected
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
ReverseOffsetDirection | Returns or sets the reverse offset direction
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AddCurveSenseToMap | This function add the selected curve and its sense into the curve_sense_map when select a new curve
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
Destroy | Deletes the builder, and cleans up any objects created by the builder.
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.
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.
RemoveCurveSenseFromMap | This function remove a curve and its sense from the curve_sense_map when deselect a curve
ReverseOffsetDirectionOfLoop | This function reverses the offset direction of the loop containing the input curve
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
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## CurveFinder

`OffsetMoveCurveBuilder.``CurveFinder`

  Returns the curve finder

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

  Getter Method

  Signature `CurveFinder`

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

  New in version NX9.0.0.

  License requirements: None.

## Distance

`OffsetMoveCurveBuilder.``Distance`

  Returns the offset distance

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

  Getter Method

  Signature `Distance`

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

  New in version NX9.0.0.

  License requirements: None.

## DistanceTolerance

`OffsetMoveCurveBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

## KeepOrthogonal

`OffsetMoveCurveBuilder.``KeepOrthogonal`

  Returns or sets a value that indicates whether keep orthogonal is enabled

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

  Getter Method

  Signature `KeepOrthogonal`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepOrthogonal`

  Parameters: | keepOrthogonal (bool) –

  New in version NX10.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

## KeepTangent

`OffsetMoveCurveBuilder.``KeepTangent`

  Returns or sets a value that indicates which keep tangent support is selected

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

  Getter Method

  Signature `KeepTangent`

  Returns: |
  Return type: | int

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepTangent`

  Parameters: | keepTangent (int) –

  New in version NX10.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

## ReverseOffsetDirection

`OffsetMoveCurveBuilder.``ReverseOffsetDirection`

  Returns or sets the reverse offset direction

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

  Getter Method

  Signature `ReverseOffsetDirection`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReverseOffsetDirection`

  Parameters: | reverseOffsetDirection (bool) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

# Method Detail

## AddCurveSenseToMap

`OffsetMoveCurveBuilder.``AddCurveSenseToMap`

  This function add the selected curve and its sense into the curve_sense_map when select a new curve

  Signature `AddCurveSenseToMap(curve, curveSense)`

  Parameters:

  - curve (`NXOpen.NXObject`) – A new selected curve
  - curveSense (int) – The sense of the selected curve

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

## RemoveCurveSenseFromMap

`OffsetMoveCurveBuilder.``RemoveCurveSenseFromMap`

  This function remove a curve and its sense from the curve_sense_map when deselect a curve

  Signature `RemoveCurveSenseFromMap(curve)`

  Parameters: | curve (`NXOpen.NXObject`) – A removed curve

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

## ReverseOffsetDirectionOfLoop

`OffsetMoveCurveBuilder.``ReverseOffsetDirectionOfLoop`

  This function reverses the offset direction of the loop containing the input curve

  Signature `ReverseOffsetDirectionOfLoop(objectInLoop)`

  Parameters: | objectInLoop (`NXOpen.NXObject`) – A curve in loop to reverse

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

## Validate

`OffsetMoveCurveBuilder.``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.