NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Preferences::PartVisualizationLine Class Reference

Represents the set of visualization preferences under Line tab applicable to part
To obtain an instance of this class, refer to NXOpen::Preferences::PartPreferences

Created in NX3.0.0. More...

Public Types

enum  LineFontDisplayType { LineFontDisplayTypeSoftware, LineFontDisplayTypeHardware }
 Describes whether Line Font Display type is hardware or software. More...
 

Public Member Functions

double CurveTolerance ()
 Returns the curve tolerance. More...
 
double DashSize ()
 Returns the dash size. More...
 
void GetPixelWidthOptions (bool *useWidthScale, double *widthScale, std::vector< int > &pixelWidths)
 Returns pixel widths used in the graphics window. More...
 
void GetPixelWidths (std::vector< int > &pixelWidths)
 Returns options that control width appearance in the graphics window. More...
 
void GetWidthOptions (bool *showWidths, double *widthScale)
 Returns the show widths and width scale options. More...
 
NXOpen::Preferences::PartVisualizationLine::LineFontDisplayType LineFontDisplay ()
 Returns the line font display. More...
 
void RegenerateFromToleranceChange (bool updateModeChanged, bool studio)
 Regenerates after changing tolerance. More...
 
void ResetPixelWidthOptions ()
 Resets all pixel width options to settings specified by customer defaults. More...
 
void SetCurveTolerance (double lineCurveTolerance)
 Sets the curve tolerance. More...
 
void SetDashSize (double lineDashSize)
 Sets the dash size. More...
 
void SetLineFontDisplay (NXOpen::Preferences::PartVisualizationLine::LineFontDisplayType lineFontDisplay)
 Sets the line font display. More...
 
void SetPixelWidthOptions (bool useWidthScale, double widthScale, const std::vector< int > &pixelWidths)
 Modifies options that control width appearance in the graphics window. More...
 
void SetPixelWidths (const std::vector< int > &pixelWidths)
 Modifies pixel widths used in the graphics window. More...
 
void SetShowWidths (bool isShowWidthOn)
 Sets the show widths option. More...
 
void SetSpaceSize (double lineSpaceSize)
 Sets the space size. More...
 
void SetSymbolSize (double lineSymbolSize)
 Sets the symbol size. More...
 
void SetWidthOptions (bool showWidths, double widthScale)
 Modifies the show widths and width scale options. More...
 
void SetWidthScale (double widthScale)
 Sets the width scale option. More...
 
bool ShowWidths ()
 Returns the show widths option. More...
 
double SpaceSize ()
 Returns the space size. More...
 
double SymbolSize ()
 Returns the symbol size. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void UpdateLineFontObjects (bool softwareUpdate)
 Regenerates after changing line-font settings. More...
 
double WidthScale ()
 Returns the width scale option. More...
 

Detailed Description

Represents the set of visualization preferences under Line tab applicable to part
To obtain an instance of this class, refer to NXOpen::Preferences::PartPreferences

Created in NX3.0.0.


Member Enumeration Documentation

Describes whether Line Font Display type is hardware or software.

Enumerator
LineFontDisplayTypeSoftware 

software

LineFontDisplayTypeHardware 

hardware

Member Function Documentation

double NXOpen::Preferences::PartVisualizationLine::CurveTolerance ( )

Returns the curve tolerance.

Specifies the level of detail for the current Display Mode.
Created in NX3.0.0.

License requirements : None

double NXOpen::Preferences::PartVisualizationLine::DashSize ( )

Returns the dash size.

Sets the length of a segment of a dashed curve.
Created in NX3.0.0.

License requirements : None

void NXOpen::Preferences::PartVisualizationLine::GetPixelWidthOptions ( bool *  useWidthScale,
double *  widthScale,
std::vector< int > &  pixelWidths 
)

Returns pixel widths used in the graphics window.


Created in NX10.0.0.

License requirements : None

Parameters
useWidthScaleIf true, width appearance in the graphics window is controlled by width scale. If false, width appearance is controlled by pixel widths.
widthScalethe 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.
pixelWidthsArray 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.
void NXOpen::Preferences::PartVisualizationLine::GetPixelWidths ( std::vector< int > &  pixelWidths)

Returns options that control width appearance in the graphics window.


Created in NX10.0.0.

License requirements : None

Parameters
pixelWidthsArray 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.
void NXOpen::Preferences::PartVisualizationLine::GetWidthOptions ( bool *  showWidths,
double *  widthScale 
)

Returns the show widths and width scale options.


Created in NX8.5.0.

License requirements : None

Parameters
showWidthsthe show widths option, which controls whether or not the object width attribute determines the displayed width of lines and curves.
widthScalethe width scale option, which controls scaling of the width of lines and curves displayed in the graphics window.
NXOpen::Preferences::PartVisualizationLine::LineFontDisplayType NXOpen::Preferences::PartVisualizationLine::LineFontDisplay ( )

