Category 3D drawings and annotations, Object ProNote

Function ProNoteAttachFreeGet


Description
Retrieves the location of the note text. The attachment point is a parametric point with respect to the model display outline. For example, (0.5, 0.5, 0.5) would be the center, whereas (0.0, 0.0, 1.1) would be just outside one of the corners. Obtain the display outline from ProSolidDispoutlineGet().

Note: For notes placed on a flat-to-screen annotation plane, the coordinates will be screen coordinates instead of the parameters discussed above, and the Z entry should be ignored.

Synopsis
#include <ProNote.h>
ProErrorProNoteAttachFreeGet(
ProNoteAttach note_att
/* (In)
The handle for the ProNoteAttach
*/
double* r_p1
/* (Out)
The pointer to the the parameter in the X direction
*/
double* r_p2
/* (Out)
The parameter in the Y direction
*/
double* r_p3
/* (Out)
The parameter in the Z direction
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the information.
PRO_TK_E_NOT_FOUNDThe note attachment does not contain a free attachment.
PRO_TK_GENERAL_ERRORA general error occurred and the function failed.

Manual References:

  1. Annotations: Annotation Features and Annotations: Accessing the Note Placement
  2. Annotations: Annotation Features and Annotations: Accessing the Note Placement
  3. Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments