Screen类 参考

#include <screen.h>

Screen 的协作图:

Public 类型
enum	ColorPair {   INVALID = 0 , GREEN_BLACK = 1 , YELLOW_BLACK , RED_BLACK ,   WHITE_BLACK , BLACK_WHITE }

Public 成员函数
	~Screen (void)
void	Init (void)
void	Run (void)
void	Resize ()
void	Stop (void)
int	Width (void) const
int	Height (void) const
void	AddStr (int x, int y, ColorPair color, const char *str) const
ColorPair	Color (void) const
void	SetCurrentColor (ColorPair color) const
void	AddStr (int x, int y, const char *str) const
void	AddStr (const char *str) const
void	MoveOffsetXY (int offsetX, int offsetY) const
void	ClearCurrentColor (void) const
void	SetCurrentRenderMessage (RenderableMessage *const render_obj)

静态 Public 成员函数
static Screen *	Instance (void)

静态 Public 属性
static const char	InteractiveCmdStr []

详细描述

在文件 screen.h 第 30 行定义.

成员枚举类型说明

ColorPair

enum Screen::ColorPair

枚举值
INVALID
GREEN_BLACK
YELLOW_BLACK
RED_BLACK
WHITE_BLACK
BLACK_WHITE

在文件 screen.h 第 34 行定义.

                 {  // foreground color - background color
    INVALID = 0,
    GREEN_BLACK = 1,
    YELLOW_BLACK,
    RED_BLACK,
    WHITE_BLACK,
    BLACK_WHITE
  };

构造及析构函数说明

~Screen()

Screen::~Screen

(

void

)

在文件 screen.cc 第 87 行定义.

                {
  current_render_obj_ = nullptr;
  endwin();
}

成员函数说明

AddStr() [1/3]

void Screen::AddStr

(

const char *

str

)

const

在文件 screen.cc 第 139 行定义.

                                         {
  if (IsInit()) {
    addstr(str);
  }
}

AddStr() [2/3]

void Screen::AddStr	(	int	x,
		int	y,
		ColorPair	color,
		const char *	str
	)		const

在文件 screen.cc 第 152 行定义.

                                                                        {
  if (IsInit()) {
    attron(COLOR_PAIR(color));
    mvaddstr(y, x, str);
    attroff(COLOR_PAIR(color));
  }
}

AddStr() [3/3]

void Screen::AddStr	(	int	x,
		int	y,
		const char *	str
	)		const

在文件 screen.cc 第 133 行定义.

                                                       {
  if (IsInit()) {
    mvaddstr(y, x, str);
  }
}

ClearCurrentColor()

void Screen::ClearCurrentColor

(

void

)

const

在文件 screen.cc 第 145 行定义.

                                         {
  if (IsInit()) {
    attroff(COLOR_PAIR(current_color_pair_));
    current_color_pair_ = INVALID;
  }
}

Color()

ColorPair Screen::Color ( void  ) const

inline

在文件 screen.h 第 56 行定义.

{ return current_color_pair_; }

Height()

int Screen::Height

(

void

)

const

在文件 screen.cc 第 122 行定义.

{ return LINES; }

Init()

void Screen::Init

(

void

)

在文件 screen.cc 第 94 行定义.

                      {
  initscr();
  if (stdscr == nullptr) {
    return;
  }
  nodelay(stdscr, true);
  keypad(stdscr, true);
  meta(stdscr, true);
  curs_set(0);
  noecho();
 
  bkgd(COLOR_BLACK);
 
  start_color();
  init_pair(GREEN_BLACK, COLOR_GREEN, COLOR_BLACK);
  init_pair(YELLOW_BLACK, COLOR_YELLOW, COLOR_BLACK);
  init_pair(RED_BLACK, COLOR_RED, COLOR_BLACK);
  init_pair(WHITE_BLACK, COLOR_WHITE, COLOR_BLACK);
  init_pair(BLACK_WHITE, COLOR_BLACK, COLOR_WHITE);
 
  refresh();
  clear();
 
  canRun_ = true;
}

Instance()

Screen * Screen::Instance ( void  )

static

在文件 screen.cc 第 39 行定义.

                             {
  static Screen s;
  return &s;
}

MoveOffsetXY()

void Screen::MoveOffsetXY	(	int	offsetX,
		int	offsetY
	)		const

在文件 screen.cc 第 160 行定义.

                                                        {
  if (IsInit()) {
    int x, y;
    getyx(stdscr, y, x);
    move(y + offsetY, x + offsetX);
  }
}

Resize()

void Screen::Resize

(

void

)

在文件 screen.cc 第 242 行定义.

                        {
  if (IsInit()) {
    clear();
    refresh();
  }
}

Run()

void Screen::Run

(

void

)

在文件 screen.cc 第 210 行定义.

                 {
  if (stdscr == nullptr || current_render_obj_ == nullptr) {
    return;
  }
 
  highlight_direction_ = 0;
 
  void (Screen::*showFuncs[])(int) = {&Screen::ShowRenderMessage,
                                      &Screen::ShowInteractiveCmd};
 
  do {
    int ch = getch();
 
    if (ch == 'q' || ch == 'Q' || ch == 27) {
      canRun_ = false;
      break;
    }
 
    ch = SwitchState(ch);
 
    (this->*showFuncs[static_cast<int>(current_state_)])(ch);
 
    double fr = current_render_obj_->frame_ratio();
    if (fr < MinHalfFrameRatio) {
      fr = MinHalfFrameRatio;
    }
    int period = static_cast<int>(1000.0 / fr);
    period >>= 1;
    std::this_thread::sleep_for(std::chrono::milliseconds(period));
  } while (canRun_);
}

SetCurrentColor()

void Screen::SetCurrentColor

(

ColorPair

color

)

const

在文件 screen.cc 第 124 行定义.

                                                  {
  if (color == INVALID) {
    return;
  }
  if (IsInit()) {
    current_color_pair_ = color;
    attron(COLOR_PAIR(color));
  }
}

SetCurrentRenderMessage()

void Screen::SetCurrentRenderMessage ( RenderableMessage *const  render_obj )

inline

在文件 screen.h 第 63 行定义.

                                                                    {
    if (render_obj) {
      current_render_obj_ = render_obj;
    }
  }

Stop()

void Screen::Stop ( void  )

inline

在文件 screen.h 第 49 行定义.

{ canRun_ = false; }

Width()

int Screen::Width

(

void

)

const

在文件 screen.cc 第 120 行定义.

{ return COLS; }

类成员变量说明

InteractiveCmdStr

const char Screen::InteractiveCmdStr

static

在文件 screen.h 第 32 行定义.

---

该类的文档由以下文件生成:

• cyber/tools/cyber_monitor/screen.h
• cyber/tools/cyber_monitor/screen.cc