nxopen.annotations

Interface Annotation

All Superinterfaces:

DisplayableObject, IFitTo, INXObject, NXObject, Remote, TaggedObject

All Known Subinterfaces:

AngularDimension, ArbitraryTarget, ArcLengthDimension, AreaTarget, BalloonNote, BaseAngularDimension, BaseArcLengthDimension, BaseArrow, BaseBoltCircleCenterline, BaseCenterline3d, BaseCenterMark, BaseChamferDimension, BaseConcentricCircleDimension, BaseCustomSymbol, BaseCylindricalDimension, BaseDatum, BaseDatumTarget, BaseDiameterDimension, BaseFcf, BaseFoldedRadiusDimension, BaseFrameBar, BaseHoleDimension, BaseHorizontalDimension, BaselineDimension, BaseNote, BaseParallelDimension, BasePerpendicularDimension, BaseRadiusDimension, BaseSurfaceFinish, BaseVerticalDimension, BoltCircleCenterline, CaeLabel, CaeNote, Centerline, Centerline2d, Centerline3d, CenterMark, ChainDimension, ChamferDimension, CircleCenterline, CircularCenterline, CircularTarget, CompanyProprietaryInformation, ConcentricCircleDimension, CoordinateNote, CustomSymbol, CuttingPlaneSymbol, CylindricalDimension, Datum, DatumTarget, DiameterDimension, Dimension, DimensionSet, DraftingAid, DraftingArbitraryTarget, DraftingDatum, DraftingDatumTarget, DraftingFcf, DraftingImage, DraftingLineTarget, DraftingPointTarget, DraftingSurfaceFinish, EnterpriseIdentification, ExportControl, Fcf, FoldedRadiusDimension, FrameBar, Gdt, GeneralArcLengthDimension, GeneralChamferDimension, GeneralConcentricCircleDimension, GeneralCustomSymbol, GeneralCylindricalDimension, GeneralDiameterDimension, GeneralFoldedRadiusDimension, GeneralHoleDimension, GeneralHorizontalDimension, GeneralLabel, GeneralMajorAngularDimension, GeneralMinorAngularDimension, GeneralNote, GeneralParallelDimension, GeneralPerpendicularDimension, GeneralRadiusDimension, GeneralVerticalDimension, GenericNote, GovernmentSecurityInformation, Hatch, HoleDimension, HorizontalDimension, HorizontalOrdinateDimension, IdSymbol, IntersectionSymbol, Label, LineTarget, LineWeld, LocatorDesignator, MajorAngularDimension, MaterialSpecification, MinorAngularDimension, Note, NoteBase, OffsetCenterPoint, OrdinateDimension, OrdinateOriginDimension, ParallelDimension, PartIdentification, PerpendicularDimension, PmiAngularDimension, PmiArcLengthDimension, PmiAttribute, PmiBaselineDimension, PmiBoltCircleCenterline, PmiCenterline3d, PmiCenterMark, PmiChainDimension, PmiChamferDimension, PmiConcentricCircleDimension, PmiCustomSymbol, PmiCylindricalDimension, PmiDiameterDimension, PmiFoldedRadiusDimension, PmiHoleDimension, PmiHorizontalDimension, PmiHorizontalOrdinateDimension, PmiInteger, PmiLabel, PmiLineWeld, PmiMajorAngularDimension, PmiMinorAngularDimension, PmiNote, PmiNumber, PmiOrdinateOriginDimension, PmiParallelDimension, PmiPerpendicularDimension, PmiRadiusDimension, PmiString, PmiTableSection, PmiUrlNote, PmiUserDefined, PmiVerticalDimension, PmiVerticalOrdinateDimension, PmiWave, PointTarget, ProcessSpecification, RadiusDimension, RectangularTarget, Region, SimpleDraftingAid, SpecificNote, SurfaceFinish, SymmetricalCenterline, TableSection, TargetPoint, TitleBlock, VerticalDimension, VerticalOrdinateDimension, ViewingDirectionArrow, ViewingDirectionArrowLabel, Weld

