AdmOffsetRegionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# AdmOffsetRegionBuilder Class

class `NXOpen.Features.``AdmOffsetRegionBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.AdmOffsetRegion` builder

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

  Default values.

  Property | Value
  --- | ---
  Distance.Value | 0.0 (millimeters part), 0.0 (inches part)
  FaceToOffset.CoaxialEnabled | 0
  FaceToOffset.CoplanarAxesEnabled | 0
  FaceToOffset.CoplanarEnabled | 0
  FaceToOffset.EqualDiameterEnabled | 0
  FaceToOffset.OffsetEnabled | 0
  FaceToOffset.ParallelEnabled | 0
  FaceToOffset.PerpendicularEnabled | 0
  FaceToOffset.SymmetricEnabled | 0
  FaceToOffset.TangentEnabled | 0
  FaceToOffset.ThicknessChainEnabled | 0
  FaceToOffset.UseFaceBrowse | 1

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
Distance | Returns the offset distance
FaceChangeOverflowBehavior | Returns the face change overflow behavior.
FaceToOffset | Returns the region faces to offset.
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
ReverseDirection | 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
--- | ---
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.
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

## Distance

`AdmOffsetRegionBuilder.``Distance`

  Returns the offset distance

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

  Getter Method

  Signature `Distance`

  Returns: | the distance expression
  Return type: | `NXOpen.Expression`

  New in version NX6.0.0.

  License requirements: None.

## FaceChangeOverflowBehavior

`AdmOffsetRegionBuilder.``FaceChangeOverflowBehavior`

  Returns the face change overflow behavior.

  Please refer `NXOpen.GeometricUtilities.FaceChangeOverflowBehavior` for details.

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

  Getter Method

  Signature `FaceChangeOverflowBehavior`

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

  New in version NX6.0.2.

  License requirements: None.

## FaceToOffset

`AdmOffsetRegionBuilder.``FaceToOffset`

  Returns the region faces to offset.

  See `NXOpen.Features.FaceRecognitionBuilder` for details.

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

  Getter Method

  Signature `FaceToOffset`

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

  New in version NX6.0.0.

  License requirements: None.

## ReverseDirection

`AdmOffsetRegionBuilder.``ReverseDirection`

  Returns or sets the reverse offset direction

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

  Getter Method

  Signature `ReverseDirection`

  Returns: | the flag of reverse direction
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReverseDirection`

  Parameters: | reverseDirection (bool) – the flag of reverse direction

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## Validate

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