llconsole.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:5k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llconsole.h
  3.  * @brief a simple console-style output device
  4.  *
  5.  * $LicenseInfo:firstyear=2001&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2001-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_LLCONSOLE_H
  33. #define LL_LLCONSOLE_H
  34. #include "llfixedbuffer.h"
  35. #include "lluictrl.h"
  36. #include "v4color.h"
  37. #include <deque>
  38. class LLSD;
  39. class LLConsole : public LLFixedBuffer, public LLUICtrl, public LLInstanceTracker<LLConsole>
  40. {
  41. public:
  42. typedef enum e_font_size
  43. {
  44. MONOSPACE = -1,
  45. SMALL = 0,
  46. BIG = 1
  47. } EFontSize;
  48. struct Params : public LLInitParam::Block<Params, LLUICtrl::Params>
  49. {
  50. Optional<U32> max_lines;
  51. Optional<F32> persist_time;
  52. Optional<S32> font_size_index;
  53. Params()
  54. : max_lines("max_lines", LLUI::sSettingGroups["config"]->getS32("ConsoleMaxLines")),
  55. persist_time("persist_time", 0.f), // forever
  56. font_size_index("font_size_index")
  57. {
  58. mouse_opaque(false);
  59. }
  60. };
  61. protected:
  62. LLConsole(const Params&);
  63. friend class LLUICtrlFactory;
  64. public:
  65. // call once per frame to pull data out of LLFixedBuffer
  66. static void updateClass();
  67. //A paragraph color segment defines the color of text in a line 
  68. //of text that was received for console display.  It has no 
  69. //notion of line wraps, screen position, or the text it contains.
  70. //It is only the number of characters that are a color and the
  71. //color.
  72. struct ParagraphColorSegment
  73. {
  74. S32 mNumChars;
  75. LLColor4 mColor;
  76. };
  77. //A line color segment is a chunk of text, the color associated
  78. //with it, and the X Position it was calculated to begin at 
  79. //on the screen.  X Positions are re-calculated if the 
  80. //screen changes size.
  81. class LineColorSegment
  82. {
  83. public:
  84. LineColorSegment(LLWString text, LLColor4 color, F32 xpos) : mText(text), mColor(color), mXPosition(xpos) {}
  85. public:
  86. LLWString mText;
  87. LLColor4  mColor;
  88. F32   mXPosition;
  89. };
  90.  
  91. typedef std::list<LineColorSegment> line_color_segments_t;
  92. //A line is composed of one or more color segments.
  93. class Line
  94. {
  95. public:
  96. line_color_segments_t mLineColorSegments;
  97. };
  98. typedef std::list<Line> lines_t;
  99. typedef std::list<ParagraphColorSegment> paragraph_color_segments_t;
  100. //A paragraph is a processed element containing the entire text of the
  101. //message (used for recalculating positions on screen resize)
  102. //The time this message was added to the console output
  103. //The visual screen width of the longest line in this block
  104. //And a list of one or more lines which are used to display this message.
  105. class Paragraph
  106. {
  107. public:
  108. Paragraph (LLWString str, const LLColor4 &color, F32 add_time, const LLFontGL* font, F32 screen_width);
  109. void makeParagraphColorSegments ( const LLColor4 &color);
  110. void updateLines ( F32 screen_width,  const LLFontGL* font, bool force_resize=false );
  111. public:
  112. LLWString mParagraphText; //The entire text of the paragraph
  113. paragraph_color_segments_t mParagraphColorSegments;
  114. F32 mAddTime; //Time this paragraph was added to the display.
  115. F32 mMaxWidth; //Width of the widest line of text in this paragraph.
  116. lines_t mLines;
  117. };
  118. //The console contains a deque of paragraphs which represent the individual messages.
  119. typedef std::deque<Paragraph> paragraph_t;
  120. paragraph_t mParagraphs;
  121. ~LLConsole(){};
  122. // each line lasts this long after being added
  123. void setLinePersistTime(F32 seconds);
  124. void reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);
  125. // -1 = monospace, 0 means small, font size = 1 means big
  126. void setFontSize(S32 size_index);
  127. // Overrides
  128. /*virtual*/ void draw();
  129. private:
  130. void update();
  131. F32 mLinePersistTime; // Age at which to stop drawing.
  132. F32 mFadeTime; // Age at which to start fading
  133. const LLFontGL* mFont;
  134. S32 mConsoleWidth;
  135. S32 mConsoleHeight;
  136. };
  137. extern LLConsole* gConsole;
  138. #endif