PHIGURE C REFERENCE MANUAL - RELATIVE ANNOTATION TEXT 3D

RELATIVE ANNOTATION TEXT 3D

tannot_text_rel3

CALL SEQUENCE

void tannot_text_rel3 (strid, string, ref_point, offset, char_height, alignment)

INPUT PARAMETERS

Pint	strid;
char	*string;
Ppoint3	*ref_point;
Pvec3	*offset;
Pfloat	char_height;
Ptext_align	*alignment;

ARGUMENTS

strid: Structure identifier
string: Character string to be displayed
ref_point: Reference point to be annotated
offset: Offset between annotation point and the displayed string
char_height: Character height
alignment: Text alignment

TYPES

typedef enum {
	PHOR_NORM,
	PHOR_LEFT,
	PHOR_CTR,
	PHOR_RIGHT
} Phor_text_align;

typedef enum {
	PVERT_NORM,
	PVERT_TOP,
	PVERT_CAP,
	PVERT_HALF,
	PVERT_BASE,
	PVERT_BOTTOM
} Pvert_text_align;

typedef struct {
	Phor_text_align	hor;
	Pvert_text_align	vert;
} Ptext_align;

EFFECT

This function creates a structure containing a text which annotates the reference point ref_point of the current domain. The plane in which the character string is generated is always parallel to the display surface. Thus the text is not subject to rotation or scaling operations. The space between the reference point and the point where the text is drawn, is defined by the vector offset which coordinates are defined in [0-1] (NPC e.g. % of viewport). The character height char_height is also defined in [0-1].

The offset between the text and the reference point ref_point can be visualized calling tset_anno_style function. Character up vector can be set calling tset_anno_char_up_vec function. Text path can be set calling tset_anno_path function.