glcgi_image.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:5k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: glcgi_image.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/12 18:14:34  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef GUI_OPENGL___GL_CGI_IMAGE__HPP
  10. #define GUI_OPENGL___GL_CGI_IMAGE__HPP
  11. /*  $Id: glcgi_image.hpp,v 1000.1 2004/04/12 18:14:34 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Authors:  Mike DiCuccio
  37.  *
  38.  * File Description:
  39.  *    CGlCgiImage -- base class for producing images via a CGI using OpenGL
  40.  */
  41. #include <cgi/cgiapp.hpp>
  42. #include <cgi/cgictx.hpp>
  43. #include <util/image/image_io.hpp>
  44. BEGIN_NCBI_SCOPE
  45. class CGlOsContext;
  46. //
  47. // class CGlCgiImageApplication wraps a simple interface for off-screen
  48. // rendering with OpenGL
  49. //
  50. class CGlCgiImageApplication : public CCgiApplication
  51. {
  52. public:
  53.     // default ctor
  54.     CGlCgiImageApplication();
  55.     ~CGlCgiImageApplication();
  56.     // Init() - here we set our image size.  Subclasses can override this and
  57.     // provide their own desired image size
  58.     virtual void Init(void);
  59.     // ProcessRequest() intercepts the request stream, builds our off-screen
  60.     // context, and calls the internal rendering hooks
  61.     virtual int  ProcessRequest(CCgiContext& ctx);
  62.     // render our scene.  This is pure virtual - all derived classes must
  63.     // provide a mechanism for rendering their image.
  64.     virtual void Render(CCgiContext& ctx) = 0;
  65.     // retrieve the aspect ratio of our virtual frame buffer
  66.     float GetAspectRatio(void) const;
  67. protected:
  68.     // dimensions of our virtual frame buffer
  69.     size_t m_Width;
  70.     size_t m_Height;
  71.     // the image format we will emit - default is PNG
  72.     CImageIO::EType m_Format;
  73.     // our off-screen renderer
  74.     CRef<CGlOsContext> m_Context;
  75.     // string holding the name of our error template file.
  76.     // This is set in Init() via calls to the registry - to use the standard
  77.     // settings, the registry file should contain a section that contains:
  78.     //
  79.     // [filesystem]
  80.     // ErrorTemplate = <some-file-name>
  81.     string m_ErrorTemplate;
  82.     // return a valid OpenGL context.  This will create m_Context if it doesn't
  83.     // exist, and make it current for rendering
  84.     CGlOsContext& x_GetContext(void);
  85.     //
  86.     // user hooks
  87.     //
  88.     // x_PreProcess is called from ProcessRequest before any actual work is
  89.     // done.  This is provided as a hook to perform some pre-processing, and
  90.     // provides access to the member with and height variables before the
  91.     // off-screen context is created.
  92.     virtual void x_PreProcess(CCgiContext& ctx);
  93.     // x_PostProcess() is called after processing has completed but before the
  94.     // image is written to the output stream.  This is provided as a point for
  95.     // any finalization tasks.
  96.     virtual void x_PostProcess(CCgiContext& ctx);
  97.     // handle an error through the standard error template
  98.     virtual void x_HandleError(CCgiContext& ctx, const string& msg);
  99. };
  100. END_NCBI_SCOPE
  101. /*
  102.  * ===========================================================================
  103.  * $Log: glcgi_image.hpp,v $
  104.  * Revision 1000.1  2004/04/12 18:14:34  gouriano
  105.  * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.4
  106.  *
  107.  * Revision 1.4  2004/04/08 13:37:45  dicuccio
  108.  * Wrapped context creation in x_GetContext()
  109.  *
  110.  * Revision 1.3  2004/03/22 17:41:28  dicuccio
  111.  * Added error handling via HTML templates
  112.  *
  113.  * Revision 1.2  2004/01/20 12:10:23  dicuccio
  114.  * Added user hooks for process request.  Moved off-screen context creation into ProcessRequest()
  115.  *
  116.  * Revision 1.1  2003/06/09 19:31:41  dicuccio
  117.  * Initial revision
  118.  *
  119.  * ===========================================================================
  120.  */
  121. #endif  // GUI_OPENGL___GL_CGI_IMAGE__HPP