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

Chapter 2. Output Primitives

These subroutines address the specification and creation of output primitives, which are structure elements. Many have both two- and three-dimensional forms and are displayed when the structure elements defining them are encountered during structure traversal. To use primitive subroutines, the structure state must be Structure Open (STOP)

Some output primitive subroutines accept lists of structure element data. These lists often are accompanied by a width parameter which allows the application program to easily input an array of structure element data that may contain additional application specific information. When these arrays are accepted as parameters, only the structure element data is stored in the structure.

For all two-dimensional output primitive subroutines, the z coordinate is assumed to equal zero by default.

If a specified workstation does not support a requested output primitive, then the graPHIGS API updates only the element number in the graPHIGS API traversal state list.

Note:

When an application inserts an element into the open structure following the element pointer, the pointer updates to that element.

GPAN2 - Annotation Text 2

GPAN2 (point, length, text)

Purpose

Use GPAN2 to insert an Annotation Text 2 structure element into the open structure following the element pointer or to replace the element pointed at by the element pointer with an Annotation Text 2 structure element depending on the current edit mode.

This structure element specifies a string of text in two-dimensional Modelling Coordinate (MC) space to be drawn at the specified location in a plane parallel to the view plane.

At the time this structure element is created, the current Text Character Set value in the graPHIGS API State List is bound to this character string.

The size and orientation of annotation text is not affected by rotation and scaling. Only its position changes.

Parameters

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

x and y coordinates of the annotation text position.

length -- specified by user, fullword integer

Length of the annotation text string in bytes (>=0)

text -- specified by user, variable length character string

Text string to be displayed.

Error Codes

5
FUNCTION REQUIRES STATE STOP OR NROP (NOT STCL)
108
NUMBER OF CHARACTERS IN TEXT STRING < ZERO

Related Subroutines

GPAAL
Set Annotation Alignment
GPAH
Set Annotation Height
GPAHSC
Set Annotation Height Scale Factor
GPAPT
Set Annotation Path
GPAUP
Set Annotation Up Vector
GPCHPM
Set Character Positioning Mode
GPCHSP
Set Character Spacing
GPTXCD
Set Text Color Direct
GPTXCI
Set Text Color Index
GPTXFO
Set Text Font
GPTXI
Set Text Index
GPTXPR
Set Text Precision
GPQXAF
Inquire Extended Annotation Font Characteristics

RCP code

201328139 (X'0C00060B')


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