Category 3D drawings and annotations, Object ProAnnotation

Function ProAnnotationShow


Description
Sets an annotation to be shown. This changes the model database to show the annotation until it is explicitly erased.
Synopsis
#include <ProAnnotation.h>
ProErrorProAnnotationShow(
ProAnnotation* annotation
/* (In)
The annotation (note, gtol, surface finish, symbol, ref. dim., driven dim, dimension).

Note: regular dimensions may only be shown in a drawing.
*/
ProAsmcomppath* comp_path
/* (In)
The assembly component path. Applicable only if view != NULL and the view contains an assembly including the owner model of the annotation. Pass NULL when not required.
*/
ProView view
/* (In)
The drawing view. Pass NULL to toggle the state in the solid model.
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_NO_CHANGEThe annotation is already shown in the target model.
PRO_TK_INVALID_MATRIXThe annotation cannot be shown due to orientation conflicts in the view.
PRO_TK_NO_LICENSELicense check failure.
PRO_TK_NOT_DISPLAYEDAnnotation is present on hidden or blank layer and so can't be shown.
See Also
ProAnnotationErase
ProAnnotationIsShown

Manual References:

  1. Annotations: Geometric Tolerances: Creating a Geometric Tolerance
  2. Assembly: Data Sharing Features: Accessing Properties of Variant Features
  3. Annotations: Annotation Features and Annotations: Access to Annotations
  4. Annotations: Annotation Features and Annotations: Access to Annotations
  5. Annotations: Annotation Features and Annotations: Accessing Reference and Driven Dimensions
  6. Annotations: Annotation Features and Annotations: Accessing Ordinate and Baseline Dimensions
  7. Annotations: Annotation Features and Annotations: Creating and Deleting Notes
  8. Annotations: Annotation Features and Annotations: Accessing Set Datum Tags
  9. Annotations: Annotation Features and Annotations: Surface Finish Annotations
  10. Annotations: Annotation Features and Annotations: Creating, Reading and Modifying 3D Symbols

Sample Code References:

  1. pt_examples ( TestDimension.c )
  2. pt_examples ( TestDimension.c )
  3. pt_examples ( TestDimension.c )
  4. pt_examples ( TestGtol.c )
  5. pt_examples ( TestSetup.c )
  6. pt_userguide ( UgDimLocationUtils.c )
  7. pt_userguide ( UgDrawingDimensions.c )
  8. pt_userguide ( UgDrawingDimensions.c )
  9. pt_userguide ( UgSolidNoteCreate.c )