ReplaceFaceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ReplaceFaceBuilder Class

class `NXOpen.Features.``ReplaceFaceBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a builder for a replace face feature, don’t use it until nx502.

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

  New in version NX5.0.2.

# Properties

Property | Description
--- | ---
BlendFace | Returns the face collector holding the all the recognized blend faces adjacent to faces to replace.
FaceChangeOverflowBehavior | Returns the face change overflow behavior.
FaceToReplace | Returns the target faces to replace, only for replace type, don’t use it until nx502
FaceToSimplify | Returns the face to simplify, only for simplify type, don’t use it until nx502
FreeEdgeProjection | Returns the free edge projection options, which defines a direction to project laminar boundaries of the original face onto the replacement face.
OffsetDistance | Returns the offset distance of replacement faces
OffsetReverseDirection | Returns or sets the offset reverse direction flag of replacement faces
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
ReplaceFaces | Returns the target faces to replace
ReplacementFace | Returns the replacement face, only for replace type, don’t use it until nx502
ReplacementFaces | Returns the replacement faces
ReverseDirection | Returns or sets the flag of reverse direction between replace face and the surface of replacement face, only for replace type, don’t use it until nx502
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the replace face type, don’t use it until further notification

# 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.
ResetFreeEdgeProjectionOption | The function used to set m_resetFreeEdgeProjectionOption in ReplaceFaceBuilder as true
ResetReplaceFaceMethod | The function used to set m_resetReplaceFaceMethod in ReplaceFaceBuilder as true
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.

# Enumerations

ReplaceFaceBuilderReplaceTypes Enumeration | Enumeration of replace face type, don’t use it until nx502

# Property Detail

## BlendFace

`ReplaceFaceBuilder.``BlendFace`

  Returns the face collector holding the all the recognized blend faces adjacent to faces to replace.

  It is auto recognized blends + user selected blends - user excluded blends, don’t use it until nx502

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

  Getter Method

  Signature `BlendFace`

  Returns: |
  Return type: | `NXOpen.ModlDirect.SelectBlend`

  New in version NX5.0.2.

  License requirements: None.

## FaceChangeOverflowBehavior

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

## FaceToReplace

`ReplaceFaceBuilder.``FaceToReplace`

  Returns the target faces to replace, only for replace type, don’t use it until nx502

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

  Getter Method

  Signature `FaceToReplace`

  Returns: | the replace faces collector
  Return type: | `NXOpen.ScCollector`

  New in version NX5.0.2.

  License requirements: None.

## FaceToSimplify

`ReplaceFaceBuilder.``FaceToSimplify`

  Returns the face to simplify, only for simplify type, don’t use it until nx502

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

  Getter Method

  Signature `FaceToSimplify`

  Returns: | the list of faces to simplify
  Return type: | `NXOpen.SelectFaceList`

  New in version NX5.0.2.

  License requirements: None.

## FreeEdgeProjection

`ReplaceFaceBuilder.``FreeEdgeProjection`

  Returns the free edge projection options, which defines a direction to project laminar boundaries of the original face onto the replacement face.

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

  Getter Method

  Signature `FreeEdgeProjection`

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

  New in version NX11.0.0.

  License requirements: None.

## OffsetDistance

`ReplaceFaceBuilder.``OffsetDistance`

  Returns the offset distance of replacement faces

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

  Getter Method

  Signature `OffsetDistance`

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

  New in version NX6.0.0.

  License requirements: None.

## OffsetReverseDirection

`ReplaceFaceBuilder.``OffsetReverseDirection`

  Returns or sets the offset reverse direction flag of replacement faces

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

  Getter Method

  Signature `OffsetReverseDirection`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OffsetReverseDirection`

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

  New in version NX6.0.0.

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

## ReplaceFaces

`ReplaceFaceBuilder.``ReplaceFaces`

  Returns the target faces to replace

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

  Getter Method

  Signature `ReplaceFaces`

  Returns: | the replace faces collector
  Return type: | `NXOpen.ScCollector`

  New in version NX6.0.0.

  License requirements: None.

## ReplacementFace

`ReplaceFaceBuilder.``ReplacementFace`

  Returns the replacement face, only for replace type, don’t use it until nx502

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

  Getter Method

  Signature `ReplacementFace`

  Returns: | the replacement faces collector
  Return type: | `NXOpen.SelectFace`

  New in version NX5.0.2.

  License requirements: None.

## ReplacementFaces

`ReplaceFaceBuilder.``ReplacementFaces`

  Returns the replacement faces

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

  Getter Method

  Signature `ReplacementFaces`

  Returns: | the replacement faces collector
  Return type: | `NXOpen.ScCollector`

  New in version NX6.0.0.

  License requirements: None.

## ReverseDirection

`ReplaceFaceBuilder.``ReverseDirection`

  Returns or sets the flag of reverse direction between replace face and the surface of replacement face, only for replace type, don’t use it until nx502

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

  Getter Method

  Signature `ReverseDirection`

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

  New in version NX5.0.2.

  License requirements: None.

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

  Setter Method

  Signature `ReverseDirection`

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

  New in version NX5.0.2.

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

## Type

`ReplaceFaceBuilder.``Type`

  Returns or sets the replace face type, don’t use it until further notification

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

  Getter Method

  Signature `Type`

  Returns: | the replace face type
  Return type: | `NXOpen.Features.ReplaceFaceBuilderReplaceTypes`

  New in version NX5.0.2.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | replaceType (`NXOpen.Features.ReplaceFaceBuilderReplaceTypes`) – the replace face type

  New in version NX5.0.2.

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

# Method Detail

## ResetFreeEdgeProjectionOption

`ReplaceFaceBuilder.``ResetFreeEdgeProjectionOption`

  The function used to set m_resetFreeEdgeProjectionOption in ReplaceFaceBuilder as true

  Signature `ResetFreeEdgeProjectionOption()`

  New in version NX11.0.0.

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

## ResetReplaceFaceMethod

`ReplaceFaceBuilder.``ResetReplaceFaceMethod`

  The function used to set m_resetReplaceFaceMethod in ReplaceFaceBuilder as true

  Signature `ResetReplaceFaceMethod()`

  New in version NX10.0.0.

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

## Validate

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