Returns 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.
Created in NX3.0.0.

License requirements : None

void NXOpen::Preferences::PartVisualizationLine::RegenerateFromToleranceChange ( bool  updateModeChanged,
bool  studio 
)

Regenerates after changing tolerance.


Created in NX12.0.0.

License requirements : None

Parameters
updateModeChangedTrue if update mode changed
studiostudio or non-studio
void NXOpen::Preferences::PartVisualizationLine::ResetPixelWidthOptions ( )

Resets all pixel width options to settings specified by customer defaults.


Created in NX10.0.0.

License requirements : None

void NXOpen::Preferences::PartVisualizationLine::SetCurveTolerance ( double  lineCurveTolerance)

Sets the curve tolerance.

Specifies the level of detail for the current Display Mode.
Created in NX3.0.0.

License requirements : None

Parameters
lineCurveToleranceline curve tolerance
void NXOpen::Preferences::PartVisualizationLine::SetDashSize ( double  lineDashSize)

Sets the dash size.

Sets the length of a segment of a dashed curve.
Created in NX3.0.0.

License requirements : None

Parameters
lineDashSizeline dash size
void NXOpen::Preferences::PartVisualizationLine::SetLineFontDisplay ( NXOpen::Preferences::PartVisualizationLine::LineFontDisplayType  lineFontDisplay)

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.
Created in NX3.0.0.

License requirements : None

Parameters
lineFontDisplayline font display
void NXOpen::Preferences::PartVisualizationLine::SetPixelWidthOptions ( bool  useWidthScale,
double  widthScale,
const std::vector< int > &  pixelWidths 
)

Modifies options that control width appearance in the graphics window.


Created in NX10.0.0.

License requirements : None

Parameters
useWidthScaleIf true, width appearance in the graphics window is controlled by width scale. If false, width appearance is controlled by pixel widths.
widthScalethe 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.
pixelWidthsArray 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.
void NXOpen::Preferences::PartVisualizationLine::SetPixelWidths ( const std::vector< int > &  pixelWidths)

Modifies pixel widths used in the graphics window.


Created in NX10.0.0.

License requirements : None

Parameters
pixelWidthsArray 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.
void NXOpen::Preferences::PartVisualizationLine::SetShowWidths ( bool  isShowWidthOn)

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.
Created in NX3.0.0.

License requirements : None

Parameters
isShowWidthOnisshowwidthon
void NXOpen::Preferences::PartVisualizationLine::SetSpaceSize ( double  lineSpaceSize)

Sets the space size.

Sets the distance between two segments of a dashed curve.
Created in NX3.0.0.

License requirements : None

Parameters
lineSpaceSizeline space size
void NXOpen::Preferences::PartVisualizationLine::SetSymbolSize ( double  lineSymbolSize)

Sets the symbol size.

Controls the displayed size of symbols used in software line fonts.
Created in NX3.0.0.

License requirements : None

Parameters
lineSymbolSizeline symbol size
void NXOpen::Preferences::PartVisualizationLine::SetWidthOptions ( bool  showWidths,
double  widthScale 
)

Modifies the show widths and width scale options.


Created in NX8.5.0.

License requirements : None

Parameters
showWidthsthe show widths option, which controls whether or not the object width attribute determines the displayed width of lines and curves.
widthScalethe width scale option, which controls scaling of the width of lines and curves displayed in the graphics window.
void NXOpen::Preferences::PartVisualizationLine::SetWidthScale ( double  widthScale)

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.
Created in NX8.5.0.

License requirements : None

Parameters
widthScalewidth scale
bool NXOpen::Preferences::PartVisualizationLine::ShowWidths ( )

Returns 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.
Created in NX3.0.0.

License requirements : None

double NXOpen::Preferences::PartVisualizationLine::SpaceSize ( )

Returns the space size.

Sets the distance between two segments of a dashed curve.
Created in NX3.0.0.

License requirements : None

double NXOpen::Preferences::PartVisualizationLine::SymbolSize ( )

Returns the symbol size.

Controls the displayed size of symbols used in software line fonts.
Created in NX3.0.0.

License requirements : None

tag_t NXOpen::Preferences::PartVisualizationLine::Tag ( ) const

Returns the tag of this object.

void NXOpen::Preferences::PartVisualizationLine::UpdateLineFontObjects ( bool  softwareUpdate)

Regenerates after changing line-font settings.


Created in NX12.0.0.

License requirements : None

Parameters
softwareUpdateTrue when changing from software fonts to hardware fonts, or when changing dash patterns
double NXOpen::Preferences::PartVisualizationLine::WidthScale ( )

Returns 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.
Created in NX8.5.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.