Represents a dimension
Abstract class

Created in NX3.0.0. More...

Inheritance diagram for NXOpen::Annotations::Dimension:

Public Member Functions
double	ComputedSize ()
	Returns the computed size of the dimension.

virtual NXOpen::Annotations::AppendedText *	GetAppendedText ()
	Returns the appended text.

NXOpen::Annotations::DimensionPreferences *	GetDimensionPreferences ()
	Returns the dimension preferences.

void	GetDimensionText (std::vector< NXString > &mainTextLines, std::vector< NXString > &dualTextLines)
	Returns the dimension text - both the main text and the dual text.

NXOpen::Annotations::Associativity *	GetFirstAssociativity ()
	Returns the first associativity data.

NXOpen::Annotations::NarrowDimensionData	GetNarrowDimensionPreferences ()
	Returns the narrow dimension preferences for the given linear dimension.

double	GetNarrowDimensionTextOffset ()
	Returns the narrow dimension text offset for the given chain dimension.

NXOpen::Annotations::Associativity *	GetSecondAssociativity ()
	Returns the second associativity data.

bool	InspectionDimensionFlag ()
	Returns a setting to control the inspection box displayed around the dimension value.

bool	IsApproximate ()
	Returns whether or not the given dimension is approximate.

bool	IsDriving ()
	Determines if a dimension is driving.

bool	IsOriginCentered ()
	Returns a flag indicating whether the dimension text is centered equally between the extension lines.

NXOpen::Annotations::FitAnsiHoleType	LimitFitAnsiHoleType ()
	Returns the tolerance limit fit ANSI hole type.

NXString	LimitFitDeviation ()
	Returns the tolerance limit fit deviation.

NXOpen::Annotations::FitDisplayStyle	LimitFitDisplayStyle ()
	Returns the tolerance limit fit display style.

NXOpen::Annotations::FitAnsiHoleType	LimitFitEnhancedDisplayType ()
	Returns the enhanced limit fit display type.

int	LimitFitGrade ()
	Returns the tolerance limit fit grade.

NXString	LimitFitShaftDeviation ()
	Returns the deviation for limit fit representation of shaft tolerance.

int	LimitFitShaftGrade ()
	Returns the grade for limit fit representation of shaft tolerance.

double	LowerMetricToleranceValue ()
	Returns a setting to control the metric lower tolerance value of a dimension.

double	LowerToleranceValue ()
	Returns a setting to control the lower tolerance value of a dimension.

NXOpen::Direction *	MeasurementDirection ()
	Returns the measurement direction.

NXOpen::View *	MeasurementDirectionView ()
	Returns the measurement direction view.

int	MetricNominalDecimalPlaces ()
	Returns a setting to control the number of decimal places for the nominal value of a metric dimension.

int	MetricToleranceDecimalPlaces ()
	Returns a setting to control the number of decimal places for the metric tolerance value of a dimension.

int	NominalDecimalPlaces ()
	Returns a setting to control the number of decimal places for the nominal value of a dimension.

bool	ReferenceDimensionFlag ()
	Returns a setting to control the visibility of the reference parenthesis of a dimension.

virtual void	SetAppendedText (NXOpen::Annotations::AppendedText *appendedText)
	Sets the appended text Created in NX4.0.0.

void	SetComputedSize (double computedSize)


void	SetDimensionPreferences (NXOpen::Annotations::DimensionPreferences *preferences)
	Sets the dimension preferences Created in NX4.0.0.

void	SetDimensionText (std::vector< NXString > &mainTextLines)
	Set the main dimension text.

void	SetFirstAssociativity (NXOpen::Annotations::Associativity *newAssociativity)
	Sets the first associativity data.

void	SetInspectionDimensionFlag (bool inspectionDimensionFlag)
	Sets a setting to control the inspection box displayed around the dimension value.

void	SetLimitFitAnsiHoleType (NXOpen::Annotations::FitAnsiHoleType fitHoleType)
	Sets the tolerance limit fit ANSI hole type.

void	SetLimitFitDeviation (const NXString &fitDeviation)
	Sets the tolerance limit fit deviation.

void	SetLimitFitDeviation (const char *fitDeviation)
	Sets the tolerance limit fit deviation.

void	SetLimitFitDisplayStyle (NXOpen::Annotations::FitDisplayStyle fitDisplayStyle)
	Sets the tolerance limit fit display style.

