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

Represents line and arrow preferences
Created in NX3.0.0. More...

Inheritance diagram for NXOpen::Annotations::LineAndArrowPreferences:
NXOpen::TransientObject

Public Member Functions

double AllAroundSymbol ()
 Returns the size of all around symbol. More...
 
double ArrowheadIncludedAngle ()
 Returns the arrowhead included angle
Created in NX3.0.0. More...
 
double ArrowheadLength ()
 Returns the arrowhead length
Created in NX3.0.0. More...
 
bool ClipOrdinateDimensionLine ()
 Returns the clipping of the dimension line to the ordinate origin at the view border
Created in NX10.0.0. More...
 
double DatumLengthPastArrow ()
 Returns the datum extension line past the arrow distance
Created in NX4.0.0. More...
 
double DotArrowheadDiameter ()
 Returns the dot arrowhead diameter
Created in NX3.0.0. More...
 
NXOpen::Annotations::ArrowheadType FirstArrowType ()
 Returns the first arrow type
Created in NX3.0.0. More...
 
double FirstPosToExtLineDist ()
 Returns the first position to extension line distance
Created in NX3.0.0. More...
 
NXOpen::Annotations::LineCfw GetFirstArrowheadCfw ()
 Returns the first arrowhead color, font, and width. More...
 
NXOpen::Annotations::LineCfw GetFirstArrowLineCfw ()
 Returns the first arrow line color, font, and width. More...
 
NXOpen::Annotations::LineCfw GetFirstExtensionLineCfw ()
 Returns the first extension line color, font, and width. More...
 
NXOpen::Annotations::LineCfw GetSecondArrowheadCfw ()
 Returns the second arrowhead color, font, and width. More...
 
NXOpen::Annotations::LineCfw GetSecondArrowLineCfw ()
 Returns the second arrow line color, font, and width. More...
 
NXOpen::Annotations::LineCfw GetSecondExtensionLineCfw ()
 Returns the second extension line color, font, and width. More...
 
NXOpen::Annotations::VerticalTextJustification LeaderLocation ()
 Returns the leader location
Created in NX3.0.0. More...
 
double LinePastArrowDistance ()
 Returns the line past arrow distance
Created in NX3.0.0. More...
 
double LinePastArrowDistance2 ()
 Returns the 2nd line past arrow distance
Created in NX9.0.0. More...
 
double ObliqueExtensionLineAngle ()
 Returns the oblique extension line angle
Created in NX3.0.0. More...
 
NXOpen::Annotations::ArrowheadType SecondArrowType ()
 Returns the second arrow type
Created in NX3.0.0. More...
 
double SecondPosToExtLineDist ()
 Returns the second position to extension line distance
Created in NX3.0.0. More...
 
void SetAllAroundSymbol (double allAroundSymbolSize)
 Sets the size of all around symbol. More...
 
void SetArrowheadIncludedAngle (double arrowheadIncludedAngle)
 Sets the arrowhead included angle
Created in NX3.0.0. More...
 
void SetArrowheadLength (double arrowheadLength)
 Sets the arrowhead length
Created in NX3.0.0. More...
 
void SetClipOrdinateDimensionLine (bool clipOrdinateDimLine)
 Sets the clipping of the dimension line to the ordinate origin at the view border
Created in NX10.0.0. More...
 
void SetDatumLengthPastArrow (double datumLengthPastArrow)
 Sets the datum extension line past the arrow distance
Created in NX4.0.0. More...
 
void SetDotArrowheadDiameter (double dotArrowheadDiameter)
 Sets the dot arrowhead diameter
Created in NX3.0.0. More...
 
void SetFirstArrowheadCfw (const NXOpen::Annotations::LineCfw &firstArrowheadCfw)
 Sets the first arrowhead color, font, and width
Created in NX3.0.0. More...
 
void SetFirstArrowLineCfw (const NXOpen::Annotations::LineCfw &firstArrowLineCfw)
 Sets the first arrow line color, font, and width
Created in NX3.0.0. More...
 
void SetFirstArrowType (NXOpen::Annotations::ArrowheadType firstArrowType)
 Sets the first arrow type
Created in NX3.0.0. More...
 
void SetFirstExtensionLineCfw (const NXOpen::Annotations::LineCfw &firstExtensionLineCfw)
 Sets the first extension line color, font, and width
Created in NX3.0.0. More...
 
void SetFirstPosToExtLineDist (double firstPosToExtensionLineDistance)
 Sets the first position to extension line distance
Created in NX3.0.0. More...
 
