Represents a Annotations::OrdinateStyleBuilder . More...

Inheritance diagram for NXOpen::Annotations::OrdinateStyleBuilder:

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.

void	SetUserDefinedText (const char *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.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

bool NXOpen::Annotations::OrdinateStyleBuilder::AlignSymbolWithBaseline ( )

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

License requirements : None

NXOpen::Annotations::OrdinateLineArrowDisplayOption NXOpen::Annotations::OrdinateStyleBuilder::DisplayDimensionLine ( )

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

License requirements : None

NXOpen::Annotations::OrdinateOriginDisplayOption NXOpen::Annotations::OrdinateStyleBuilder::DisplayNameStyle ( )

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

License requirements : None

double NXOpen::Annotations::OrdinateStyleBuilder::DoglegAngle ( )

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

NXOpen::Annotations::OrdinateDoglegCreationOption NXOpen::Annotations::OrdinateStyleBuilder::DoglegCreationOption ( )

Returns the dogleg creation option
Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateStyleBuilder::DoglegEndOffset ( )

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

NXOpen::Annotations::OrdinateDoglegDefinition NXOpen::Annotations::OrdinateStyleBuilder::DoglegSetting ( )

Returns the dogleg setting.

       This specifies which options are used to specify the dogleg

Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateStyleBuilder::DoglegStartOffset ( )

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

double NXOpen::Annotations::OrdinateStyleBuilder::MarginFirstOffset ( )

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

double NXOpen::Annotations::OrdinateStyleBuilder::MarginSpacing ( )

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

License requirements : None

int NXOpen::Annotations::OrdinateStyleBuilder::NumberOfMargins ( )

Returns the number of margins to create.

       The maximum is 32

Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateStyleBuilder::OrdinateTextAngle ( )

Returns the ordinate text angle
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::TextOrientation NXOpen::Annotations::OrdinateStyleBuilder::OrdinateTextOrientation ( )

Returns the ordinate text orientation
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::OrdinatePositiveDirection NXOpen::Annotations::OrdinateStyleBuilder::PositiveDirection ( )

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

License requirements : None

void NXOpen::Annotations::OrdinateStyleBuilder::SetAlignSymbolWithBaseline ( bool alignSymbolWithBaseline )

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

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

Parameters

alignSymbolWithBaseline alignsymbolwithbaseline

void NXOpen::Annotations::OrdinateStyleBuilder::SetDisplayDimensionLine ( NXOpen::Annotations::OrdinateLineArrowDisplayOption displayDimensionLine )

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

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

Parameters

displayDimensionLine displaydimensionline

void NXOpen::Annotations::OrdinateStyleBuilder::SetDisplayNameStyle ( NXOpen::Annotations::OrdinateOriginDisplayOption displayNameStyle )

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

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

Parameters

displayNameStyle displaynamestyle

void NXOpen::Annotations::OrdinateStyleBuilder::SetDoglegAngle ( double doglegAngle )

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

doglegAngle doglegangle

void NXOpen::Annotations::OrdinateStyleBuilder::SetDoglegCreationOption ( NXOpen::Annotations::OrdinateDoglegCreationOption doglegCreationOption )

Sets the dogleg creation option
Created in NX6.0.0.

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

Parameters

doglegCreationOption doglegcreationoption

void NXOpen::Annotations::OrdinateStyleBuilder::SetDoglegEndOffset ( double doglegEndOffset )

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

doglegEndOffset doglegendoffset

void NXOpen::Annotations::OrdinateStyleBuilder::SetDoglegSetting ( NXOpen::Annotations::OrdinateDoglegDefinition doglegSetting )

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

doglegSetting doglegsetting

void NXOpen::Annotations::OrdinateStyleBuilder::SetDoglegStartOffset ( double doglegStartOffset )

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

doglegStartOffset doglegstartoffset

void NXOpen::Annotations::OrdinateStyleBuilder::SetMarginFirstOffset ( double marginFirstOffset )

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

marginFirstOffset marginfirstoffset

void NXOpen::Annotations::OrdinateStyleBuilder::SetMarginSpacing ( double marginSpacing )

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

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

Parameters

marginSpacing marginspacing

void NXOpen::Annotations::OrdinateStyleBuilder::SetNumberOfMargins ( int numberOfMargins )

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

numberOfMargins numberofmargins

void NXOpen::Annotations::OrdinateStyleBuilder::SetOrdinateTextAngle ( double ordinateTextAngle )

Sets the ordinate text angle
Created in NX6.0.0.

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

Parameters

ordinateTextAngle ordinatetextangle

void NXOpen::Annotations::OrdinateStyleBuilder::SetOrdinateTextOrientation ( NXOpen::Annotations::TextOrientation ordinateTextOrientation )

Sets the ordinate text orientation
Created in NX6.0.0.

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

Parameters

ordinateTextOrientation ordinatetextorientation

void NXOpen::Annotations::OrdinateStyleBuilder::SetPositiveDirection ( NXOpen::Annotations::OrdinatePositiveDirection positiveDirection )

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

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

Parameters

positiveDirection positivedirection

void NXOpen::Annotations::OrdinateStyleBuilder::SetSymbolAngle ( double symbolAngle )

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

symbolAngle symbolangle

void NXOpen::Annotations::OrdinateStyleBuilder::SetSymbolAspectRatio ( double symbolAspectRatio )

Sets the symbol aspect ratio
Created in NX6.0.0.

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

Parameters

symbolAspectRatio symbolaspectratio

void NXOpen::Annotations::OrdinateStyleBuilder::SetSymbolHeight ( double symbolHeight )

Sets the symbol height
Created in NX6.0.0.

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

Parameters

symbolHeight symbolheight

void NXOpen::Annotations::OrdinateStyleBuilder::SetSymbolLength ( double symbolLength )

Sets the symbol length
Created in NX6.0.0.

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

Parameters

symbolLength symbollength

void NXOpen::Annotations::OrdinateStyleBuilder::SetSymbolScale ( double symbolScale )

Sets the symbol scale
Created in NX6.0.0.

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

Parameters

symbolScale symbolscale

void NXOpen::Annotations::OrdinateStyleBuilder::SetUserDefinedText ( const NXString & userDefinedText )

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

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

Parameters

userDefinedText userdefinedtext

void NXOpen::Annotations::OrdinateStyleBuilder::SetUserDefinedText ( const char * userDefinedText )

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

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

Parameters

userDefinedText userdefinedtext

double NXOpen::Annotations::OrdinateStyleBuilder::SymbolAngle ( )

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

double NXOpen::Annotations::OrdinateStyleBuilder::SymbolAspectRatio ( )

Returns the symbol aspect ratio
Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateStyleBuilder::SymbolHeight ( )

Returns the symbol height
Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateStyleBuilder::SymbolLength ( )

Returns the symbol length
Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateStyleBuilder::SymbolScale ( )

Returns the symbol scale
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Annotations::OrdinateStyleBuilder::UserDefinedText ( )

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

License requirements : None

virtual bool NXOpen::Annotations::OrdinateStyleBuilder::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:

Annotations_OrdinateStyleBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation