BrokenViewBuilder Class¶
-
class
NXOpen.Drawings.BrokenViewBuilder¶ Bases:
NXOpen.BuilderThis class is used to construct the broken view Builder
To create a new instance of this class, use
NXOpen.Drawings.DraftingViewCollection.CreateBrokenViewBuilder()Default values.
Property Value Amplitude.Value 5 (millimeters part), 0.25 (inches part) BreakLine1Offset.Value 0 (millimeters part), 0 (inches part) BreakLine2Offset.Value 0 (millimeters part), 0 (inches part) BreakLineType Simple BreakType Regular DirectionType Vector Extension1.Value 0 (millimeters part), 0 (inches part) Extension2.Value 0 (millimeters part), 0 (inches part) Gap.Value 10 (millimeters part), 0.25 (inches part) IsBreakLine1Associative 1 IsBreakLine2Associative 1 Repetition 1 Width Medium New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| Amplitude | Returns the break line amplitude |
| BreakLine1Anchor | Returns or sets the object specifying the position of the first break line |
| BreakLine1ModelAnchor | Returns or sets the object specifying the position of the first break line |
| BreakLine1Offset | Returns the offset from the object locating the first break line |
| BreakLine2Anchor | Returns or sets the object specifying the position of the second break line. |
| BreakLine2ModelAnchor | Returns or sets the object specifying the position of the second break line. |
| BreakLine2Offset | Returns the offset from the object locating the second break line. |
| BreakLineType | Returns or sets the break line type |
| BreakType | Returns or sets the break type |
| BreakVisibility | Returns or sets the view break visibilitity |
| Color | Returns or sets the break line color |
| CrossHatch | Returns the HatchFillSetting |
| DirectionType | Returns or sets the direction type |
| DirectionVector | Returns or sets the direction vector. |
| ExistingCurve | Returns the curve to use as existing curve |
| Extension1 | Returns the break line extension (top/right) beyond geometry |
| Extension2 | Returns the break line extension (bottom/left) beyond geometry |
| Gap | Returns the gap on the sheet between the two break lines |
| IsBreakLine1Associative | Returns or sets the associative positionning of the first break line |
| IsBreakLine2Associative | Returns or sets the associative positionning of the second break line. |
| MasterView | Returns the master view |
| Repetition | Returns or sets the repetition of the break line pattern |
| Suppress | Returns or sets the view break suppress status |
| Tag | Returns the Tag for this object. |
| Width | Returns or sets the curve width of the break line |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| 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. |
| 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¶
| BrokenViewBuilderBreakLineStyle Enumeration | Break Line Type |
| BrokenViewBuilderHorizontalBreakSide Enumeration | Which side to remove in case of vertical single-sided break. |
| BrokenViewBuilderLineWidth Enumeration | Line Width |
| BrokenViewBuilderTypeBreak Enumeration | Specifies whether the break is two-sided (regular) or one-sided. |
| BrokenViewBuilderTypeDirection Enumeration | Direction Enum |
| BrokenViewBuilderVerticalBreakSide Enumeration | Which side to remove in case of horizontal single-sided break. |
Property Detail¶
Amplitude¶
-
BrokenViewBuilder.Amplitude¶ Returns the break line amplitude
-------------------------------------Getter Method
Signature
AmplitudeReturns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
BreakLine1Anchor¶
-
BrokenViewBuilder.BreakLine1Anchor¶ Returns or sets the object specifying the position of the first break line
-------------------------------------Getter Method
Signature
BreakLine1AnchorReturns: Return type: NXOpen.PointNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BreakLine1AnchorParameters: anchor1 ( NXOpen.Point) –New in version NX7.5.0.
License requirements: None.
BreakLine1ModelAnchor¶
-
BrokenViewBuilder.BreakLine1ModelAnchor¶ Returns or sets the object specifying the position of the first break line
-------------------------------------Getter Method
Signature
BreakLine1ModelAnchorReturns: Return type: NXOpen.PointNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BreakLine1ModelAnchorParameters: anchor1 ( NXOpen.Point) –New in version NX7.5.0.
License requirements: None.
BreakLine1Offset¶
-
BrokenViewBuilder.BreakLine1Offset¶ Returns the offset from the object locating the first break line
-------------------------------------Getter Method
Signature
BreakLine1OffsetReturns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
BreakLine2Anchor¶
-
BrokenViewBuilder.BreakLine2Anchor¶ Returns or sets the object specifying the position of the second break line.
For
Drawings.BrokenViewBuilderTypeBreak.Regularonly-------------------------------------Getter Method
Signature
BreakLine2AnchorReturns: Return type: NXOpen.PointNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BreakLine2AnchorParameters: anchor2 ( NXOpen.Point) –New in version NX7.5.0.
License requirements: None.
BreakLine2ModelAnchor¶
-
BrokenViewBuilder.BreakLine2ModelAnchor¶ Returns or sets the object specifying the position of the second break line.
For
Drawings.BrokenViewBuilderTypeBreak.Regularonly-------------------------------------Getter Method
Signature
BreakLine2ModelAnchorReturns: Return type: NXOpen.PointNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BreakLine2ModelAnchorParameters: anchor2 ( NXOpen.Point) –New in version NX7.5.0.
License requirements: None.
BreakLine2Offset¶
-
BrokenViewBuilder.BreakLine2Offset¶ Returns the offset from the object locating the second break line.
For
Drawings.BrokenViewBuilderTypeBreak.Regularonly-------------------------------------Getter Method
Signature
BreakLine2OffsetReturns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
BreakLineType¶
-
BrokenViewBuilder.BreakLineType¶ Returns or sets the break line type
-------------------------------------Getter Method
Signature
BreakLineTypeReturns: Return type: NXOpen.Drawings.BrokenViewBuilderBreakLineStyleNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BreakLineTypeParameters: lineType ( NXOpen.Drawings.BrokenViewBuilderBreakLineStyle) –New in version NX7.5.0.
License requirements: None.
BreakType¶
-
BrokenViewBuilder.BreakType¶ Returns or sets the break type
-------------------------------------Getter Method
Signature
BreakTypeReturns: Return type: NXOpen.Drawings.BrokenViewBuilderTypeBreakNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BreakTypeParameters: breakType ( NXOpen.Drawings.BrokenViewBuilderTypeBreak) –New in version NX7.5.0.
License requirements: None.
BreakVisibility¶
-
BrokenViewBuilder.BreakVisibility¶ Returns or sets the view break visibilitity
-------------------------------------Getter Method
Signature
BreakVisibilityReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BreakVisibilityParameters: visibilitity (bool) – New in version NX8.0.0.
License requirements: None.
Color¶
-
BrokenViewBuilder.Color¶ Returns or sets the break line color
-------------------------------------Getter Method
Signature
ColorReturns: Return type: Id New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ColorParameters: color (Id) – New in version NX7.5.0.
License requirements: None.
CrossHatch¶
-
BrokenViewBuilder.CrossHatch¶ Returns the HatchFillSetting
-------------------------------------Getter Method
Signature
CrossHatchReturns: Return type: NXOpen.Annotations.HatchFillSettingsBuilderNew in version NX7.5.0.
License requirements: None.
DirectionType¶
-
BrokenViewBuilder.DirectionType¶ Returns or sets the direction type
-------------------------------------Getter Method
Signature
DirectionTypeReturns: Return type: NXOpen.Drawings.BrokenViewBuilderTypeDirectionNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DirectionTypeParameters: directionType ( NXOpen.Drawings.BrokenViewBuilderTypeDirection) –New in version NX7.5.0.
License requirements: None.
DirectionVector¶
-
BrokenViewBuilder.DirectionVector¶ Returns or sets the direction vector.
For
Drawings.BrokenViewBuilderTypeDirection.Vector.-------------------------------------Getter Method
Signature
DirectionVectorReturns: Return type: NXOpen.DirectionNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DirectionVectorParameters: directionVector ( NXOpen.Direction) –New in version NX7.5.0.
License requirements: None.
ExistingCurve¶
-
BrokenViewBuilder.ExistingCurve¶ Returns the curve to use as existing curve
-------------------------------------Getter Method
Signature
ExistingCurveReturns: Return type: NXOpen.ScCollectorNew in version NX7.5.0.
License requirements: None.
Extension1¶
-
BrokenViewBuilder.Extension1¶ Returns the break line extension (top/right) beyond geometry
-------------------------------------Getter Method
Signature
Extension1Returns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
Extension2¶
-
BrokenViewBuilder.Extension2¶ Returns the break line extension (bottom/left) beyond geometry
-------------------------------------Getter Method
Signature
Extension2Returns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
Gap¶
-
BrokenViewBuilder.Gap¶ Returns the gap on the sheet between the two break lines
-------------------------------------Getter Method
Signature
GapReturns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
IsBreakLine1Associative¶
-
BrokenViewBuilder.IsBreakLine1Associative¶ Returns or sets the associative positionning of the first break line
-------------------------------------Getter Method
Signature
IsBreakLine1AssociativeReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsBreakLine1AssociativeParameters: isBreakLine1Associative (bool) – New in version NX7.5.0.
License requirements: None.
IsBreakLine2Associative¶
-
BrokenViewBuilder.IsBreakLine2Associative¶ Returns or sets the associative positionning of the second break line.
For
Drawings.BrokenViewBuilderTypeBreak.Regularonly-------------------------------------Getter Method
Signature
IsBreakLine2AssociativeReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsBreakLine2AssociativeParameters: isBreakLine2Associative (bool) – New in version NX7.5.0.
License requirements: None.
MasterView¶
-
BrokenViewBuilder.MasterView¶ Returns the master view
-------------------------------------Getter Method
Signature
MasterViewReturns: Return type: NXOpen.Drawings.SelectDraftingViewNew in version NX7.5.0.
License requirements: None.
Repetition¶
-
BrokenViewBuilder.Repetition¶ Returns or sets the repetition of the break line pattern
-------------------------------------Getter Method
Signature
RepetitionReturns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RepetitionParameters: repetition (int) – New in version NX7.5.0.
License requirements: None.
Suppress¶
-
BrokenViewBuilder.Suppress¶ Returns or sets the view break suppress status
-------------------------------------Getter Method
Signature
SuppressReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SuppressParameters: suppress (bool) – New in version NX7.5.0.
License requirements: None.
Width¶
-
BrokenViewBuilder.Width¶ Returns or sets the curve width of the break line
-------------------------------------Getter Method
Signature
WidthReturns: Return type: NXOpen.Drawings.BrokenViewBuilderLineWidthNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
WidthParameters: width ( NXOpen.Drawings.BrokenViewBuilderLineWidth) –New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
BrokenViewBuilder.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.