EdgePatchBuilder Class¶
-
class
NXOpen.Tooling.
EdgePatchBuilder
¶ Bases:
NXOpen.Builder
Represents a builder to be used to create edge patch surfaces.
To create a new instance of this class, use
NXOpen.Tooling.EdgePatchCollection.CreateBuilder()
Default values.
Property Value PatchSurface 1 SelType Face New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
AllowPatch | Returns or sets the flag indicating if creating copies for patch surface is allowed. |
Body | Returns the body to use to search for loops. |
BodyColor | Returns or sets the patch body color. |
Face | Returns the face to use to search for loops. |
Loops | Returns the loops to patch. |
PatchSurface | Returns or sets the indication to create patch surface bodies in core/cavity. |
ReferenceFace | Returns the reference face to use to create edge patch. |
SelType | Returns or sets the patch type of the edge patch creation. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
ClearList | Clear the index list. |
Commit | Commits any edits that have been applied to the builder. |
DeleteOneLoopList | Delete one loop list of the index. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
DestroyMemory | Destroy the builder memory. |
DirectionReverse | Reverse reference face direction. |
EditReferenceFace | Add or remove reference faces. |
FindBodyHoles | Find holes on the input body. |
FindEdgesPatch | Get hole information of input edges. |
FindFaceHoles | Find holes on the input faces. |
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. |
MakeMoldWizardFills | Create a mold wizard fill. |
SetDeletedList | Set deleted list value. |
SetGiveFailedMessage | Set the giving failed message value. |
SetSelectedItems | Set the selected items index value. |
SetTolerance | Set the tolerance value. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
EdgePatchBuilderPatchStatus Enumeration | Settings of the patch status types. |
EdgePatchBuilderSelectTypes Enumeration | Settings of the selection types. |
Property Detail¶
AllowPatch¶
-
EdgePatchBuilder.
AllowPatch
¶ Returns or sets the flag indicating if creating copies for patch surface is allowed.
-------------------------------------
Getter Method
Signature
AllowPatch
Returns: Return type: bool New in version NX7.5.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
AllowPatch
Parameters: patch (bool) – New in version NX7.5.3.
License requirements: None.
Body¶
-
EdgePatchBuilder.
Body
¶ Returns the body to use to search for loops.
-------------------------------------
Getter Method
Signature
Body
Returns: Return type: NXOpen.SelectBody
New in version NX7.5.0.
License requirements: None.
BodyColor¶
-
EdgePatchBuilder.
BodyColor
¶ Returns or sets the patch body color.
-------------------------------------
Getter Method
Signature
BodyColor
Returns: the color index Return type: Id New in version NX7.5.5.
License requirements: None.
-------------------------------------
Setter Method
Signature
BodyColor
Parameters: patchColor (Id) – the color index New in version NX7.5.5.
License requirements: None.
Face¶
-
EdgePatchBuilder.
Face
¶ Returns the face to use to search for loops.
-------------------------------------
Getter Method
Signature
Face
Returns: Return type: NXOpen.ScCollector
New in version NX7.5.0.
License requirements: None.
Loops¶
-
EdgePatchBuilder.
Loops
¶ Returns the loops to patch.
-------------------------------------
Getter Method
Signature
Loops
Returns: Return type: NXOpen.ScCollector
New in version NX7.5.0.
License requirements: None.
PatchSurface¶
-
EdgePatchBuilder.
PatchSurface
¶ Returns or sets the indication to create patch surface bodies in core/cavity.
-------------------------------------
Getter Method
Signature
PatchSurface
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PatchSurface
Parameters: patchSurface (bool) – New in version NX7.5.0.
License requirements: None.
ReferenceFace¶
-
EdgePatchBuilder.
ReferenceFace
¶ Returns the reference face to use to create edge patch.
-------------------------------------
Getter Method
Signature
ReferenceFace
Returns: Return type: NXOpen.ScCollector
New in version NX7.5.0.
License requirements: None.
SelType¶
-
EdgePatchBuilder.
SelType
¶ Returns or sets the patch type of the edge patch creation.
-------------------------------------
Getter Method
Signature
SelType
Returns: Return type: NXOpen.Tooling.EdgePatchBuilderSelectTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelType
Parameters: selType ( NXOpen.Tooling.EdgePatchBuilderSelectTypes
) –New in version NX7.5.0.
License requirements: None.
Method Detail¶
ClearList¶
-
EdgePatchBuilder.
ClearList
¶ Clear the index list.
Signature
ClearList(type)
Parameters: type (int) – indicating which index list to clear New in version NX7.5.0.
License requirements: None.
DeleteOneLoopList¶
-
EdgePatchBuilder.
DeleteOneLoopList
¶ Delete one loop list of the index.
Signature
DeleteOneLoopList(index)
Parameters: index (int) – the index value New in version NX7.5.0.
License requirements: None.
DestroyMemory¶
-
EdgePatchBuilder.
DestroyMemory
¶ Destroy the builder memory.
Signature
DestroyMemory()
New in version NX7.5.0.
License requirements: None.
DirectionReverse¶
-
EdgePatchBuilder.
DirectionReverse
¶ Reverse reference face direction.
Signature
DirectionReverse()
New in version NX7.5.0.
License requirements: None.
EditReferenceFace¶
-
EdgePatchBuilder.
EditReferenceFace
¶ Add or remove reference faces.
Signature
EditReferenceFace(index, addFaces, removeFaces)
Parameters: - index (int) – the index of list loop
- addFaces (list of
NXOpen.Face
) – The faces to add to reference faces - removeFaces (list of
NXOpen.Face
) – The faces to remove from reference faces
New in version NX7.5.0.
License requirements: None.
FindBodyHoles¶
-
EdgePatchBuilder.
FindBodyHoles
¶ Find holes on the input body.
Signature
FindBodyHoles(body)
Parameters: body ( NXOpen.Body
) – the body to find holes on whichNew in version NX7.5.0.
License requirements: None.
FindEdgesPatch¶
-
EdgePatchBuilder.
FindEdgesPatch
¶ Get hole information of input edges.
Signature
FindEdgesPatch(edges)
Parameters: edges (list of NXOpen.NXObject
) – the edges or curves to find holes informationReturns: the edges or curves patch status Return type: NXOpen.Tooling.EdgePatchBuilderPatchStatus
New in version NX7.5.0.
License requirements: None.
FindFaceHoles¶
-
EdgePatchBuilder.
FindFaceHoles
¶ Find holes on the input faces.
Signature
FindFaceHoles(referFaces)
Parameters: referFaces ( NXOpen.Face
) – the faces to find holesReturns: the loop status Return type: NXOpen.Tooling.EdgePatchBuilderPatchStatus
New in version NX7.5.0.
License requirements: None.
MakeMoldWizardFills¶
-
EdgePatchBuilder.
MakeMoldWizardFills
¶ Create a mold wizard fill.
Signature
MakeMoldWizardFills(tolerance, edges, origFaces)
Parameters: - tolerance (float) – distance tolerance
- edges (list of
NXOpen.NXObject
) – ordered edges array - origFaces (list of
NXOpen.Face
) – selected faces array
New in version NX9.0.1.
License requirements: None.
SetDeletedList¶
-
EdgePatchBuilder.
SetDeletedList
¶ Set deleted list value.
Signature
SetDeletedList(items)
Parameters: items (list of int) – the deleted index values New in version NX7.5.0.
License requirements: None.
SetGiveFailedMessage¶
-
EdgePatchBuilder.
SetGiveFailedMessage
¶ Set the giving failed message value.
Signature
SetGiveFailedMessage(giveMessage)
Parameters: giveMessage (int) – the giving failed message value New in version NX7.5.0.
License requirements: None.
SetSelectedItems¶
-
EdgePatchBuilder.
SetSelectedItems
¶ Set the selected items index value.
Signature
SetSelectedItems(selectedItems)
Parameters: selectedItems (list of int) – the selected index values New in version NX7.5.0.
License requirements: None.
SetTolerance¶
-
EdgePatchBuilder.
SetTolerance
¶ Set the tolerance value.
Signature
SetTolerance(tolerance)
Parameters: tolerance (float) – the tolerance value New in version NX7.5.0.
License requirements: None.
Validate¶
-
EdgePatchBuilder.
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.