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

Represents set of General View Styles Preferences applicable to drafting views. More...

Inheritance diagram for NXOpen::Drawings::GeneralViewStyle:
NXOpen::Preferences::IGeneralViewPreferences

Public Member Functions

double Angle ()
 Returns the value of angle of a member view. More...
 
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...
 
NXOpen::ScalarAssociativeAngle ()
 Returns the value of angle of a member view. More...
 
bool AutomaticAnchorPoint ()
 Returns the status of Automatic Anchor Point. More...
 
bool AutomaticUpdate ()
 Returns the status of Automatic update, if true then position, hidden lines, silhouettes, view bounds, section views, and section view details updated after a model change else the above items are not updated after a model change. More...
 
bool BoundaryStatus ()
 Returns the boundary status. More...
 
NXOpen::Preferences::GeneralDisplayIdOption DisplayId ()
 Returns the display identifier option for a member view. More...
 
NXOpen::ExpressionExpressionForScale ()
 Returns the expression for scale
Created in NX5.0.0. More...
 
NXOpen::Preferences::GeneralExtractedEdgesOption ExtractedEdges ()
 Returns the extracted edge, that provides an alternative way to display model geometry in a drawing view. 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, that toggles a view from active to reference. More...
 
int RenderCount ()
 Returns the render count. More...
 
double Scale ()
 Returns the scale of a member view. More...
 
bool ScaleLabel ()
 Returns the display of scale label. More...
 
void SetAngle (double angle)
 Sets the value of angle of a member view. More...
 
void SetAngleDecimalPointFormat (NXOpen::Preferences::DecimalPointCharacter format)
 Sets the decimal point character to use for view angle display. More...
 
void SetAngleFormat (NXOpen::Preferences::AngleFormat angleFormat)
 Sets the format to use for view angle display. More...
 
void SetAnglePrecision (int anglePrecision)
 Sets the precision to use for view angle display. More...
 
void SetAssociativeAngle (NXOpen::Scalar *angle)
 Sets the value of angle of a member view. More...
 
void SetAutomaticAnchorPoint (bool automaticAnchorPoint)
 Sets the status of Automatic Anchor Point. More...
 
void SetAutomaticUpdate (bool automaticUpdate)
 Sets the status of Automatic update, if true then position, hidden lines, silhouettes, view bounds, section views, and section view details updated after a model change else the above items are not updated after a model change. More...
 
void SetBoundaryStatus (bool boundaryStatus)
 Sets the boundary status. More...
 
void SetCenterlines (bool centerlines)
 The status of center line, if true 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. More...
 
void SetDisplayId (NXOpen::Preferences::GeneralDisplayIdOption option)
 Sets the display identifier option for a member view. More...
 
void SetExpressionForScale (NXOpen::Expression *expressionForScale)
 Sets the expression for scale
Created in NX5.0.0. 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 framebarHorizontal)
 The status of framebar horizontal, if true automatically creates horizontal framebar for views where the view axis match with ship axis. More...
 
void SetFramebarVertical (bool framebarVertical)
 The status of framebar vertical, if true automatically creates vertical framebar for views where the view axis match with ship axis. 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, that toggles a view from active to reference. More...
 
void SetRenderCount (int renderCount)
 Sets the render count. More...
 
void SetScale (double scale)
 Sets the scale of a member view. More...
 
void SetScaleLabel (bool scaleLabel)
 Sets the display of scale label. 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 added else silhouettes 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, if true, grid curves for selected drawing member views are added else the grid curves are removed from the selected member views. More...
 
void SetViewLabel (bool viewLabel)
 Sets the display of view label. More...
 
void SetViewQuality (NXOpen::Preferences::GeneralViewQualityOption qualityOption)
 Sets the view quality, that provides an alternative way to display model geometry in a drawing 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 colorOption)
 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 added else silhouettes 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, if true, grid curves for selected drawing member views are added else the grid curves are removed from the selected member views. More...
 
bool ViewLabel ()
 Returns the display of view label. More...
 
NXOpen::Preferences::GeneralViewQualityOption ViewQuality ()
 Returns the view quality, that provides an alternative way to display model geometry in a drawing 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 Styles Preferences applicable to drafting views.


To obtain an instance of this class use Drawings::ViewStyle::General

Created in NX5.0.0.

Member Function Documentation

double NXOpen::Drawings::GeneralViewStyle::Angle ( )

Returns the value of angle of a member view.


Created in NX5.0.0.

License requirements : None

NXOpen::Preferences::DecimalPointCharacter NXOpen::Drawings::GeneralViewStyle::AngleDecimalPointFormat ( )

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


Created in NX8.5.0.

License requirements : None

NXOpen::Preferences::AngleFormat NXOpen::Drawings::GeneralViewStyle::AngleFormat ( )

Returns the format to use for view angle display.


Created in NX8.5.0.

License requirements : None

int NXOpen::Drawings::GeneralViewStyle::AnglePrecision ( )

Returns the precision to use for view angle display.


Created in NX8.5.0.

License requirements : None

NXOpen::Scalar* NXOpen::Drawings::GeneralViewStyle::AssociativeAngle ( )

Returns the value of angle of a member view.


Created in NX11.0.0.

License requirements : None

bool NXOpen::Drawings::GeneralViewStyle::AutomaticAnchorPoint ( )

Returns the status of Automatic Anchor Point.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Drawings::GeneralViewStyle::AutomaticUpdate ( )

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


Created in NX5.0.0.

License requirements : None

bool NXOpen::Drawings::GeneralViewStyle::BoundaryStatus ( )

Returns the boundary status.


Created in NX5.0.0.

License requirements : None

NXOpen::Preferences::GeneralDisplayIdOption NXOpen::Drawings::GeneralViewStyle::DisplayId ( )

Returns the display identifier option for a member view.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Drawings::GeneralViewStyle::ExpressionForScale ( )

Returns the expression for scale
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

NXOpen::Preferences::GeneralExtractedEdgesOption NXOpen::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::Reference ( )

Returns the status of reference, that toggles a view from active to reference.

If true, the view is considered a reference view.


Created in NX5.0.0.

License requirements : None

int NXOpen::Drawings::GeneralViewStyle::RenderCount ( )

Returns the render count.


Created in NX5.0.0.

License requirements : None

double NXOpen::Drawings::GeneralViewStyle::Scale ( )

Returns the scale of a member view.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Drawings::GeneralViewStyle::ScaleLabel ( )

Returns the display of scale label.


Created in NX5.0.0.

License requirements : None

void NXOpen::Drawings::GeneralViewStyle::SetAngle ( double  angle)

Sets the value of angle of a member view.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
angleangle
void NXOpen::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::SetAngleFormat ( NXOpen::Preferences::AngleFormat  angleFormat)

Sets the format to use for view angle display.


Created in NX8.5.0.

License requirements : drafting ("DRAFTING")

Parameters
angleFormatangleformat
void NXOpen::Drawings::GeneralViewStyle::SetAnglePrecision ( int  anglePrecision)

Sets the precision to use for view angle display.


Created in NX8.5.0.

License requirements : drafting ("DRAFTING")

Parameters
anglePrecisionangleprecision
void NXOpen::Drawings::GeneralViewStyle::SetAssociativeAngle ( NXOpen::Scalar angle)

Sets the value of angle of a member view.


Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters
angleangle
void NXOpen::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::SetAutomaticUpdate ( bool  automaticUpdate)

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


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
automaticUpdateautomatic update
void NXOpen::Drawings::GeneralViewStyle::SetBoundaryStatus ( bool  boundaryStatus)

Sets the boundary status.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
boundaryStatusboundary status
void NXOpen::Drawings::GeneralViewStyle::SetCenterlines ( bool  centerlines)

The status of center line, if true 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::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::SetExpressionForScale ( NXOpen::Expression expressionForScale)

Sets the expression for scale
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
expressionForScaleexpression for scale
void NXOpen::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::SetFramebarHorizontal ( bool  framebarHorizontal)

The status of framebar horizontal, if true automatically creates horizontal framebar for views where the view axis match with ship axis.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters
framebarHorizontalframebarhorizontal
void NXOpen::Drawings::GeneralViewStyle::SetFramebarVertical ( bool  framebarVertical)

The status of framebar vertical, if true automatically creates vertical framebar for views where the view axis match with ship axis.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters
framebarVerticalframebarvertical
void NXOpen::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::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 lock method option on the general sub-builder
void NXOpen::Drawings::GeneralViewStyle::SetReference ( bool  reference)

Sets the status of reference, that toggles a view from active to reference.

If true, the view is considered a reference view.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
referencereference
void NXOpen::Drawings::GeneralViewStyle::SetRenderCount ( int  renderCount)

Sets the render count.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
renderCountrender count
void NXOpen::Drawings::GeneralViewStyle::SetScale ( double  scale)

Sets the scale of a member view.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
scalescale
void NXOpen::Drawings::GeneralViewStyle::SetScaleLabel ( bool  scaleLabel)

Sets the display of scale label.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
scaleLabelscale label
void NXOpen::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::SetSilhouettes ( bool  silhouettes)

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


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
silhouettessilhouettes
void NXOpen::Drawings::GeneralViewStyle::SetSnapshotView ( bool  snapshotView)

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

Deprecated:
Deprecated in NX11.0.1.

Use NXOpen::Drawings::GeneralViewStyle::SetLockmethodView instead.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters
snapshotViewSets a snapshot view toggle value on the general sub-builder
void NXOpen::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::SetViewLabel ( bool  viewLabel)

Sets the display of view label.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
viewLabelview label
void NXOpen::Drawings::GeneralViewStyle::SetViewQuality ( NXOpen::Preferences::GeneralViewQualityOption  qualityOption)

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


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters
qualityOptionquality option
void NXOpen::Drawings::GeneralViewStyle::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 view
void NXOpen::Drawings::GeneralViewStyle::SetWireframeColorSource ( NXOpen::Preferences::GeneralWireframeColorSourceOption  colorOption)

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


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
colorOptioncolor option
bool NXOpen::Drawings::GeneralViewStyle::ShowAngleLeadingZeros ( )

Returns the status of leading zeros display in view angle.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Drawings::GeneralViewStyle::ShowAngleTrailingZeros ( )

Returns the status of trailing zeros display in view angle.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Drawings::GeneralViewStyle::Silhouettes ( )

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


Created in NX5.0.0.

License requirements : None

bool NXOpen::Drawings::GeneralViewStyle::SnapshotView ( )

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

Deprecated:
Deprecated in NX11.0.1.

Use NXOpen::Drawings::GeneralViewStyle::LockmethodView instead.


Created in NX8.0.0.

License requirements : None

tag_t NXOpen::Drawings::GeneralViewStyle::Tag ( ) const

Returns the tag of this object.

double NXOpen::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::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

bool NXOpen::Drawings::GeneralViewStyle::ViewLabel ( )

Returns the display of view label.


Created in NX5.0.0.

License requirements : None

NXOpen::Preferences::GeneralViewQualityOption NXOpen::Drawings::GeneralViewStyle::ViewQuality ( )

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


Created in NX8.0.0.

License requirements : None

NXOpen::Preferences::GeneralViewRepresentationOption NXOpen::Drawings::GeneralViewStyle::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::Drawings::GeneralViewStyle::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.