public interface Annotation
extends DisplayableObject

Represents an annotation / PMI (Product and Manufacturing Information) display instance object.
Creation of drafting annotation objects is controlled by drafting license.

Creation of PMI display instance objects is controlled by geometric_tol license.

In all edit methods, the changes are not applied to the system until an update is performed. An update can be performed by calling Update.doUpdate(int) ().

This is an abstract class.

Created in NX3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Annotation.AssociativeOriginData Describes the geometry that an annotation's origin is associated with

Nested classes/interfaces inherited from interface nxopen.DisplayableObject

DisplayableObject.ObjectFont, DisplayableObject.ObjectWidth

Nested classes/interfaces inherited from interface nxopen.NXObject

NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData

Method Summary

Modifier and Type	Method and Description
Point3d	annotationOrigin() Returns the origin (location) of the annotation.
Xform	annotationPlane() Returns the annotation plane.
Annotation.AssociativeOriginData	getAssociativeOrigin() Gets data that specifies the origin's associativity License requirements: None.
Associativity	getAssociativity(int associativityIndex) Returns the associativity at specified index.
Xform	getInferredAnnotationPlane(PmiDefaultPlane jaDefaultPlane) Returns the inferred annotation plane License requirements: None.
LetteringPreferences	getLetteringPreferences() Returns the lettering preferences for the annotation License requirements: None.
LineAndArrowPreferences	getLineAndArrowPreferences() Returns the line and arrow preferences for the annotation License requirements: None.
SymbolPreferences	getSymbolPreferences() Returns the symbol preferences for the annotation License requirements: None.
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.
boolean	hasAssociativeOrigin() Returns a flag indicating whether the origin is associative License requirements: None.
void	insertIntoStack(Annotation stack, StackAlignmentPosition position) Inserts the annotation into a stack.
boolean	isRetained() Returns a flag indicating whether the annotation is retained License requirements: None.
LeaderOrientation	leaderOrientation() Returns the leader orientation for the annotation.
int	numberOfAssociativities() Returns the number of associativities for the annotation.
boolean	parallelToScreen() Returns the PMI parallel to screen setting License requirements: None.
void	removeFromStack() Removes the annotation from a stack.
void	setAnnotationOrigin(Point3d origin) Sets the origin (location) of the annotation.
void	setAnnotationPlane(Xform annotationPlane) Sets the annotation plane.
void	setAssociativeOrigin(Annotation.AssociativeOriginData assocOrigin, Point3d origin) Associates the annotation's origin to the specified geometry.
void	setAssociativity(int associativityIndex, Associativity associativity) Sets the associativity at specified index.The index starts from 1, and is less than or equal to the return value from numberOfAssociativities() .
void	setLeaderOrientation(LeaderOrientation leaderOrientation) Sets the leader orientation for the annotation.
void	setLetteringPreferences(LetteringPreferences letteringPrefs) Sets the lettering preferences for the annotation.
void	setLineAndArrowPreferences(LineAndArrowPreferences lineArrowPrefs) Sets the line and arrow preferences for the annotation.
void	setParallelToScreen(boolean parallelToScreen) Sets the PMI parallel to screen setting License requirements: geometric_tol ("GDT") .
void	setSymbolPreferences(SymbolPreferences symbolPrefs) Sets the symbol preferences for the annotation.
void	setViews(View[] modelViews) Sets the views that the PMI display instance object is displayed in.
boolean	suppressed() Returns the flag indicating whether the annotation is suppressed License requirements: None.

Methods inherited from interface nxopen.DisplayableObject

blank, color, highlight, isBlanked, layer, lineFont, lineWidth, nameLocation, redisplayObject, removeViewDependency, setColor, setLayer, setLineFont, setLineWidth, setNameLocation, unblank, unhighlight

