Functions | |
void | Set_Text_Region (int pCount, const HC_POINT *points, const char *options) |
void | UnSet_Text_Region (void) |
void Set_Text_Region | ( | int | pCount, | |
const HC_POINT * | points, | |||
const char * | options | |||
) |
Allows the user to define a region into which the currently open text string will be fitted.
pCount | - Number of (x,y,z) triplets in points. Should be either 2 or 3. | |
points | - The set of (x,y,z) triplets which define the text region. | |
options | - A quoted string or a string variable containing a list of the desired option settings. |
A 2-point region behaves as if the up vector for the text is 90 degrees, counter-clockwise from the region line.
A 3-point region implies a user-defined up-vector. The 3rd point is used to determine the plane & orientation, and the point is considered to lie in the 'upper half' of the plane. If the user has a plane equation, the normal of the plane crossed with the vector between the first 2 points gives an 'up vector', which can be added to the first (or, actually, either) point to generate the third.
Valid choices for options include the following:
[no] adjust direction
When set, the text will be aligned in a consistent direction in screen space, regardless of the view settings. This means that text strings will read the same whether you are looking at them from the "front" or "back". Default is "no adjust direction".
alignment = top | center | bottom
Defines how the text string will be aligned relative to the text region. The default setting is "alignment=bottom".
[no] relative coordinates
When set, the text region coordinates will be relative to the text string position. Default is "no relative coordinates".
[no] window space
When set, the text region coordinates are assumed to be in window space coordinates. Default is "no window space".
void UnSet_Text_Region | ( | void | ) |
Removes all settings established by a previous call to Set_Text_Region().