IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3dm/fx/DMFXImageViewer.z/DMFXImageViewer

Text File | 2002-10-03 | 8.5 KB | 133 lines

DDDDMMMMFFFFXXXXIIIImmmmaaaaggggeeeeVVVViiiieeeewwwweeeerrrr((((3333ddddmmmm))))                                      DDDDMMMMFFFFXXXXIIIImmmmaaaaggggeeeeVVVViiiieeeewwwweeeerrrr((((3333ddddmmmm))))



NNNNAAAAMMMMEEEE
     DDDDMMMMFFFFXXXXIIIImmmmaaaaggggeeeeVVVViiiieeeewwwweeeerrrr - An image viewer class for plugins


SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ffffxxxx____iiiimmmmaaaaggggeeee____vvvviiiieeeewwwweeeerrrr....hhhh>>>>

         Methods of class DMFXImageViewer:


              DDDDMMMMFFFFXXXXIIIImmmmaaaaggggeeeeVVVViiiieeeewwwweeeerrrr(((( WWWWiiiiddddggggeeeetttt ppppaaaarrrreeeennnntttt ))))

              ~~~~DDDDMMMMFFFFXXXXIIIImmmmaaaaggggeeeeVVVViiiieeeewwwweeeerrrr(((())))

     vvvvooooiiiidddd     sssseeeettttBBBBuuuuffff((((ccccoooonnnnsssstttt vvvvooooiiiidddd ****bbbbuuuuffff,,,, uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt wwwwiiiiddddtttthhhh,,,, uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt hhhheeeeiiiigggghhhhtttt,,,,
                     uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt rrrroooowwwwBBBByyyytttteeeessss))))

     vvvvooooiiiidddd     rrrreeeeddddrrrraaaawwww(((())))

     vvvvooooiiiidddd     sssseeeettttEEEExxxxppppoooosssseeeeCCCCaaaallllllllbbbbaaaacccckkkk((((EEEExxxxppppoooosssseeeeCCCCaaaallllllllbbbbaaaacccckkkk eeeexxxxppppoooosssseeeeCCCCBBBB,,,, XXXXttttPPPPooooiiiinnnntttteeeerrrr cccclllliiiieeeennnnttttDDDDaaaattttaaaa))))

     vvvvooooiiiidddd     sssseeeettttGGGGLLLLCCCCoooonnnntttteeeexxxxtttt(((())))

     vvvvooooiiiidddd     rrrreeeessssttttoooorrrreeeeGGGGLLLLCCCCoooonnnntttteeeexxxxtttt(((())))

     BBBBoooooooolllleeeeaaaannnn  sssseeeettttKKKKeeeeeeeeppppAAAAssssppppeeeeccccttttRRRRaaaattttiiiioooo((((BBBBoooooooolllleeeeaaaannnn kkkkeeeeeeeeppppAAAAssssppppeeeecccctttt))))

     BBBBoooooooolllleeeeaaaannnn  ggggeeeettttKKKKeeeeeeeeppppAAAAssssppppeeeeccccttttRRRRaaaattttiiiioooo(((())))



DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     Special effects plugins may have user customizable settings in the form
     of a dialog box.  These dialog boxes may have an image viewer.  This
     class provides an easy way for plugins to display an image.


MMMMEEEETTTTHHHHOOOODDDDSSSS
     DDDDMMMMFFFFXXXXIIIImmmmaaaaggggeeeeVVVViiiieeeewwwweeeerrrr((((ccccoooonnnnsssstttt cccchhhhaaaarrrr ****nnnnaaaammmmeeee,,,, WWWWiiiiddddggggeeeetttt ppppaaaarrrreeeennnntttt,,,, ccccoooonnnnsssstttt SSSSttttrrrriiiinnnngggg ****rrrreeeessssoooouuuurrrrcccceeeessss))))

         The plugin image viewer constructor.

     ~~~~DDDDMMMMFFFFXXXXIIIImmmmaaaaggggeeeeVVVViiiieeeewwwweeeerrrr(((( ))))

         The plugin image viewer destructor.

     vvvvooooiiiidddd sssseeeettttBBBBuuuuffff((((ccccoooonnnnsssstttt vvvvooooiiiidddd ****bbbbuuuuffff,,,, uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt wwwwiiiiddddtttthhhh,,,, uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt hhhheeeeiiiigggghhhhtttt,,,,
                 uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt rrrroooowwwwBBBByyyytttteeeessss))))

         Takes a pointer to an ABGR image that is to be displayed in the gl
     widget.  The image is resized as needed to show up in the window.
     Ownership of the pointer remains with the caller, *but* this object



                                                                        PPPPaaaaggggeeee 1111






