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

GPCHUB - Set Character Up and Base Vectors

GPCHUB (up, base)

Purpose

Use GPCHUB to insert a Set Character Up and Base Vectors structure element into the open structure following the element pointer or to replace the element pointed at by the element pointer with a Set Character Up and Base Vectors structure element depending on the current edit mode.

During structure traversal, this structure element sets the current character up vector and base vector entries in the graPHIGS API traversal state list to the specified values.

The character up vector specifies the direction of the font coordinate y-axis within the text reference coordinate system. The character base vector specifies the direction of the font coordinate x-axis within the text reference coordinate system. The vectors need not be perpendicular to one another.

This attribute sets the same traversal state as the Set Character Up Vector (GPCHUP) subroutine.

The traversal default value for character up vector is 0.0, 1.0 and the traversal default value for character base vector is 1.0, 0.0.

If the character up and base vector are invalid, then the up vector defaults to 0.0, 1.0, and the base vector value defaults to 1.0, 0.0.

The graPHIGS API normalizes the specified vectors. If the application later inquires the content of this structure element, then the graPHIGS API returns the normalized vectors not the original vectors specified by this subroutine.

Parameters

up -- specified by user, 2 short floating-point numbers

Character up vector. (Magnitude must be >0)

base -- specified by user, 2 short floating-point numbers

Character base vector. (Magnitude must be >0)

Error Codes

5
FUNCTION REQUIRES STATE STOP OR NROP (NOT STCL)
80
CHARACTER UP AND BASE VECTORS ARE COLINEAR

Related Subroutines

GPCHUP
Set Character Up Vector
GPTXPR
Set Text Precision

RCP code

201328662 (X'0C000816')


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