DividefaceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DividefaceBuilder Class

class `NXOpen.Features.``DividefaceBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a divide face builder.

  Inputs to this class can be convergent objects. To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateDividefaceBuilder()`

  Default values.

  Property | Value
  --- | ---
  SelectDividingObject.OffsetDistance.Value | 5 (millimeters part), 0.2 (inches part)
  SelectDividingObject.ToolOption | Object

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
BlankOption | Returns or sets the curve blanking option
DividingObjectsList | Returns the Dividing Objects
ExtendOption | Returns or sets the Extend resulting edges to boundary
FacesToDivide | Returns or sets the Faces to Divide
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
ProjectCurvesThatLieOnFaceOption | Returns or sets the Do not project curves that lie on face
ProjectionOption | Returns the Projection Options data
SelectDividingObject | Returns the Select Dividing Objects
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Tolerance | Returns or sets the tolerance

# 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

## BlankOption

`DividefaceBuilder.``BlankOption`

  Returns or sets the curve blanking option

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

  Getter Method

  Signature `BlankOption`

  Returns: | false: maintain curves; true: blank curves
  Return type: | bool

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BlankOption`

  Parameters: | blank (bool) – false: maintain curves; true: blank curves

  New in version NX4.0.0.

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

## DividingObjectsList

`DividefaceBuilder.``DividingObjectsList`

  Returns the Dividing Objects

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

  Getter Method

  Signature `DividingObjectsList`

  Returns: | dividing objects list. List contains Section and ScCollector
  Return type: | `NXOpen.SelectDisplayableObjectList`

  New in version NX6.0.0.

  Deprecated since version NX9.0.0: This is for pre NX9 usage, do not use this method. Instead use `NXOpen.Features.DividefaceBuilder.SelectDividingObject()` instead.

  License requirements: None.

## ExtendOption

`DividefaceBuilder.``ExtendOption`

  Returns or sets the Extend resulting edges to boundary

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

  Getter Method

  Signature `ExtendOption`

  Returns: | false: do not extend curves; true: extend curves
  Return type: | bool

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ExtendOption`

  Parameters: | extend (bool) – false: do not extend curves; true: extend curves

  New in version NX4.0.0.

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

## FacesToDivide

`DividefaceBuilder.``FacesToDivide`

  Returns or sets the Faces to Divide

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

  Getter Method

  Signature `FacesToDivide`

  Returns: | Smart collector for faces to divide
  Return type: | `NXOpen.ScCollector`

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FacesToDivide`

  Parameters: | facesToDivide (`NXOpen.ScCollector`) – Smart collector for faces to divide

  New in version NX4.0.0.

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

## ProjectCurvesThatLieOnFaceOption

`DividefaceBuilder.``ProjectCurvesThatLieOnFaceOption`

  Returns or sets the Do not project curves that lie on face

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

  Getter Method

  Signature `ProjectCurvesThatLieOnFaceOption`

  Returns: | false: project curves that lie on face option; true: Do not project curves that lie on face option
  Return type: | bool

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ProjectCurvesThatLieOnFaceOption`

  Parameters: | projectCurvesThatLieOnFace (bool) – false: project curves that lie on face option; true: Do not project curves that lie on face option

  New in version NX4.0.0.

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

## ProjectionOption

`DividefaceBuilder.``ProjectionOption`

  Returns the Projection Options data

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

  Getter Method

  Signature `ProjectionOption`

  Returns: | Projection Options data
  Return type: | `NXOpen.GeometricUtilities.ProjectionOptions`

  New in version NX4.0.0.

  License requirements: None.

## SelectDividingObject

`DividefaceBuilder.``SelectDividingObject`

  Returns the Select Dividing Objects

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

  Getter Method

  Signature `SelectDividingObject`

  Returns: | dividing objects
  Return type: | `NXOpen.GeometricUtilities.SelectDividingObjectBuilder`

  New in version NX9.0.0.

  License requirements: None.

## Tolerance

`DividefaceBuilder.``Tolerance`

  Returns or sets the tolerance

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

  Getter Method

  Signature `Tolerance`

  Returns: | Tolerance
  Return type: | float

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Tolerance`

  Parameters: | tolerance (float) – Tolerance

  New in version NX4.0.0.

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

# Method Detail

## Validate

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