SET ANNOTATION TEXT PATH(3P) — SUNPHIGS LIBRARY

NAME

SET ANNOTATION TEXT PATH − create a structure element to set the current text path attribute

SYNOPSIS

C Syntax

void
psetannotationpath ( path )
Ptxpathpath;annotation text path

FORTRAN Syntax

SUBROUTINE psatp ( ATP )
INTEGERATPannotation text path (PRIGHT, PLEFT, PUP, PDOWN)

Required PHIGS Operating States

(PHOP, ∗, STOP, ∗)

DESCRIPTION

Purpose

SET ANNOTATION TEXT PATH creates a structure element containing a value for the text path attribute, which controls the direction the string is written in, relative to the character up and base vectors.

This attribute applies to the output primitives:

• ANNOTATION TEXT RELATIVE
• ANNOTATION TEXT RELATIVE 3.

which follow in the structure network.

If the current edit mode is INSERT, a SET ANNOTATION TEXT PATH element is inserted into the currently open structure after the element pointed to by the current element pointer. If the edit mode is REPLACE, the new SET ANNOTATION TEXT PATH element replaces the element pointed to by the element pointer. In either case, the element pointer is updated to point to the new element.

C Input Parameter

pathThe annotation text path is one of the following enumerated values:

PTP_RIGHT“Right”
PTP_LEFT“Left”
PTP_UP“Up”
PTP_DOWN“Down”

FORTRAN Input Parameter

ATPThe annotation text path is one of the following enumerated values:

PRIGHT“Right”
PLEFT“Left”
PUP“Up”
PDOWN“Down”

Execution

When the SET ANNOTATION TEXT PATH element is traversed, the ‘current annotation text path’ entry in the PHIGS traversal state list is set to annotation text path. The annotation text path determines the direction of displacement between one character and the next in a string, defined in relation to the “annotation text character base and up vectors”.

If annotation text path is set to “Right,” the text string is written along a baseline in the direction of the ANNOTATION TEXT CHARACTER BASE VECTOR.

If text path is set to “Left,” the text string is written along a baseline in the direction opposite to the ANNOTATION TEXT CHARACTER BASE VECTOR.

If text path is set to “Up,” the text string is written in the direction of the ANNOTATION TEXT CHARACTER UP VECTOR.

If text path is set to “Down,” the text string is written in the direction opposite to the ANNOTATION TEXT CHARACTER UP VECTOR.

The ANNOTATION TEXT CHARACTER BASE VECTOR attribute is an implicit attribute derived from the ANNOTATION TEXT CHARACTER UP VECTOR.

Note: annotation text path controls only the direction in which the string is written. The position of the string in relation to the text position point is controlled by the “annotation text alignment”.

ERRORS

005Ignoring function, function requires state (PHOP, ∗, STOP, ∗)

Museum