void	SetLimitFitEnhancedDisplayType (NXOpen::Annotations::FitAnsiHoleType fitEnhancedDisplayType)
	Sets the enhanced limit fit display type.

void	SetLimitFitGrade (int fitGrade)
	Sets the tolerance limit fit grade.

void	SetLimitFitShaftDeviation (const NXString &fitShaftDeviation)
	Sets the deviation for limit fit representation of shaft tolerance.

void	SetLimitFitShaftDeviation (const char *fitShaftDeviation)
	Sets the deviation for limit fit representation of shaft tolerance.

void	SetLimitFitShaftGrade (int fitShaftGrade)
	Sets the grade for limit fit representation of shaft tolerance.

void	SetLowerMetricToleranceValue (double toleranceValue)
	Sets a setting to control the metric lower tolerance value of a dimension.

void	SetLowerToleranceValue (double upperToleranceValue)
	Sets a setting to control the lower tolerance value of a dimension.

void	SetMeasurementDirection (NXOpen::Direction *direction)
	Sets the measurement direction.

void	SetMeasurementDirectionView (NXOpen::View *view)
	Sets the measurement direction view.

void	SetMetricNominalDecimalPlaces (int decimalPlaces)
	Sets a setting to control the number of decimal places for the nominal value of a metric dimension.

void	SetMetricToleranceDecimalPlaces (int decimalPlaces)
	Sets a setting to control the number of decimal places for the metric tolerance value of a dimension.

void	SetNarrowDimensionPreferences (const NXOpen::Annotations::NarrowDimensionData &narrowDimensionData)
	Sets the narrow dimension preferences to the given linear dimension.

void	SetNarrowDimensionTextOffset (double narrowTextOffset)
	Sets the narrow dimension text offset for the given chain dimension.

void	SetNominalDecimalPlaces (int decimalPlaces)
	Sets a setting to control the number of decimal places for the nominal value of a dimension.

void	SetOriginCentered (bool isOriginCentered)
	Sets a flag indicating whether the dimension text is centered equally between the extension lines.

void	SetReferenceDimensionFlag (bool referenceDimensionFlag)
	Sets a setting to control the visibility of the reference parenthesis of a dimension.

void	SetSecondAssociativity (NXOpen::Annotations::Associativity *newAssociativity)
	Sets the second associativity data.

void	SetToleranceDecimalPlaces (int decimalPlaces)
	Sets a setting to control the number of decimal places for the primary tolerance value of a dimension.

void	SetToleranceType (NXOpen::Annotations::ToleranceType toleranceType)
	Sets a setting to control the tolerance display style.

void	SetUpperMetricToleranceValue (double toleranceValue)
	Sets a setting to control the metric upper tolerance value of a dimension.

void	SetUpperToleranceValue (double upperToleranceValue)
	Sets a setting to control the upper tolerance value of a dimension.

int	ToleranceDecimalPlaces ()
	Returns a setting to control the number of decimal places for the primary tolerance value of a dimension.

NXOpen::Annotations::ToleranceType	ToleranceType ()
	Returns a setting to control the tolerance display style.

double	UpperMetricToleranceValue ()
	Returns a setting to control the metric upper tolerance value of a dimension.

double	UpperToleranceValue ()
	Returns a setting to control the upper tolerance value of a dimension.

Public Member Functions inherited from NXOpen::Annotations::Annotation
NXOpen::Point3d	AnnotationOrigin ()
	Returns the origin (location) of the annotation.

NXOpen::Xform *	AnnotationPlane ()
	Returns the annotation plane.

NXOpen::Annotations::Annotation::AssociativeOriginData	GetAssociativeOrigin (NXOpen::Point3d *origin)
	Gets data that specifies the origin's associativity.

NXOpen::Annotations::Associativity *	GetAssociativity (int associativityIndex)
	Returns the associativity at specified index.

NXOpen::Xform *	GetInferredAnnotationPlane (NXOpen::Annotations::PmiDefaultPlane jaDefaultPlane)
	Returns the inferred annotation plane.

NXOpen::Annotations::LetteringPreferences *	GetLetteringPreferences ()
	Returns the lettering preferences for the annotation.

NXOpen::Annotations::LineAndArrowPreferences *	GetLineAndArrowPreferences ()
	Returns the line and arrow preferences for the annotation.

