/*
* TODO BEFORE THE STABLE RELEASE:
*
- * It would be cool if the submenu entries were somehow marked, for example with a dings
- * on the right menu border or something like that. Think about the possibility of doing
- * the menu on layers *or* using the native window system instead of OpenGL.
+ * Wouldn't 1.0 have been "the" stable release? Now we are past 2.0,
+ * so this comment is probably just out of date. (20031026; rkr)
+ *
+ * Think about the possibility of doing the menu on layers *or* using the
+ * native window system instead of OpenGL.
*/
/* -- DEFINITIONS ---------------------------------------------------------- */
/*
- * We'll be using freeglut fonts to draw the menu
+ * FREEGLUT_MENU_FONT can be any freeglut bitmapped font.
+ * (Stroked fonts would not be out of the question, but we'd need to alter
+ * code, since GLUT (hence freeglut) does not quite unify stroked and
+ * bitmapped font handling.)
+ * Old UNIX/X11 GLUT (BSD, UNIX, IRIX, LINUX, HPUX, ...) used a system
+ * font best approximated by an 18-pixel HELVETICA, I think. MS-WINDOWS
+ * GLUT used something closest to the 8x13 fixed-width font. (Old
+ * GLUT apparently uses host-system menus rather than building its own.
+ * freeglut is building its own menus from scratch.)
+ *
+ * FREEGLUT_MENU_HEIGHT gives the height of ONE menu box. This should be
+ * the distances between two adjacent menu entries. It should scale
+ * automatically with the font choice, so you needn't alter it---unless you
+ * use a stroked font.
+ *
+ * FREEGLUT_MENU_BORDER says how many pixels to allow around the edge of a
+ * menu. (It also seems to be the same as the number of pixels used as
+ * a border around *items* to separate them from neighbors. John says
+ * that that wasn't the original intent...if not, perhaps we need another
+ * symbolic constant, FREEGLUT_MENU_ITEM_BORDER, or such.)
*/
+#if TARGET_HOST_WIN32
#define FREEGLUT_MENU_FONT GLUT_BITMAP_8_BY_13
-/*#define FREEGLUT_MENU_FONT GLUT_BITMAP_HELVETICA_18*/
+#else
+#define FREEGLUT_MENU_FONT GLUT_BITMAP_HELVETICA_18
+#endif
+
#define FREEGLUT_MENU_HEIGHT (glutBitmapHeight(FREEGLUT_MENU_FONT) + FREEGLUT_MENU_BORDER)
#define FREEGLUT_MENU_BORDER 2
/*
- * These variables should be moved into the freeglut global state, but for now,
- * we'll put them here. They are for rendering the freeglut menu items.
+ * These variables are for rendering the freeglut menu items.
+ *
* The choices are fore- and background, with and without h for Highlighting.
* Old GLUT appeared to be system-dependant for its colors (sigh) so we are
* too. These variables should be stuffed into global state and initialized
* via the glutInit*() system.
*/
+#if TARGET_HOST_WIN32
static float menu_pen_fore [4] = {0.0f, 0.0f, 0.0f, 1.0f};
static float menu_pen_back [4] = {0.85f, 0.85f, 0.85f, 1.0f};
-
-#if TARGET_HOST_WIN32
static float menu_pen_hfore [4] = {1.0f, 1.0f, 1.0f, 1.0f};
static float menu_pen_hback [4] = {0.15f, 0.15f, 0.45f, 1.0f};
#else
+static float menu_pen_fore [4] = {0.0f, 0.0f, 0.0f, 1.0f};
+static float menu_pen_back [4] = {0.70f, 0.70f, 0.70f, 1.0f};
static float menu_pen_hfore [4] = {0.0f, 0.0f, 0.0f, 1.0f};
static float menu_pen_hback [4] = {1.0f, 1.0f, 1.0f, 1.0f};
#endif
/* -- PRIVATE FUNCTIONS ---------------------------------------------------- */
/*
- * Private static function to find a menu entry by index
+ * Private function to find a menu entry by index
*/
static SFG_MenuEntry *fghFindMenuEntry( SFG_Menu* menu, int index )
{
}
/*
- * Private static function to check for the current menu/sub menu activity state
+ * Private function to check for the current menu/sub menu activity state
*/
static GLboolean fghCheckMenuStatus( SFG_Window* window, SFG_Menu* menu )
{
for( menuEntry = (SFG_MenuEntry *)menu->Entries.First; menuEntry;
menuEntry = (SFG_MenuEntry *)menuEntry->Node.Next )
{
- /*
- * Is that an active sub menu by any case?
- */
if( menuEntry->SubMenu != NULL && menuEntry->IsActive == TRUE )
{
/*
GLboolean return_status = fghCheckMenuStatus( window, menuEntry->SubMenu ) ;
/*
- * Reactivate the submenu as the checkMenuStatus may have turned it off if the mouse
- * is in its parent menu entry.
+ * Reactivate the submenu as the checkMenuStatus may have turned it off
+ * if the mouse is in its parent menu entry.
*/
menuEntry->SubMenu->IsActive = TRUE ;
if ( return_status == TRUE )
x = window->State.MouseX;
y = window->State.MouseY;
- /*
- * Mark all menu entries inactive...
- */
for( menuEntry = (SFG_MenuEntry *)menu->Entries.First; menuEntry;
menuEntry = (SFG_MenuEntry *)menuEntry->Node.Next )
{
/*
* Check if the mouse cursor is contained within the current menu box
*/
- if ( ( x >= FREEGLUT_MENU_BORDER ) && ( x < menu->Width - FREEGLUT_MENU_BORDER ) &&
- ( y >= FREEGLUT_MENU_BORDER ) && ( y < menu->Height - FREEGLUT_MENU_BORDER ) &&
- ( window == menu->Window ) )
+ if( ( x >= FREEGLUT_MENU_BORDER ) &&
+ ( x < menu->Width - FREEGLUT_MENU_BORDER ) &&
+ ( y >= FREEGLUT_MENU_BORDER ) &&
+ ( y < menu->Height - FREEGLUT_MENU_BORDER ) &&
+ ( window == menu->Window ) )
{
- /*
- * Calculation of the highlighted menu item is easy enough now:
- */
int menuID = ( y - FREEGLUT_MENU_BORDER ) / FREEGLUT_MENU_HEIGHT ;
/*
menuEntry = fghFindMenuEntry( menu, menuID + 1 );
assert( menuEntry != NULL );
- /*
- * Mark the menu as active...
- */
menuEntry->IsActive = TRUE;
menuEntry->Ordinal = menuID;
/*
- * If this is not the same as the last active menu entry, deactivate the previous entry.
- * Specifically, if the previous active entry was a submenu then deactivate it.
+ * If this is not the same as the last active menu entry, deactivate the
+ * previous entry. Specifically, if the previous active entry was a
+ * submenu then deactivate it.
*/
if ( menu->ActiveEntry && ( menuEntry != menu->ActiveEntry ) )
{
}
menu->ActiveEntry = menuEntry ;
-
- /*
- * Don't forget about marking the current menu as active, too:
- */
-
menu->IsActive = TRUE;
/*
* Set up the initial menu position now...
*/
- /*
- * Mark the menu as active, so that it gets displayed:
- */
menuEntry->SubMenu->IsActive = TRUE ;
/*
if ( menuEntry->SubMenu->Y + menuEntry->SubMenu->Height > glutGet (GLUT_SCREEN_HEIGHT ) )
menuEntry->SubMenu->Y -= (menuEntry->SubMenu->Height -
- FREEGLUT_MENU_HEIGHT - 2*FREEGLUT_MENU_BORDER);
+ FREEGLUT_MENU_HEIGHT - 2*FREEGLUT_MENU_BORDER);
fgSetWindow ( menuEntry->SubMenu->Window ) ;
glutPositionWindow ( menuEntry->SubMenu->X, menuEntry->SubMenu->Y ) ;
fgSetWindow ( current_window ) ;
}
- /*
- * ...then check the submenu's state:
- */
fghCheckMenuStatus( window, menuEntry->SubMenu );
/*
- * Even if the submenu turned up inactive, activate it because its parent entry is active
+ * Activate it because its parent entry is active
*/
menuEntry->SubMenu->IsActive = TRUE ;
}
int FGAPIENTRY glutGetMenu( void )
{
freeglut_assert_ready;
-
- /*
- * Is there a current menu set?
- */
if( fgStructure.Menu != NULL )
- {
- /*
- * Yes, there is indeed...
- */
return( fgStructure.Menu->ID );
- }
-
- /*
- * No, there is no current menu at all
- */
return( 0 );
}
{
SFG_Menu* menu = fgMenuByID( menuID );
- freeglut_assert_ready; freeglut_return_if_fail( menu != NULL );
-
- /*
- * The current menu pointer is stored in fgStructure.Menu
- */
+ freeglut_assert_ready;
+ freeglut_return_if_fail( menu != NULL );
fgStructure.Menu = menu;
}
{
SFG_MenuEntry* menuEntry = (SFG_MenuEntry *)calloc( sizeof(SFG_MenuEntry), 1 );
- /*
- * Make sure there is a current menu set
- */
- freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Menu != NULL );
-
- /*
- * Fill in the appropriate values...
- */
+ freeglut_assert_ready;
+ freeglut_return_if_fail( fgStructure.Menu != NULL );
menuEntry->Text = strdup( label );
menuEntry->ID = value;
* Have the new menu entry attached to the current menu
*/
fgListAppend( &fgStructure.Menu->Entries, &menuEntry->Node );
-
- /*
- * Update the menu's dimensions now
- */
fghCalculateMenuBoxSize();
}
SFG_MenuEntry* menuEntry = (SFG_MenuEntry *)calloc( sizeof(SFG_MenuEntry), 1 );
SFG_Menu* subMenu = fgMenuByID( subMenuID );
- /*
- * Make sure there is a current menu and the sub menu
- * we want to attach actually exists...
- */
- freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Menu != NULL );
+ freeglut_assert_ready;
+ freeglut_return_if_fail( fgStructure.Menu != NULL );
freeglut_return_if_fail( subMenu != NULL );
- /*
- * Fill in the appropriate values
- */
menuEntry->Text = strdup( label );
menuEntry->SubMenu = subMenu;
menuEntry->ID = -1;
* Make the submenu's parent window be the menu's parent window
*/
fghSetSubmenuParentWindow ( fgStructure.Menu->ParentWindow, subMenu ) ;
-
- /*
- * Have the new menu entry attached to the current menu
- */
fgListAppend( &fgStructure.Menu->Entries, &menuEntry->Node );
-
- /*
- * Update the menu's dimensions now
- */
fghCalculateMenuBoxSize();
}
{
SFG_MenuEntry* menuEntry = NULL;
- /*
- * Make sure there is a current menu set...
- */
- freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Menu != NULL );
-
- /*
- * Get n-th menu entry in the current menu, starting from one:
- */
+ freeglut_assert_ready;
+ freeglut_return_if_fail( fgStructure.Menu != NULL );
menuEntry = fghFindMenuEntry( fgStructure.Menu, item );
-
- /*
- * Make sure the menu entry exists
- */
freeglut_return_if_fail( menuEntry != NULL );
/*
menuEntry->ID = value;
menuEntry->SubMenu = NULL;
- /*
- * Update the menu's dimensions now
- */
fghCalculateMenuBoxSize();
}
SFG_Menu* subMenu = fgMenuByID( subMenuID );
SFG_MenuEntry* menuEntry = NULL;
- /*
- * Make sure there is a current menu set and the sub menu exists...
- */
- freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Menu != NULL );
- freeglut_return_if_fail( subMenu != NULL );
-
- /*
- * Get n-th menu entry in the current menu, starting from one:
- */
+ freeglut_assert_ready;
+ freeglut_return_if_fail( fgStructure.Menu );
+ freeglut_return_if_fail( subMenu );
menuEntry = fghFindMenuEntry( fgStructure.Menu, item );
-
- /*
- * Make sure the menu entry exists
- */
- freeglut_return_if_fail( menuEntry != NULL );
+ freeglut_return_if_fail( menuEntry );
/*
* We want it to become a sub menu entry, so:
*/
- if( menuEntry->Text != NULL )
+ if( menuEntry->Text )
free( menuEntry->Text );
menuEntry->Text = strdup( label );
menuEntry->SubMenu = subMenu;
menuEntry->ID = -1;
- /*
- * Update the menu's dimensions now
- */
fghCalculateMenuBoxSize();
}
{
SFG_MenuEntry* menuEntry;
- /*
- * Make sure there is a current menu set
- */
- freeglut_assert_ready; freeglut_return_if_fail( fgStructure.Menu != NULL );
-
- /*
- * Get n-th menu entry in the current menu, starting from one:
- */
+ freeglut_assert_ready;
+ freeglut_return_if_fail( fgStructure.Menu );
menuEntry = fghFindMenuEntry( fgStructure.Menu, item );
-
- /*
- * Make sure the menu entry exists
- */
- freeglut_return_if_fail( menuEntry != NULL );
-
- /*
- * Removing a menu entry is quite simple...
- */
+ freeglut_return_if_fail( menuEntry );
fgListRemove( &fgStructure.Menu->Entries, &menuEntry->Node );
-
- /*
- * Free the entry label string, too
- */
free( menuEntry->Text );
-
free( menuEntry );
-
- /*
- * Update the menu's dimensions now
- */
fghCalculateMenuBoxSize();
}
void FGAPIENTRY glutAttachMenu( int button )
{
freeglut_assert_ready;
-
- /*
- * There must be a current window and a current menu set:
- */
- freeglut_return_if_fail( fgStructure.Window != NULL || fgStructure.Menu != NULL );
-
- /*
- * Make sure the button value is valid (0, 1 or 2, see freeglut.h)
- */
- freeglut_return_if_fail( button == GLUT_LEFT_BUTTON || button == GLUT_MIDDLE_BUTTON || button == GLUT_RIGHT_BUTTON );
-
- /*
- * It is safe now to attach the menu
- */
+ freeglut_return_if_fail( fgStructure.Window );
+ freeglut_return_if_fail( fgStructure.Menu );
+ freeglut_return_if_fail( button >= 0 );
+ freeglut_return_if_fail( button < FREEGLUT_MAX_MENUS );
fgStructure.Window->Menu[ button ] = fgStructure.Menu;
/*
void FGAPIENTRY glutDetachMenu( int button )
{
freeglut_assert_ready;
-
- /*
- * There must be a current window set:
- */
- freeglut_return_if_fail( fgStructure.Window != NULL );
-
- /*
- * Make sure the button value is valid (0, 1 or 2, see freeglut.h)
- */
- freeglut_return_if_fail( button != 0 && button != 1 && button != 2 );
-
- /*
- * It is safe now to detach the menu
- */
+ freeglut_return_if_fail( fgStructure.Window );
+ freeglut_return_if_fail( fgStructure.Menu );
+ freeglut_return_if_fail( button >= 0 );
+ freeglut_return_if_fail( button < FREEGLUT_MAX_MENUS );
fgStructure.Window->Menu[ button ] = NULL;
}
projects / freeglut / blobdiff