[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface: ISO PHIGS Subroutine Reference

ANNOTATION TEXT RELATIVE 3 (PHOP,*,STOP,*)

Purpose

Use Annotation Text Relative 3 to insert an Annotation Text Relative 3 structure element into the open structure following the element pointer or replace the element pointed at by the element pointer with an Annotation Text Relative 3 structure element, depending on the current edit mode.

During structure traversal, this element annotates the specified reference point according to the annotation style in the traversal state list. The specified annotation offset determines the position of the annotation string. The annotation string defines the origin of a local text coordinate system relative to the specified reference point after transformation to Normalized Projection Coordinates (NPC). The text plane is always parallel to the x., y plane in NPC. If the resulting text position is outside the usable NPC space [0,1][0,1][0,1], then the graPHIGS API may clip part or all of the string.

The graPHIGS API positions and renders the text string in the local coordinate system according to the annotation text attributes in the traversal state list. If the graPHIGS API clips the specified reference point to NPC during structure traversal, then no representation for this primitive is displayed. If the graPHIGS API does not clip the specified reference point, then the graPHIGS API clips the displayed representation according to the rules for the corresponding primitive type (e.g., text, polyline, etc.).

The graPHIGS API treats control characters in a character string as undefined characters and displays the default for the character set. This default for the character set is the default character in the graPHIGS API character set file. For U.S. English, this is the hyphen character (EBCDIC X'60', ASCII X'2D').

If the annotation style attribute entry in the PHIGS traversal state list is set to LEAD LINE, then after transformation the graPHIGS API draws a single line segment from the specified reference point to the origin of the local text coordinate system using the polyline attributes in the PHIGS traversal state list.

Language Bindings

C

panno_text_rel3 (ref_pt, offset, char_string)

Input Parameters

const Ppoint3 *ref_pt
Reference point in MC.

const Pvec3 *offset
Annotation offset in NPC. Determines the position of the annotation character string.

const char *char_string
Annotation character string to be displayed.

FORTRAN

PATR3 (rpx, rpy, rpz, apx, apy, apz, chars)

Input Parameters

real rpx
x coordinate of the reference location, in MC, that is to be annotated.

real rpy
y coordinate of the reference location, in MC, that is to be annotated.

real rpz
z coordinate of the reference location, in MC, that is to be annotated.

real apx
xcomponent of the annotation offset in NPC. Determines the position of the annotation character string (xcomponent).

real apy
ycomponent of the annotation offset in NPC. Determines the position of the annotation character string (ycomponent).

real apz
z component of the annotation offset in NPC. Determines the position of the annotation character string (z component).

character*(*) chars
Annotation character string to be displayed.

FORTRAN Subset

PATR3S (rpx, rpy, rpz, apx, apy, apz, lstr, chars)

Input Parameters

real rpx
x coordinate of the reference location, in MC, that is to be annotated.

real rpy
y coordinate of the reference location, in MC, that is to be annotated.

real rpz
z coordinate of the reference location, in MC, that is to be annotated.

real apx
xcomponent of the annotation offset in NPC. Determines the position of the annotation character string (xcomponent).

real apy
ycomponent of the annotation offset in NPC. Determines the position of the annotation character string (ycomponent).

real apz
z component of the annotation offset in NPC. Determines the position of the annotation character string (z component).

integer lstr
Length of string in characters.

character*80 chars
Annotation character string to be displayed.

Errors

5
Function Requires State (PHOP,*,STOP,*)

Related Subroutines

  • Set Annotation Style

    • [ Previous | Next | Contents | Glossary | Home | Search ]