yorick banner

Home

Manual

Packages

Global Index

Keywords

Quick Reference

functions in yeti_gist_gui.i - g

 
 
 
gg_button


 gg_button  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 717  
 
 
 
gg_default


 gg_default  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1756  
 
 
 
gg_dialog


 gg_dialog  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 48  
 
 
 
gg_draw_3d_rect


             gg_draw_3d_rect, x0, y0, x1, y1, one_pixel,  
                              bd, relief, bg, fg, hi, lo;  
 
     Draw 3D rectangle onto current coordinate system.  (X0,Y0,X1,Y1) is  
     the bounding box of rectangle (included) in units of current plotting  
     system (NDC if plotting system is 0).  ONE_PIXEL is the pixel size in  
     units of current plotting system.  BD is the border width in pixels.  
     RELIEF is the type of relief (see gg_get_relief) FG is the foreground  
     color (used for "solid" border).  BG is the background color (no  
     background get drawn if set to GG_EXTRA) HI and LO are the colors used  
     to draw bright/dark parts of the 3D border.  All colors (BG, FG, HI  
     and LO) must be given as scalar integer.  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1534  
SEE ALSO: gg_get_relief  
 
 
 
gg_finalize


 gg_finalize  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 513  
 
 
 
gg_find


             gg_find(widget, xndc, yndc)  
 
       -or- gg_find(widget, xndc, yndc, match)  
     Get topmost widget under NDC coordinates (XNDC,YNDC) starting at  
     WIDGET.  Optional argument MATCH is the returned value if no  
     descendant of WIDGET, nor WIDGET itself, is found under (XNDC,YNDC).  
     If MATCH is the same as WIDGET, it is assumed that WIDGET is under  
     (XNDC,YNDC) regardless its actual bounding box (i.e. no check is done  
     for WIDGET itself in this case).  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1638  
SEE ALSO: mouse,   gg_find_clicked  
 
 
 
gg_find_clicked


             gg_find_clicked(top, ms)  
 
     Get widget managed by container TOP which received click event as  
     defined by MS.  MS has the same contents/meaning as the result of the  
     builtin mouse() function.  A widget is eligible as the receiver of the  
     click event if the button press and release events have occured over  
     this widget.  The return value may be nil if no children of TOP is  
     eligible for the click event.  If several widgets are eligible the  
     topmost one is returned.  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1619  
SEE ALSO: mouse,   gg_find  
 
 
 
gg_forget


             gg_forget, container, widget;  
 
     Remove WIDGET from the descendant list of CONTAINER, WIDGET will  
     no longer be displayed for subsquent repaints of CONTAINER.  If  
     WIDGET is not a descendant of CONTAINER, nothing is done.  
interpreted function, defined at contrib/yeti_gist_gui.i   line 490  
SEE ALSO: gg_manage  
 
 
 
gg_frame


 gg_frame  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 359  
 
 
 
gg_get_anchor


 gg_get_anchor  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1380  
 
 
 
gg_get_axis_flags


             gg_get_axis_flags(value, name, defvalue);  
 
     Parse axis specification VALUE which can be an integer or a string  
     where each bits/character toggle an option (see table below). If VALUE  
     is nil, the value of keyword DEFVALUE is returned.  Keyword NAME can  
     be used to set the name of the parameter for error message.  
     char  bit    option  
     ----  -----  ----------------------------------------------------  
     t     0x001  Draw ticks on bottom or left edge of viewport  
     T     0x002  Draw ticks on top or right edge of viewport  
     c     0x004  Draw ticks centered on origin in middle of viewport  
     i     0x008  Ticks project inward into viewport  
     o     0x010  Ticks project outward away from viewport (0x18 for both)  
     l     0x020  Draw tick label numbers on bottom or left edge of viewport  
     L     0x040  Draw tick label numbers on top or right edge of viewport  
     g     0x080  Draw all grid lines down to gridLevel  
     z     0x100  Draw single grid line at origin  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1326  
SEE ALSO,   gg_window.  
 
 
 
gg_get_color


 gg_get_color  
 
