mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-06-19 06:43:58 -07:00
a33fd55e81
Improves performance for Draw calls by 3-5% according to a shady benchmark. Improves memory layout, since the values are not on the heap anymore but in the using class. Reduces complexity of the implementation and increases type safety. Allows specifying default values at setting value construction time, refs D2242. Inspired by Vladislav introducing members that cached GetSetting values in c016a74309/D325, refs #4039, ee38f0db37/D763, refs 4225, a1c4c23ce4/D474, D406, which were formerly proposed to be removed in D2241. Differential Revision: https://code.wildfiregames.com/D2313 Tested on: clang 8.0.1, gcc 9.1.0, Jenkins vs2015 Comments By: Vladislav This was SVN commit r23005.
98 lines
3.1 KiB
C++
98 lines
3.1 KiB
C++
/* Copyright (C) 2019 Wildfire Games.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/*
|
|
Interface class that enhance the IGUIObject with
|
|
buttony behavior (click and release to click a button),
|
|
and the GUI message GUIM_PRESSED.
|
|
When creating a class with extended settings and
|
|
buttony behavior, just do a multiple inheritance.
|
|
*/
|
|
|
|
#ifndef INCLUDED_IGUIBUTTONBEHAVIOR
|
|
#define INCLUDED_IGUIBUTTONBEHAVIOR
|
|
|
|
#include "gui/IGUIObject.h"
|
|
|
|
class CGUISpriteInstance;
|
|
|
|
/**
|
|
* Appends button behaviours to the IGUIObject.
|
|
* Can be used with multiple inheritance alongside
|
|
* IGUISettingsObject and such.
|
|
*/
|
|
class IGUIButtonBehavior : virtual public IGUIObject
|
|
{
|
|
public:
|
|
IGUIButtonBehavior(CGUI& pGUI);
|
|
virtual ~IGUIButtonBehavior();
|
|
|
|
/**
|
|
* @see IGUIObject#HandleMessage()
|
|
*/
|
|
virtual void HandleMessage(SGUIMessage& Message);
|
|
|
|
/**
|
|
* This is a function that lets a button being drawn,
|
|
* it regards if it's over, disabled, pressed and such.
|
|
* You input sprite names and area and it'll output
|
|
* it accordingly.
|
|
*
|
|
* This class is meant to be used manually in Draw()
|
|
*
|
|
* @param rect Rectangle in which the sprite should be drawn
|
|
* @param z Z-value
|
|
* @param sprite Sprite drawn when not pressed, hovered or disabled
|
|
* @param sprite_over Sprite drawn when m_MouseHovering is true
|
|
* @param sprite_pressed Sprite drawn when m_Pressed is true
|
|
* @param sprite_disabled Sprite drawn when "enabled" is false
|
|
* @param cell_id Identifies the icon to be used (if the sprite contains
|
|
* cell-using images)
|
|
*/
|
|
void DrawButton(const CRect& rect, const float& z, const CGUISpriteInstance& sprite, const CGUISpriteInstance& sprite_over, const CGUISpriteInstance& sprite_pressed, const CGUISpriteInstance& sprite_disabled, int cell_id);
|
|
|
|
protected:
|
|
/**
|
|
* @see IGUIObject#ResetStates()
|
|
*/
|
|
virtual void ResetStates()
|
|
{
|
|
// Notify the gui that we aren't hovered anymore
|
|
UpdateMouseOver(nullptr);
|
|
m_Pressed = false;
|
|
m_PressedRight = false;
|
|
}
|
|
|
|
/**
|
|
* Everybody knows how a button works, you don't simply press it,
|
|
* you have to first press the button, and then release it...
|
|
* in between those two steps you can actually leave the button
|
|
* area, as long as you release it within the button area... Anyway
|
|
* this lets us know we are done with step one (clicking).
|
|
*/
|
|
bool m_Pressed;
|
|
bool m_PressedRight;
|
|
|
|
// Settings
|
|
CStrW m_SoundDisabled;
|
|
CStrW m_SoundEnter;
|
|
CStrW m_SoundLeave;
|
|
CStrW m_SoundPressed;
|
|
CStrW m_SoundReleased;
|
|
};
|
|
|
|
#endif // INCLUDED_IGUIBUTTONBEHAVIOR
|