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

Represents a NXOpen::Drawings::ViewSectionLineBuilder. More...

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

Public Types

enum  DisplayType { DisplayTypeArrowsAwayfromLine, DisplayTypeArrowstowardsLine, DisplayTypeThickEndsArrowstowardsLine, DisplayTypeThickEndsArrowsAwayfromLine }
 specifies the section line symbol display More...
 
enum  LocationType { LocationTypeOnArrow, LocationTypeOnEnd }
 specifies the label location for ISO128 section lines. More...
 
enum  ShowSectionLineType { ShowSectionLineTypeWithSectionView, ShowSectionLineTypeWithoutSectionView }
 specifies the show section line options More...
 
enum  StyleType { StyleTypeOpen, StyleTypeClosed, StyleTypeFilled }
 specifies the section line arrowhead style More...
 

Public Member Functions

double ArrowheadAngle ()
 Returns the included angle for the arrowhead
Created in NX9.0.0. More...
 
double ArrowheadLength ()
 Returns the arrowhead length
Created in NX9.0.0. More...
 
double ArrowLength ()
 Returns the arrow length
Created in NX9.0.0. More...
 
double BendAndEndSegmentWidthFactor ()
 Returns the section line bend and end segment width factor
Created in NX9.0.0. More...
 
double BorderToArrowDistance ()
 Returns the border to arrow distance
Created in NX9.0.0. More...
 
bool Display ()
 Returns the display
Created in NX9.0.0. More...
 
bool DisplayLettersOnBends ()
 Returns the display letters on bends
Created in NX9.0.0. More...
 
bool DisplayRotationLetter ()
 Returns the display rotation letter
Created in NX9.0.0. More...
 
double Gap ()
 Returns the gap
Created in NX9.0.0. More...
 
void InheritSettingsFromCustomerDefault ()
 Inherit Settings From Customer Default
Created in NX9.0.0. More...
 
void InheritSettingsFromPreferences ()
 Inherit Settings From Preference
Created in NX9.0.0. More...
 
void InheritSettingsFromSelectedObjects (NXOpen::NXObject *selectedObject)
 Inherit Settings From Selected Objects
Created in NX9.0.0. More...
 
NXOpen::Drawings::ViewSectionLineBuilder::LocationType LabelLocation ()
 Returns the label location
Created in NX9.0.0. More...
 
NXOpen::LineColorFontWidthBuilderLineColorFontWidth ()
 Returns the line color font width
Created in NX9.0.0. More...
 
double LineLength ()
 Returns the length of the end of the ESKD section line
Created in NX9.0.0. More...
 
double Overhang ()
 Returns the stub length
Created in NX9.0.0. More...
 
NXOpen::SelectTaggedObjectSelectRotationLetter ()
 Returns the selected objected should be note type only which is the desired location of the rotation point of the section line specified
Created in NX9.0.0. More...
 
void SetArrowheadAngle (double arrowheadAngle)
 Sets the included angle for the arrowhead
Created in NX9.0.0. More...
 
void SetArrowheadLength (double arrowheadLength)
 Sets the arrowhead length
Created in NX9.0.0. More...
 
void SetArrowLength (double arrowLength)
 Sets the arrow length
Created in NX9.0.0. More...
 
void SetBendAndEndSegmentWidthFactor (double bendAndEndSegmentWidthFactor)
 Sets the section line bend and end segment width factor
Created in NX9.0.0. More...
 
void SetBorderToArrowDistance (double borderToArrowDistance)
 Sets the border to arrow distance
Created in NX9.0.0. More...
 
void SetDisplay (bool display)
 Sets the display
Created in NX9.0.0. More...
 
void SetDisplayLettersOnBends (bool displayLettersOnBends)
 Sets the display letters on bends
Created in NX9.0.0. More...
 
void SetDisplayRotationLetter (bool displayRotationLetter)
 Sets the display rotation letter
Created in NX9.0.0. More...
 
void SetGap (double gap)
 Sets the gap
Created in NX9.0.0. More...
 
void SetLabelLocation (NXOpen::Drawings::ViewSectionLineBuilder::LocationType labelLocation)
 Sets the label location
Created in NX9.0.0. More...
 
void SetLineLength (double lineLength)
 Sets the length of the end of the ESKD section line
Created in NX9.0.0. More...
 
void SetOverhang (double overhang)
 Sets the stub length
Created in NX9.0.0. More...
 
void SetShowSectionLine (NXOpen::Drawings::ViewSectionLineBuilder::ShowSectionLineType showSectionLine)
 Sets the value to show section line with or without view
Created in NX9.0.0. More...
 
void SetStyle (NXOpen::Drawings::ViewSectionLineBuilder::StyleType style)
 Sets the section line arrowhead style
Created in NX9.0.0. More...
 
