Brief Index      Full Index      Events Index      I.M. Reference

Show_Metafile

Functions

void Show_Metafile (char *options)
void Show_Net_Metafile (char *options)
void PShow_Net_Metafile (int keycount, HC_KEY *pathkeys, char *options)
void Show_One_Metafile (const char *type, char *value)
void Show_One_Net_Metafile (const char *type, char *value)
void PShow_One_Net_Metafile (int count, HC_KEY *keys, const char *type, char *value)

Function Documentation

void Show_Metafile ( char *  options)

Returns a list of the metafile attributes that have been set on the currently open segment.

Parameters:
options- A list of the current metafile attributes. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Metafile()

NOTES

The Show_Metafile() routines return the actual attribute values stored in the particular segment at hand. The Show_Net_Metafile 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_Metafile() 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 Show_Net_Metafile ( char *  options)

Similar to Show_Metafile(), but returns the net effective settings rather than the local ones.

Parameters:
options- A list of the current metafile attributes. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Metafile()

void PShow_Net_Metafile ( int  keycount,
HC_KEY *  pathkeys,
char *  options 
)

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

Parameters:
keycountThe size of pathkeys
pathkeysAn array of HC_KEY's delineating a path of segments.
optionsA list of the current metafile attributes. Passed by reference. Returned to user.

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 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.

For other details, see Show_Net_Camera_Field()

void Show_One_Metafile ( const char *  type,
char *  value 
)

Similar to Show_Metafile() but returns a single setting, rather than the entire set.

Parameters:
typeThe type in type = value.
valueThe value of type. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Metafile()

void Show_One_Net_Metafile ( const char *  type,
char *  value 
)

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

Parameters:
typeThe type in type = value.
valueThe value of type. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Metafile()

void PShow_One_Net_Metafile ( int  count,
HC_KEY *  keys,
const char *  type,
char *  value 
)

Similar to Show_One_Net_Metafile() but returns the net settings along a discrete path.

Parameters:
countThe size of keys
keysAn array of HC_KEY's delineating a path of segments.
typeThe type in type = value.
valueThe value of type. Passed by reference. Returned to user.

DETAILS

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. For additional details, see Set_Metafile()

Brief Index      Full Index      Events Index      I.M. Reference