MWSearchRegionBuilder Class¶
-
class
NXOpen.Tooling.
MWSearchRegionBuilder
¶ Bases:
NXOpen.Builder
The Search Region builder is for defining a region by searching the region faces given a set of seed faces and boundary edges.
To create a new instance of this class, use
NXOpen.Tooling.MWSearchRegionCollection.CreateBuilder
Default values.
Property Value HighlightConnectingFacesScale 0 MaximumNumberOfFacesSearched 1 TranslucencyAsBoundaryFacesToggle 0 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
BoundaryFacesColor | Returns or sets the color to be applied to the selected boundary faces |
DifferentColorsAsBoundaryFacesOption | Returns or sets the option to use different colors as boundary faces |
HighlightConnectingFacesScale | Returns or sets the highlight connecting faces scale |
MaximumNumberOfFacesSearched | Returns or sets the maximum number of faces to be searched |
SelectBoundaryEdges | Returns the select boundary edges |
SelectBoundaryFaces | Returns the select boundary faces |
SelectSeedFaces | Returns the select seed faces |
Tag | Returns the Tag for this object. |
TranslucencyAsBoundaryFacesToggle | Returns or sets the translucency as boundary faces toggle |
Methods¶
Method | Description |
---|---|
ChangeBoundaryFacesColor | Change the color of the selected boundary using the specified color |
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
DisplayProductBody | Display the product body in the part file |
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. |
InitBuilderData | Initialize the data for the Search Region builder |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
TurnOffAllPartingLines | Turn off all parting lines |
UpdateRegion | Update the region with the new region faces and seed faces |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
BoundaryFacesColor¶
-
MWSearchRegionBuilder.
BoundaryFacesColor
¶ Returns or sets the color to be applied to the selected boundary faces
-------------------------------------
Getter Method
Signature
BoundaryFacesColor()
Returns: Return type: Id New in version NX6.0.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
BoundaryFacesColor(boundaryFacesColor)
Parameters: boundaryFacesColor (Id) – New in version NX6.0.3.
License requirements: None.
DifferentColorsAsBoundaryFacesOption¶
-
MWSearchRegionBuilder.
DifferentColorsAsBoundaryFacesOption
¶ Returns or sets the option to use different colors as boundary faces
-------------------------------------
Getter Method
Signature
DifferentColorsAsBoundaryFacesOption()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DifferentColorsAsBoundaryFacesOption(differentColorsAsBoundaryFacesOption)
Parameters: differentColorsAsBoundaryFacesOption (bool) – New in version NX7.5.0.
License requirements: None.
HighlightConnectingFacesScale¶
-
MWSearchRegionBuilder.
HighlightConnectingFacesScale
¶ Returns or sets the highlight connecting faces scale
-------------------------------------
Getter Method
Signature
HighlightConnectingFacesScale()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HighlightConnectingFacesScale(highlightConnectingFacesScale)
Parameters: highlightConnectingFacesScale (int) – New in version NX6.0.0.
License requirements: None.
MaximumNumberOfFacesSearched¶
-
MWSearchRegionBuilder.
MaximumNumberOfFacesSearched
¶ Returns or sets the maximum number of faces to be searched
-------------------------------------
Getter Method
Signature
MaximumNumberOfFacesSearched()
Returns: Return type: int New in version NX6.0.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaximumNumberOfFacesSearched(maximumNumberOfFacesSearched)
Parameters: maximumNumberOfFacesSearched (int) – New in version NX6.0.3.
License requirements: None.
SelectBoundaryEdges¶
-
MWSearchRegionBuilder.
SelectBoundaryEdges
¶ Returns the select boundary edges
-------------------------------------
Getter Method
Signature
SelectBoundaryEdges()
Returns: Return type: NXOpen.SelectEdgeList
New in version NX6.0.0.
License requirements: None.
SelectBoundaryFaces¶
-
MWSearchRegionBuilder.
SelectBoundaryFaces
¶ Returns the select boundary faces
-------------------------------------
Getter Method
Signature
SelectBoundaryFaces()
Returns: Return type: NXOpen.SelectFaceList
New in version NX6.0.3.
License requirements: None.
SelectSeedFaces¶
-
MWSearchRegionBuilder.
SelectSeedFaces
¶ Returns the select seed faces
-------------------------------------
Getter Method
Signature
SelectSeedFaces()
Returns: Return type: NXOpen.SelectFaceList
New in version NX6.0.0.
License requirements: None.
TranslucencyAsBoundaryFacesToggle¶
-
MWSearchRegionBuilder.
TranslucencyAsBoundaryFacesToggle
¶ Returns or sets the translucency as boundary faces toggle
-------------------------------------
Getter Method
Signature
TranslucencyAsBoundaryFacesToggle()
Returns: Return type: bool New in version NX6.0.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
TranslucencyAsBoundaryFacesToggle(translucencyAsBoundaryFacesToggle)
Parameters: translucencyAsBoundaryFacesToggle (bool) – New in version NX6.0.3.
License requirements: None.
Method Detail¶
ChangeBoundaryFacesColor¶
-
MWSearchRegionBuilder.
ChangeBoundaryFacesColor
¶ Change the color of the selected boundary using the specified color
Signature
ChangeBoundaryFacesColor()
New in version NX6.0.3.
License requirements: None.
DisplayProductBody¶
-
MWSearchRegionBuilder.
DisplayProductBody
¶ Display the product body in the part file
Signature
DisplayProductBody()
New in version NX6.0.3.
License requirements: None.
InitBuilderData¶
-
MWSearchRegionBuilder.
InitBuilderData
¶ Initialize the data for the Search Region builder
Signature
InitBuilderData()
New in version NX6.0.3.
License requirements: None.
TurnOffAllPartingLines¶
-
MWSearchRegionBuilder.
TurnOffAllPartingLines
¶ Turn off all parting lines
Signature
TurnOffAllPartingLines()
New in version NX6.0.3.
License requirements: None.
UpdateRegion¶
-
MWSearchRegionBuilder.
UpdateRegion
¶ Update the region with the new region faces and seed faces
Signature
UpdateRegion()
New in version NX6.0.3.
License requirements: None.
Validate¶
-
MWSearchRegionBuilder.
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.