Brief Index      Full Index      I.M. Reference

Show_Text_Spacing


Functions

void Show_Text_Spacing (float *spacing)
void QShow_Text_Spacing (const char *segment, float *spacing)
void Show_Net_Text_Spacing (float *spacing)
void PShow_Net_Text_Spacing (int keycount, HC_KEY *pathkeys, float *spacing)
void QShow_Net_Text_Spacing (const char *segment, float *spacing)

Function Documentation

void Show_Text_Spacing ( float *  spacing  ) 

Returns the text spacing that has been set on the currrently open segment.

Parameters:
spacing A scalar describing the spacing of text characters.

DETAILS

No additional details. See Set_Text_Spacing()

NOTES

The Show_Text_Spacing routines return the actual attribute values stored in the particular segment at hand. The Show_Net_Text_Spacing routines return the effective attribute value for the specified segment. The distinction is that there may or may not be an "actual" stored value for an attribute for a given segment, but there is guaranteed always to be an effective value for every attribute for every segment. Also, "Show Net" will return the cumulative effects of those attributes that concatenate as you go up and down the segment tree (Modelling Matrices and Windows).

When the value being passed back is a string, be sure you've declared your string variable to be long enough.

In C, "passed by reference" means that you have to allocate an appropriate variable, either statically or off the stack, and pass a pointer to that variable to the HOOPS routine. To generate a pointer to a variable C, you prefix the variable with a "&". In other languages you normally don't have to do anything different from usual.

The Show_Text_Spacing routines will complain if they're called and the attribute is not actually set in the segment. Use Show_Existence() to avoid this, if necessary.

void QShow_Text_Spacing ( const char *  segment,
float *  spacing 
)

Similar to Show_Text_Spacing() but operates on a given segment rather than the currently open one.

Parameters:
segment The segment to query.
spacing A scalar describing the spacing of text characters.

DETAILS

No additional details. See Set_Text_Spacing()

void Show_Net_Text_Spacing ( float *  spacing  ) 

Similar to Show_Text_Spacing(), but returns the net effective setting rather than the local one.

Parameters:
spacing A scalar describing the spacing of text characters.

DETAILS

No additional details. See Set_Text_Spacing()

void PShow_Net_Text_Spacing ( int  keycount,
HC_KEY *  pathkeys,
float *  spacing 
)

Similar to Show_Net_Text_Spacing(), but returns the net effective setting along a discrete segment path.

Parameters:
keycount The size of pathkeys
pathkeys An array of HC_KEY's delineating a path of segments.
spacing A scalar describing the spacing of text characters.

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from KInclude_Segment(). For other details, see Show_Net_Text_Spacing()

void QShow_Net_Text_Spacing ( const char *  segment,
float *  spacing 
)

Similar to Show_Net_Text_Spacing() but operates on a given segment rather than the currently open one.

Parameters:
segment The segment to query.
spacing A scalar describing the spacing of text characters.

DETAILS

No additional details. See Set_Text_Spacing()

Main Index
Brief Index      Full Index      I.M. Functions