Represents ordinate dimension preferences
Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Annotations::OrdinateDimensionPreferences:

Public Member Functions
bool	AlignSymbolWithBaseline ()
	Returns the flag indicating whether to align the user defined symbol with the base line Created in NX4.0.0. More...

bool	DisplayZeroAtBaseline ()
	Returns the display zero at baseline flag. More...

double	DoglegAngle ()
	Returns the dogleg angle Created in NX4.0.0. More...

NXOpen::Annotations::OrdinateDoglegCreationOption	DoglegCreationOption ()
	Returns the dogleg creation option Created in NX4.0.0. More...

NXOpen::Annotations::OrdinateDoglegDefinition	DoglegDefinition ()
	Returns the dogleg definition Created in NX4.0.0. More...

double	DoglegEndOffset ()
	Returns the dogleg end offset Created in NX4.0.0. More...

double	DoglegStartOffset ()
	Returns the dogleg start offset Created in NX4.0.0. More...

double	FirstMarginOffset ()
	Returns the first margin offset Created in NX4.0.0. More...

NXOpen::Annotations::OrdinateLineArrowDisplayOption	LineArrowDisplayOption ()
	Returns the dimension line and arrow display option Created in NX4.0.0. More...

double	MarginSpacing ()
	Returns the spacing, the distance between margins Created in NX4.0.0. More...

double	NumberOfMargins ()
	Returns the number of margins Created in NX4.0.0. More...

NXOpen::Annotations::OrdinateOriginDisplayOption	OriginDisplay ()
	Returns the origin display option Created in NX4.0.0. More...

NXOpen::Annotations::OrdinatePositiveDirection	PositiveDirection ()
	Returns the positive direction Created in NX4.0.0. More...

void	SetAlignSymbolWithBaseline (bool alignSymbolWithBaseline)
	Sets the flag indicating whether to align the user defined symbol with the base line Created in NX4.0.0. More...

void	SetDisplayZeroAtBaseline (bool zeroTextsDisplay)
	Sets the display zero at baseline flag. More...

void	SetDoglegAngle (double doglegAngle)
	Sets the dogleg angle Created in NX4.0.0. More...

void	SetDoglegCreationOption (NXOpen::Annotations::OrdinateDoglegCreationOption option)
	Sets the dogleg creation option Created in NX4.0.0. More...

void	SetDoglegDefinition (NXOpen::Annotations::OrdinateDoglegDefinition definition)
	Sets the dogleg definition Created in NX4.0.0. More...

void	SetDoglegEndOffset (double doglegEndOffset)
	Sets the dogleg end offset Created in NX4.0.0. More...

void	SetDoglegStartOffset (double doglegStartOffset)
	Sets the dogleg start offset Created in NX4.0.0. More...

void	SetFirstMarginOffset (double firstMarginOffset)
	Sets the first margin offset Created in NX4.0.0. More...

void	SetLineArrowDisplayOption (NXOpen::Annotations::OrdinateLineArrowDisplayOption option)
	Sets the dimension line and arrow display option Created in NX4.0.0. More...

void	SetMarginSpacing (double marginSpacing)
	Sets the spacing, the distance between margins Created in NX4.0.0. More...

void	SetNumberOfMargins (double nMargins)
	Sets the number of margins Created in NX4.0.0. More...

void	SetOriginDisplay (NXOpen::Annotations::OrdinateOriginDisplayOption option)
	Sets the origin display option Created in NX4.0.0. More...

void	SetPositiveDirection (NXOpen::Annotations::OrdinatePositiveDirection option)
	Sets the positive direction Created in NX4.0.0. More...

void	SetSymbolAngle (double symbolAngle)
	Sets the user defined symbol angle with baseline, if the symbol is not aligned with the baseline Created in NX4.0.0. More...

void	SetSymbolAspectRatio (double symbolAspectRatio)
	Sets the user defined symbol aspect ratio Created in NX4.0.0. More...

void	SetSymbolHeight (double symbolHeight)
	Sets the user defined symbol height Created in NX4.0.0. More...

void	SetSymbolLength (double symbolLength)
	Sets the user defined symbol length Created in NX4.0.0. More...

void	SetSymbolScale (double symbolScale)
	Sets the user defined symbol scale Created in NX4.0.0. More...

void	SetTextOrientation (NXOpen::Annotations::TextOrientation orientation)
	Sets the text orientation Created in NX5.0.0. More...

void	SetTextOrientationAngle (double textOrientationAngle)
	Sets the angle if text orientation is NXOpen::Annotations::TextOrientationByAngle Created in NX5.0.0. More...

void	SetUserDefinedText (const NXString &userDefinedText)
	Sets the user defined text, if the user defined symbol option is used to display the origin Created in NX4.0.0. More...

