MidSurfaceByFacePairsBuilder Class¶
-
class
NXOpen.Features.
MidSurfaceByFacePairsBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.MidSurfaceByFacePairs
builderTo create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateMidSurfaceByFacePairsBuilder()
Default values.
Property Value AutoPopulateSideTwoOption 0 HideBodyOption 0 MergeAngleTolerance 5 PairingStrategy Progressive SearchDistance.Value 2.0 (millimeters part), 0.078 (inches part) ThicknessRatio 0.1 ThicknessValue.Value 2.0 (millimeters part), 0.078 (inches part) TrimmingOption AdvancedTrimming New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
AutoPopulateSideTwoOption | Returns or sets the auto populate side two faces option |
BodySelection | Returns the solid bodies for midsurface definition |
HideBodyOption | Returns or sets the hide solid body option |
IgnoreFaceSelection | Returns the ignore face selection |
MergeAngleTolerance | Returns or sets the merge angle tolerance |
PairingStrategy | Returns or sets the pairing strategy used by automatic pairs |
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 |
SearchDistance | Returns the search distance to be used when searching for side 2 faces |
SheetSelection | Returns the user defined sheet selection |
SideOneSelection | Returns the side one faces for manual pair |
SideTwoSelection | Returns the side two faces for manual pair |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
ThicknessRatio | Returns or sets the dt ratio for ignoring small features |
ThicknessValue | Returns the thickness value when pairing strategy is set to Thickness |
TrimmingOption | Returns or sets the trimming option |
UpdateOption | Returns or sets the immediate update |
UserDefinedMidSurfaceSelection | Returns the user defined sheet selection. |
Methods¶
Method | Description |
---|---|
AutoPopulateSideTwo | Automatically populate side two faces |
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature |
CreateFacePair | Create or edit a face pair from selected side1 and side2 faces |
DeleteFacePair | Deletes the face pair |
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. |
MergeFacePairs | Merges the face pairs |
ModifyMidsurface | Use cloud of points to generate neutral sheet |
ReverseFacePair | Reverse face pair |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
SetupFacePairInContext | Set face pair to edit |
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. |
Trim | Trim the face pairs |
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. |
ValidateSelection | Validate and filter out invalid items from the selection list |
Enumerations¶
MidSurfaceByFacePairsBuilderPairingStrategyType Enumeration | pairing strategy |
MidSurfaceByFacePairsBuilderSurfaceType Enumeration | midsurface options |
MidSurfaceByFacePairsBuilderTrimmingOptionType Enumeration | trimming options |
Property Detail¶
AutoPopulateSideTwoOption¶
-
MidSurfaceByFacePairsBuilder.
AutoPopulateSideTwoOption
¶ Returns or sets the auto populate side two faces option
-------------------------------------
Getter Method
Signature
AutoPopulateSideTwoOption
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutoPopulateSideTwoOption
Parameters: autoPopulateSideTwoOption (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
BodySelection¶
-
MidSurfaceByFacePairsBuilder.
BodySelection
¶ Returns the solid bodies for midsurface definition
-------------------------------------
Getter Method
Signature
BodySelection
Returns: Return type: NXOpen.SelectBodyList
New in version NX7.5.0.
License requirements: None.
HideBodyOption¶
-
MidSurfaceByFacePairsBuilder.
HideBodyOption
¶ Returns or sets the hide solid body option
-------------------------------------
Getter Method
Signature
HideBodyOption
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HideBodyOption
Parameters: hideBodyOption (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
IgnoreFaceSelection¶
-
MidSurfaceByFacePairsBuilder.
IgnoreFaceSelection
¶ Returns the ignore face selection
-------------------------------------
Getter Method
Signature
IgnoreFaceSelection
Returns: Return type: NXOpen.ScCollector
New in version NX7.5.0.
License requirements: None.
MergeAngleTolerance¶
-
MidSurfaceByFacePairsBuilder.
MergeAngleTolerance
¶ Returns or sets the merge angle tolerance
-------------------------------------
Getter Method
Signature
MergeAngleTolerance
Returns: Return type: float New in version NX8.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
MergeAngleTolerance
Parameters: mergeAngleTolerance (float) – New in version NX8.0.1.
License requirements: None.
PairingStrategy¶
-
MidSurfaceByFacePairsBuilder.
PairingStrategy
¶ Returns or sets the pairing strategy used by automatic pairs
-------------------------------------
Getter Method
Signature
PairingStrategy
Returns: Return type: NXOpen.Features.MidSurfaceByFacePairsBuilderPairingStrategyType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PairingStrategy
Parameters: pairingStrategy ( NXOpen.Features.MidSurfaceByFacePairsBuilderPairingStrategyType
) –New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SearchDistance¶
-
MidSurfaceByFacePairsBuilder.
SearchDistance
¶ Returns the search distance to be used when searching for side 2 faces
-------------------------------------
Getter Method
Signature
SearchDistance
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
SheetSelection¶
-
MidSurfaceByFacePairsBuilder.
SheetSelection
¶ Returns the user defined sheet selection
-------------------------------------
Getter Method
Signature
SheetSelection
Returns: Return type: NXOpen.SelectBodyList
New in version NX7.5.0.
License requirements: None.
SideOneSelection¶
-
MidSurfaceByFacePairsBuilder.
SideOneSelection
¶ Returns the side one faces for manual pair
-------------------------------------
Getter Method
Signature
SideOneSelection
Returns: Return type: NXOpen.ScCollector
New in version NX7.5.0.
License requirements: None.
SideTwoSelection¶
-
MidSurfaceByFacePairsBuilder.
SideTwoSelection
¶ Returns the side two faces for manual pair
-------------------------------------
Getter Method
Signature
SideTwoSelection
Returns: Return type: NXOpen.ScCollector
New in version NX7.5.0.
License requirements: None.
ThicknessRatio¶
-
MidSurfaceByFacePairsBuilder.
ThicknessRatio
¶ Returns or sets the dt ratio for ignoring small features
-------------------------------------
Getter Method
Signature
ThicknessRatio
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ThicknessRatio
Parameters: thicknessRatio (float) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ThicknessValue¶
-
MidSurfaceByFacePairsBuilder.
ThicknessValue
¶ Returns the thickness value when pairing strategy is set to Thickness
-------------------------------------
Getter Method
Signature
ThicknessValue
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
TrimmingOption¶
-
MidSurfaceByFacePairsBuilder.
TrimmingOption
¶ Returns or sets the trimming option
-------------------------------------
Getter Method
Signature
TrimmingOption
Returns: Return type: NXOpen.Features.MidSurfaceByFacePairsBuilderTrimmingOptionType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TrimmingOption
Parameters: trimmingOption ( NXOpen.Features.MidSurfaceByFacePairsBuilderTrimmingOptionType
) –New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
UpdateOption¶
-
MidSurfaceByFacePairsBuilder.
UpdateOption
¶ Returns or sets the immediate update
-------------------------------------
Getter Method
Signature
UpdateOption
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UpdateOption
Parameters: updateOption (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
UserDefinedMidSurfaceSelection¶
-
MidSurfaceByFacePairsBuilder.
UserDefinedMidSurfaceSelection
¶ Returns the user defined sheet selection.
A face, body or datum plane to define user defined midsurface
-------------------------------------
Getter Method
Signature
UserDefinedMidSurfaceSelection
Returns: sheet body, face or datum plane Return type: NXOpen.SelectDisplayableObjectList
New in version NX10.0.0.
License requirements: None.
Method Detail¶
AutoPopulateSideTwo¶
-
MidSurfaceByFacePairsBuilder.
AutoPopulateSideTwo
¶ Automatically populate side two faces
Signature
AutoPopulateSideTwo()
New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
CreateFacePair¶
-
MidSurfaceByFacePairsBuilder.
CreateFacePair
¶ Create or edit a face pair from selected side1 and side2 faces
Signature
CreateFacePair()
Returns: Return type: list of NXOpen.Features.Feature
New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DeleteFacePair¶
-
MidSurfaceByFacePairsBuilder.
DeleteFacePair
¶ Deletes the face pair
Signature
DeleteFacePair(facePairs)
Parameters: facePairs (list of NXOpen.NXObject
) – Pairs to be deletedNew in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
MergeFacePairs¶
-
MidSurfaceByFacePairsBuilder.
MergeFacePairs
¶ Merges the face pairs
Signature
MergeFacePairs(facePairs)
Parameters: facePairs (list of NXOpen.NXObject
) – Pairs to be mergedNew in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ModifyMidsurface¶
-
MidSurfaceByFacePairsBuilder.
ModifyMidsurface
¶ Use cloud of points to generate neutral sheet
Signature
ModifyMidsurface(surfaceOption, facePairs)
Parameters: - surfaceOption (
NXOpen.Features.MidSurfaceByFacePairsBuilderSurfaceType
) – - facePairs (list of
NXOpen.NXObject
) – Pairs to use cloud of points
New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
- surfaceOption (
ReverseFacePair¶
-
MidSurfaceByFacePairsBuilder.
ReverseFacePair
¶ Reverse face pair
Signature
ReverseFacePair(facePairs)
Parameters: facePairs (list of NXOpen.NXObject
) – Pairs to be reversedNew in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SetupFacePairInContext¶
-
MidSurfaceByFacePairsBuilder.
SetupFacePairInContext
¶ Set face pair to edit
Signature
SetupFacePairInContext(facePair)
Parameters: facePair ( NXOpen.Features.Feature
) – Face pair to editNew in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Trim¶
-
MidSurfaceByFacePairsBuilder.
Trim
¶ Trim the face pairs
Signature
Trim(trimmingOption, facePairs)
Parameters: - trimmingOption (
NXOpen.Features.MidSurfaceByFacePairsBuilderTrimmingOptionType
) – - facePairs (list of
NXOpen.NXObject
) – Pairs to be deleted
New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
- trimmingOption (
Validate¶
-
MidSurfaceByFacePairsBuilder.
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.
ValidateSelection¶
-
MidSurfaceByFacePairsBuilder.
ValidateSelection
¶ Validate and filter out invalid items from the selection list
Signature
ValidateSelection(selectionType)
Parameters: selectionType (int) – 0 - BodySelection, 1 - SideOneSelection, 2 - SideTwoSelection New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)