Methods inherited from interface nxopen.NXObject

createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

setAnnotationOrigin

void setAnnotationOrigin(Point3d origin)
                  throws NXException,
                         RemoteException

Sets the origin (location) of the annotation. 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.
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Created in NX3.0.0

Parameters:

origin - the new location

Throws:

NXException

RemoteException

annotationOrigin

Point3d annotationOrigin()
                  throws NXException,
                         RemoteException

Returns the origin (location) of the annotation. 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.
License requirements: None.

Created in NX3.0.0

Returns:

the location

Throws:

NXException

RemoteException

hasAssociativeOrigin

boolean hasAssociativeOrigin()
                      throws NXException,
                             RemoteException

Returns a flag indicating whether the origin is associative
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

getAssociativeOrigin

Annotation.AssociativeOriginData getAssociativeOrigin()
                                               throws NXException,
                                                      RemoteException

Gets data that specifies the origin's associativity
License requirements: None.

Created in NX3.0.0

Returns:

associativity data

Throws:

NXException

RemoteException

setAssociativeOrigin

void setAssociativeOrigin(Annotation.AssociativeOriginData assocOrigin,
                          Point3d origin)
                   throws NXException,
                          RemoteException

Associates the annotation's origin to the specified geometry. 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.
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Created in NX3.0.0

Parameters:

assocOrigin - associativity data

origin - coordinates of the origin

Throws:

NXException

RemoteException

getLetteringPreferences

LetteringPreferences getLetteringPreferences()
                                      throws NXException,
                                             RemoteException

Returns the lettering preferences for the annotation
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setLetteringPreferences

void setLetteringPreferences(LetteringPreferences letteringPrefs)
                      throws NXException,
                             RemoteException

Sets the lettering preferences for the annotation. 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.
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Created in NX3.0.0

Parameters:

letteringPrefs -

Throws:

NXException

RemoteException

getLineAndArrowPreferences

LineAndArrowPreferences getLineAndArrowPreferences()
                                            throws NXException,
                                                   RemoteException

Returns the line and arrow preferences for the annotation
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setLineAndArrowPreferences

void setLineAndArrowPreferences(LineAndArrowPreferences lineArrowPrefs)
                         throws NXException,
                                RemoteException

Sets the line and arrow preferences for the annotation. 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.
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Created in NX3.0.0

Parameters:

lineArrowPrefs -

Throws:

NXException

RemoteException

getSymbolPreferences

SymbolPreferences getSymbolPreferences()
                                throws NXException,
                                       RemoteException

Returns the symbol preferences for the annotation
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setSymbolPreferences

void setSymbolPreferences(SymbolPreferences symbolPrefs)
                   throws NXException,
                          RemoteException

Sets the symbol preferences for the annotation. 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.
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Created in NX5.0.0

Parameters:

symbolPrefs -

Throws:

NXException

RemoteException

setLeaderOrientation

void setLeaderOrientation(LeaderOrientation leaderOrientation)
                   throws NXException,
                          RemoteException

Sets the leader orientation for the annotation. 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.
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Created in NX3.0.0

Parameters:

leaderOrientation -

Throws:

NXException

RemoteException

leaderOrientation

LeaderOrientation leaderOrientation()
                             throws NXException,
                                    RemoteException

Returns the leader orientation for the annotation. 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.
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

isRetained

boolean isRetained()
            throws NXException,
                   RemoteException

Returns a flag indicating whether the annotation is retained
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

annotationPlane

Xform annotationPlane()
               throws NXException,
                      RemoteException

Returns the annotation plane. 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.
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

setAnnotationPlane

void setAnnotationPlane(Xform annotationPlane)
                 throws NXException,
                        RemoteException

Sets the annotation plane. 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.
License requirements: geometric_tol ("GDT")

Created in NX4.0.0

Parameters:

annotationPlane -

Throws:

NXException

RemoteException

numberOfAssociativities

int numberOfAssociativities()
                     throws NXException,
                            RemoteException

