PartVisualizationLine Class¶
-
class
NXOpen.Preferences.PartVisualizationLine¶ Bases:
objectRepresents the set of visualization preferences under Line tab applicable to part
To obtain an instance of this class, refer to
NXOpen.Preferences.PartPreferencesNew in version NX3.0.0.
Properties¶
| Property | Description |
|---|---|
| CurveTolerance | Returns or sets the curve tolerance. |
| DashSize | Returns or sets the dash size. |
| LineFontDisplay | Returns or sets the line font display. |
| ShowWidths | Returns or sets the show widths option. |
| SpaceSize | Returns or sets the space size. |
| SymbolSize | Returns or sets the symbol size. |
| WidthScale | Returns or sets the width scale option. |
Methods¶
| Method | Description |
|---|---|
| GetPixelWidthOptions | Returns pixel widths used in the graphics window. |
| GetPixelWidths | Returns options that control width appearance in the graphics window. |
| GetWidthOptions | Returns the show widths and width scale options. |
| RegenerateFromToleranceChange | Regenerates after changing tolerance. |
| ResetPixelWidthOptions | Resets all pixel width options to settings specified by customer defaults. |
| SetPixelWidthOptions | Modifies options that control width appearance in the graphics window. |
| SetPixelWidths | Modifies pixel widths used in the graphics window. |
| SetWidthOptions | Modifies the show widths and width scale options. |
| UpdateLineFontObjects | Regenerates after changing line-font settings. |
Enumerations¶
| PartVisualizationLineLineFontDisplayType Enumeration | Describes whether Line Font Display type is hardware or software. |
Property Detail¶
CurveTolerance¶
-
PartVisualizationLine.CurveTolerance¶ Returns or sets the curve tolerance.
Specifies the level of detail for the current Display Mode.
-------------------------------------Getter Method
Signature
CurveToleranceReturns: Return type: float New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CurveToleranceParameters: lineCurveTolerance (float) – New in version NX3.0.0.
License requirements: None.
DashSize¶
-
PartVisualizationLine.DashSize¶ Returns or sets the dash size.
Sets the length of a segment of a dashed curve.
-------------------------------------Getter Method
Signature
DashSizeReturns: Return type: float New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DashSizeParameters: lineDashSize (float) – New in version NX3.0.0.
License requirements: None.
LineFontDisplay¶
-
PartVisualizationLine.LineFontDisplay¶ Returns or sets the line font display.
Controls the line font. The Hardware option uses the system graphics library to generate the seven standard line fonts. Selecting hardware line fonts can improve drawing performance and reduce memory consumption. The Software option generates non-solid curves with the values entered for the Dash, Space, and Symbol size.
-------------------------------------Getter Method
Signature
LineFontDisplayReturns: Return type: NXOpen.Preferences.PartVisualizationLineLineFontDisplayTypeNew in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LineFontDisplayParameters: lineFontDisplay ( NXOpen.Preferences.PartVisualizationLineLineFontDisplayType) –New in version NX3.0.0.
License requirements: None.
ShowWidths¶
-
PartVisualizationLine.ShowWidths¶ Returns or sets the show widths option.
If true, the object width attribute determines the displayed width of lines or curves used to represent an object.If false, all curves are drawn thin, regardless of object width settings.
-------------------------------------Getter Method
Signature
ShowWidthsReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShowWidthsParameters: isShowWidthOn (bool) – New in version NX3.0.0.
License requirements: None.
SpaceSize¶
-
PartVisualizationLine.SpaceSize¶ Returns or sets the space size.
Sets the distance between two segments of a dashed curve.
-------------------------------------Getter Method
Signature
SpaceSizeReturns: Return type: float New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SpaceSizeParameters: lineSpaceSize (float) – New in version NX3.0.0.
License requirements: None.
SymbolSize¶
-
PartVisualizationLine.SymbolSize¶ Returns or sets the symbol size.
Controls the displayed size of symbols used in software line fonts.
-------------------------------------Getter Method
Signature
SymbolSizeReturns: Return type: float New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SymbolSizeParameters: lineSymbolSize (float) – New in version NX3.0.0.
License requirements: None.
WidthScale¶
-
PartVisualizationLine.WidthScale¶ Returns or sets the width scale option.
Controls scaling of the width of lines and curves displayed in the graphics window. If set to 0.0 (the minimum value), widths range from 1 to 3 pixels. If set to 1.0 (the maximum value), widths range from 1 to the maximum supported pixel width.
-------------------------------------Getter Method
Signature
WidthScaleReturns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
WidthScaleParameters: widthScale (float) – New in version NX8.5.0.
License requirements: None.
Method Detail¶
GetPixelWidthOptions¶
-
PartVisualizationLine.GetPixelWidthOptions¶ Returns pixel widths used in the graphics window.
Signature
GetPixelWidthOptions()Returns: a tuple Return type: A tuple consisting of (useWidthScale, widthScale, pixelWidths) useWidthScale is a bool. If true, width appearance in the graphics window is controlled by width scale. If false, width appearance is controlled by pixel widths. widthScale is a float. the width scale option, which controls scaling of widths in the graphics window when useWidthScale is true. If set to 0.0 (the minimum value), widths range from 1 to 3 pixels. If set to 1.0 (the maximum value), widths range from 1 to 9 pixels. pixelWidths is a list of int. Array of 9 pixel widths, one for each of the 9 width settings, that defines the appearance of widths in the graphics window when useWidthScale is false. Valid pixel widths range from 1 to 9. New in version NX10.0.0.
License requirements: None.
GetPixelWidths¶
-
PartVisualizationLine.GetPixelWidths¶ Returns options that control width appearance in the graphics window.
Signature
GetPixelWidths()Returns: Array of 9 pixel widths, one for each of the 9 width settings, that defines the appearance of widths in the graphics window. Valid pixel widths range from 1 to 9. :rtype: list of int
New in version NX10.0.0.
License requirements: None.
GetWidthOptions¶
-
PartVisualizationLine.GetWidthOptions¶ Returns the show widths and width scale options.
Signature
GetWidthOptions()Returns: a tuple Return type: A tuple consisting of (showWidths, widthScale) showWidths is a bool. the show widths option, which controls whether or not the object width attribute determines the displayed width of lines and curves. widthScale is a float. the width scale option, which controls scaling of the width of lines and curves displayed in the graphics window. New in version NX8.5.0.
License requirements: None.
RegenerateFromToleranceChange¶
-
PartVisualizationLine.RegenerateFromToleranceChange¶ Regenerates after changing tolerance.
Signature
RegenerateFromToleranceChange(updateModeChanged, studio)Parameters: - updateModeChanged (bool) – True if update mode changed
- studio (bool) – studio or non-studio
New in version NX12.0.0.
License requirements: None.
ResetPixelWidthOptions¶
-
PartVisualizationLine.ResetPixelWidthOptions¶ Resets all pixel width options to settings specified by customer defaults.
Signature
ResetPixelWidthOptions()New in version NX10.0.0.
License requirements: None.
SetPixelWidthOptions¶
-
PartVisualizationLine.SetPixelWidthOptions¶ Modifies options that control width appearance in the graphics window.
Signature
SetPixelWidthOptions(useWidthScale, widthScale, pixelWidths)Parameters: - useWidthScale (bool) – If true, width appearance in the graphics window is controlled by width scale. If false, width appearance is controlled by pixel widths.
- widthScale (float) – the width scale option, which controls scaling of widths in the graphics window when useWidthScale is true. If set to 0.0 (the minimum value), widths range from 1 to 3 pixels. If set to 1.0 (the maximum value), widths range from 1 to 9 pixels.
- pixelWidths (list of int) – Array of 9 pixel widths, one for each of the 9 width settings, that defines the appearance of widths in the graphics window when useWidthScale is false. Valid pixel widths range from 1 to 9.
New in version NX10.0.0.
License requirements: None.
SetPixelWidths¶
-
PartVisualizationLine.SetPixelWidths¶ Modifies pixel widths used in the graphics window.
Signature
SetPixelWidths(pixelWidths)Parameters: pixelWidths (list of int) – Array of 9 pixel widths, one for each of the 9 width settings, that defines the appearance of widths in the graphics window. Valid pixel widths range from 1 to 9. New in version NX10.0.0.
License requirements: None.
SetWidthOptions¶
-
PartVisualizationLine.SetWidthOptions¶ Modifies the show widths and width scale options.
Signature
SetWidthOptions(showWidths, widthScale)Parameters: - showWidths (bool) – the show widths option, which controls whether or not the object width attribute determines the displayed width of lines and curves.
- widthScale (float) – the width scale option, which controls scaling of the width of lines and curves displayed in the graphics window.
New in version NX8.5.0.
License requirements: None.
UpdateLineFontObjects¶
-
PartVisualizationLine.UpdateLineFontObjects¶ Regenerates after changing line-font settings.
Signature
UpdateLineFontObjects(softwareUpdate)Parameters: softwareUpdate (bool) – True when changing from software fonts to hardware fonts, or when changing dash patterns New in version NX12.0.0.
License requirements: None.