Dimension References
The functions explained in this section enable you to work with semantic dimension references.
Function Introduced:
The function
ProDimensionAdditionalRefsAdd() allows you to add additional semantic references to a specified dimension. It will provide you or the downstream applications with additional semantic data beyond the dimension attachments. This is useful when you need to associate a dimension with extra references beyond its primary ones, such as surfaces or annotation elements. The input arguments are:
• dim—Specifies a dimension.
• type—Specifies the type of reference using the enumerated data type ProDimensionReferenceType. The type is classified based on the list to which the references are added. The valid values are:
◦ PRO_DIM_REF_FIRST—Adds the semantic references to the first list of references.
◦ PRO_DIM_REF_SECOND—Adds the semantic references to the second list of references.
◦ PRO_DIM_SRF_COLL—Adds the semantic references to the collection of surfaces.
|
Note:
|
When a reference includes more than one collection, the function ProDimensionAdditionalRefsAdd() returns the error PRO_TK_MAX_LIMIT_REACHED and no reference is added. |
• refs —Specifies a ProArray of references that will be added to the specified dimension.
|
Note:
|
Currently, the reference types PRO_ANNOT_REF_SINGLE and PRO_ANNOT_REF_SRF_COLLECTION are supported.
|
The function
ProDimensionAdditionalRefsGet() returns all additional semantic references associated with a given dimension which were previously added by the function
ProDimensionAdditionalRefsAdd() or by the references part of the annotation feature dialog. Specify the type of reference using the enumerated data type
ProDimensionReferenceType. Use the function
ProAnnotationreferencearrayFree() to release the memory assigned to the
ProArray of references.
Use the function
ProDimensionAdditionalRefDelete() to delete a specific semantic reference previously added to a dimension using
ProDimensionAdditionalRefsAdd() or through the annotation feature dialog . The references are specified by their index number which start from
0. You can get existing references from
ProDimensionAdditionalRefsGet(). The index is ignored if the type of reference is surface collection, as only one reference of the type
PRO_DIM_SRF_COLL can exist.
The input argument for both the functions
ProDimensionAdditionalRefsGet() and
ProDimensionAdditionalRefDelete() specifies the type of reference using the enumerated data type
ProDimensionReferenceType. The type is classified based on the list to which the references are added. The valid values are:
• PRO_DIM_REF_FIRST—Adds the semantic references to the first list of references.
• PRO_DIM_REF_SECOND—Adds the semantic references to the second list of references.
• PRO_DIM_SRF_COLL—Adds the semantic references to the collection of surfaces.