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

Represents the set of visualization preferences under screen tab applicable to entire session
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences

Created in NX3.0.0. More...

Public Types

enum  ViewTriadLocation { ViewTriadLocationBottomLeft, ViewTriadLocationBottomRight }
 The view triad location types. More...
 

Public Member Functions

bool CsysFixedSizeOnScreen ()
 Returns whether the CSYS display in fixed size on screen. More...
 
bool CsysShowThrough ()
 Returns whether the CSYS display in show through mode
More...
 
bool DisplayCenterOfRotation ()
 Returns whether a graphic representing the center of rotation is displayed during interactive view rotation. More...
 
bool DoFitOnHideOrShow ()
 Returns the option to specify whether a Fit should be done when a Hide or Show is performed. More...
 
bool ExcludeDatumsFromFit ()
 Returns the option to specify whether datum objects and planar ship grids should not be examined when a Fit is done. More...
 
int FitPercentage ()
 Returns the fit percentage. More...
 
bool FitToSectionClipPlanes ()
 Returns the option to specify whether, when sectioning is enabled for a view, the bounds computed by a Fit operation should be limited by the sectioning clipping planes. More...
 
bool HighPrecisionRotation ()
 Returns whether mouse-driven rotation is to be done using a higher precision than normal, which means that a given mouse motion will result in a smaller rotation. More...
 
bool InferEdgeOutput ()
 Returns whether plotted edges reflect onscreen edge appearance. More...
 
bool PreserveFieldOfViewAngleForFit ()
 Returns whether for a perspective view the Fit operation should not change the field of view angle from the camera position to the view bounds
Created in NX8.0.0. More...
 
int RotationPointDelay ()
 Returns
Created in NX5.0.0. More...
 
void SetCsysFixedSizeOnScreen (bool fixedSizeOnScreen)
 Sets whether the CSYS display in fixed size on screen. More...
 
void SetCsysShowThrough (bool showThrough)
 Sets whether the CSYS display in show through mode
More...
 
void SetDisplayCenterOfRotation (bool displayCenterOfRotation)
 Sets whether a graphic representing the center of rotation is displayed during interactive view rotation. More...
 
void SetDoFitOnHideOrShow (bool doFitOnHideOrShow)
 Sets the option to specify whether a Fit should be done when a Hide or Show is performed. More...
 
void SetExcludeDatumsFromFit (bool excludeDatumsFromFit)
 Sets the option to specify whether datum objects and planar ship grids should not be examined when a Fit is done. More...
 
void SetFitPercentage (int fitPercentage)
 Sets the fit percentage. More...
 
void SetFitToSectionClipPlanes (bool fitToSectionClipPlanes)
 Sets the option to specify whether, when sectioning is enabled for a view, the bounds computed by a Fit operation should be limited by the sectioning clipping planes. More...
 
void SetHighPrecisionRotation (bool highPrecisionRotation)
 Sets whether mouse-driven rotation is to be done using a higher precision than normal, which means that a given mouse motion will result in a smaller rotation. More...
 
void SetInferEdgeOutput (bool inferEdgeOutput)
 Sets whether plotted edges reflect onscreen edge appearance. More...
 
void SetPreserveFieldOfViewAngleForFit (bool preserveFieldOfViewAngleForFit)
 Sets whether for a perspective view the Fit operation should not change the field of view angle from the camera position to the view bounds
Created in NX8.0.0. More...
 
void SetRotationPointDelay (int rotationPointDelay)
 Sets
Created in NX5.0.0. More...
 
void SetTriadLocation (NXOpen::Preferences::SessionVisualizationScreen::ViewTriadLocation triadLocation)
 Sets the view triad location
More...
 
void SetTriadVisibility (int triadVisibility)
 Sets
More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
NXOpen::Preferences::SessionVisualizationScreen::ViewTriadLocation TriadLocation ()
 Returns the view triad location
More...
 
int TriadVisibility ()
 Returns
More...
 

Detailed Description

Represents the set of visualization preferences under screen tab applicable to entire session
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences

Created in NX3.0.0.


Member Enumeration Documentation

The view triad location types.


Deprecated:
Deprecated in NX12.0.0. Use NXOpen::Preferences::PartVisualizationScreen::ViewTriadLocation instead
Enumerator
ViewTriadLocationBottomLeft 

View triad display on the bottom left of the view.

ViewTriadLocationBottomRight 

View triad display on the bottom right of the view.

Member Function Documentation

bool NXOpen::Preferences::SessionVisualizationScreen::CsysFixedSizeOnScreen ( )

Returns whether the CSYS display in fixed size on screen.


Deprecated:
Deprecated in NX12.0.0. Use NXOpen::Preferences::PartVisualizationScreen::CsysFixedSizeOnScreen and NXOpen::Preferences::PartVisualizationScreen::SetCsysFixedSizeOnScreen instead


Created in NX10.0.0.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationScreen::CsysShowThrough ( )

Returns whether the CSYS display in show through mode

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::Preferences::PartVisualizationScreen::CsysShowThrough and NXOpen::Preferences::PartVisualizationScreen::SetCsysShowThrough instead


Created in NX10.0.0.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationScreen::DisplayCenterOfRotation ( )

Returns whether a graphic representing the center of rotation is displayed during interactive view rotation.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationScreen::DoFitOnHideOrShow ( )

Returns the option to specify whether a Fit should be done when a Hide or Show is performed.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationScreen::ExcludeDatumsFromFit ( )

Returns the option to specify whether datum objects and planar ship grids should not be examined when a Fit is done.


Created in NX8.5.0.

License requirements : None

int NXOpen::Preferences::SessionVisualizationScreen::FitPercentage ( )

Returns the fit percentage.

Specifies the area of the graphics display to be occupied by the model after a fit operation is performed. For example, a fit percentage of 100% scales the model so that it occupies 100% of the graphics display. Similarly, a fit percentage of 80% fits the model within 80% of the graphics display area.
Created in NX3.0.0.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationScreen::FitToSectionClipPlanes ( )

Returns the option to specify whether, when sectioning is enabled for a view, the bounds computed by a Fit operation should be limited by the sectioning clipping planes.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationScreen::HighPrecisionRotation ( )

Returns whether mouse-driven rotation is to be done using a higher precision than normal, which means that a given mouse motion will result in a smaller rotation.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationScreen::InferEdgeOutput ( )

Returns whether plotted edges reflect onscreen edge appearance.

This option affects the appearance of edges in output produced by Plot, Print, CGM Export and similar functions. It affects edge appearance for modeling views only, not for views on a drawing sheet. When this option is disabled, the appearance of plotted edges is controlled by edge display options (Hidden Edges, Silhouettes, Smooth Edges) used for Static Wireframe rendering style. When this option is enabled, the appearance of plotted edges is inferred from onscreen edge appearance.
Created in NX4.0.4.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationScreen::PreserveFieldOfViewAngleForFit ( )

Returns whether for a perspective view the Fit operation should not change the field of view angle from the camera position to the view bounds
Created in NX8.0.0.



License requirements : None

int NXOpen::Preferences::SessionVisualizationScreen::RotationPointDelay ( )

Returns
Created in NX5.0.0.



License requirements : None

void NXOpen::Preferences::SessionVisualizationScreen::SetCsysFixedSizeOnScreen ( bool  fixedSizeOnScreen)

Sets whether the CSYS display in fixed size on screen.


Deprecated:
Deprecated in NX12.0.0. Use NXOpen::Preferences::PartVisualizationScreen::CsysFixedSizeOnScreen and NXOpen::Preferences::PartVisualizationScreen::SetCsysFixedSizeOnScreen instead


Created in NX10.0.0.

License requirements : None

Parameters
fixedSizeOnScreenfixed size on screen
void NXOpen::Preferences::SessionVisualizationScreen::SetCsysShowThrough ( bool  showThrough)

Sets whether the CSYS display in show through mode

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::Preferences::PartVisualizationScreen::CsysShowThrough and NXOpen::Preferences::PartVisualizationScreen::SetCsysShowThrough instead


Created in NX10.0.0.

License requirements : None

Parameters
showThroughshow through
void NXOpen::Preferences::SessionVisualizationScreen::SetDisplayCenterOfRotation ( bool  displayCenterOfRotation)

Sets whether a graphic representing the center of rotation is displayed during interactive view rotation.


Created in NX8.5.0.

License requirements : None

Parameters
displayCenterOfRotationdisplay center of rotation
void NXOpen::Preferences::SessionVisualizationScreen::SetDoFitOnHideOrShow ( bool  doFitOnHideOrShow)

Sets the option to specify whether a Fit should be done when a Hide or Show is performed.


Created in NX8.5.0.

License requirements : None

Parameters
doFitOnHideOrShowdo fit on hide or show
void NXOpen::Preferences::SessionVisualizationScreen::SetExcludeDatumsFromFit ( bool  excludeDatumsFromFit)

