OffsetCurve3DBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# OffsetCurve3DBuilder Class

class `NXOpen.Tooling.``OffsetCurve3DBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Tooling.OffsetCurve3DBuilder` builder which implements offset curves along a direction with offset distance in three dimension.

  This builder’s Commit can produce more than one offset curves, the GetCommittedObjects can be used to get the objects. To create a new instance of this class, use `NXOpen.Tooling.CAMDataManager.CreateOffsetCurve3dBuilder()`

  Default values.

  Property | Value
  --- | ---
  DistanceTolerance (deprecated) | 0.0254 (millimeters part), 0.001 (inches part)
  OffsetDistance (deprecated) | 10 (millimeters part), 0.4 (inches part)

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.Features.Offset3DCurveBuilder` instead

# Properties

Property | Description
--- | ---
DistanceTolerance | Returns or sets the distance tolerance.
OffsetCurves | Returns the curves to offset.
OffsetDistance | Returns or sets the offset distance.
OffsetViewDirection | Returns or sets the reference direction from which to get the offset direction.
ReverseDirection | Returns or sets the flag of reverse all offset direction.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetAllReverseDirectionFlags | Gets reverse direction flags for each offset curve.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
SetAllReverseDirectionFlags | Sets reverse direction flags for each offset curve.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## DistanceTolerance

`OffsetCurve3DBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance.

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.GeometricUtilities.CurveFitData.Tolerance()` instead

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.GeometricUtilities.CurveFitData.Tolerance()` instead

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

## OffsetCurves

`OffsetCurve3DBuilder.``OffsetCurves`

  Returns the curves to offset.

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

  Getter Method

  Signature `OffsetCurves`

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

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.Features.Offset3DCurveBuilder.OffsetCurves()` instead

  License requirements: None.

## OffsetDistance

`OffsetCurve3DBuilder.``OffsetDistance`

  Returns or sets the offset distance.

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

  Getter Method

  Signature `OffsetDistance`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.Features.Offset3DCurveBuilder.OffsetDistance()` instead

  License requirements: None.

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

  Setter Method

  Signature `OffsetDistance`

  Parameters: | offsetDistance (float) –

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.Features.Offset3DCurveBuilder.OffsetDistance()` instead

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

## OffsetViewDirection

`OffsetCurve3DBuilder.``OffsetViewDirection`

  Returns or sets the reference direction from which to get the offset direction.

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

  Getter Method

  Signature `OffsetViewDirection`

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

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.Features.Offset3DCurveBuilder.OffsetViewDirection()` instead

  License requirements: None.

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

  Setter Method

  Signature `OffsetViewDirection`

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

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.Features.Offset3DCurveBuilder.SetOffsetViewDirection()` instead

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

## ReverseDirection

`OffsetCurve3DBuilder.``ReverseDirection`

  Returns or sets the flag of reverse all offset direction.

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

  Getter Method

  Signature `ReverseDirection`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.Features.Offset3DCurveBuilder.ReverseSide()` instead

  License requirements: None.

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

  Setter Method

  Signature `ReverseDirection`

  Parameters: | reverseDirection (bool) –

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.Features.Offset3DCurveBuilder.SetReverseSide()` instead

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

# Method Detail

## GetAllReverseDirectionFlags

`OffsetCurve3DBuilder.``GetAllReverseDirectionFlags`

  Gets reverse direction flags for each offset curve.

  Signature `GetAllReverseDirectionFlags()`

  Returns: | the reverse direction flags for each offset curve
  Return type: | list of bool

  New in version NX9.0.0.

  Deprecated since version NX10.0.0.

  License requirements: None.

## SetAllReverseDirectionFlags

`OffsetCurve3DBuilder.``SetAllReverseDirectionFlags`

  Sets reverse direction flags for each offset curve.

  Signature `SetAllReverseDirectionFlags(allReverseDirectionFlags)`

  Parameters: | allReverseDirectionFlags (list of bool) – the reverse direction flags for each offset curve

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Please use `NXOpen.Features.Offset3DCurveBuilder.FlipOffsetCurveDirection()` instead

  License requirements: nx_freeform_2 (“advanced freeform modeling”) OR die_engineering (“DIE ENGINEERING”)

## Validate

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