Brief Index      Full Index      I.M. Reference

Set_Window_Frame


Functions

void Set_Window_Frame (const char *flag)
void QSet_Window_Frame (const char *segment, const char *flag)
void UnSet_Window_Frame (void)
void QUnSet_Window_Frame (const char *segment)

Function Documentation

void Set_Window_Frame ( const char *  flag  ) 

Causes the system to automatically delineate any windows encountered.

Parameters:
flag - A string that details the framing behavior for the currently open segment.

DETAILS

Set_Window_Frame tells HOOPS to draw a frame around a HOOPS window. The options for flag are "on", "off" or "single", with the added optional modifiers of "inset" and "decorative".

A value of "on" draws the frame as a two-pixel-wide frame, while "single" draws the frame a single pixel in width.

There are two modifiers that can be used in conjunction with either "on" or "single". By default, turning a window frame on will result in the image being shrunk a little. Setting the "decorative" modifier will ensure that the image will not be shrunk at all, and that the frame will be drawn on top of any geometry in the window. The second modifier -- "inset" -- will guarantee that the window frame will be wholly inside the window frame of the owning window. So, if the scene contains one window on top of another, both of which have the same window coordinates, setting the "inset" option will ensure that both window frames will be visible.

The color of the frame is set through the "window contrast" color.

NOTES

If HOOPS is running on top of another windowing system, that other windowing system may automatically outline the topmost HOOPS window, in which case HOOPS does not bother to re-outline it. The "border" and "control area" Driver_Options may be of interest in this situation.

RESTRICTIONS

See also:
Set_Window, Set_Window_Pattern, Set_Color, Set_Driver_Options.

void QSet_Window_Frame ( const char *  segment,
const char *  flag 
)

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

Parameters:
segment - Name of the segment(s) to be changed.
flag - Special constant---either "On" or "Off".The constant is a quoted string. Uppercase versus lowercase is not significant.

DETAILS

No additional details. See Set_Window_Frame()

void UnSet_Window_Frame ( void   ) 

Removes all settings established by a previous call to Set_Window_Frame().

DETAILS

No additional details. See Set_Window_Frame()

void QUnSet_Window_Frame ( const char *  segment  ) 

Removes all settings established by a previous call Set_Window_Frame(), but operates on a given segment rather than the currently open one.

Parameters:
segment - Name of the segment(s) to be changed.

DETAILS

No additional details. See Set_Window_Frame()

Main Index
Brief Index      Full Index      I.M. Functions