void	SetUserDefinedText (const char *userDefinedText)
	Sets the user defined text, if the user defined symbol option is used to display the origin Created in NX4.0.0. More...

double	SymbolAngle ()
	Returns the user defined symbol angle with baseline, if the symbol is not aligned with the baseline Created in NX4.0.0. More...

double	SymbolAspectRatio ()
	Returns the user defined symbol aspect ratio Created in NX4.0.0. More...

double	SymbolHeight ()
	Returns the user defined symbol height Created in NX4.0.0. More...

double	SymbolLength ()
	Returns the user defined symbol length Created in NX4.0.0. More...

double	SymbolScale ()
	Returns the user defined symbol scale Created in NX4.0.0. More...

NXOpen::Annotations::TextOrientation	TextOrientation ()
	Returns the text orientation Created in NX5.0.0. More...

double	TextOrientationAngle ()
	Returns the angle if text orientation is NXOpen::Annotations::TextOrientationByAngle Created in NX5.0.0. More...

NXString	UserDefinedText ()
	Returns the user defined text, if the user defined symbol option is used to display the origin Created in NX4.0.0. More...

virtual	~OrdinateDimensionPreferences ()
	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 ordinate dimension preferences
Created in NX4.0.0.

Constructor & Destructor Documentation

virtual NXOpen::Annotations::OrdinateDimensionPreferences::~OrdinateDimensionPreferences ( )

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 NX4.0.0.

License requirements : None

Member Function Documentation

bool NXOpen::Annotations::OrdinateDimensionPreferences::AlignSymbolWithBaseline ( )

Returns the flag indicating whether to align the user defined symbol with the base line
Created in NX4.0.0.

License requirements : None

bool NXOpen::Annotations::OrdinateDimensionPreferences::DisplayZeroAtBaseline ( )

Returns the display zero at baseline flag.

If this is true, then ordinate set will have zero text displayed at extension lines.
Created in NX12.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::DoglegAngle ( )

Returns the dogleg angle
Created in NX4.0.0.

License requirements : None

NXOpen::Annotations::OrdinateDoglegCreationOption NXOpen::Annotations::OrdinateDimensionPreferences::DoglegCreationOption ( )

Returns the dogleg creation option
Created in NX4.0.0.

License requirements : None

NXOpen::Annotations::OrdinateDoglegDefinition NXOpen::Annotations::OrdinateDimensionPreferences::DoglegDefinition ( )

Returns the dogleg definition
Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::DoglegEndOffset ( )

Returns the dogleg end offset
Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::DoglegStartOffset ( )

Returns the dogleg start offset
Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::FirstMarginOffset ( )

Returns the first margin offset
Created in NX4.0.0.

License requirements : None

NXOpen::Annotations::OrdinateLineArrowDisplayOption NXOpen::Annotations::OrdinateDimensionPreferences::LineArrowDisplayOption ( )

Returns the dimension line and arrow display option
Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::MarginSpacing ( )

Returns the spacing, the distance between margins
Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::NumberOfMargins ( )

Returns the number of margins
Created in NX4.0.0.

License requirements : None

NXOpen::Annotations::OrdinateOriginDisplayOption NXOpen::Annotations::OrdinateDimensionPreferences::OriginDisplay ( )

Returns the origin display option
Created in NX4.0.0.

License requirements : None

NXOpen::Annotations::OrdinatePositiveDirection NXOpen::Annotations::OrdinateDimensionPreferences::PositiveDirection ( )

Returns the positive direction
Created in NX4.0.0.

License requirements : None

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

Sets the flag indicating whether to align the user defined symbol with the base line
Created in NX4.0.0.

License requirements : None

Parameters

alignSymbolWithBaseline Flag to align user defined symbol with base line

void NXOpen::Annotations::OrdinateDimensionPreferences::SetDisplayZeroAtBaseline ( bool zeroTextsDisplay )

Sets the display zero at baseline flag.

If this is true, then ordinate set will have zero text displayed at extension lines.
Created in NX12.0.0.

License requirements : None

Parameters

zeroTextsDisplay New Display Zero at Baseline flag

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

Sets the dogleg angle
Created in NX4.0.0.

License requirements : None

Parameters

doglegAngle New dogleg angle

void NXOpen::Annotations::OrdinateDimensionPreferences::SetDoglegCreationOption ( NXOpen::Annotations::OrdinateDoglegCreationOption option )

Sets the dogleg creation option
Created in NX4.0.0.

License requirements : None

Parameters

option New dogleg creation option

void NXOpen::Annotations::OrdinateDimensionPreferences::SetDoglegDefinition ( NXOpen::Annotations::OrdinateDoglegDefinition definition )

Sets the dogleg definition
Created in NX4.0.0.

License requirements : None

Parameters

definition New dogleg definition

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

Sets the dogleg end offset
Created in NX4.0.0.

License requirements : None

Parameters

doglegEndOffset New dogleg end offset

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

Sets the dogleg start offset
Created in NX4.0.0.

License requirements : None

Parameters

doglegStartOffset New dogleg start offset

void NXOpen::Annotations::OrdinateDimensionPreferences::SetFirstMarginOffset ( double firstMarginOffset )

Sets the first margin offset
Created in NX4.0.0.

License requirements : None

Parameters

firstMarginOffset New first margin offeset

void NXOpen::Annotations::OrdinateDimensionPreferences::SetLineArrowDisplayOption ( NXOpen::Annotations::OrdinateLineArrowDisplayOption option )

Sets the dimension line and arrow display option
Created in NX4.0.0.

License requirements : None

Parameters

option New dimension line and arrow display option

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

Sets the spacing, the distance between margins
Created in NX4.0.0.

License requirements : None

Parameters

marginSpacing New margin spacing

void NXOpen::Annotations::OrdinateDimensionPreferences::SetNumberOfMargins ( double nMargins )

Sets the number of margins
Created in NX4.0.0.

License requirements : None

Parameters

nMargins New number of margins

void NXOpen::Annotations::OrdinateDimensionPreferences::SetOriginDisplay ( NXOpen::Annotations::OrdinateOriginDisplayOption option )

Sets the origin display option
Created in NX4.0.0.

License requirements : None

Parameters

option New origin display option

void NXOpen::Annotations::OrdinateDimensionPreferences::SetPositiveDirection ( NXOpen::Annotations::OrdinatePositiveDirection option )

Sets the positive direction
Created in NX4.0.0.

License requirements : None

Parameters

option New postive direction

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

Sets the user defined symbol angle with baseline, if the symbol is not aligned with the baseline
Created in NX4.0.0.

License requirements : None

Parameters

symbolAngle New user defined symbol angle

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

Sets the user defined symbol aspect ratio
Created in NX4.0.0.

License requirements : None

Parameters

symbolAspectRatio New user defined symbol aspect ratio

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

Sets the user defined symbol height
Created in NX4.0.0.

License requirements : None

Parameters

symbolHeight New user defined symbol height

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

Sets the user defined symbol length
Created in NX4.0.0.

License requirements : None

Parameters

symbolLength New user defined symbol length

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

Sets the user defined symbol scale
Created in NX4.0.0.

License requirements : None

Parameters

symbolScale New user defiend symbol scale

void NXOpen::Annotations::OrdinateDimensionPreferences::SetTextOrientation ( NXOpen::Annotations::TextOrientation orientation )

Sets the text orientation
Created in NX5.0.0.

License requirements : None

Parameters

orientation New dimension text orientation

void NXOpen::Annotations::OrdinateDimensionPreferences::SetTextOrientationAngle ( double textOrientationAngle )

Sets the angle if text orientation is NXOpen::Annotations::TextOrientationByAngle
Created in NX5.0.0.

License requirements : None

Parameters

textOrientationAngle New dimension text orienation angle

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

Sets the user defined text, if the user defined symbol option is used to display the origin
Created in NX4.0.0.

License requirements : None

Parameters

userDefinedText New user defined text

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

Sets the user defined text, if the user defined symbol option is used to display the origin
Created in NX4.0.0.

License requirements : None

Parameters

userDefinedText New user defined text

double NXOpen::Annotations::OrdinateDimensionPreferences::SymbolAngle ( )

Returns the user defined symbol angle with baseline, if the symbol is not aligned with the baseline
Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::SymbolAspectRatio ( )

Returns the user defined symbol aspect ratio
Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::SymbolHeight ( )

Returns the user defined symbol height
Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::SymbolLength ( )

Returns the user defined symbol length
Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::SymbolScale ( )

Returns the user defined symbol scale
Created in NX4.0.0.

License requirements : None

NXOpen::Annotations::TextOrientation NXOpen::Annotations::OrdinateDimensionPreferences::TextOrientation ( )

Returns the text orientation
Created in NX5.0.0.

License requirements : None

double NXOpen::Annotations::OrdinateDimensionPreferences::TextOrientationAngle ( )

Returns the angle if text orientation is NXOpen::Annotations::TextOrientationByAngle
Created in NX5.0.0.

License requirements : None

NXString NXOpen::Annotations::OrdinateDimensionPreferences::UserDefinedText ( )

Returns the user defined text, if the user defined symbol option is used to display the origin
Created in NX4.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Annotations_OrdinateDimensionPreferences.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation