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

Represents a Drawings::ViewSettingsBuilder . More...

Inheritance diagram for NXOpen::Drawings::ViewSettingsBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  RenderingStyleEnum { RenderingStyleEnumShaded, RenderingStyleEnumDrawingViewSetting }
 enum is used to list out different rendering style types More...
 

Public Member Functions

bool AddSheetName ()
 Returns the add sheet name
Created in NX11.0.0. More...
 
bool AddSheetNumber ()
 Returns the add sheet number
Created in NX11.0.0. More...
 
bool ApplyCrosshatchToSectionView ()
 Returns the apply crosshatch To section view
Created in NX11.0.0. More...
 
bool ConvertAnnotation ()
 Returns the convert annotation
Created in NX11.0.0. More...
 
NXString Prefix ()
 Returns the prefix string
Created in NX11.0.0. More...
 
NXOpen::Drawings::ViewSettingsBuilder::RenderingStyleEnum RenderingStyle ()
 Returns the rendering style
Created in NX11.0.0. More...
 
double SectionGeometryTolerance ()
 Returns the section geometry tolerance
Created in NX11.0.0. More...
 
NXString Separator ()
 Returns the separator string
Created in NX11.0.0. More...
 
void SetAddSheetName (bool addSheetName)
 Sets the add sheet name
Created in NX11.0.0. More...
 
void SetAddSheetNumber (bool addSheetNumber)
 Sets the add sheet number
Created in NX11.0.0. More...
 
void SetApplyCrosshatchToSectionView (bool applyCrosshatchToSectionView)
 Sets the apply crosshatch To section view
Created in NX11.0.0. More...
 
void SetConvertAnnotation (bool convertAnnotation)
 Sets the convert annotation
Created in NX11.0.0. More...
 
void SetPrefix (const NXString &prefix)
 Sets the prefix string
Created in NX11.0.0. More...
 
void SetPrefix (const char *prefix)
 Sets the prefix string
Created in NX11.0.0. More...
 
void SetRenderingStyle (NXOpen::Drawings::ViewSettingsBuilder::RenderingStyleEnum renderingStyle)
 Sets the rendering style
Created in NX11.0.0. More...
 
void SetSectionGeometryTolerance (double sectionGeometryTolerance)
 Sets the section geometry tolerance
Created in NX11.0.0. More...
 
void SetSeparator (const NXString &separator)
 Sets the separator string
Created in NX11.0.0. More...
 
void SetSeparator (const char *separator)
 Sets the separator string
Created in NX11.0.0. More...
 
void SetUseAssemblyCrosshatch (bool useAssemblyCrosshatch)
 Sets the use assembly crosshatch
Created in NX11.0.0. More...
 
bool UseAssemblyCrosshatch ()
 Returns the use assembly crosshatch
Created in NX11.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a Drawings::ViewSettingsBuilder .

This class queries and sets settings specific to drawings data which will get converted to PMI.s


Created in NX11.0.0.

Member Enumeration Documentation

enum is used to list out different rendering style types

Enumerator
RenderingStyleEnumShaded 

shaded

RenderingStyleEnumDrawingViewSetting 

drawing view setting

Member Function Documentation

bool NXOpen::Drawings::ViewSettingsBuilder::AddSheetName ( )

Returns the add sheet name
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::ViewSettingsBuilder::AddSheetNumber ( )

Returns the add sheet number
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::ViewSettingsBuilder::ApplyCrosshatchToSectionView ( )

Returns the apply crosshatch To section view
Created in NX11.0.0.



License requirements : None

bool NXOpen::Drawings::ViewSettingsBuilder::ConvertAnnotation ( )

Returns the convert annotation
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Drawings::ViewSettingsBuilder::Prefix ( )

Returns the prefix string
Created in NX11.0.0.



License requirements : None

NXOpen::Drawings::ViewSettingsBuilder::RenderingStyleEnum NXOpen::Drawings::ViewSettingsBuilder::RenderingStyle ( )

Returns the rendering style
Created in NX11.0.0.



License requirements : None

double NXOpen::Drawings::ViewSettingsBuilder::SectionGeometryTolerance ( )

Returns the section geometry tolerance
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Drawings::ViewSettingsBuilder::Separator ( )

Returns the separator string
Created in NX11.0.0.



License requirements : None

void NXOpen::Drawings::ViewSettingsBuilder::SetAddSheetName ( bool  addSheetName)

Sets the add sheet name
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
addSheetNameaddsheetname
void NXOpen::Drawings::ViewSettingsBuilder::SetAddSheetNumber ( bool  addSheetNumber)

Sets the add sheet number
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
addSheetNumberaddsheetnumber
void NXOpen::Drawings::ViewSettingsBuilder::SetApplyCrosshatchToSectionView ( bool  applyCrosshatchToSectionView)

Sets the apply crosshatch To section view
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
applyCrosshatchToSectionViewapplycrosshatchtosectionview
void NXOpen::Drawings::ViewSettingsBuilder::SetConvertAnnotation ( bool  convertAnnotation)

Sets the convert annotation
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
convertAnnotationconvertannotation
void NXOpen::Drawings::ViewSettingsBuilder::SetPrefix ( const NXString prefix)

Sets the prefix string
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
prefixprefix
void NXOpen::Drawings::ViewSettingsBuilder::SetPrefix ( const char *  prefix)

Sets the prefix string
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
prefixprefix
void NXOpen::Drawings::ViewSettingsBuilder::SetRenderingStyle ( NXOpen::Drawings::ViewSettingsBuilder::RenderingStyleEnum  renderingStyle)

Sets the rendering style
Created in NX11.0.0.



License requirements : convert_to_pmi (" Convert To PMI"), drafting ("DRAFTING")

Parameters
renderingStylerenderingstyle
void NXOpen::Drawings::ViewSettingsBuilder::SetSectionGeometryTolerance ( double  sectionGeometryTolerance)

Sets the section geometry tolerance
Created in NX11.0.0.



License requirements : convert_to_pmi (" Convert To PMI"), drafting ("DRAFTING")

Parameters
sectionGeometryTolerancesectiongeometrytolerance
void NXOpen::Drawings::ViewSettingsBuilder::SetSeparator ( const NXString separator)

Sets the separator string
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
separatorseparator
void NXOpen::Drawings::ViewSettingsBuilder::SetSeparator ( const char *  separator)

Sets the separator string
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
separatorseparator
void NXOpen::Drawings::ViewSettingsBuilder::SetUseAssemblyCrosshatch ( bool  useAssemblyCrosshatch)

Sets the use assembly crosshatch
Created in NX11.0.0.



License requirements : drafting ("DRAFTING")

Parameters
useAssemblyCrosshatchuseassemblycrosshatch
bool NXOpen::Drawings::ViewSettingsBuilder::UseAssemblyCrosshatch ( )

Returns the use assembly crosshatch
Created in NX11.0.0.



License requirements : None

virtual bool NXOpen::Drawings::ViewSettingsBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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