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

GPAH - Set Annotation Height

GPAH (height)

Purpose

Use GPAH to insert a Set Annotation Height structure element into the open structure following the element pointer or to replace the element pointed at by the element pointer with a Set Annotation Height structure element depending on the current edit mode.

The application specifies the annotation text character height with respect to the annotation text local coordinate system; that is, a two-dimensional coordinate system parallel to the NPC (Normalized Projection Coordinates) x, y plane. The graPHIGS API multiplies the specified height by the scale factor of the current workstation transformation, and then maps the result to the closest available height on the workstation.

The current annotation character height entry in the graPHIGS API traversal state list is also set by the Set Annotation Height Scale Factor (GPAHSC) structure element. As a result, the traversal default annotation height corresponds to a default annotation height scale factor of 1.0.

For more information concerning annotation text and annotation text attributes, see The graPHIGS Programming Interface: Understanding Concepts

Parameters

height -- specified by user, short floating-point number (NPC)

Annotation text character height (>0)

Error Codes

5
FUNCTION REQUIRES STATE STOP OR NROP (NOT STCL)
78
CHARACTER HEIGHT VALUE <= ZERO

Related Subroutines

GPAHSC
Set Annotation Height Scale Factor
GPQXAF
Inquire Extended Annotation Font Characteristics

RCP code

201328660 (X'0C000814')


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