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

Represents a Drawings.SectionLineStyleBuiler. More...

Inheritance diagram for NXOpen::Drawings::SectionLineStyleBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ArrowheadStyleType { ArrowheadStyleTypeOpen, ArrowheadStyleTypeClosed, ArrowheadStyleTypeFilled }
 This enum represents arrowhead style type. More...
 
enum  CreateSectionLineType { CreateSectionLineTypeWithView, CreateSectionLineTypeWithoutView }
 This enum represents whether or not to create a view for the section line. More...
 
enum  FontStyle {
  FontStyleNone, FontStyleSolid, FontStyleDashed, FontStylePhantom,
  FontStyleCenterline, FontStyleDotted, FontStyleLongDashed, FontStyleDottedDashed
}
 This enum represents section line font style type. More...
 
enum  LabelLocationStyle { LabelLocationStyleOnArrow, LabelLocationStyleOnEnd }
 This enum represents section line label location for ISO128 section lines. More...
 
enum  StandardStyle {
  StandardStyleAnsiStandard, StandardStyleIsoStandard, StandardStyleIso128Standard, StandardStyleJisStandard,
  StandardStyleGbStandard, StandardStyleEskdStandard
}
 This enum represents section line standard style type. More...
 
enum  WidthStyle {
  WidthStyleThin, WidthStyleNormal, WidthStyleThick, WidthStyleThicknessOne = 5,
  WidthStyleThicknessTwo, WidthStyleThicknessThree, WidthStyleThicknessFour, WidthStyleThicknessFive,
  WidthStyleThicknessSix, WidthStyleThicknessSeven, WidthStyleThicknessEight, WidthStyleThicknessNine
}
 This enum represents section line width style type. More...
 

Public Member Functions

double ArrowheadAngle ()
 Returns the arrowhead angle
More...
 
double ArrowheadLength ()
 Returns the arrowhead length
More...
 
NXOpen::Drawings::SectionLineStyleBuilder::ArrowheadStyleType ArrowheadStyle ()
 Returns the arrowhead style
More...
 
double ArrowLength ()
 Returns the arrow length
More...
 
double BorderToArrowDistance ()
 Returns the border to arrow distance
More...
 
NXOpen::Drawings::SectionLineStyleBuilder::CreateSectionLineType CreateSectionLine ()
 Returns a value that indicates whether or not to create a view for the section line
More...
 
bool DisplayJisrotationLetter ()
 Returns the display jisrotation letter
More...
 
bool DisplayLabel ()
 Returns the display label
More...
 
NXOpen::Drawings::SectionLineStyleBuilder::FontStyle Font ()
 Returns the font
More...
 
NXOpen::NXColorGetColor ()
 Returns the color. More...
 
NXOpen::Drawings::SectionLineStyleBuilder::LabelLocationStyle LabelLocation ()
 Returns the label location
More...
 
NXString Letter ()
 Returns the letter
More...
 
double LineLength ()
 Returns the line length
More...
 
double Offset ()
 Returns the offset
More...
 
NXOpen::SelectTaggedObjectSelectLetter ()
 Returns the selected note for jisrotation letter
More...
 
void SetArrowheadAngle (double arrowheadAngle)
 Sets the arrowhead angle
More...
 
void SetArrowheadLength (double arrowheadLength)
 Sets the arrowhead length
More...
 
void SetArrowheadStyle (NXOpen::Drawings::SectionLineStyleBuilder::ArrowheadStyleType arrowheadStyle)
 Sets the arrowhead style
More...
 
void SetArrowLength (double arrowLength)
 Sets the arrow length
More...
 
void SetBorderToArrowDistance (double borderToArrowDistance)
 Sets the border to arrow distance
More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the color
More...
 
void SetCreateSectionLine (NXOpen::Drawings::SectionLineStyleBuilder::CreateSectionLineType createSectionLine)
 Sets a value that indicates whether or not to create a view for the section line
More...
 
void SetDisplayJisrotationLetter (bool displayJISRotationLetter)
 Sets the display jisrotation letter
More...
 
void SetDisplayLabel (bool displayLabel)
 Sets the display label
