graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPTX3 - Geometric Text 3

GPTX3 (point, length, text, refv1, refv2)

Purpose

Use GPTX3 to insert a three-dimensional, geometric text element into the open structure following the element pointer or to replace the element pointed at by the element pointer with a Geometric Text 3 structure element depending on the current edit mode.

This structure element specifies a string of geometric text that the graPHIGS API draws on the plane defined by the specified text position and reference vectors.

When you create this structure element, the current Text Character Set value in the graPHIGS API State List is bound to this character string.

Two vectors definitions orient a local coordinate system, within which the text is positioned. The two reference vectors and the text position define the plane in which the text is drawn. The first vector defines the x-axis of the local coordinate system. The second reference vector defines the half plane of the text in which the positive y-axis lies. The directions specified by Character Up Vector and Text Path attributes are relative to this coordinate system.

Parameters

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

x, y, and z coordinates of the text position. This position serves as the origin of the local coordinate system within which three-dimensional text is defined.

length -- specified by user, fullword integer

Length of text string in bytes (>=0)

text -- specified by user, variable length character string

Text to be displayed.

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

Directional components of the first text reference vector.

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

Directional components of the second reference vector.

Error Codes

5: FUNCTION REQUIRES STATE STOP OR NROP (NOT STCL)
107: REFERENCE VECTORS ARE COLINEAR
108: NUMBER OF CHARACTERS IN TEXT STRING < ZERO

Related Subroutines

GPCHH: Set Character Height
GPCHPM: Set Character Positioning Mode
GPCHSP: Set Character Spacing
GPCHUB: Set Character Up and Base Vectors
GPCHUP: Set Character Up Vector
GPCHXP: Set Character Expansion Factor
GPQGFC: Inquire Geometric Font Characteristics
GPQXTX: Inquire Extended Text Facilities
GPTXAL: Set Text Alignment
GPTXCD: Set Text Color Direct
GPTXCI: Set Text Color Index
GPTXFO: Set Text Font
GPTXI: Set Text Index
GPTXPR: Set Text Precision
GPTXPT: Set Text Path

RCP code

201328133 (X'0C000605')