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

Represents set of General View Preferencess applicable to drafting views. More...

Inheritance diagram for NXOpen::Preferences::GeneralViewPreferences:
NXOpen::Preferences::IGeneralViewPreferences

Public Member Functions

NXOpen::Preferences::DecimalPointCharacter AngleDecimalPointFormat ()
 Returns the decimal point character to use for view angle display. More...
 
NXOpen::Preferences::AngleFormat AngleFormat ()
 Returns the format to use for view angle display. More...
 
int AnglePrecision ()
 Returns the precision to use for view angle display. More...
 
bool AutomaticAnchorPoint ()
 Returns the status of Automatic anchor point
Created in NX5.0.0. More...
 
bool AutomaticUpdate ()
 Returns the status of Automatic Update. More...
 
bool BoundaryStatus ()
 Returns the boundary status. More...
 
bool Centerlines ()
 Returns the status of center line. More...
 
NXOpen::Preferences::GeneralDisplayIdOption DisplayId ()
 Returns the display identifier option for a member view. More...
 
NXOpen::Preferences::GeneralExtractedEdgesOption ExtractedEdges ()
 Returns the extracted edge that provides an alternative way to display model geometry in a drawing view. More...
 
bool FramebarHorizontal ()
 Returns the status of horizontal framebar. More...
 
bool FramebarVertical ()
 Returns the status of vertical framebar. More...
 
bool LegacyView ()
 Returns the leagcy view toggle on the GENERAL tab of the View Style Dialog
Created in NX8.0.0. More...
 
bool LightweightView ()
 Returns the view representation enum on the GENERAL tab of the View Style Dialog
Created in NX8.0.0. More...
 
NXOpen::Preferences::GeneralViewLockmethodOption LockmethodView ()
 Returns the lock method setting on the Configuration tab of the View Style Dialog
Created in NX11.0.1. More...
 
bool Reference ()
 Returns the status of reference.A view can have a status of either Active or Reference. More...
 
void SetAngleDecimalPointFormat (NXOpen::Preferences::DecimalPointCharacter format)
 Sets the decimal point character to use for view angle display. More...
 
void SetAngleFormat (NXOpen::Preferences::AngleFormat format)
 Sets the format to use for view angle display. More...
 
void SetAnglePrecision (int precision)
 Sets the precision to use for view angle display. More...
 
void SetAutomaticAnchorPoint (bool automaticAnchorPoint)
 Sets the status of Automatic anchor point
Created in NX5.0.0. More...
 
void SetAutomaticUpdate (bool automaticUpdate)
 Sets the status of Automatic Update. More...
 
void SetBoundaryStatus (bool boundaryStatus)
 Sets the boundary status. More...
 
void SetCenterlines (bool centerlines)
 Sets the status of center line. More...
 
void SetDisplayId (NXOpen::Preferences::GeneralDisplayIdOption option)
 Sets the display identifier option for a member view. More...
 
void SetExtractedEdges (NXOpen::Preferences::GeneralExtractedEdgesOption edgesOption)
 Sets the extracted edge that provides an alternative way to display model geometry in a drawing view. More...
 
void SetFramebarHorizontal (bool horizontal)
 Sets the status of horizontal framebar. More...
 
void SetFramebarVertical (bool vertical)
 Sets the status of vertical framebar. More...
 
void SetLegacyView (bool legacyView)
 Sets the leagcy view toggle on the GENERAL tab of the View Style Dialog
Created in NX8.0.0. More...
 
void SetLightweightView (bool lightweightView)
 Sets the view representation enum on the GENERAL tab of the View Style Dialog
Created in NX8.0.0. More...
 
void SetLockmethodView (NXOpen::Preferences::GeneralViewLockmethodOption lockmethodView)
 Sets the lock method setting on the Configuration tab of the View Style Dialog
Created in NX11.0.1. More...
 
void SetReference (bool reference)
 Sets the status of reference.A view can have a status of either Active or Reference. More...
 
void SetShowAngleLeadingZeros (bool show)
 Sets the status of leading zeros display in view angle. More...
 
void SetShowAngleTrailingZeros (bool show)
 Sets the status of trailing zeros display in view angle. More...
 
void SetSilhouettes (bool silhouettes)
 Sets the status of silhouettes curves, if true silhouettes for selected drawing member views are added else silhouettes are removed from the selected member views. More...
 
void SetSnapshotView (bool snapshotView)
 Sets the snapshot toggle on the GENERAL tab of the View Style Dialog
More...
 
void SetTolerance (double tolerance)
 Sets the value of tolerance that specifies a chord height tolerance value for silhouette and hidden line generation in a given drawing view. More...
 