void SetLeaderLocation (NXOpen::Annotations::VerticalTextJustification leaderLocation)
 Sets the leader location
Created in NX3.0.0. More...
 
void SetLinePastArrowDistance (double linePastArrowDistance)
 Sets the line past arrow distance
Created in NX3.0.0. More...
 
void SetLinePastArrowDistance2 (double linePastArrowDistance)
 Sets the 2nd line past arrow distance
Created in NX9.0.0. More...
 
void SetObliqueExtensionLineAngle (double obliqueExtensionLineAngle)
 Sets the oblique extension line angle
Created in NX3.0.0. More...
 
void SetSecondArrowheadCfw (const NXOpen::Annotations::LineCfw &secondArrowheadCfw)
 Sets the second arrowhead color, font, and width
Created in NX3.0.0. More...
 
void SetSecondArrowLineCfw (const NXOpen::Annotations::LineCfw &secondArrowLineCfw)
 Sets the second arrow line color, font, and width
Created in NX3.0.0. More...
 
void SetSecondArrowType (NXOpen::Annotations::ArrowheadType secondArrowType)
 Sets the second arrow type
Created in NX3.0.0. More...
 
void SetSecondExtensionLineCfw (const NXOpen::Annotations::LineCfw &secondExtensionLineCfw)
 Sets the second extension line color, font, and width
Created in NX3.0.0. More...
 
void SetSecondPosToExtLineDist (double secondPosToExtensionLineDistance)
 Sets the second position to extension line distance
Created in NX3.0.0. More...
 
void SetStubLength (double stubLength)
 Sets the stub length
Created in NX3.0.0. More...
 
void SetTextOverLeaderGapFactor (double textOverLeaderGapFactor)
 Sets the character size factor that controls the gap between text and the leader
Created in NX8.0.0. More...
 
void SetTextOverStubSpaceFactor (double textOverStubSpaceFactor)
 Sets the text to stub spacing factor
Created in NX4.0.0. More...
 
void SetTextToLineDistance (double textToLineDistance)
 Sets the text to line distance
Created in NX3.0.0. More...
 
double StubLength ()
 Returns the stub length
Created in NX3.0.0. More...
 
double TextOverLeaderGapFactor ()
 Returns the character size factor that controls the gap between text and the leader
Created in NX8.0.0. More...
 
double TextOverStubSpaceFactor ()
 Returns the text to stub spacing factor
Created in NX4.0.0. More...
 
double TextToLineDistance ()
 Returns the text to line distance
Created in NX3.0.0. More...
 
virtual ~LineAndArrowPreferences ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents line and arrow preferences
Created in NX3.0.0.


Constructor & Destructor Documentation

virtual NXOpen::Annotations::LineAndArrowPreferences::~LineAndArrowPreferences ( )
virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX3.0.0.

License requirements : None

Member Function Documentation

double NXOpen::Annotations::LineAndArrowPreferences::AllAroundSymbol ( )

Returns the size of all around symbol.

This is also used for inner diameter of all over symbol
Created in NX8.5.0.

License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::ArrowheadIncludedAngle ( )

Returns the arrowhead included angle
Created in NX3.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::ArrowheadLength ( )

Returns the arrowhead length
Created in NX3.0.0.



License requirements : None

bool NXOpen::Annotations::LineAndArrowPreferences::ClipOrdinateDimensionLine ( )

Returns the clipping of the dimension line to the ordinate origin at the view border
Created in NX10.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::DatumLengthPastArrow ( )

Returns the datum extension line past the arrow distance
Created in NX4.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::DotArrowheadDiameter ( )

Returns the dot arrowhead diameter
Created in NX3.0.0.



License requirements : None

NXOpen::Annotations::ArrowheadType NXOpen::Annotations::LineAndArrowPreferences::FirstArrowType ( )

Returns the first arrow type
Created in NX3.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::FirstPosToExtLineDist ( )

Returns the first position to extension line distance
Created in NX3.0.0.



License requirements : None

NXOpen::Annotations::LineCfw NXOpen::Annotations::LineAndArrowPreferences::GetFirstArrowheadCfw ( )

Returns the first arrowhead color, font, and width.

Returns

Created in NX3.0.0.

License requirements : None
NXOpen::Annotations::LineCfw NXOpen::Annotations::LineAndArrowPreferences::GetFirstArrowLineCfw ( )

Returns the first arrow line color, font, and width.

Returns

Created in NX3.0.0.

License requirements : None
NXOpen::Annotations::LineCfw NXOpen::Annotations::LineAndArrowPreferences::GetFirstExtensionLineCfw ( )

