NX Open C++ Reference Guide
Public Member Functions
NXOpen::Annotations::OrdinateStyleBuilder Class Reference

Represents a Annotations::OrdinateStyleBuilder . More...

Inheritance diagram for NXOpen::Annotations::OrdinateStyleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Member Functions

bool AlignSymbolWithBaseline ()
 Returns the align symbol with baseline preference
Created in NX6.0.0.
NXOpen::Annotations::OrdinateLineArrowDisplayOption DisplayDimensionLine ()
 Returns the display dimension line preference for an ordinate set
Created in NX6.0.0.
NXOpen::Annotations::OrdinateOriginDisplayOption DisplayNameStyle ()
 Returns the name display style for an ordinate set
Created in NX6.0.0.
double DoglegAngle ()
 Returns the dogleg angle.
NXOpen::Annotations::OrdinateDoglegCreationOption DoglegCreationOption ()
 Returns the dogleg creation option
Created in NX6.0.0.
double DoglegEndOffset ()
 Returns the dogleg end offset.
NXOpen::Annotations::OrdinateDoglegDefinition DoglegSetting ()
 Returns the dogleg setting.
double DoglegStartOffset ()
 Returns the dogleg start offset.
double MarginFirstOffset ()
 Returns the distance from the baseline to the first margin.
double MarginSpacing ()
 Returns the interval distance between successive margins
Created in NX6.0.0.
int NumberOfMargins ()
 Returns the number of margins to create.
double OrdinateTextAngle ()
 Returns the ordinate text angle
Created in NX6.0.0.
NXOpen::Annotations::TextOrientation OrdinateTextOrientation ()
 Returns the ordinate text orientation
Created in NX6.0.0.
NXOpen::Annotations::OrdinatePositiveDirection PositiveDirection ()
 Returns the positive direction of measurement for an ordinate set
Created in NX6.0.0.
void SetAlignSymbolWithBaseline (bool alignSymbolWithBaseline)
 Sets the align symbol with baseline preference
Created in NX6.0.0.
void SetDisplayDimensionLine (NXOpen::Annotations::OrdinateLineArrowDisplayOption displayDimensionLine)
 Sets the display dimension line preference for an ordinate set
Created in NX6.0.0.
void SetDisplayNameStyle (NXOpen::Annotations::OrdinateOriginDisplayOption displayNameStyle)
 Sets the name display style for an ordinate set
Created in NX6.0.0.
void SetDoglegAngle (double doglegAngle)
 Sets the dogleg angle.
void SetDoglegCreationOption (NXOpen::Annotations::OrdinateDoglegCreationOption doglegCreationOption)
 Sets the dogleg creation option
Created in NX6.0.0.
void SetDoglegEndOffset (double doglegEndOffset)
 Sets the dogleg end offset.
void SetDoglegSetting (NXOpen::Annotations::OrdinateDoglegDefinition doglegSetting)
 Sets the dogleg setting.
void SetDoglegStartOffset (double doglegStartOffset)
 Sets the dogleg start offset.
void SetMarginFirstOffset (double marginFirstOffset)
 Sets the distance from the baseline to the first margin.
void SetMarginSpacing (double marginSpacing)
 Sets the interval distance between successive margins
Created in NX6.0.0.
void SetNumberOfMargins (int numberOfMargins)
 Sets the number of margins to create.
void SetOrdinateTextAngle (double ordinateTextAngle)
 Sets the ordinate text angle
Created in NX6.0.0.
void SetOrdinateTextOrientation (NXOpen::Annotations::TextOrientation ordinateTextOrientation)
 Sets the ordinate text orientation
Created in NX6.0.0.
void SetPositiveDirection (NXOpen::Annotations::OrdinatePositiveDirection positiveDirection)
 Sets the positive direction of measurement for an ordinate set
Created in NX6.0.0.
void SetSymbolAngle (double symbolAngle)
 Sets the symbol angle in degress with respect to the baseline.
void SetSymbolAspectRatio (double symbolAspectRatio)
 Sets the symbol aspect ratio
Created in NX6.0.0.
void SetSymbolHeight (double symbolHeight)
 Sets the symbol height
Created in NX6.0.0.
void SetSymbolLength (double symbolLength)
 Sets the symbol length
Created in NX6.0.0.
void SetSymbolScale (double symbolScale)
 Sets the symbol scale
Created in NX6.0.0.
void SetUserDefinedText (const NXString &userDefinedText)
 Sets the ordinate origin user defined text
Created in NX6.0.0.
double SymbolAngle ()
 Returns the symbol angle in degress with respect to the baseline.
double SymbolAspectRatio ()
 Returns the symbol aspect ratio
Created in NX6.0.0.
double SymbolHeight ()
 Returns the symbol height
Created in NX6.0.0.
double SymbolLength ()
 Returns the symbol length
Created in NX6.0.0.
double SymbolScale ()
 Returns the symbol scale
Created in NX6.0.0.
NXString UserDefinedText ()
 Returns the ordinate origin user defined text
Created in NX6.0.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Represents a Annotations::OrdinateStyleBuilder .

This class queries and sets ordinate specific preferences when creating or editing an ordinate set or ordinate dimension.


Created in NX6.0.0.