void SetUvGrid (bool uvGrid)
 Sets the status of UV grid. More...
 
void SetViewQuality (NXOpen::Preferences::GeneralViewQualityOption viewQualityOption)
 Sets the view quality that provides alternative ways to display geometry in a drawing member view. More...
 
void SetViewRepresentation (NXOpen::Preferences::GeneralViewRepresentationOption viewRepresentation)
 Sets the view representation enum on the GENERAL tab of the View Style Dialog
Created in NX8.5.0. More...
 
void SetWireframeColorSource (NXOpen::Preferences::GeneralWireframeColorSourceOption edgesOption)
 Sets the source of the wireframe color for a member view. More...
 
bool ShowAngleLeadingZeros ()
 Returns the status of leading zeros display in view angle. More...
 
bool ShowAngleTrailingZeros ()
 Returns the status of trailing zeros display in view angle. More...
 
bool Silhouettes ()
 Returns the status of silhouettes curves, if true silhouettes for selected drawing member views are added else silhouettes are removed from the selected member views. More...
 
bool SnapshotView ()
 Returns the snapshot toggle on the GENERAL tab of the View Style Dialog
More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
double Tolerance ()
 Returns the value of tolerance that specifies a chord height tolerance value for silhouette and hidden line generation in a given drawing view. More...
 
bool UvGrid ()
 Returns the status of UV grid. More...
 
NXOpen::Preferences::GeneralViewQualityOption ViewQuality ()
 Returns the view quality that provides alternative ways to display geometry in a drawing member view. More...
 
NXOpen::Preferences::GeneralViewRepresentationOption ViewRepresentation ()
 Returns the view representation enum on the GENERAL tab of the View Style Dialog
Created in NX8.5.0. More...
 
NXOpen::Preferences::GeneralWireframeColorSourceOption WireframeColorSource ()
 Returns the source of the wireframe color for a member view. More...
 

Detailed Description

Represents set of General View Preferencess applicable to drafting views.

These settings apply to any newly created base view.
To obtain an instance of this class use Preferences::ViewPreferences::General

Created in NX5.0.0.

Member Function Documentation

NXOpen::Preferences::DecimalPointCharacter NXOpen::Preferences::GeneralViewPreferences::AngleDecimalPointFormat ( )

Returns the decimal point character to use for view angle display.


Created in NX8.5.0.

License requirements : None

NXOpen::Preferences::AngleFormat NXOpen::Preferences::GeneralViewPreferences::AngleFormat ( )

Returns the format to use for view angle display.


Created in NX8.5.0.

License requirements : None

int NXOpen::Preferences::GeneralViewPreferences::AnglePrecision ( )

Returns the precision to use for view angle display.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::AutomaticAnchorPoint ( )

Returns the status of Automatic anchor point
Created in NX5.0.0.



License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::AutomaticUpdate ( )

Returns the status of Automatic Update.

if true, then position, hidden lines, silhouettes, view bounds, section views and section view details are updated after a model change else above items are not updated after a model change.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::BoundaryStatus ( )

Returns the boundary status.

This option determines whether or not a view's out-of-date status includes its boundary. If True, the system checks the view boundary and marks it out of date if changes to non-solid geometry would cause the view's boundary to change when updated, else the system does not perform view boundary checks.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::Centerlines ( )

Returns the status of center line.

If true it automatically creates linear, cylindrical, and bolt circle centerlines (with a circular instance set) for views where the hole or pin axis is perpendicular or parallel to the plane of the drawing view.


Created in NX5.0.0.

License requirements : None

NXOpen::Preferences::GeneralDisplayIdOption NXOpen::Preferences::GeneralViewPreferences::DisplayId ( )

Returns the display identifier option for a member view.


Created in NX7.5.0.

License requirements : None

NXOpen::Preferences::GeneralExtractedEdgesOption NXOpen::Preferences::GeneralViewPreferences::ExtractedEdges ( )

Returns the extracted edge that provides an alternative way to display model geometry in a drawing view.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::FramebarHorizontal ( )

Returns the status of horizontal framebar.

If true it automatically creates horizontal framebar for views when ship axis matches with view axis for horizontal framebar.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::FramebarVertical ( )

Returns the status of vertical framebar.

If true it automatically creates vertical framebar for views when ship axis matches with view axis for vertical framebar.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::LegacyView ( )

Returns the leagcy view toggle on the GENERAL tab of the View Style Dialog
Created in NX8.0.0.



License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::LightweightView ( )

Returns the view representation enum on the GENERAL tab of the View Style Dialog
Created in NX8.0.0.



License requirements : None