interpreted function, defined at contrib/yeti_gist_gui.i   line 1201  
SEE gg_is_ndx  
 
 
 
gg_get_font


             gg_get_font(value);  
 
     Parse font VALUE which can have any value recognized by Yorick  
     for the "font" keyword in builtin plotting functions and return the  
     corresponding integer value. If VALUE is nil, the value of keyword  
     DEFVALUE is returned. Keyword NAME can be used to set the name of the  
     parameter for error message.  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1297  
SEE ALSO,   font,,   gg_get_color,,   gg_window.  
 
 
 
gg_get_integer


 gg_get_integer  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1161  
 
 
 
gg_get_justify


 gg_get_justify  
 
keyword,  defined at contrib/yeti_gist_gui.i   line 1474  
SEE __gg_justify_table  
 
 
 
gg_get_real


 gg_get_real  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1176  
 
 
 
gg_get_relief


 gg_get_relief  
 
keyword,  defined at contrib/yeti_gist_gui.i   line 1489  
SEE GG_FLAT  
 
 
 
gg_get_string


 gg_get_string  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1192  
 
 
 
gg_is_ndx


             gg_is_ndx(colors)  -- true where COLORS is indexed  
 
       -or- gg_is_rgb(colors)  -- true where COLORS is RGB  
       -or- gg_rgb(r,g,b)      -- convert to RGB color  
       -or- gg_rgb_r(colors)   -- red intensity of RGB COLORS  
       -or- gg_rgb_g(colors)   -- green intensity of RGB COLORS  
       -or- gg_rgb_b(colors)   -- blue intensity of RGB COLORS  
     These routines are useful to deal with color values (as integers).  
     R, G, and B are the components of RGB colors (0=black, 255=maximum).  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1201  
SEE ALSO,   gg_get_color.  
 
 
 
gg_is_rgb


 gg_is_rgb  
 
interpreted function, defined at contrib/yeti_gist_gui.i   line 1201  
SEE gg_is_ndx  
 
 
 
gg_label


 gg_label  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 674  
 
 
 
gg_manage


             gg_manage, container, col, row, widget;  
 
     Make WIDGET a children of widget CONTAINER that will be displayed into  
     cell (COL,ROW) of CONTAINER grid.  
     Keyword ANCHOR can be used to indicates how WIDGET should be anchored  
     in its cell if there is remaining space (see gg_get_anchor).  The  
     default anchoring is centered.  
     Keywords COLSPAN and ROWSPAN indicates how many colmuns/rows the widget  
     will occupy.  The default is COLSPAN=1 and ROWSPAN=1.  
     Keywords PADX and PADY indicates how many pixels shoulkd be left around  
     the widget in its cell.  
     If keyword INSERT is true, WIDGET will be the first children of the  
     list and therefore displayed below all other children; otherwise,  
     WIDGET will be the topmost one (if children of CONTAINER do not  
     overlap, this dictinction is irrelevant).  
interpreted function, defined at contrib/yeti_gist_gui.i   line 430  
SEE ALSO: gg_finalize,   gg_forget  
 
 
 
gg_map


             gg_map(op, arg);  
 
       -or- gg_map(op, arg, defvalue);  
     Map scalar function OP onto array argument ARG to mimics element-wise  
     unary operation.  If ARG is NIL, DEFVALUE is returned.  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1738  
 
 
 
gg_no_op


 gg_no_op  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 344  
 
 
 
gg_on_click


 gg_on_click  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 728  
 
 
 
gg_one_pixel


 gg_one_pixel  
 
keyword,  defined at contrib/yeti_gist_gui.i   line 347  
SEE GG_ONE_POINT  
 
 
 
gg_paint


 gg_paint  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 336  
 
 
 
gg_pli_tool


 gg_pli_tool  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 114  
 
 
 
gg_rgb


 gg_rgb  
 
interpreted function, defined at contrib/yeti_gist_gui.i   line 1201  
SEE gg_is_ndx  
 
 
 
gg_rgb_b


 gg_rgb_b  
 
interpreted function, defined at contrib/yeti_gist_gui.i   line 1201  
SEE gg_is_ndx  
 
 
 