More...
 
void SetFont (NXOpen::Drawings::SectionLineStyleBuilder::FontStyle font)
 Sets the font
More...
 
void SetLabelLocation (NXOpen::Drawings::SectionLineStyleBuilder::LabelLocationStyle labelLocation)
 Sets the label location
More...
 
void SetLetter (const NXString &letter)
 Sets the letter
More...
 
void SetLetter (const char *letter)
 Sets the letter
More...
 
void SetLineLength (double lineLength)
 Sets the line length
More...
 
void SetOffset (double offset)
 Sets the offset
More...
 
void SetStandard (NXOpen::Drawings::SectionLineStyleBuilder::StandardStyle standard)
 Sets the standard
More...
 
void SetStubLength (double stubLength)
 Sets the stub length
More...
 
void SetUseOffset (bool useOffset)
 Sets the use offset
More...
 
void SetWidth (NXOpen::Drawings::SectionLineStyleBuilder::WidthStyle width)
 Sets the width
More...
 
NXOpen::Drawings::SectionLineStyleBuilder::StandardStyle Standard ()
 Returns the standard
More...
 
double StubLength ()
 Returns the stub length
More...
 
bool UseOffset ()
 Returns the use offset
More...
 
NXOpen::Drawings::SectionLineStyleBuilder::WidthStyle Width ()
 Returns the width
More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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.SectionLineStyleBuiler.

The SectionLineStyleBuilder is used to specify section line style.
To create a new instance of this class, use NXOpen::Drawings::SectionLineCollection::CreateSectionLineStyleBuilder

Created in NX6.0.0.

Member Enumeration Documentation

This enum represents arrowhead style type.


Deprecated:
Deprecated in NX10.0.0. Use NXOpen::Drawings::ViewSectionLineBuilder::StyleType instead.
Enumerator
ArrowheadStyleTypeOpen 

open

ArrowheadStyleTypeClosed 

closed

ArrowheadStyleTypeFilled 

filled

This enum represents whether or not to create a view for the section line.


Deprecated:
Deprecated in NX10.0.0. Use NXOpen::Drawings::ViewSectionLineBuilder::ShowSectionLineType instead.
Enumerator
CreateSectionLineTypeWithView 

with view

CreateSectionLineTypeWithoutView 

without view

This enum represents section line font style type.


Deprecated:
Deprecated in NX10.0.0. This API is not supported yet and should not be used.
Enumerator
FontStyleNone 

none

FontStyleSolid 

solid

FontStyleDashed 

dashed

FontStylePhantom 

phantom

FontStyleCenterline 

centerline

FontStyleDotted 

dotted

FontStyleLongDashed 

long dashed

FontStyleDottedDashed 

dotted dashed

This enum represents section line label location for ISO128 section lines.


Deprecated:
Deprecated in NX10.0.0. Use NXOpen::Drawings::ViewSectionLineBuilder::LocationType instead.
Enumerator
LabelLocationStyleOnArrow 

on arrow

LabelLocationStyleOnEnd 

on end

This enum represents section line standard style type.


Deprecated:
Deprecated in NX10.0.0. Use NXOpen::Drawings::ViewSectionLineBuilder::DisplayType instead.
Enumerator
StandardStyleAnsiStandard 

ansi standard

StandardStyleIsoStandard 

iso standard

StandardStyleIso128Standard 

iso128standard

StandardStyleJisStandard 

jis standard

StandardStyleGbStandard 

gb standard

StandardStyleEskdStandard 

eskd standard

This enum represents section line width style type.


Deprecated:
Deprecated in NX10.0.0. This API is not supported yet and should not be used.
Enumerator
WidthStyleThin 

Thin.

WidthStyleNormal 

Normal.

WidthStyleThick 

Thick.

WidthStyleThicknessOne 

Width One.

WidthStyleThicknessTwo 

Width Two.

WidthStyleThicknessThree 

Width Three.

WidthStyleThicknessFour 

Width Four.

WidthStyleThicknessFive 

Width Five.

WidthStyleThicknessSix 

Width Six.

WidthStyleThicknessSeven 

Width Seven.

WidthStyleThicknessEight 

