Brief Index      Full Index      Events Index      I.M. Reference

Show_Line_Style

Functions

void Show_Line_Style (const char *style, char *definition)
 
void Show_Line_Style_Size (const char *style, int *size)
 
void PShow_Net_Line_Style (int count, HC_KEY const *keys, char const *name, char *definition)
 
void PShow_Net_Line_Style_Size (int count, HC_KEY const *keys, char const *name, int *size)
 

Detailed Description

Function Documentation

void Show_Line_Style ( const char *  style,
char *  definition 
)

Returns the line style that has been set on the currently open segment.

Parameters
styleName of a line style defined in a call to Define_Line_Style().
definitionDefinition of a line style. See description in Define_Line_Style(). Passed by reference. Returned to user.

DETAILS

No additional details. See Define_Line_Style()

NOTES

Show_Line_Style returns the actual attribute values stored in the segment at hand.

Be sure you've declared your string variable to be long enough with a call to Show_Line_Style_Size().

Show_Line_Style will complain if called on a segment where the style attribute is not actually set in the segment. Use Show_Existence() to avoid this, if necessary.

See Also
Define_Line_Style, Define_Glyph, Begin_Line_Style_Search, Show_Line_Style_Size
void Show_Line_Style_Size ( const char *  style,
int *  size 
)

Returns the size of the line style that has been set on the currently open segment.

Parameters
styleName of a line style defined in a call to Define_Line_Style.
sizeLength of the string that defines the line style. Passed by reference. Returned to user.

DETAILS

No additional details. See Show_Line_Style()

NOTES

See Also
Define_Line_Style, Define_Glyph, Begin_Line_Style_Search, Show_Line_Style
void PShow_Net_Line_Style ( int  count,
HC_KEY const *  keys,
char const *  name,
char *  definition 
)

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

Parameters
countThe size of keys
keysAn array of HC_KEY's delineating a path of segments.
nameName of a line style defined in a call to Define_Line_Style().
definitionDefinition of a line style. See description in Define_Line_Style(). Passed by reference. Returned to user.

DETAILS

As with all PShow_Net_* routines, keys[0] represents the lowest (a.k.a the "most local" or "leaf"), and key[count-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 keys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.

void PShow_Net_Line_Style_Size ( int  count,
HC_KEY const *  keys,
char const *  name,
int *  size 
)

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

Parameters
countThe size of keys
keysAn array of HC_KEY's delineating a path of segments.
nameName of a line style defined in a call to Define_Line_Style().
sizeLength of the string that defines the line style. Passed by reference. Returned to user.

DETAILS

As with all PShow_Net_* routines, keys[0] represents the lowest (a.k.a the "most local" or "leaf"), and key[count-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 keys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.

Brief Index      Full Index      Events Index      I.M. Reference