NXOpen::Preferences::GeneralViewLockmethodOption NXOpen::Preferences::GeneralViewPreferences::LockmethodView ( )

Returns the lock method setting on the Configuration tab of the View Style Dialog
Created in NX11.0.1.



License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::Reference ( )

Returns the status of reference.A view can have a status of either Active or Reference.

So if the status is True the view is considered a reference view else considered as an Active view.


Created in NX5.0.0.

License requirements : None

void NXOpen::Preferences::GeneralViewPreferences::SetAngleDecimalPointFormat ( NXOpen::Preferences::DecimalPointCharacter  format)

Sets the decimal point character to use for view angle display.


Created in NX8.5.0.

License requirements : drafting ("DRAFTING")

Parameters
formatformat
void NXOpen::Preferences::GeneralViewPreferences::SetAngleFormat ( NXOpen::Preferences::AngleFormat  format)

Sets the format to use for view angle display.


Created in NX8.5.0.

License requirements : drafting ("DRAFTING")

Parameters
formatformat
void NXOpen::Preferences::GeneralViewPreferences::SetAnglePrecision ( int  precision)

Sets the precision to use for view angle display.


Created in NX8.5.0.

License requirements : drafting ("DRAFTING")

Parameters
precisionprecision
void NXOpen::Preferences::GeneralViewPreferences::SetAutomaticAnchorPoint ( bool  automaticAnchorPoint)

Sets the status of Automatic anchor point
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
automaticAnchorPointautomatic anchor point
void NXOpen::Preferences::GeneralViewPreferences::SetAutomaticUpdate ( bool  automaticUpdate)

Sets the status of Automatic Update.

if true, then position, hidden lines, silhouettes, view bounds, section views and section view details are updated after a model change else above items are not updated after a model change.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
automaticUpdateautomatic update
void NXOpen::Preferences::GeneralViewPreferences::SetBoundaryStatus ( bool  boundaryStatus)

Sets the boundary status.

This option determines whether or not a view's out-of-date status includes its boundary. If True, the system checks the view boundary and marks it out of date if changes to non-solid geometry would cause the view's boundary to change when updated, else the system does not perform view boundary checks.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
boundaryStatusboundary status
void NXOpen::Preferences::GeneralViewPreferences::SetCenterlines ( bool  centerlines)

Sets the status of center line.

If true it automatically creates linear, cylindrical, and bolt circle centerlines (with a circular instance set) for views where the hole or pin axis is perpendicular or parallel to the plane of the drawing view.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
centerlinescenterlines
void NXOpen::Preferences::GeneralViewPreferences::SetDisplayId ( NXOpen::Preferences::GeneralDisplayIdOption  option)

Sets the display identifier option for a member view.


Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters
optionoption
void NXOpen::Preferences::GeneralViewPreferences::SetExtractedEdges ( NXOpen::Preferences::GeneralExtractedEdgesOption  edgesOption)

Sets the extracted edge that provides an alternative way to display model geometry in a drawing view.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
edgesOptionedges option
void NXOpen::Preferences::GeneralViewPreferences::SetFramebarHorizontal ( bool  horizontal)

Sets the status of horizontal framebar.

If true it automatically creates horizontal framebar for views when ship axis matches with view axis for horizontal framebar.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters
horizontalhorizontal
void NXOpen::Preferences::GeneralViewPreferences::SetFramebarVertical ( bool  vertical)

Sets the status of vertical framebar.

If true it automatically creates vertical framebar for views when ship axis matches with view axis for vertical framebar.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters
verticalvertical
void NXOpen::Preferences::GeneralViewPreferences::SetLegacyView ( bool  legacyView)

Sets the leagcy view toggle on the GENERAL tab of the View Style Dialog
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
legacyViewSets a legacy view toggle value on the general sub-builder
void NXOpen::Preferences::GeneralViewPreferences::SetLightweightView ( bool  lightweightView)

Sets the view representation enum on the GENERAL tab of the View Style Dialog
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
lightweightViewSets a view representation option on the general sub-builder
void NXOpen::Preferences::GeneralViewPreferences::SetLockmethodView ( NXOpen::Preferences::GeneralViewLockmethodOption  lockmethodView)

Sets the lock method setting on the Configuration tab of the View Style Dialog
Created in NX11.0.1.



License requirements : drafting ("DRAFTING")

Parameters
lockmethodViewSets a lockmethod option on the general sub-builder
void NXOpen::Preferences::GeneralViewPreferences::SetReference ( bool  reference)

Sets the status of reference.A view can have a status of either Active or Reference.

So if the status is True the view is considered a reference view else considered as an Active view.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
referencereference
void NXOpen::Preferences::GeneralViewPreferences::SetShowAngleLeadingZeros ( bool  show)