Width Eight.

WidthStyleThicknessNine 

Width Nine.

Member Function Documentation

double NXOpen::Drawings::SectionLineStyleBuilder::ArrowheadAngle ( )

Returns the arrowhead angle

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::ArrowheadAngle instead.


Created in NX6.0.0.

License requirements : None

double NXOpen::Drawings::SectionLineStyleBuilder::ArrowheadLength ( )

Returns the arrowhead length

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::ArrowheadLength instead.


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::SectionLineStyleBuilder::ArrowheadStyleType NXOpen::Drawings::SectionLineStyleBuilder::ArrowheadStyle ( )

Returns the arrowhead style

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::Style instead.


Created in NX6.0.0.

License requirements : None

double NXOpen::Drawings::SectionLineStyleBuilder::ArrowLength ( )

Returns the arrow length

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::ArrowLength instead.


Created in NX6.0.0.

License requirements : None

double NXOpen::Drawings::SectionLineStyleBuilder::BorderToArrowDistance ( )

Returns the border to arrow distance

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::BorderToArrowDistance instead.


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::SectionLineStyleBuilder::CreateSectionLineType NXOpen::Drawings::SectionLineStyleBuilder::CreateSectionLine ( )

Returns a value that indicates whether or not to create a view for the section line

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::ShowSectionLine instead.


Created in NX6.0.0.

License requirements : None

bool NXOpen::Drawings::SectionLineStyleBuilder::DisplayJisrotationLetter ( )

Returns the display jisrotation letter

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::DisplayRotationLetter instead.


Created in NX6.0.0.

License requirements : None

bool NXOpen::Drawings::SectionLineStyleBuilder::DisplayLabel ( )

Returns the display label

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::Display instead.


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::SectionLineStyleBuilder::FontStyle NXOpen::Drawings::SectionLineStyleBuilder::Font ( )

Returns the font

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::LineColorFontWidth instead.


Created in NX6.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::Drawings::SectionLineStyleBuilder::GetColor ( )

Returns the color.

Returns

Deprecated:
Deprecated in NX10.0.0. Use NXOpen::Drawings::ViewSectionLineBuilder::LineColorFontWidth instead.


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::SectionLineStyleBuilder::LabelLocationStyle NXOpen::Drawings::SectionLineStyleBuilder::LabelLocation ( )

Returns the label location

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::LabelLocation instead.


Created in NX6.0.0.

License requirements : None

NXString NXOpen::Drawings::SectionLineStyleBuilder::Letter ( )

Returns the letter

Deprecated:
Deprecated in NX10.0.0.

Use Drawings::ViewCommonViewLabelBuilder::Letter instead.


Created in NX6.0.0.

License requirements : None

double NXOpen::Drawings::SectionLineStyleBuilder::LineLength ( )

Returns the line length

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::LineLength instead.


Created in NX6.0.0.

License requirements : None

double NXOpen::Drawings::SectionLineStyleBuilder::Offset ( )

Returns the offset

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::UseOffset instead.


Created in NX6.0.0.

License requirements : None

NXOpen::SelectTaggedObject* NXOpen::Drawings::SectionLineStyleBuilder::SelectLetter ( )

Returns the selected note for jisrotation letter

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SelectRotationLetter instead.


Created in NX6.0.0.

License requirements : None

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

Sets the arrowhead angle

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetArrowheadAngle instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

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

Sets the arrowhead length

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetArrowheadLength instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
arrowheadLengtharrowheadlength
void NXOpen::Drawings::SectionLineStyleBuilder::SetArrowheadStyle ( NXOpen::Drawings::SectionLineStyleBuilder::ArrowheadStyleType  arrowheadStyle)

Sets the arrowhead style

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetStyle instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
arrowheadStylearrowheadstyle
void NXOpen::Drawings::SectionLineStyleBuilder::SetArrowLength ( double  arrowLength)

Sets the arrow length

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetArrowLength instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
arrowLengtharrowlength
void NXOpen::Drawings::SectionLineStyleBuilder::SetBorderToArrowDistance ( double  borderToArrowDistance)