void SetTypeStandard (NXOpen::Drawings::ViewSectionLineBuilder::DisplayType typeStandard)
 Sets the section line symbol display
Created in NX9.0.0. More...
 
void SetUseLineLength (bool uselineLength)
 Sets the use line length in case of ESKD section line
Created in NX9.0.0. More...
 
void SetUseOffset (bool useOffset)
 Sets the use offset
Created in NX9.0.0. More...
 
NXOpen::Drawings::ViewSectionLineBuilder::ShowSectionLineType ShowSectionLine ()
 Returns the value to show section line with or without view
Created in NX9.0.0. More...
 
NXOpen::Drawings::ViewSectionLineBuilder::StyleType Style ()
 Returns the section line arrowhead style
Created in NX9.0.0. More...
 
NXOpen::Drawings::ViewSectionLineBuilder::DisplayType TypeStandard ()
 Returns the section line symbol display
Created in NX9.0.0. More...
 
bool UseLineLength ()
 Returns the use line length in case of ESKD section line
Created in NX9.0.0. More...
 
bool UseOffset ()
 Returns the use offset
Created in NX9.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 NXOpen::Drawings::ViewSectionLineBuilder.


Created in NX9.0.0.

Member Enumeration Documentation

specifies the section line symbol display

Enumerator
DisplayTypeArrowsAwayfromLine 

arrows awayfrom line

DisplayTypeArrowstowardsLine 

arrowstowards line

DisplayTypeThickEndsArrowstowardsLine 

thick ends arrowstowards line

DisplayTypeThickEndsArrowsAwayfromLine 

thick ends arrows awayfrom line

specifies the label location for ISO128 section lines.

Enumerator
LocationTypeOnArrow 

on arrow

LocationTypeOnEnd 

on end

specifies the show section line options

Enumerator
ShowSectionLineTypeWithSectionView 

with section view

ShowSectionLineTypeWithoutSectionView 

without section view

specifies the section line arrowhead style

Enumerator
StyleTypeOpen 

open

StyleTypeClosed 

closed

StyleTypeFilled 

filled

Member Function Documentation

double NXOpen::Drawings::ViewSectionLineBuilder::ArrowheadAngle ( )

Returns the included angle for the arrowhead
Created in NX9.0.0.



License requirements : None

double NXOpen::Drawings::ViewSectionLineBuilder::ArrowheadLength ( )

Returns the arrowhead length
Created in NX9.0.0.



License requirements : None

double NXOpen::Drawings::ViewSectionLineBuilder::ArrowLength ( )

Returns the arrow length
Created in NX9.0.0.



License requirements : None

double NXOpen::Drawings::ViewSectionLineBuilder::BendAndEndSegmentWidthFactor ( )

Returns the section line bend and end segment width factor
Created in NX9.0.0.



License requirements : None

double NXOpen::Drawings::ViewSectionLineBuilder::BorderToArrowDistance ( )

Returns the border to arrow distance
Created in NX9.0.0.



License requirements : None

bool NXOpen::Drawings::ViewSectionLineBuilder::Display ( )

Returns the display
Created in NX9.0.0.



License requirements : None

bool NXOpen::Drawings::ViewSectionLineBuilder::DisplayLettersOnBends ( )

Returns the display letters on bends
Created in NX9.0.0.



License requirements : None

bool NXOpen::Drawings::ViewSectionLineBuilder::DisplayRotationLetter ( )

Returns the display rotation letter
Created in NX9.0.0.



License requirements : None

double NXOpen::Drawings::ViewSectionLineBuilder::Gap ( )

Returns the gap
Created in NX9.0.0.



License requirements : None

void NXOpen::Drawings::ViewSectionLineBuilder::InheritSettingsFromCustomerDefault ( )

Inherit Settings From Customer Default
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

void NXOpen::Drawings::ViewSectionLineBuilder::InheritSettingsFromPreferences ( )

Inherit Settings From Preference
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

void NXOpen::Drawings::ViewSectionLineBuilder::InheritSettingsFromSelectedObjects ( NXOpen::NXObject selectedObject)

Inherit Settings From Selected Objects
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
selectedObjectThe selected annotation or table or view instance object. NULL is not allowed.
NXOpen::Drawings::ViewSectionLineBuilder::LocationType NXOpen::Drawings::ViewSectionLineBuilder::LabelLocation ( )

Returns the label location
Created in NX9.0.0.



License requirements : None

NXOpen::LineColorFontWidthBuilder* NXOpen::Drawings::ViewSectionLineBuilder::LineColorFontWidth ( )

Returns the line color font width
Created in NX9.0.0.



License requirements : None

double NXOpen::Drawings::ViewSectionLineBuilder::LineLength ( )

Returns the length of the end of the ESKD section line
Created in NX9.0.0.



License requirements : None

double NXOpen::Drawings::ViewSectionLineBuilder::Overhang ( )

