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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: glbackground.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 19:49:20  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef GUI_OPENGL___GLBACKGROUND__HPP
  10. #define GUI_OPENGL___GLBACKGROUND__HPP
  11. /*  $Id: glbackground.hpp,v 1000.2 2004/06/01 19:49:20 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.  *
  40.  */
  41. #include <corelib/ncbiobj.hpp>
  42. #include <gui/opengl/glbackground.hpp>
  43. #include <gui/opengl/glcolor.hpp>
  44. #include <gui/opengl/glteximage.hpp>
  45. #include <gui/opengl/glrect.hpp>
  46. /** @addtogroup GUI_OPENGL
  47.  *
  48.  * @{
  49.  */
  50. BEGIN_NCBI_SCOPE
  51. //
  52. // class CGlBackground abstracts the notion of the background for a scene.
  53. //
  54. // This class provides options for easily creating a number of simple
  55. // background effects.  The options supported include:
  56. //      - solid color
  57. //      - color gradient from top->bottom or left->right with arbitrarily
  58. //        defined light and dark colors
  59. class NCBI_GUIOPENGL_EXPORT CGlBackground
  60. {
  61. public:
  62.     // enum of rvarious background effects
  63.     enum EType {
  64.         eSolid,         // solid color
  65.         eGradientDown,  // gradient color, light->dark from top->bottom
  66.         eGradientRight, // gradient color, light->dark from left->right
  67.         eTexture        // texture
  68.     };
  69.     CGlBackground();
  70.     explicit CGlBackground(EType type);
  71.     // set the type of background we use
  72.     void SetType(EType type);
  73.     // set the colors we use for the background.  We have more than one color -
  74.     // light color and dark.  For the solid color background, the light color
  75.     // is used (this is exposed as SetColor()).  For the gradient colors, we
  76.     // use two, a light and a dark.  Calling SetDark() with no parameters sets
  77.     // the dark color as a multiple of the light color.
  78.     // There is no requirement that the light color be brighter than the dark
  79.     // color.
  80.     void SetColor(const CGlColor& c);
  81.     void SetLightColor(const CGlColor& c);
  82.     void SetDarkColor(const CGlColor& c);
  83.     void SetDarkColor(void);
  84.     // set the texture we use.  This is only used if the background type is
  85.     // eTexture
  86.     void SetTexture(CTexImage& tex);
  87.     // draw our background.  This will explicitly preserve all matrices.
  88.     void Draw(void);
  89.     // draw our background in the specified viewport.  This will explicitly
  90.     // preserve all matrices.
  91.     void Draw(const CGlRect<int>& vp);
  92. private:
  93.     // the type of background we draw
  94.     EType m_Type;
  95.     // our colors
  96.     CGlColor m_LightColor;
  97.     CGlColor m_DarkColor;
  98.     // our texture
  99.     CRef<CTexImage> m_Texture;
  100. };
  101. END_NCBI_SCOPE
  102. /* @} */
  103. /*
  104.  * ===========================================================================
  105.  * $Log: glbackground.hpp,v $
  106.  * Revision 1000.2  2004/06/01 19:49:20  gouriano
  107.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
  108.  *
  109.  * Revision 1.4  2004/05/11 18:54:22  dicuccio
  110.  * Added doxygne modules info
  111.  *
  112.  * Revision 1.3  2004/03/24 19:30:27  gorelenk
  113.  * Added export prefix NCBI_GUIOPENGL_EXPORT to class CGlBackground .
  114.  *
  115.  * Revision 1.2  2004/03/22 18:50:38  dicuccio
  116.  * Removed dtor.  Added #include for CTexImage.  Added Draw() variant to restrict
  117.  * drawing to a given viewport
  118.  *
  119.  * Revision 1.1  2003/06/09 19:31:40  dicuccio
  120.  * Initial revision
  121.  *
  122.  * ===========================================================================
  123.  */
  124. #endif  // GUI_OPENGL___GLBACKGROUND__HPP