Returns the first extension line color, font, and width.

Returns

Created in NX3.0.0.

License requirements : None
NXOpen::Annotations::LineCfw NXOpen::Annotations::LineAndArrowPreferences::GetSecondArrowheadCfw ( )

Returns the second arrowhead color, font, and width.

Returns

Created in NX3.0.0.

License requirements : None
NXOpen::Annotations::LineCfw NXOpen::Annotations::LineAndArrowPreferences::GetSecondArrowLineCfw ( )

Returns the second arrow line color, font, and width.

Returns

Created in NX3.0.0.

License requirements : None
NXOpen::Annotations::LineCfw NXOpen::Annotations::LineAndArrowPreferences::GetSecondExtensionLineCfw ( )

Returns the second extension line color, font, and width.

Returns

Created in NX3.0.0.

License requirements : None
NXOpen::Annotations::VerticalTextJustification NXOpen::Annotations::LineAndArrowPreferences::LeaderLocation ( )

Returns the leader location
Created in NX3.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::LinePastArrowDistance ( )

Returns the line past arrow distance
Created in NX3.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::LinePastArrowDistance2 ( )

Returns the 2nd line past arrow distance
Created in NX9.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::ObliqueExtensionLineAngle ( )

Returns the oblique extension line angle
Created in NX3.0.0.



License requirements : None

NXOpen::Annotations::ArrowheadType NXOpen::Annotations::LineAndArrowPreferences::SecondArrowType ( )

Returns the second arrow type
Created in NX3.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::SecondPosToExtLineDist ( )

Returns the second position to extension line distance
Created in NX3.0.0.



License requirements : None

void NXOpen::Annotations::LineAndArrowPreferences::SetAllAroundSymbol ( double  allAroundSymbolSize)

Sets the size of all around symbol.

This is also used for inner diameter of all over symbol
Created in NX8.5.0.

License requirements : None

Parameters
allAroundSymbolSizeallaroundsymbolsize
void NXOpen::Annotations::LineAndArrowPreferences::SetArrowheadIncludedAngle ( double  arrowheadIncludedAngle)

Sets the arrowhead included angle
Created in NX3.0.0.



License requirements : None

Parameters
arrowheadIncludedAnglearrowhead included angle
void NXOpen::Annotations::LineAndArrowPreferences::SetArrowheadLength ( double  arrowheadLength)

Sets the arrowhead length
Created in NX3.0.0.



License requirements : None

Parameters
arrowheadLengtharrowhead length
void NXOpen::Annotations::LineAndArrowPreferences::SetClipOrdinateDimensionLine ( bool  clipOrdinateDimLine)

Sets the clipping of the dimension line to the ordinate origin at the view border
Created in NX10.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
clipOrdinateDimLineclipordinatedimline
void NXOpen::Annotations::LineAndArrowPreferences::SetDatumLengthPastArrow ( double  datumLengthPastArrow)

Sets the datum extension line past the arrow distance
Created in NX4.0.0.



License requirements : None

Parameters
datumLengthPastArrowdatum length past arrow
void NXOpen::Annotations::LineAndArrowPreferences::SetDotArrowheadDiameter ( double  dotArrowheadDiameter)

Sets the dot arrowhead diameter
Created in NX3.0.0.



License requirements : None

Parameters
dotArrowheadDiameterdot arrowhead diameter
void NXOpen::Annotations::LineAndArrowPreferences::SetFirstArrowheadCfw ( const NXOpen::Annotations::LineCfw firstArrowheadCfw)

Sets the first arrowhead color, font, and width
Created in NX3.0.0.



License requirements : None

Parameters
firstArrowheadCfwfirst arrowhead cfw
void NXOpen::Annotations::LineAndArrowPreferences::SetFirstArrowLineCfw ( const NXOpen::Annotations::LineCfw firstArrowLineCfw)

Sets the first arrow line color, font, and width
Created in NX3.0.0.



License requirements : None

Parameters
firstArrowLineCfwfirst arrow line cfw
void NXOpen::Annotations::LineAndArrowPreferences::SetFirstArrowType ( NXOpen::Annotations::ArrowheadType  firstArrowType)

Sets the first arrow type
Created in NX3.0.0.



License requirements : None

Parameters
firstArrowTypefirst arrow type
void NXOpen::Annotations::LineAndArrowPreferences::SetFirstExtensionLineCfw ( const NXOpen::Annotations::LineCfw firstExtensionLineCfw)

Sets the first extension line color, font, and width
Created in NX3.0.0.



License requirements : None

Parameters
firstExtensionLineCfwfirst extension line cfw
void NXOpen::Annotations::LineAndArrowPreferences::SetFirstPosToExtLineDist ( double  firstPosToExtensionLineDistance)

Sets the first position to extension line distance
Created in NX3.0.0.



License requirements : None

Parameters
firstPosToExtensionLineDistancefirst pos to extension line distance
void NXOpen::Annotations::LineAndArrowPreferences::SetLeaderLocation ( NXOpen::Annotations::VerticalTextJustification  leaderLocation)

Sets the leader location
Created in NX3.0.0.



License requirements : None

Parameters
leaderLocationleader location
void NXOpen::Annotations::LineAndArrowPreferences::SetLinePastArrowDistance ( double  linePastArrowDistance)

Sets the line past arrow distance
Created in NX3.0.0.



License requirements : None

Parameters
linePastArrowDistanceline past arrow distance
void NXOpen::Annotations::LineAndArrowPreferences::SetLinePastArrowDistance2 ( double  linePastArrowDistance)

Sets the 2nd line past arrow distance
Created in NX9.0.0.



License requirements : None

Parameters
linePastArrowDistanceline past arrow distance
void NXOpen::Annotations::LineAndArrowPreferences::SetObliqueExtensionLineAngle ( double  obliqueExtensionLineAngle)

Sets the oblique extension line angle
Created in NX3.0.0.



License requirements : None

Parameters
obliqueExtensionLineAngleoblique extension line angle
void NXOpen::Annotations::LineAndArrowPreferences::SetSecondArrowheadCfw ( const NXOpen::Annotations::LineCfw secondArrowheadCfw)

Sets the second arrowhead color, font, and width
Created in NX3.0.0.



License requirements : None

Parameters
secondArrowheadCfwsecond arrowhead cfw
void NXOpen::Annotations::LineAndArrowPreferences::SetSecondArrowLineCfw ( const NXOpen::Annotations::LineCfw secondArrowLineCfw)

Sets the second arrow line color, font, and width
Created in NX3.0.0.



License requirements : None

Parameters
secondArrowLineCfwsecond arrow line cfw
void NXOpen::Annotations::LineAndArrowPreferences::SetSecondArrowType ( NXOpen::Annotations::ArrowheadType  secondArrowType)

Sets the second arrow type
Created in NX3.0.0.



License requirements : None

Parameters
secondArrowTypesecond arrow type
void NXOpen::Annotations::LineAndArrowPreferences::SetSecondExtensionLineCfw ( const NXOpen::Annotations::LineCfw secondExtensionLineCfw)

Sets the second extension line color, font, and width
Created in NX3.0.0.



License requirements : None

Parameters
secondExtensionLineCfwsecond extension line cfw
void NXOpen::Annotations::LineAndArrowPreferences::SetSecondPosToExtLineDist ( double  secondPosToExtensionLineDistance)

Sets the second position to extension line distance
Created in NX3.0.0.



License requirements : None

Parameters
secondPosToExtensionLineDistancesecond pos to extension line distance
void NXOpen::Annotations::LineAndArrowPreferences::SetStubLength ( double  stubLength)

Sets the stub length
Created in NX3.0.0.



License requirements : None

Parameters
stubLengthstub length
void NXOpen::Annotations::LineAndArrowPreferences::SetTextOverLeaderGapFactor ( double  textOverLeaderGapFactor)

Sets the character size factor that controls the gap between text and the leader
Created in NX8.0.0.



License requirements : None

Parameters
textOverLeaderGapFactortext over leader gap factor
void NXOpen::Annotations::LineAndArrowPreferences::SetTextOverStubSpaceFactor ( double  textOverStubSpaceFactor)

Sets the text to stub spacing factor
Created in NX4.0.0.



License requirements : None

Parameters
textOverStubSpaceFactortext over stub space factor
void NXOpen::Annotations::LineAndArrowPreferences::SetTextToLineDistance ( double  textToLineDistance)

Sets the text to line distance
Created in NX3.0.0.



License requirements : None

Parameters
textToLineDistancetext to line distance
double NXOpen::Annotations::LineAndArrowPreferences::StubLength ( )

Returns the stub length
Created in NX3.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::TextOverLeaderGapFactor ( )

Returns the character size factor that controls the gap between text and the leader
Created in NX8.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::TextOverStubSpaceFactor ( )

Returns the text to stub spacing factor
Created in NX4.0.0.



License requirements : None

double NXOpen::Annotations::LineAndArrowPreferences::TextToLineDistance ( )

Returns the text to line distance
Created in NX3.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.