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

GPCHL2 - Character Line 2

GPCHL2 (startp, endp, nomhgt, char)

Purpose

Use GPCHL2 to insert a Character Line structure element into the open structure following the element pointer or to replace the element pointed at by the element pointer with a Character Line 2 structure element depending on the current edit mode.

When you create GPCHL2, the graPHIGS API binds the current character set to this structure element.

During structure traversal, the graPHIGS API draws an integral number of characters between the starting point (startp and the ending point (endp) The character set and character code (char) within the structure element in conjunction with the current font in the traversal state list, determine the characters drawn at each point. If the character set and font combination is not currently active, then the graPHIGS API applies the normal defaulting rules. The height of the characters is the product of the nominal character height (nomhgt) and the current Character Line Scale Factor in the traversal state list. The height is subject to all transformations. The actual width of the characters may be adjusted slightly so that there is an integral number between the two endpoints.

The application draws the character in the character line in the x, y plane in Modelling Coordinate (MC) space. For the exact method on how text attributes are applied to this primitive, see The graPHIGS Programming Interface: Understanding Concepts

If the currently active character set and font combination is a double bye character set, then the graPHIGS API ignores this structure element.

GPCHL2 is identified as GDP 1039.

Note:

Not all GDPs are supported on all workstations. Use the Inquire List of Generalized Drawing Primitives (GPQGD) subroutine to determine the GDPs supported by an opened workstation. See also the workstation description in The graPHIGS Programming Interface: Technical Reference

Parameters

startp -- specified by user, 2 short floating-point numbers (MC)

Starting point.

endp -- specified by user, 2 short floating-point numbers (MC)

End point.

nomhgt -- specified by user, short floating-point number (MC)

Nominal character height (>0)

char -- specified by user, 1-byte character string

Character code.

Error Codes

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

Related Subroutines

GPCHLS
Set Character Line Scale Factor
GPCHPM
Set Character Positioning Mode
GPCHXP
Set Character Expansion Factor
GPTXCD
Set Text Color Direct
GPTXCI
Set Text Color Index
GPTXFO
Set Text Font
GPTXI
Set Text Index

RCP code

201344514 (X'0C004602')


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