gg_rgb_g


 gg_rgb_g  
 
interpreted function, defined at contrib/yeti_gist_gui.i   line 1201  
SEE gg_is_ndx  
 
 
 
gg_rgb_r


 gg_rgb_r  
 
interpreted function, defined at contrib/yeti_gist_gui.i   line 1201  
SEE gg_is_ndx  
 
 
 
gg_test


 gg_test  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 257  
 
 
 
gg_toplevel


 gg_toplevel  
 
  
interpreted function, defined at contrib/yeti_gist_gui.i   line 384  
 
 
 
gg_viewport


             gg_viewport, left, right, bottom, top;  
 
       -or- gg_viewport, vp;  
       
interpreted function, defined at contrib/yeti_gist_gui.i   line 769  
SEE ALSO: window,   viewport,   set_style  
 
 
 
gg_window


             gg_window, win;  
 
       -or- gg_window;  
       -or- gg_window(...);  
     Create/switch to graphic window WIN.  This routine allows one to  
     create a window of given size with viewport(s) different from the  
     default one.  Otherwise its behaviour should mimics that of the  
     "window" builtin routine.  If called as a function, the return  
     value is an array of 6 double values:  
       [WIN, ONE_PIXEL, XMIN, XMAX, YMIN, YMAX]  
     where WIN is the window number, ONE_PIXEL is the pixel size in NDC  
     units and [XMIN,XMAX,YMIN,YMAX] is the bounding box in NDC units.  
   KEYWORDS  
     DPI, DISPLAY, PRIVATE, DUMP, HCP - Same options as for the  
                 window builtin routine.  
     WIDTH, HEIGHT - Window width/height in pixels; default: 450 at 75dpi  
                 and 600 at 100dpi.  
     LANDSCAPE - Orientation.  
     VIEWPORT  - Viewport coordinates: [XMIN, XMAX, YMIN, YMAX].  Several  
                 viewports can be specified at the same time, in this  
                 case, first dimension of VIEWPORT must be a 4 and  
                 XMIN is VIEWPORT(1,..), XMAX is VIEWPORT(2,..) and so on.  
     UNITS     - Units for the viewport keyword: 0 for NDC (default),  
                 1 for relative, and 2 for pixels.  
     FONT      - Font to use to label axes (see gg_get_font); default is  
                 Helvetica.  
     SIZE      - Text size for axis labels in points; default is 12.  
     COLOR     - Axis color (see gg_get_color); default is foreground.  
     KEEP      - Keep WIN if it already exists? Otherwise the window is  
                 forced to be recreated (this is the default behaviour).  
     XOPT      - Options for X-axis of viewport (see gg_get_axis_flags).  
     YOPT      - Options for Y-axis of viewport (see gg_get_axis_flags).  
     XMARGIN, YMARGIN -  
     Note: If you specify multiple viewports, FONT, SIZE, COLOR, XOPT  
           and YOPT can by different for each viewport.  
interpreted function, defined at contrib/yeti_gist_gui.i   line 949  
SEE ALSO,   gg_get_axis_flags,,   gg_get_color,,  
gg_get_font,,   window.  
 
 
 
gg_zoom


             gg_zoom, ms;  
 
       -or- gg_zoom, ms, zoom_factor;  
     Mimics the "zooming with the mouse" feature of Gist interactive windows.  
     Argument MS is identical to the return value of the mouse() function:  
       MS = [x_pressed,    y_pressed,    x_released,    y_released,  
             xndc_pressed, yndc_pressed, xndc_released, yndc_released,  
             system, button, modifiers];  
     Optional second argument can be used to set the zoom factor to a  
     real >=1.0.  With ZOOM_FACTOR=1.0, you can still drag the viewing  
     region.  
     For instance, the following statements will interactively  
     zoom in/out forever:  
       for (;;) {  
         ms = mouse(-1,2,"");  
         if (is_void(ms)) break;  
         gg_zoom, ms;  
       }  
interpreted function, defined at contrib/yeti_gist_gui.i   line 1665  
SEE ALSO: gg_window,   limits,   mouse,   unzoom