Sets the border to arrow distance

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetBorderToArrowDistance instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
borderToArrowDistancebordertoarrowdistance
void NXOpen::Drawings::SectionLineStyleBuilder::SetColor ( NXOpen::NXColor color)

Sets the color

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::LineColorFontWidth instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
colorcolor
void NXOpen::Drawings::SectionLineStyleBuilder::SetCreateSectionLine ( NXOpen::Drawings::SectionLineStyleBuilder::CreateSectionLineType  createSectionLine)

Sets a value that indicates whether or not to create a view for the section line

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetShowSectionLine instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
createSectionLinecreatesectionline
void NXOpen::Drawings::SectionLineStyleBuilder::SetDisplayJisrotationLetter ( bool  displayJISRotationLetter)

Sets the display jisrotation letter

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetDisplayRotationLetter instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
displayJISRotationLetterdisplayjisrotationletter
void NXOpen::Drawings::SectionLineStyleBuilder::SetDisplayLabel ( bool  displayLabel)

Sets the display label

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetDisplay instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
displayLabeldisplaylabel
void NXOpen::Drawings::SectionLineStyleBuilder::SetFont ( NXOpen::Drawings::SectionLineStyleBuilder::FontStyle  font)

Sets the font

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::LineColorFontWidth instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
fontfont
void NXOpen::Drawings::SectionLineStyleBuilder::SetLabelLocation ( NXOpen::Drawings::SectionLineStyleBuilder::LabelLocationStyle  labelLocation)

Sets the label location

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetLabelLocation instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
labelLocationlabel location
void NXOpen::Drawings::SectionLineStyleBuilder::SetLetter ( const NXString letter)

Sets the letter

Deprecated:
Deprecated in NX10.0.0.

Use Drawings::ViewCommonViewLabelBuilder::SetLetter instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
letterletter
void NXOpen::Drawings::SectionLineStyleBuilder::SetLetter ( const char *  letter)

Sets the letter

Deprecated:
Deprecated in NX10.0.0.

Use Drawings::ViewCommonViewLabelBuilder::SetLetter instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
letterletter
void NXOpen::Drawings::SectionLineStyleBuilder::SetLineLength ( double  lineLength)

Sets the line length

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetLineLength instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
lineLengthlinelength
void NXOpen::Drawings::SectionLineStyleBuilder::SetOffset ( double  offset)

Sets the offset

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetUseOffset instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
offsetoffset
void NXOpen::Drawings::SectionLineStyleBuilder::SetStandard ( NXOpen::Drawings::SectionLineStyleBuilder::StandardStyle  standard)

Sets the standard

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetTypeStandard instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
standardstandard
void NXOpen::Drawings::SectionLineStyleBuilder::SetStubLength ( double  stubLength)

Sets the stub length

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetOverhang instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
stubLengthstublength
void NXOpen::Drawings::SectionLineStyleBuilder::SetUseOffset ( bool  useOffset)

Sets the use offset

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::SetUseOffset instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
useOffsetuseoffset
void NXOpen::Drawings::SectionLineStyleBuilder::SetWidth ( NXOpen::Drawings::SectionLineStyleBuilder::WidthStyle  width)

Sets the width

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::LineColorFontWidth instead.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters
widthwidth
NXOpen::Drawings::SectionLineStyleBuilder::StandardStyle NXOpen::Drawings::SectionLineStyleBuilder::Standard ( )

Returns the standard

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::TypeStandard instead.


Created in NX6.0.0.

License requirements : None

double NXOpen::Drawings::SectionLineStyleBuilder::StubLength ( )

Returns the stub length

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::Overhang instead.


Created in NX6.0.0.

License requirements : None

bool NXOpen::Drawings::SectionLineStyleBuilder::UseOffset ( )

Returns the use offset

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::UseOffset instead.


Created in NX6.0.0.

License requirements : None

NXOpen::Drawings::SectionLineStyleBuilder::WidthStyle NXOpen::Drawings::SectionLineStyleBuilder::Width ( )

Returns the width

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Drawings::ViewSectionLineBuilder::LineColorFontWidth instead.


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.