menu_window.h

Go to the documentation of this file.

//            Copyright (C) 2004-2007 by The Allacrost Project
//                         All Rights Reserved
//
// This code is licensed under the GNU GPL version 2. It is free software
// and you may modify it and/or redistribute it under the terms of this license.
// See http://www.gnu.org/copyleft/gpl.html for details.

#ifndef __MENU_WINDOW_HEADER__
#define __MENU_WINDOW_HEADER__

#include "defs.h"
#include "utils.h"
#include "gui.h"
#include "screen_rect.h"
#include "image.h"

namespace hoa_video {

const int32 VIDEO_MENU_SCROLL_TIME = 200;


const int32 VIDEO_MENU_EDGE_LEFT   = 0x1;
const int32 VIDEO_MENU_EDGE_RIGHT  = 0x2;
const int32 VIDEO_MENU_EDGE_TOP    = 0x4;
const int32 VIDEO_MENU_EDGE_BOTTOM = 0x8;
const int32 VIDEO_MENU_EDGE_ALL    = 0xF;


enum VIDEO_MENU_DISPLAY_MODE {
  VIDEO_MENU_INVALID            = -1,
  VIDEO_MENU_INSTANT            =  0,
  VIDEO_MENU_EXPAND_FROM_CENTER =  1,
  VIDEO_MENU_TOTAL              =  2
};


enum VIDEO_MENU_STATE {
  VIDEO_MENU_STATE_INVALID = -1,
  VIDEO_MENU_STATE_SHOWN   = 0,
  VIDEO_MENU_STATE_SHOWING = 1,
  VIDEO_MENU_STATE_HIDING  = 2,
  VIDEO_MENU_STATE_HIDDEN  = 3,
  VIDEO_MENU_STATE_TOTAL   = 4
};


namespace private_video {

class MenuSkin {
public:
  StillImage borders[3][3];

  StillImage connectors[5];

  StillImage background;

  MenuSkin()
    {}

  ~MenuSkin()
    {}
}; // class MenuSkin

} // namespace private_video


class MenuWindow : public private_video::GUIElement {
  friend class private_video::GUISupervisor;
public:
  MenuWindow();

  ~MenuWindow()
    {}

  bool Create(std::string skin_name, float w, float h, int32 visible_flags = VIDEO_MENU_EDGE_ALL, int32 shared_flags = 0);
  
  bool Create(float w, float h, int32 visible_flags = VIDEO_MENU_EDGE_ALL, int32 shared_flags = 0);

  void Destroy();

  void Update(uint32 frame_time);

  void Draw();

  void Show();

  void Hide();

  bool IsInitialized(std::string &errors);

  void ChangeEdgeVisibleFlags(int32 flags);

  void ChangeEdgeSharedFlags(int32 flags);

  void ChangeMenuSkin(std::string& skin_name);


  void SetDisplayMode(VIDEO_MENU_DISPLAY_MODE mode);

  void GetDimensions(float &w, float &h) const
    { w = _width; h = _height; }

  VIDEO_MENU_DISPLAY_MODE GetDisplayMode() const
    { return _display_mode; }

  VIDEO_MENU_STATE GetState() const
    { return _window_state; }

  ScreenRect GetScissorRect() const
    { return _scissor_rect; }

private:
  int32 _id;

  float _width, _height;

  float _inner_width, _inner_height;

  int32 _edge_visible_flags;

  int32 _edge_shared_flags;

  private_video::MenuSkin* _skin;

  VIDEO_MENU_STATE _window_state;

  int32 _display_timer;

  StillImage _menu_image;

  VIDEO_MENU_DISPLAY_MODE _display_mode;

  bool _is_scissored;

  ScreenRect _scissor_rect;

  bool _RecreateImage();
}; // class MenuWindow : public GUIElement

} // namespace hoa_video

#endif  // __MENU_WINDOW_HEADER__

---