Annotation Class¶
-
class
NXOpen.Annotations.
Annotation
¶ Bases:
NXOpen.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 :py:meth:`Update.DoUpdate`().
This is an abstract class.
New in version NX3.0.0.
Properties¶
Property | Description |
---|---|
AnnotationOrigin | Returns or sets the origin (location) of the annotation. |
AnnotationPlane | Returns or sets the annotation plane. |
Color | Returns or sets the color of the object. |
HasAssociativeOrigin | Returns a flag indicating whether the origin is associative |
IsBlanked | Returns the blank status of this object. |
IsOccurrence | Returns whether this object is an occurrence or not. |
IsRetained | Returns a flag indicating whether the annotation is retained |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Layer | Returns or sets the layer that the object is in. |
LeaderOrientation | Returns or sets the leader orientation for the annotation. |
LineFont | Returns or sets the line font of the object. |
LineWidth | Returns or sets the line width of the object. |
Name | Returns the custom name of the object. |
NameLocation | Returns the location of the object’s name. |
NumberOfAssociativities | Returns the number of associativities for the annotation. |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
ParallelToScreen | Returns or sets the PMI parallel to screen setting |
Prototype | Returns the prototype of this object if it is an occurrence. |
Suppressed | Returns the flag indicating whether the annotation is suppressed |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Blank | Blanks the object. |
CreateAttributeIterator | Create an attribute iterator |
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAssociativeOrigin | Gets data that specifies the origin’s associativity |
GetAssociativity | Returns the associativity at specified index. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetInferredAnnotationPlane | Returns the inferred annotation plane |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetLetteringPreferences | Returns the lettering preferences for the annotation |
GetLineAndArrowPreferences | Returns the line and arrow preferences for the annotation |
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
GetRealAttribute | Gets a real attribute by title. |
GetRealUserAttribute | Gets a real attribute by Title and array Index. |
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetSymbolPreferences | Returns the symbol preferences for the annotation |
GetTimeAttribute | Gets a time attribute by title. |
GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator. |
GetUserAttributeLock | Determine the lock of the given attribute. |
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
GetViews | Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects. |
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
Highlight | Highlights the object. |
InsertIntoStack | Inserts the annotation into a stack. |
Prints a representation of this object to the system log file. | |
RedisplayObject | Redisplays the object in all views. |
RemoveFromStack | Removes the annotation from a stack. |
RemoveViewDependency | Remove dependency on all views from an object. |
SetAssociativeOrigin | Associates the annotation’s origin to the specified geometry. |
SetAssociativity | Sets the associativity at specified index. |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetLetteringPreferences | Sets the lettering preferences for the annotation. |
SetLineAndArrowPreferences | Sets the line and arrow preferences for the annotation. |
SetName | Sets the custom name of the object. |
SetNameLocation | Sets the location of the object’s name. |
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetSymbolPreferences | Sets the symbol preferences for the annotation. |
SetTimeAttribute | Creates or modifies a time attribute. |
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
SetUserAttributeLock | Lock or unlock the given attribute. |
SetViews | Sets the views that the PMI display instance object is displayed in. |
Unblank | Unblanks the object. |
Unhighlight | Unhighlights the object. |
Structs¶
AnnotationAssociativeOriginData_Struct Struct | Describes the geometry that an annotation’s origin is associated with |
Property Detail¶
AnnotationOrigin¶
-
Annotation.
AnnotationOrigin
¶ Returns or 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.
-------------------------------------
Getter Method
Signature
AnnotationOrigin
Returns: the location Return type: NXOpen.Point3d
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnnotationOrigin
Parameters: origin ( NXOpen.Point3d
) – the new locationNew in version NX3.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AnnotationPlane¶
-
Annotation.
AnnotationPlane
¶ Returns or 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.
-------------------------------------
Getter Method
Signature
AnnotationPlane
Returns: Return type: NXOpen.Xform
New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnnotationPlane
Parameters: annotationPlane ( NXOpen.Xform
) –New in version NX4.0.0.
License requirements: geometric_tol (“GDT”)
HasAssociativeOrigin¶
-
Annotation.
HasAssociativeOrigin
¶ Returns a flag indicating whether the origin is associative
-------------------------------------
Getter Method
Signature
HasAssociativeOrigin
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
IsOccurrence¶
-
Annotation.
IsOccurrence
¶ Returns whether this object is an occurrence or not.
-------------------------------------
Getter Method
Signature
IsOccurrence
Returns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
IsRetained¶
-
Annotation.
IsRetained
¶ Returns a flag indicating whether the annotation is retained
-------------------------------------
Getter Method
Signature
IsRetained
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
Annotation.
JournalIdentifier
¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------
Getter Method
Signature
JournalIdentifier
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
LeaderOrientation¶
-
Annotation.
LeaderOrientation
¶ Returns or 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.
-------------------------------------
Getter Method
Signature
LeaderOrientation
Returns: Return type: NXOpen.Annotations.LeaderOrientation
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LeaderOrientation
Parameters: leaderOrientation ( NXOpen.Annotations.LeaderOrientation
) –New in version NX3.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Name¶
-
Annotation.
Name
¶ Returns the custom name of the object.
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
NumberOfAssociativities¶
-
Annotation.
NumberOfAssociativities
¶ Returns the number of associativities for the annotation.
-------------------------------------
Getter Method
Signature
NumberOfAssociativities
Returns: Number of associativities Return type: int New in version NX4.0.0.
License requirements: None.
OwningComponent¶
-
Annotation.
OwningComponent
¶ Returns the owning component, if this object is an occurrence.
-------------------------------------
Getter Method
Signature
OwningComponent
Returns: Return type: NXOpen.Assemblies.Component
New in version NX3.0.0.
License requirements: None.
OwningPart¶
-
Annotation.
OwningPart
¶ Returns the owning part of this object
-------------------------------------
Getter Method
Signature
OwningPart
Returns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePart
New in version NX3.0.0.
License requirements: None.
ParallelToScreen¶
-
Annotation.
ParallelToScreen
¶ Returns or sets the PMI parallel to screen setting
-------------------------------------
Getter Method
Signature
ParallelToScreen
Returns: Parallel to Screen Setting Return type: bool New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
ParallelToScreen
Parameters: parallelToScreen (bool) – Parallel to Screen Setting New in version NX11.0.1.
License requirements: geometric_tol (“GDT”)
Prototype¶
-
Annotation.
Prototype
¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------
Getter Method
Signature
Prototype
Returns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
Annotation.
FindObject
¶ Finds the
NXOpen.NXObject
with the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)
Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
GetAssociativeOrigin¶
-
Annotation.
GetAssociativeOrigin
¶ Overloaded method GetAssociativeOrigin
GetAssociativeOrigin()
GetAssociativeOrigin()
-------------------------------------
Gets data that specifies the origin’s associativity
Signature
GetAssociativeOrigin()
Returns: a tuple Return type: A tuple consisting of (assocOrigin, origin). assocOrigin is a NXOpen.Annotations.AnnotationAssociativeOriginData_Struct
. associativity data origin is aNXOpen.Point3d
. coordinates of the originNew in version NX3.0.0.
License requirements: None.
-------------------------------------
GetAssociativity¶
-
Annotation.
GetAssociativity
¶ Returns the associativity at specified index.
The index starts from 1, and is less than or equal to the return value from
NXOpen.Annotations.Annotation.NumberOfAssociativities()
.Signature
GetAssociativity(associativityIndex)
Parameters: associativityIndex (int) – Associativity index Returns: Associativity object Return type: NXOpen.Annotations.Associativity
New in version NX4.0.0.
License requirements: None.
GetInferredAnnotationPlane¶
-
Annotation.
GetInferredAnnotationPlane
¶ Returns the inferred annotation plane
Signature
GetInferredAnnotationPlane(jaDefaultPlane)
Parameters: jaDefaultPlane ( NXOpen.Annotations.PmiDefaultPlane
) –Returns: Return type: NXOpen.Xform
New in version NX4.0.0.
License requirements: None.
GetLetteringPreferences¶
-
Annotation.
GetLetteringPreferences
¶ Returns the lettering preferences for the annotation
Signature
GetLetteringPreferences()
Returns: Return type: NXOpen.Annotations.LetteringPreferences
New in version NX3.0.0.
License requirements: None.
GetLineAndArrowPreferences¶
-
Annotation.
GetLineAndArrowPreferences
¶ Returns the line and arrow preferences for the annotation
Signature
GetLineAndArrowPreferences()
Returns: Return type: NXOpen.Annotations.LineAndArrowPreferences
New in version NX3.0.0.
License requirements: None.
GetSymbolPreferences¶
-
Annotation.
GetSymbolPreferences
¶ Returns the symbol preferences for the annotation
Signature
GetSymbolPreferences()
Returns: Return type: NXOpen.Annotations.SymbolPreferences
New in version NX5.0.0.
License requirements: None.
GetViews¶
-
Annotation.
GetViews
¶ 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.
Signature
GetViews()
Returns: List of views that PMI display instance object is displayed in Return type: list of NXOpen.View
New in version NX4.0.0.
License requirements: None.
InsertIntoStack¶
-
Annotation.
InsertIntoStack
¶ 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.
Signature
InsertIntoStack(stack, position)
Parameters: - stack (
NXOpen.Annotations.Annotation
) – Annotation in the stack - position (
NXOpen.Annotations.StackAlignmentPosition
) – Alignment position
New in version NX6.0.1.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
- stack (
Print¶
-
Annotation.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
RemoveFromStack¶
-
Annotation.
RemoveFromStack
¶ Removes the annotation from a stack.
Annotations that do not reside within a stack are ignored.
Signature
RemoveFromStack()
New in version NX11.0.1.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SetAssociativeOrigin¶
-
Annotation.
SetAssociativeOrigin
¶ 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.
Signature
SetAssociativeOrigin(assocOrigin, origin)
Parameters: - assocOrigin (
NXOpen.Annotations.AnnotationAssociativeOriginData_Struct
) – associativity data - origin (
NXOpen.Point3d
) – coordinates of the origin
New in version NX3.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
- assocOrigin (
SetAssociativity¶
-
Annotation.
SetAssociativity
¶ Sets the associativity at specified index.
The index starts from 1, and is less than or equal to the return value from
NXOpen.Annotations.Annotation.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.Signature
SetAssociativity(associativityIndex, associativity)
Parameters: - associativityIndex (int) – Associativity index
- associativity (
NXOpen.Annotations.Associativity
) – Associativity object
New in version NX4.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SetLetteringPreferences¶
-
Annotation.
SetLetteringPreferences
¶ 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.
Signature
SetLetteringPreferences(letteringPrefs)
Parameters: letteringPrefs ( NXOpen.Annotations.LetteringPreferences
) –New in version NX3.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SetLineAndArrowPreferences¶
-
Annotation.
SetLineAndArrowPreferences
¶ 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.
Signature
SetLineAndArrowPreferences(lineArrowPrefs)
Parameters: lineArrowPrefs ( NXOpen.Annotations.LineAndArrowPreferences
) –New in version NX3.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SetName¶
-
Annotation.
SetName
¶ Sets the custom name of the object.
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.
Signature
SetName(name)
Parameters: name (str) – New in version NX3.0.0.
License requirements: None.
SetSymbolPreferences¶
-
Annotation.
SetSymbolPreferences
¶ 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.
Signature
SetSymbolPreferences(symbolPrefs)
Parameters: symbolPrefs ( NXOpen.Annotations.SymbolPreferences
) –New in version NX5.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SetViews¶
-
Annotation.
SetViews
¶ 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.
Signature
SetViews(modelViews)
Parameters: modelViews (list of NXOpen.View
) – List of new views to display PMI display instance object inNew in version NX4.0.0.
License requirements: geometric_tol (“GDT”)