Member Function Documentation

Returns the align symbol with baseline preference
Created in NX6.0.0.



License requirements : None

Returns the display dimension line preference for an ordinate set
Created in NX6.0.0.



License requirements : None

Returns the name display style for an ordinate set
Created in NX6.0.0.



License requirements : None

Returns the dogleg angle.

The valid range is greater than zero and less than or equal to 90 degrees
Created in NX6.0.0.

License requirements : None

Returns the dogleg creation option
Created in NX6.0.0.



License requirements : None

Returns the dogleg end offset.

This is the offset between the dimension line and the end position of the dogleg. This value must be greater than or equal to zero and less than or equal to the start offset
Created in NX6.0.0.

License requirements : None

Returns the dogleg setting.

This specifies which options are used to specify the dogleg
Created in NX6.0.0.

License requirements : None

Returns the dogleg start offset.

This is the offset between the dimension line and the start position of the dogleg. The value must be greater than or equal to zero
Created in NX6.0.0.

License requirements : None

Returns the distance from the baseline to the first margin.

This can be a positive or negative number. The positive direction is away from the view's center
Created in NX6.0.0.

License requirements : None

Returns the interval distance between successive margins
Created in NX6.0.0.



License requirements : None

Returns the number of margins to create.

The maximum is 32
Created in NX6.0.0.

License requirements : None

Returns the ordinate text angle
Created in NX6.0.0.



License requirements : None

Returns the ordinate text orientation
Created in NX6.0.0.



License requirements : None

Returns the positive direction of measurement for an ordinate set
Created in NX6.0.0.



License requirements : None

Sets the align symbol with baseline preference
Created in NX6.0.0.



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

Parameters:
alignSymbolWithBaselinealignsymbolwithbaseline

Sets the display dimension line preference for an ordinate set
Created in NX6.0.0.



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

Parameters:
displayDimensionLinedisplaydimensionline

Sets the name display style for an ordinate set
Created in NX6.0.0.



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

Parameters:
displayNameStyledisplaynamestyle

Sets the dogleg angle.

The valid range is greater than zero and less than or equal to 90 degrees
Created in NX6.0.0.

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

Parameters:
doglegAngledoglegangle

Sets the dogleg creation option
Created in NX6.0.0.



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

Parameters:
doglegCreationOptiondoglegcreationoption

Sets the dogleg end offset.

This is the offset between the dimension line and the end position of the dogleg. This value must be greater than or equal to zero and less than or equal to the start offset
Created in NX6.0.0.

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

Parameters:
doglegEndOffsetdoglegendoffset

Sets the dogleg setting.

This specifies which options are used to specify the dogleg
Created in NX6.0.0.

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

Parameters:
doglegSettingdoglegsetting

Sets the dogleg start offset.

This is the offset between the dimension line and the start position of the dogleg. The value must be greater than or equal to zero
Created in NX6.0.0.

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

Parameters:
doglegStartOffsetdoglegstartoffset

Sets the distance from the baseline to the first margin.

This can be a positive or negative number. The positive direction is away from the view's center
Created in NX6.0.0.

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

Parameters:
marginFirstOffsetmarginfirstoffset

Sets the interval distance between successive margins
Created in NX6.0.0.



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

Parameters:
marginSpacingmarginspacing

Sets the number of margins to create.

The maximum is 32
Created in NX6.0.0.

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

Parameters:
numberOfMarginsnumberofmargins

Sets the ordinate text angle
Created in NX6.0.0.



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

Parameters:
ordinateTextAngleordinatetextangle

Sets the ordinate text orientation
Created in NX6.0.0.



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

Parameters:
ordinateTextOrientationordinatetextorientation

Sets the positive direction of measurement for an ordinate set
Created in NX6.0.0.



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

Parameters:
positiveDirectionpositivedirection

Sets the symbol angle in degress with respect to the baseline.

This option only applies if the name display style is User-Defined and the the value of the Align Symbol with Baseline preference is false
Created in NX6.0.0.

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

Parameters:
symbolAnglesymbolangle

Sets the symbol aspect ratio
Created in NX6.0.0.



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

Parameters:
symbolAspectRatiosymbolaspectratio

Sets the symbol height
Created in NX6.0.0.



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

Parameters:
symbolHeightsymbolheight

Sets the symbol length
Created in NX6.0.0.



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

Parameters:
symbolLengthsymbollength

Sets the symbol scale
Created in NX6.0.0.



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

Parameters:
symbolScalesymbolscale

Sets the ordinate origin user defined text
Created in NX6.0.0.



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

Parameters:
userDefinedTextuserdefinedtext

Returns the symbol angle in degress with respect to the baseline.

This option only applies if the name display style is User-Defined and the the value of the Align Symbol with Baseline preference is false
Created in NX6.0.0.

License requirements : None

Returns the symbol aspect ratio
Created in NX6.0.0.



License requirements : None

Returns the symbol height
Created in NX6.0.0.



License requirements : None

Returns the symbol length
Created in NX6.0.0.



License requirements : None

Returns the symbol scale
Created in NX6.0.0.



License requirements : None

Returns the ordinate origin user defined text
Created in NX6.0.0.



License requirements : None

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.