Returns the stub length
Created in NX9.0.0.



License requirements : None

NXOpen::SelectTaggedObject* NXOpen::Drawings::ViewSectionLineBuilder::SelectRotationLetter ( )

Returns the selected objected should be note type only which is the desired location of the rotation point of the section line specified
Created in NX9.0.0.



License requirements : None

void NXOpen::Drawings::ViewSectionLineBuilder::SetArrowheadAngle ( double  arrowheadAngle)

Sets the included angle for the arrowhead
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
arrowheadAnglearrowheadangle
void NXOpen::Drawings::ViewSectionLineBuilder::SetArrowheadLength ( double  arrowheadLength)

Sets the arrowhead length
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
arrowheadLengtharrowheadlength
void NXOpen::Drawings::ViewSectionLineBuilder::SetArrowLength ( double  arrowLength)

Sets the arrow length
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
arrowLengtharrowlength
void NXOpen::Drawings::ViewSectionLineBuilder::SetBendAndEndSegmentWidthFactor ( double  bendAndEndSegmentWidthFactor)

Sets the section line bend and end segment width factor
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
bendAndEndSegmentWidthFactorbendandendsegmentwidthfactor
void NXOpen::Drawings::ViewSectionLineBuilder::SetBorderToArrowDistance ( double  borderToArrowDistance)

Sets the border to arrow distance
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
borderToArrowDistancebordertoarrowdistance
void NXOpen::Drawings::ViewSectionLineBuilder::SetDisplay ( bool  display)

Sets the display
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
displaydisplay
void NXOpen::Drawings::ViewSectionLineBuilder::SetDisplayLettersOnBends ( bool  displayLettersOnBends)

Sets the display letters on bends
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
displayLettersOnBendsdisplaylettersonbends
void NXOpen::Drawings::ViewSectionLineBuilder::SetDisplayRotationLetter ( bool  displayRotationLetter)

Sets the display rotation letter
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
displayRotationLetterdisplayrotationletter
void NXOpen::Drawings::ViewSectionLineBuilder::SetGap ( double  gap)

Sets the gap
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
gapgap
void NXOpen::Drawings::ViewSectionLineBuilder::SetLabelLocation ( NXOpen::Drawings::ViewSectionLineBuilder::LocationType  labelLocation)

Sets the label location
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
labelLocationlabellocation
void NXOpen::Drawings::ViewSectionLineBuilder::SetLineLength ( double  lineLength)

Sets the length of the end of the ESKD section line
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
lineLengthlinelength
void NXOpen::Drawings::ViewSectionLineBuilder::SetOverhang ( double  overhang)

Sets the stub length
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
overhangoverhang
void NXOpen::Drawings::ViewSectionLineBuilder::SetShowSectionLine ( NXOpen::Drawings::ViewSectionLineBuilder::ShowSectionLineType  showSectionLine)

Sets the value to show section line with or without view
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
showSectionLineshowsectionline
void NXOpen::Drawings::ViewSectionLineBuilder::SetStyle ( NXOpen::Drawings::ViewSectionLineBuilder::StyleType  style)

Sets the section line arrowhead style
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
stylestyle
void NXOpen::Drawings::ViewSectionLineBuilder::SetTypeStandard ( NXOpen::Drawings::ViewSectionLineBuilder::DisplayType  typeStandard)

Sets the section line symbol display
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
typeStandardtypestandard
void NXOpen::Drawings::ViewSectionLineBuilder::SetUseLineLength ( bool  uselineLength)

Sets the use line length in case of ESKD section line
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
uselineLengthuselinelength
void NXOpen::Drawings::ViewSectionLineBuilder::SetUseOffset ( bool  useOffset)

Sets the use offset
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
useOffsetuseoffset
NXOpen::Drawings::ViewSectionLineBuilder::ShowSectionLineType NXOpen::Drawings::ViewSectionLineBuilder::ShowSectionLine ( )

Returns the value to show section line with or without view
Created in NX9.0.0.



License requirements : None

NXOpen::Drawings::ViewSectionLineBuilder::StyleType NXOpen::Drawings::ViewSectionLineBuilder::Style ( )

Returns the section line arrowhead style
Created in NX9.0.0.



License requirements : None

NXOpen::Drawings::ViewSectionLineBuilder::DisplayType NXOpen::Drawings::ViewSectionLineBuilder::TypeStandard ( )

Returns the section line symbol display
Created in NX9.0.0.



License requirements : None

bool NXOpen::Drawings::ViewSectionLineBuilder::UseLineLength ( )

Returns the use line length in case of ESKD section line
Created in NX9.0.0.



License requirements : None

bool NXOpen::Drawings::ViewSectionLineBuilder::UseOffset ( )

Returns the use offset
Created in NX9.0.0.



License requirements : None

virtual bool NXOpen::Drawings::ViewSectionLineBuilder::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.