Sets the status of leading zeros display in view angle.


Created in NX8.5.0.

License requirements : drafting ("DRAFTING")

Parameters
showshow
void NXOpen::Preferences::GeneralViewPreferences::SetShowAngleTrailingZeros ( bool  show)

Sets the status of trailing zeros display in view angle.


Created in NX8.5.0.

License requirements : drafting ("DRAFTING")

Parameters
showshow
void NXOpen::Preferences::GeneralViewPreferences::SetSilhouettes ( bool  silhouettes)

Sets the status of silhouettes curves, if true silhouettes for selected drawing member views are added else silhouettes are removed from the selected member views.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
silhouettessilhouettes
void NXOpen::Preferences::GeneralViewPreferences::SetSnapshotView ( bool  snapshotView)

Sets the snapshot toggle on the GENERAL tab of the View Style Dialog

Deprecated:
Deprecated in NX11.0.1.

Use NXOpen::Preferences::GeneralViewPreferences::SetLockmethodView instead(the value is NXOpen.Preferences.GeneralViewPreferences.GeneralViewLockmethodOptionSnapshot).


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters
snapshotViewSets a snapshot view toggle value on the general sub-builder
void NXOpen::Preferences::GeneralViewPreferences::SetTolerance ( double  tolerance)

Sets the value of tolerance that specifies a chord height tolerance value for silhouette and hidden line generation in a given drawing view.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
tolerancetolerance
void NXOpen::Preferences::GeneralViewPreferences::SetUvGrid ( bool  uvGrid)

Sets the status of UV grid.

If true, grid curves for selected drawing member views are added else the grid curves are removed from the selected member views.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
uvGriduv grid
void NXOpen::Preferences::GeneralViewPreferences::SetViewQuality ( NXOpen::Preferences::GeneralViewQualityOption  viewQualityOption)

Sets the view quality that provides alternative ways to display geometry in a drawing member view.


Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters
viewQualityOptionview quality option
void NXOpen::Preferences::GeneralViewPreferences::SetViewRepresentation ( NXOpen::Preferences::GeneralViewRepresentationOption  viewRepresentation)

Sets the view representation enum on the GENERAL tab of the View Style Dialog
Created in NX8.5.0.



License requirements : drafting ("DRAFTING")

Parameters
viewRepresentationSets a view representation option on the general sub-builder
void NXOpen::Preferences::GeneralViewPreferences::SetWireframeColorSource ( NXOpen::Preferences::GeneralWireframeColorSourceOption  edgesOption)

Sets the source of the wireframe color for a member view.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
edgesOptionedges option
bool NXOpen::Preferences::GeneralViewPreferences::ShowAngleLeadingZeros ( )

Returns the status of leading zeros display in view angle.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::ShowAngleTrailingZeros ( )

Returns the status of trailing zeros display in view angle.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::Silhouettes ( )

Returns the status of silhouettes curves, if true silhouettes for selected drawing member views are added else silhouettes are removed from the selected member views.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::SnapshotView ( )

Returns the snapshot toggle on the GENERAL tab of the View Style Dialog

Deprecated:
Deprecated in NX11.0.1.

Use NXOpen::Preferences::GeneralViewPreferences::LockmethodView instead(the value is NXOpen.Preferences.GeneralViewPreferences.GeneralViewLockmethodOptionSnapshot).


Created in NX8.0.0.

License requirements : None

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

Returns the tag of this object.

double NXOpen::Preferences::GeneralViewPreferences::Tolerance ( )

Returns the value of tolerance that specifies a chord height tolerance value for silhouette and hidden line generation in a given drawing view.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Preferences::GeneralViewPreferences::UvGrid ( )

Returns the status of UV grid.

If true, grid curves for selected drawing member views are added else the grid curves are removed from the selected member views.


Created in NX5.0.0.

License requirements : None

NXOpen::Preferences::GeneralViewQualityOption NXOpen::Preferences::GeneralViewPreferences::ViewQuality ( )

Returns the view quality that provides alternative ways to display geometry in a drawing member view.


Created in NX7.5.0.

License requirements : None

NXOpen::Preferences::GeneralViewRepresentationOption NXOpen::Preferences::GeneralViewPreferences::ViewRepresentation ( )

Returns the view representation enum on the GENERAL tab of the View Style Dialog
Created in NX8.5.0.



License requirements : None

NXOpen::Preferences::GeneralWireframeColorSourceOption NXOpen::Preferences::GeneralViewPreferences::WireframeColorSource ( )

Returns the source of the wireframe color for a member view.


Created in NX6.0.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.