Accessing Annotation Elements
The following functions provide access to the properties of an annotation element.
Functions Introduced:
The function
ProAnnotationelemAnnotationGet() returns the annotation contained in an annotation element.
The function
ProAnnotationelemCopyGet() returns the copy flag of the annotation elements. This property is not supported for elements in data sharing features.
The function
ProAnnotationelemFeatureGet() returns the feature that owns the annotation element.
The function
ProAnnotationelemIsDependent() returns the value of the dependency flag for the annotation element. This property is supported only for the elements in data sharing features.
The function
ProAnnotationelemIsIncomplete() returns a true value if the annotation element has missing strong references.
The function
ProAnnotationelemReferencesCollect() returns an array of references contained in the specified annotation element. The input arguments for this function are:
• element—Specifies the annotation element.
• ref_type—Specifies the type of references and can have one of the following values:
◦ PRO_ANNOTATION_REF_ALL—All references
◦ PRO_ANNOTATION_REF_WEAK—Weak references
◦ PRO_ANNOTATION_REF_STRONG—Strong references
• source—Specifies the source of the references and can have one of the following values:
◦ PRO_ANNOTATION_REF_ALL—From both user and annotation.
◦ PRO_ANNOTATION_REF_FROM_ANNOTATION—From the annotation (or custom data) only.
◦ PRE_ANNOTATION_REF_FROM_USER—From the user only.
Annotation elements have special default behavior for propagation of datum points to features in other models. The flag that controls this behavior can automatically propagate datum points or any other applicable items to data sharing features after the user has selected all other strong references of the annotation elements.
Here, applicable items are items that are designated to auto-propagate, using a checkbox in the references collector, for specific annotation elements.
The function
ProAnnotationelemQuiltreferenceSurfacesCollect() returns the surfaces which make up a quilt surface collection reference for the annotation element.
|
Note:
|
All the surfaces made inactive by features occurring after the annotation element in the model regeneration are also returned.
|
The function
ProAnnotationelemReferenceAutopropagateGet() gets the autopropagate flag of the specified annotation element reference.
The function
ProAnnotationelemTypeGet() returns the type of the annotation contained in the annotation element. It can have one of the following values:
• PRO_ANNOT_TYPE_NONE—Specifies a non-graphical annotation.
• PRO_ANNOT_TYPE_NOTE—Specifies a note. Refer to the section
Notes for details.
• PRO_ANNOT_TYPE_GTOL—Specifies a geometric tolerance. Refer to the section
Geometric Tolerances for details.
• PRO_ANNOT_TYPE_SYMBOL—Specifies a symbol. Refer to the section
Symbol Annotations for details.
• PRO_ANNOT_TYPE_CUSTOM—Specifies a manufacturing template annotation.
The function
ProAnnotationelemReferenceDescriptionGet() gets the description property for a given annotation element reference.
|
Note:
|
The description string is same as that of the tooltip text for the reference name in the Annotation Feature UI.
|
The function
ProAnnotationelemReferenceIsStrong() identifies if a reference is weak or strong in a given annotation element.
The function
ProAnnotationelemHasMissingrefs() enables you to identify if an annotation element has missing references. The input parameters of this function allow you to investigate specific types and sources of references, or check all references simultaneously.