Returns the number of associativities for the annotation.
License requirements: None.

Created in NX4.0.0

Returns:

Number of associativities

Throws:

NXException

RemoteException

getAssociativity

Associativity getAssociativity(int associativityIndex)
                        throws NXException,
                               RemoteException

Returns the associativity at specified index. The index starts from 1, and is less than or equal to the return value from numberOfAssociativities() .
License requirements: None.

Created in NX4.0.0

Parameters:

associativityIndex - Associativity index

Returns:

Associativity object

Throws:

NXException

RemoteException

setAssociativity

void setAssociativity(int associativityIndex,
                      Associativity associativity)
               throws NXException,
                      RemoteException

Sets the associativity at specified index.The index starts from 1, and is less than or equal to the return value from numberOfAssociativities() . 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.
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Created in NX4.0.0

Parameters:

associativityIndex - Associativity index

associativity - Associativity object

Throws:

NXException

RemoteException

getInferredAnnotationPlane

Xform getInferredAnnotationPlane(PmiDefaultPlane jaDefaultPlane)
                          throws NXException,
                                 RemoteException

Returns the inferred annotation plane
License requirements: None.

Created in NX4.0.0

Parameters:

jaDefaultPlane -

Throws:

NXException

RemoteException

getViews

View[] getViews()
         throws NXException,
                RemoteException

Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects. This method will return an empty view list for non-PMI display instance objects. This method will return an empty view list if the PMI object is displayed in all views.
License requirements: None.

Created in NX4.0.0

Returns:

List of views that PMI display instance object is displayed in

Throws:

NXException

RemoteException

setViews

void setViews(View[] modelViews)
       throws NXException,
              RemoteException

Sets the views that the PMI display instance object is displayed in. NOTE: This method is only valid for PMI display instance objects. 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.
License requirements: geometric_tol ("GDT")

Created in NX4.0.0

Parameters:

modelViews - List of new views to display PMI display instance object in

Throws:

NXException

RemoteException

insertIntoStack

void insertIntoStack(Annotation stack,
                     StackAlignmentPosition position)
              throws NXException,
                     RemoteException

Inserts the annotation into a stack. Annotations that already reside within a stack cannot be inserted into another stack (or the same stack) without first being removed from the stack they are in (attempting to do so will result in no changes to the annotation). The "position" parameter controls where in the stack the annotation will be inserted relative to the "stack" parameter. It is important to note that stacks have a primary column of members. Each member in the primary column can have up to three children (left, right, and below). If you stack an annotation above an existing stack member, the existing member becomes a child of the newly added member. The top most element in the primary column is the "owner" of the stack and all other annotations in the stack move relative to it. 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.
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Created in NX6.0.1

Parameters:

stack - Annotation in the stack

position - Alignment position

Throws:

NXException

RemoteException

parallelToScreen

boolean parallelToScreen()
                  throws NXException,
                         RemoteException

Returns the PMI parallel to screen setting
License requirements: None.

Created in NX11.0.1

Returns:

Parallel to Screen Setting

Throws:

NXException

RemoteException

setParallelToScreen

void setParallelToScreen(boolean parallelToScreen)
                  throws NXException,
                         RemoteException

Sets the PMI parallel to screen setting
License requirements: geometric_tol ("GDT")
.
Created in NX11.0.1

Parameters:

parallelToScreen - Parallel to Screen Setting

Throws:

NXException

RemoteException

removeFromStack

void removeFromStack()
              throws NXException,
                     RemoteException

Removes the annotation from a stack. Annotations that do not reside within a stack are ignored.
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Created in NX11.0.1

Throws:

NXException

RemoteException

suppressed

boolean suppressed()
            throws NXException,
                   RemoteException

Returns the flag indicating whether the annotation is suppressed
License requirements: None.

Created in NX12.0.0

Returns:

Suppression status of annotation

Throws:

NXException

RemoteException