Show_Driver_Options

Functions

HC_BOOLEAN PShow_Net_Driver_Options (int key_count, const HC_KEY *path_keys, char *list)
 Similar to Show_Driver_Options(), but returns the net effective settings along a discrete segment path. More...
 
HC_BOOLEAN PShow_One_Net_Driver_Option (int count, const HC_KEY *keys, const char *type, char *value)
 Show_One_Driver_Option() but returns the net settings along a discrete path. More...
 
void Show_Driver_Options (char *list)
 Returns a list of the driver options that have been set on the currently open segment. More...
 
void Show_One_Driver_Option (const char *type, char *value)
 Similar to Show_Driver_Options() but returns a single option rather than the entire set. More...
 

Detailed Description

Function Documentation

◆ PShow_Net_Driver_Options()

HC_BOOLEAN PShow_Net_Driver_Options ( int  key_count,
const HC_KEY *  path_keys,
char *  list 
)

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

Parameters
key_count- The size of pathkeys
path_keys- An array of HC_KEY's delineating a path of segments.
list- The list of the driver options that are set on a particular segment. 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.

◆ PShow_One_Net_Driver_Option()

HC_BOOLEAN PShow_One_Net_Driver_Option ( int  count,
const HC_KEY *  keys,
const char *  type,
char *  value 
)

Show_One_Driver_Option() but returns the net settings along a discrete path.

Parameters
count- The size of keys
keys- An array of HC_KEY's delineating a path of segments.
type- The type in type = value.
value- The 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_Driver_Options()

◆ Show_Driver_Options()

void Show_Driver_Options ( char *  list)

Returns a list of the driver options that have been set on the currently open segment.

Parameters
list- The list of the driver options that are set on a particular segment. Passed by reference. Returned to user.
Options returned:
absolute line weight, anti-alias, backing store, border, color consolidation, control area, debug, disable input, double-buffering, fallback font, first color, fixed colors, force grayscale, gamma correction, gpu resident,
hardcopy resolution, isolated, landscape orientation, light scaling, locater transform, marker drawing, number of colors, output format, pen speed, physical size, quick_moves preference, selection proximity, shadow preference, special events, spotlight interpolation, stencil, stereo, subscreen, subscreen moving, subscreen resizing, subscreen stretching, text preference, title, update interrupts, use colormap ID, use window ID, write mask

DETAILS

No additional details. See Set_Driver_Options()

NOTES

The Show_Driver_Options routines return the actual attribute values stored in the particular segment at hand. The Show_Net_Driver_Options 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_Driver_Options() 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.

See also
Set_Rendering_Options, Set_Driver, Set_Heuristics, Show_Special_Event, Show_Device_Info, Get_Selection.

◆ Show_One_Driver_Option()

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

Similar to Show_Driver_Options() but returns a single option rather than the entire set.

Parameters
type- The type in type = value.
value- The value of type. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Driver_Options()