NXOpen::Annotations::SymbolPreferences *	GetSymbolPreferences ()
	Returns the symbol preferences for the annotation.

std::vector< NXOpen::View * >	GetViews ()
	Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects.

bool	HasAssociativeOrigin ()
	Returns a flag indicating whether the origin is associative Created in NX3.0.0.

void	InsertIntoStack (NXOpen::Annotations::Annotation *stack, NXOpen::Annotations::StackAlignmentPosition position)
	Inserts the annotation into a stack.

bool	IsRetained ()
	Returns a flag indicating whether the annotation is retained Created in NX3.0.0.

NXOpen::Annotations::LeaderOrientation	LeaderOrientation ()
	Returns the leader orientation for the annotation.

int	NumberOfAssociativities ()
	Returns the number of associativities for the annotation.

void	SetAnnotationOrigin (const NXOpen::Point3d &origin)
	Sets the origin (location) of the annotation.

void	SetAnnotationPlane (NXOpen::Xform *annotationPlane)
	Sets the annotation plane.

void	SetAssociativeOrigin (const NXOpen::Annotations::Annotation::AssociativeOriginData &assocOrigin, const NXOpen::Point3d &origin)
	Associates the annotation's origin to the specified geometry.

void	SetAssociativity (int associativityIndex, NXOpen::Annotations::Associativity *associativity)
	Sets the associativity at specified index.

void	SetLeaderOrientation (NXOpen::Annotations::LeaderOrientation leaderOrientation)
	Sets the leader orientation for the annotation.

void	SetLetteringPreferences (NXOpen::Annotations::LetteringPreferences *letteringPrefs)
	Sets the lettering preferences for the annotation.

void	SetLineAndArrowPreferences (NXOpen::Annotations::LineAndArrowPreferences *lineArrowPrefs)
	Sets the line and arrow preferences for the annotation.

void	SetSymbolPreferences (NXOpen::Annotations::SymbolPreferences *symbolPrefs)
	Sets the symbol preferences for the annotation.

void	SetViews (const std::vector< NXOpen::View * > &modelViews)
	Sets the views that the PMI display instance object is displayed in.

Public Member Functions inherited from NXOpen::DisplayableObject
void	Blank ()
	Blanks the object.

int	Color ()
	Returns the color of the object.

void	Highlight ()
	Highlights the object.

bool	IsBlanked ()
	Returns the blank status of this object.

int	Layer ()
	Returns the layer that the object is in.

NXOpen::DisplayableObject::ObjectFont	LineFont ()
	Returns the line font of the object.

NXOpen::DisplayableObject::ObjectWidth	LineWidth ()
	Returns the line width of the object.

NXOpen::Point3d	NameLocation ()
	Returns the location of the object's name.

void	RedisplayObject ()
	Redisplays the object in all views.

void	SetColor (int color)
	Sets the color of the object.

void	SetLayer (int layer)
	Sets the layer that the object is in.

void	SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
	Sets the line font of the object.

void	SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
	Sets the line width of the object.

void	SetNameLocation (const NXOpen::Point3d &location)
	Sets the location of the object's name.

void	Unblank ()
	Unblanks the object.

void	Unhighlight ()
	Unhighlights the object.

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type.

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not.

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type.

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index.

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title.

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title.

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index.

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title.

double	GetRealAttribute (const char *title)
	Gets a real attribute by title.

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index.

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title.

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title.

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title.

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index.

NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index.

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes that have been set on the given object.

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object.

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes.

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not.

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object.

virtual NXString	Name ()
	Returns the custom name of the object.

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence.

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0.

virtual void	Print ()
	Prints a representation of this object to the system log file.

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence.

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute.

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute.

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

virtual void	SetName (const NXString &name)
	Sets the custom name of the object.

void	SetName (const char *name)
	Sets the custom name of the object.

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const char title, const char value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetReferenceAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

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.

Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

void	SetName (const char *name)
	Sets the custom name of the object.

Additional Inherited Members
Public Types inherited from NXOpen::DisplayableObject
enum	ObjectFont { ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline, ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed }
	specifies the object font for objects such as lines Created in NX3.0.0. More...

enum	ObjectWidth { ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5, ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive, ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine }
	specifies object width for objects such as lines and text Created in NX3.0.0. More...

