GapDisplayBuilder Class¶
-
class
NXOpen.Routing.
GapDisplayBuilder
¶ Bases:
NXOpen.Builder
Builder for creating a gap arc object on a line segment.
To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreateGapDisplayBuilder()
New in version NX8.5.0.
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateBuilder | Takes selected line, gap start and end points, and gap type settings in to initialise builder data. |
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. |
GetObject | Returns the object currently being edited by this builder. |
SetBuilderData | Takes selected line, gap start and end points, and gap type settings in to set builder data. |
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. |
Method Detail¶
CreateBuilder¶
-
GapDisplayBuilder.
CreateBuilder
¶ Takes selected line, gap start and end points, and gap type settings in to initialise builder data.
Signature
CreateBuilder(selLine, crossLine, gapWidth, gapStartPoint, gapEndPoint, bridgeOverGap, arcOrientation)
Parameters: - selLine (
NXOpen.Line
) – - crossLine (
NXOpen.Line
) – - gapWidth (float) –
- gapStartPoint (
NXOpen.Point3d
) – - gapEndPoint (
NXOpen.Point3d
) – - bridgeOverGap (bool) –
- arcOrientation (bool) –
New in version NX8.5.0.
License requirements: routing_base (“Routing Basic”)
- selLine (
SetBuilderData¶
-
GapDisplayBuilder.
SetBuilderData
¶ Takes selected line, gap start and end points, and gap type settings in to set builder data.
Signature
SetBuilderData(selLine, crossLine, gapWidth, gapStartPoint, gapEndPoint, bridgeOverGap, arcOrientation)
Parameters: - selLine (
NXOpen.Line
) – - crossLine (
NXOpen.Line
) – - gapWidth (float) –
- gapStartPoint (
NXOpen.Point3d
) – - gapEndPoint (
NXOpen.Point3d
) – - bridgeOverGap (bool) –
- arcOrientation (bool) –
New in version NX8.5.0.
License requirements: routing_base (“Routing Basic”)
- selLine (
Validate¶
-
GapDisplayBuilder.
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.