Sets the option to specify whether datum objects and planar ship grids should not be examined when a Fit is done.


Created in NX8.5.0.

License requirements : None

Parameters
excludeDatumsFromFitexclude datums from fit
void NXOpen::Preferences::SessionVisualizationScreen::SetFitPercentage ( int  fitPercentage)

Sets the fit percentage.

Specifies the area of the graphics display to be occupied by the model after a fit operation is performed. For example, a fit percentage of 100% scales the model so that it occupies 100% of the graphics display. Similarly, a fit percentage of 80% fits the model within 80% of the graphics display area.
Created in NX3.0.0.

License requirements : None

Parameters
fitPercentagefit percentage
void NXOpen::Preferences::SessionVisualizationScreen::SetFitToSectionClipPlanes ( bool  fitToSectionClipPlanes)

Sets the option to specify whether, when sectioning is enabled for a view, the bounds computed by a Fit operation should be limited by the sectioning clipping planes.


Created in NX8.5.0.

License requirements : None

Parameters
fitToSectionClipPlanesfit to section clip planes
void NXOpen::Preferences::SessionVisualizationScreen::SetHighPrecisionRotation ( bool  highPrecisionRotation)

Sets whether mouse-driven rotation is to be done using a higher precision than normal, which means that a given mouse motion will result in a smaller rotation.


Created in NX8.0.0.

License requirements : None

Parameters
highPrecisionRotationhigh precision rotation
void NXOpen::Preferences::SessionVisualizationScreen::SetInferEdgeOutput ( bool  inferEdgeOutput)

Sets whether plotted edges reflect onscreen edge appearance.

This option affects the appearance of edges in output produced by Plot, Print, CGM Export and similar functions. It affects edge appearance for modeling views only, not for views on a drawing sheet. When this option is disabled, the appearance of plotted edges is controlled by edge display options (Hidden Edges, Silhouettes, Smooth Edges) used for Static Wireframe rendering style. When this option is enabled, the appearance of plotted edges is inferred from onscreen edge appearance.
Created in NX4.0.4.

License requirements : None

Parameters
inferEdgeOutputinfer edge output
void NXOpen::Preferences::SessionVisualizationScreen::SetPreserveFieldOfViewAngleForFit ( bool  preserveFieldOfViewAngleForFit)

Sets whether for a perspective view the Fit operation should not change the field of view angle from the camera position to the view bounds
Created in NX8.0.0.



License requirements : None

Parameters
preserveFieldOfViewAngleForFitpreserve field of view angle for fit
void NXOpen::Preferences::SessionVisualizationScreen::SetRotationPointDelay ( int  rotationPointDelay)

Sets
Created in NX5.0.0.



License requirements : None

Parameters
rotationPointDelayrotation point delay
void NXOpen::Preferences::SessionVisualizationScreen::SetTriadLocation ( NXOpen::Preferences::SessionVisualizationScreen::ViewTriadLocation  triadLocation)

Sets the view triad location

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::Preferences::PartVisualizationScreen::TriadLocation and NXOpen::Preferences::PartVisualizationScreen::SetTriadLocation instead


Created in NX10.0.0.

License requirements : None

Parameters
triadLocationtriad location
void NXOpen::Preferences::SessionVisualizationScreen::SetTriadVisibility ( int  triadVisibility)

Sets

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::Preferences::PartVisualizationScreen::TriadVisibility and NXOpen::Preferences::PartVisualizationScreen::SetTriadVisibility instead


Created in NX5.0.0.

License requirements : None

Parameters
triadVisibilitytriad visibility
tag_t NXOpen::Preferences::SessionVisualizationScreen::Tag ( ) const

Returns the tag of this object.

NXOpen::Preferences::SessionVisualizationScreen::ViewTriadLocation NXOpen::Preferences::SessionVisualizationScreen::TriadLocation ( )

Returns the view triad location

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::Preferences::PartVisualizationScreen::TriadLocation and NXOpen::Preferences::PartVisualizationScreen::SetTriadLocation instead


Created in NX10.0.0.

License requirements : None

int NXOpen::Preferences::SessionVisualizationScreen::TriadVisibility ( )

Returns

Deprecated:
Deprecated in NX12.0.0.

Use NXOpen::Preferences::PartVisualizationScreen::TriadVisibility and NXOpen::Preferences::PartVisualizationScreen::SetTriadVisibility instead


Created in NX5.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.