Detailed Description

Represents a dimension
Abstract class

Created in NX3.0.0.

Member Function Documentation

double NXOpen::Annotations::Dimension::ComputedSize ( )

Returns the computed size of the dimension.

Created in NX5.0.0.

License requirements : None

virtual NXOpen::Annotations::AppendedText* NXOpen::Annotations::Dimension::GetAppendedText ( )

virtual

Returns the appended text.

Returns: Appended text
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IAppendedText.

NXOpen::Annotations::DimensionPreferences* NXOpen::Annotations::Dimension::GetDimensionPreferences ( )

Returns the dimension preferences.

Returns: Dimenension preferences
Created in NX4.0.0.

License requirements : None

void NXOpen::Annotations::Dimension::GetDimensionText	(	std::vector< NXString > &	mainTextLines,
		std::vector< NXString > &	dualTextLines
	)

Returns the dimension text - both the main text and the dual text.

The returned text may contain just the computed dimension value or manual text including the control characters.
Note that the text doesn't contain the tolerance text, appended text or text for flags like inspection/reference.

Created in NX6.0.0.

License requirements : None

Parameters

mainTextLines	List of main text lines
dualTextLines	List of dual text lines

NXOpen::Annotations::Associativity* NXOpen::Annotations::Dimension::GetFirstAssociativity ( )

Returns the first associativity data.

Returns: Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::NarrowDimensionData NXOpen::Annotations::Dimension::GetNarrowDimensionPreferences ( )

Returns the narrow dimension preferences for the given linear dimension.

Returns: Narrow dimension preferences
Created in NX5.0.0.

License requirements : None

double NXOpen::Annotations::Dimension::GetNarrowDimensionTextOffset ( )

Returns the narrow dimension text offset for the given chain dimension.

Returns: Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::Associativity* NXOpen::Annotations::Dimension::GetSecondAssociativity ( )

Returns the second associativity data.

Returns: Created in NX5.0.0.

License requirements : None

bool NXOpen::Annotations::Dimension::InspectionDimensionFlag ( )

Returns a setting to control the inspection box displayed around the dimension value.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

bool NXOpen::Annotations::Dimension::IsApproximate ( )

Returns whether or not the given dimension is approximate.

A dimension is approximate if it is attached to lightweight view geometry that doesn't have exact data.

Returns: TRUE, if dimension is approximate. FALSE, if dimension is not approximate.
Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::Dimension::IsDriving ( )

Determines if a dimension is driving.

A driving dimension is a dimension that is used to constrain geometry created by the sketcher on a drawing. A driving dimension is also referred to as a sketch dimension.

Returns: Created in NX6.0.0.

License requirements : None

bool NXOpen::Annotations::Dimension::IsOriginCentered ( )

Returns a flag indicating whether the dimension text is centered equally between the extension lines.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::FitAnsiHoleType NXOpen::Annotations::Dimension::LimitFitAnsiHoleType ( )

Returns the tolerance limit fit ANSI hole type.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::Dimension::LimitFitDeviation ( )

Returns the tolerance limit fit deviation.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::FitDisplayStyle NXOpen::Annotations::Dimension::LimitFitDisplayStyle ( )

Returns the tolerance limit fit display style.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::FitAnsiHoleType NXOpen::Annotations::Dimension::LimitFitEnhancedDisplayType ( )

Returns the enhanced limit fit display type.

Used to determine if the tolerance representation is for hole, shaft, or fit tolerance (fit meaning both hole and shaft tolerances are displayed).

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX9.0.0.

License requirements : None

int NXOpen::Annotations::Dimension::LimitFitGrade ( )

Returns the tolerance limit fit grade.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::Dimension::LimitFitShaftDeviation ( )

Returns the deviation for limit fit representation of shaft tolerance.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX9.0.0.

License requirements : None

int NXOpen::Annotations::Dimension::LimitFitShaftGrade ( )

Returns the grade for limit fit representation of shaft tolerance.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX9.0.0.

License requirements : None

double NXOpen::Annotations::Dimension::LowerMetricToleranceValue ( )

Returns a setting to control the metric lower tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

double NXOpen::Annotations::Dimension::LowerToleranceValue ( )

Returns a setting to control the lower tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Annotations::Dimension::MeasurementDirection ( )

Returns the measurement direction.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

License requirements : None

NXOpen::View* NXOpen::Annotations::Dimension::MeasurementDirectionView ( )

Returns the measurement direction view.

       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

License requirements : None

int NXOpen::Annotations::Dimension::MetricNominalDecimalPlaces ( )

Returns a setting to control the number of decimal places for the nominal value of a metric dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

int NXOpen::Annotations::Dimension::MetricToleranceDecimalPlaces ( )

Returns a setting to control the number of decimal places for the metric tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

int NXOpen::Annotations::Dimension::NominalDecimalPlaces ( )

Returns a setting to control the number of decimal places for the nominal value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

bool NXOpen::Annotations::Dimension::ReferenceDimensionFlag ( )

Returns a setting to control the visibility of the reference parenthesis of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

virtual void NXOpen::Annotations::Dimension::SetAppendedText ( NXOpen::Annotations::AppendedText * appendedText )

virtual

Sets the appended text
Created in NX4.0.0.

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

Parameters

appendedText Appended text

Implements NXOpen::Annotations::IAppendedText.

void NXOpen::Annotations::Dimension::SetComputedSize ( double computedSize )

Deprecated:: Deprecated in NX8.0.0.

Use Annotations::Dimension::SetDimensionText instead.

Created in NX5.0.0.

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

Parameters

computedSize computed size

void NXOpen::Annotations::Dimension::SetDimensionPreferences ( NXOpen::Annotations::DimensionPreferences * preferences )

Sets the dimension preferences
Created in NX4.0.0.

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

Parameters

preferences New dimension preferences

void NXOpen::Annotations::Dimension::SetDimensionText ( std::vector< NXString > & mainTextLines )

Set the main dimension text.

        For a dual dimension, the dual dimension text is determined from the main dimension text

Created in NX7.5.0.

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

Parameters

mainTextLines List of main text lines

void NXOpen::Annotations::Dimension::SetFirstAssociativity ( NXOpen::Annotations::Associativity * newAssociativity )

Sets the first associativity data.

Created in NX5.0.0.

License requirements : None

Parameters

newAssociativity new associativity

void NXOpen::Annotations::Dimension::SetInspectionDimensionFlag ( bool inspectionDimensionFlag )

Sets a setting to control the inspection box displayed around the dimension value.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

inspectionDimensionFlag inspection dimension flag

void NXOpen::Annotations::Dimension::SetLimitFitAnsiHoleType ( NXOpen::Annotations::FitAnsiHoleType fitHoleType )

Sets the tolerance limit fit ANSI hole type.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

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

Parameters

fitHoleType New limit fit ansi hole type

void NXOpen::Annotations::Dimension::SetLimitFitDeviation ( const NXString & fitDeviation )

Sets the tolerance limit fit deviation.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

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

Parameters

fitDeviation New limit fit deviation

void NXOpen::Annotations::Dimension::SetLimitFitDeviation ( const char * fitDeviation )

Sets the tolerance limit fit deviation.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

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

Parameters

fitDeviation New limit fit deviation

void NXOpen::Annotations::Dimension::SetLimitFitDisplayStyle ( NXOpen::Annotations::FitDisplayStyle fitDisplayStyle )

Sets the tolerance limit fit display style.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

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

Parameters

fitDisplayStyle New limit fit tolerance display style

void NXOpen::Annotations::Dimension::SetLimitFitEnhancedDisplayType ( NXOpen::Annotations::FitAnsiHoleType fitEnhancedDisplayType )

Sets the enhanced limit fit display type.

Used to determine if the tolerance representation is for hole, shaft, or fit tolerance (fit meaning both hole and shaft tolerances are displayed).

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX9.0.0.

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

Parameters

fitEnhancedDisplayType New limit fit enhanced tolerance display style

void NXOpen::Annotations::Dimension::SetLimitFitGrade ( int fitGrade )

Sets the tolerance limit fit grade.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

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

Parameters

fitGrade New limit fit grade

void NXOpen::Annotations::Dimension::SetLimitFitShaftDeviation ( const NXString & fitShaftDeviation )

Sets the deviation for limit fit representation of shaft tolerance.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX9.0.0.

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

Parameters

fitShaftDeviation New limit fit shaft deviation

void NXOpen::Annotations::Dimension::SetLimitFitShaftDeviation ( const char * fitShaftDeviation )

Sets the deviation for limit fit representation of shaft tolerance.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX9.0.0.

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

Parameters

fitShaftDeviation New limit fit shaft deviation

void NXOpen::Annotations::Dimension::SetLimitFitShaftGrade ( int fitShaftGrade )

Sets the grade for limit fit representation of shaft tolerance.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX9.0.0.

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

Parameters

fitShaftGrade New limit fit shaft grade

void NXOpen::Annotations::Dimension::SetLowerMetricToleranceValue ( double toleranceValue )

Sets a setting to control the metric lower tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

toleranceValue tolerance value

void NXOpen::Annotations::Dimension::SetLowerToleranceValue ( double upperToleranceValue )

Sets a setting to control the lower tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

upperToleranceValue upper tolerance value

void NXOpen::Annotations::Dimension::SetMeasurementDirection ( NXOpen::Direction * direction )

Sets the measurement direction.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

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

Parameters

direction Direction Object

void NXOpen::Annotations::Dimension::SetMeasurementDirectionView ( NXOpen::View * view )

Sets the measurement direction view.

       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX7.5.0.

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

Parameters

view	View Object

void NXOpen::Annotations::Dimension::SetMetricNominalDecimalPlaces ( int decimalPlaces )

Sets a setting to control the number of decimal places for the nominal value of a metric dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

decimalPlaces decimal places

void NXOpen::Annotations::Dimension::SetMetricToleranceDecimalPlaces ( int decimalPlaces )

Sets a setting to control the number of decimal places for the metric tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

decimalPlaces decimal places

void NXOpen::Annotations::Dimension::SetNarrowDimensionPreferences ( const NXOpen::Annotations::NarrowDimensionData & narrowDimensionData )

Sets the narrow dimension preferences to the given linear dimension.

Created in NX5.0.0.

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

Parameters

narrowDimensionData New narrow dimension preferences

void NXOpen::Annotations::Dimension::SetNarrowDimensionTextOffset ( double narrowTextOffset )

Sets the narrow dimension text offset for the given chain dimension.

Created in NX5.0.0.

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

Parameters

narrowTextOffset narrow text offset

void NXOpen::Annotations::Dimension::SetNominalDecimalPlaces ( int decimalPlaces )

Sets a setting to control the number of decimal places for the nominal value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

decimalPlaces decimal places

void NXOpen::Annotations::Dimension::SetOriginCentered ( bool isOriginCentered )

Sets a flag indicating whether the dimension text is centered equally between the extension lines.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

isOriginCentered is origin centered

void NXOpen::Annotations::Dimension::SetReferenceDimensionFlag ( bool referenceDimensionFlag )

Sets a setting to control the visibility of the reference parenthesis of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

referenceDimensionFlag reference dimension flag

void NXOpen::Annotations::Dimension::SetSecondAssociativity ( NXOpen::Annotations::Associativity * newAssociativity )

Sets the second associativity data.

Created in NX5.0.0.

License requirements : None

Parameters

newAssociativity new associativity

void NXOpen::Annotations::Dimension::SetToleranceDecimalPlaces ( int decimalPlaces )

Sets a setting to control the number of decimal places for the primary tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

decimalPlaces decimal places

void NXOpen::Annotations::Dimension::SetToleranceType ( NXOpen::Annotations::ToleranceType toleranceType )

Sets a setting to control the tolerance display style.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

toleranceType tolerance type

void NXOpen::Annotations::Dimension::SetUpperMetricToleranceValue ( double toleranceValue )

Sets a setting to control the metric upper tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

toleranceValue tolerance value

void NXOpen::Annotations::Dimension::SetUpperToleranceValue ( double upperToleranceValue )

Sets a setting to control the upper tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

upperToleranceValue upper tolerance value

int NXOpen::Annotations::Dimension::ToleranceDecimalPlaces ( )

Returns a setting to control the number of decimal places for the primary tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::ToleranceType NXOpen::Annotations::Dimension::ToleranceType ( )

Returns a setting to control the tolerance display style.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

double NXOpen::Annotations::Dimension::UpperMetricToleranceValue ( )

Returns a setting to control the metric upper tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

double NXOpen::Annotations::Dimension::UpperToleranceValue ( )

Returns a setting to control the upper tolerance value of a dimension.

       NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

License requirements : None

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

Annotations_Dimension.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation