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

GPAHSC - Set Annotation Height Scale Factor

GPAHSC (factor)

Purpose

Use GPAHSC to insert a Set Annotation Height Scale Factor 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 Scale Factor structure element depending on the current edit mode.

The specified annotation height scale factor specifies a ratio of the annotation character height to the workstation's nominal character height. Because the current annotation text character height in the graPHIGS API traversal state list is expressed in Device Coordinates (DC), the graPHIGS API multiplies the specified value by the nominal character height and sets the specified value to the entry.

The current annotation character height entry in the graPHIGS API traversal state list is also set by the Set Annotation Height (GPAH) structure element.

The traversal default value for annotation height scale factor is 1.0.

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

Parameters

factor -- specified by user, short floating-point number

This attribute specifies the height scale factor. This factor is multiplied by the workstation dependent nominal annotation text character height.

Error Codes

5
FUNCTION REQUIRES STATE STOP OR NROP (NOT STCL)

Related Subroutines

GPAH
Set Annotation Height
GPQXAF
Inquire Extended Annotation Font Characteristics

RCP code

201328655 (X'0C00080F')


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