DDDDMMMMFFFFXXXXIIIImmmmaaaaggggeeeeVVVViiiieeeewwwweeeerrrr((((3333ddddmmmm))))                                      DDDDMMMMFFFFXXXXIIIImmmmaaaaggggeeeeVVVViiiieeeewwwweeeerrrr((((3333ddddmmmm))))



     retains a pointer to it until the next sssseeeettttBBBBuuuuffff call.  It is OK to call
     sssseeeettttBBBBuuuuffff with NULL.

     vvvvooooiiiidddd rrrreeeeddddrrrraaaawwww(((( ))))

         Redraws the image. Note that no explicit call to rrrreeeeddddrrrraaaawwww(((()))) is
     necessary after a sssseeeettttBBBBuuuuffff(((()))) call.

     vvvvooooiiiidddd sssseeeettttEEEExxxxppppoooosssseeeeCCCCaaaallllllllbbbbaaaacccckkkk((((EEEExxxxppppoooosssseeeeCCCCaaaallllllllbbbbaaaacccckkkk eeeexxxxppppoooosssseeeeCCCCBBBB,,,, XXXXttttPPPPooooiiiinnnntttteeeerrrr cccclllliiiieeeennnnttttDDDDaaaattttaaaa))))

         Set the expose callback, where exposeCB should look like:

     void exposeCB(Widget w, XtPointer clientData, const XEvent *xev);

     Note that when using sssseeeettttBBBBuuuuffff(((()))), expose events are handled by the image
     viewer class, and the plugin does not need to handle them.

     vvvvooooiiiidddd sssseeeettttGGGGLLLLCCCCoooonnnntttteeeexxxxtttt(((( ))))

         Saves the GL context. PlugIns that render with OpenGL, and want to
     render directly to the screen can use the sssseeeettttGGGGLLLLCCCCoooonnnntttteeeexxxxtttt(((()))), and
     rrrreeeessssttttoooorrrreeeeGGGGLLLLCCCCoooonnnntttteeeexxxxtttt(((()))).

     vvvvooooiiiidddd rrrreeeessssttttoooorrrreeeeGGGGLLLLCCCCoooonnnntttteeeexxxxtttt(((( ))))

         Restores the GL context.  PlugIns that render with OpenGL, and want
     to render directly to the screen can use the sssseeeettttGGGGLLLLCCCCoooonnnntttteeeexxxxtttt(((()))), and
     rrrreeeessssttttoooorrrreeeeGGGGLLLLCCCCoooonnnntttteeeexxxxtttt(((()))).

     BBBBoooooooolllleeeeaaaannnn sssseeeettttKKKKeeeeeeeeppppAAAAssssppppeeeeccccttttRRRRaaaattttiiiioooo((((BBBBoooooooolllleeeeaaaannnn kkkkeeeeeeeeppppAAAAssssppppeeeecccctttt))))

         Set whether or not the image viewer should maintain its aspect ratio.

     BBBBoooooooolllleeeeaaaannnn ggggeeeettttKKKKeeeeeeeeppppAAAAssssppppeeeeccccttttRRRRaaaattttiiiioooo(((( ))))

         Return whether or not the image viewer should maintain its aspect
     ratio.


SSSSEEEEEEEE AAAALLLLSSSSOOOO
     DMFXDialog(3dm).














                                                                        PPPPaaaaggggeeee 2222