User:Thav/libwsmenu

From WiiBrew
< User:Thav
Jump to navigation Jump to search

Template:Infobox homebrewapp

libwsmenu is a brand new project with the intention of building a wrapper for libwiisprite to easily create menus for homebrew software. It will be hosted at Google Code. I would greatly appreciate any feedback on features that should be included, suggestions on implementation or if this even seems like a worthwhile project. Feel free to discuss on the talk page or to me privately at my gmail address, thavilden@..... I'm working out all the details here so the process can be open for feedback. I really hate when a "standard" sort of comes out without any community input and is lousy because the creator didn't think it through all the way. I fear I might be one of those creators.


Project Info

Proposed Features

  • Menu object that takes an array of Button objects, which each contain a function pointer, default button image, hover button image, selected button image, foreground icon and foreground text.
  • Menu object will have methods to check if any of the Buttons are being hovered over or selected and then will return or call their pointed function.
  • Allow copying a menu object, so that one main menu can be created with other sub menus copied therefrom and modified.

Possible issues

  • The menu, buttons and all will have to sit in a LayerManager, but LayerManager has no visible option, so where do we put the Menu when not in use? Or is it better to discard the menu from memory and rebuild later? Will look into how this is done on other software. Each menu/function can sit in its own LayerManager and be shoved offscreen when needed. Maybe if the manager is not drawn before a flush it will not appear? Will look into this.
  • When allowing some other function to access video that does not use libwiisprite (say an emulator) then how do we make sure the path is clear, so to speak?


Class Member Function Outline

Menu

Inherit from wsp::LayerManager so I don't have to re-implement managing the list. Broke out the constructor in the same was as Button here.

Code removed, see source download

Button

Inheriting from the Sprite class now so I wouldn't have to copy the code for zoom, stretch, transparency, reference etc. Had to redefine a few of the private variables from Sprite because my SetImage will work a little differently. I have most of the functions written except for Draw (which I'm sure will take a while) so I can start testing in the next week or so.

For now, it looks like all the images will have to be the same size in the button so it can have a consistent collision rectangle and frame width/height. I'm not sure of the best way to throw an error back yet so I'm just going to have it do nothing if you muck it up.

/*
 * libwsmenu - Button
 */
#ifndef LIBWSMENU_BUTTON
#define LIBWSMENU_BUTTON
#include <gccore.h>
#include "layer.h"
#include "image.h"
//!libwsmenu namespace
namespace wsm{
	//!Generates a button object for use with a menu
	class Button : public Sprite {
 		public:
			//!Constructor
			Button();
			~Button();
			void SetUp(Image* img_up, u32 frameWidth = 0, u32 frameHeight = 0);
			void SetDown(Image* img_down, u32 frameWidth = 0, u32 frameHeight = 0);
			void SetOver(Image* img_over, u32 frameWidth = 0, u32 frameHeight = 0);
			void SetIcon(Image* icon, u32 frameWidth = 0, u32 frameHeight = 0);
			void setText(char* btn_txt);
			void setText(std::string btn_txt);
			void SetFunction(void (*f_ptr)(void));
			bool IsPointerOver(u32 x, u32 y, bool select = 0) const;
			void Draw();
		private:
			bool _hovered;
			bool _selected;
			Image* _img_up;
			Image* _img_over;
			Image* _img_down;
			Image* _image;
			void _SetImage(Image* target, Image* image, u32 frameWidth, u32 frameHeight)
			std::string _btn_txt;
			void (*_f_ptr)(void);
			void _CalcFrame();
			Rectangle* _colRect;
			u32 _frame, _frameRawCount;
			u32* _frameSeq; u32 _frameSeqLength, _frameSeqPos;
			f32 _refPixelX, _refPixelY, _refWidth, _refHeight;
			REFPIXEL_POSITIONING _positioning;
 	};
};
#endif

Development information

Borrowing heavily from