NewButton Class Reference

#include <newbutton.h>

Inheritance diagram for NewButton:

Public Types
enum	{   NORMAL_STATE =0, DOWN_STATE, HIGHLIGHT_STATE, DISABLED_STATE,   FINAL_BUTTON_STATE =DISABLED_STATE }

Public Member Functions
virtual int	drawingState (void)
virtual void	setDrawingState (int newState)
virtual EventCommandId	command (void)
virtual void	setCommand (EventCommandId id)
virtual std::string	label (void)
virtual void	setLabel (std::string l)
virtual GFXColor	highlightColor (void)
virtual void	setHighlightColor (const GFXColor &c)
virtual GFXColor	textHighlightColor (void)
virtual void	setTextHighlightColor (const GFXColor &c)
virtual GFXColor	downColor (void)
virtual void	setDownColor (const GFXColor &c)
virtual GFXColor	downTextColor (void)
virtual void	setDownTextColor (const GFXColor &c)
virtual float	shadowWidth (void)
virtual void	setShadowWidth (float width)
virtual float	variableBorderCycleTime (void)
virtual void	setVariableBorderCycleTime (float cycleTime)
virtual GFXColor	borderColor (void)
virtual void	setBorderColor (const GFXColor &c)
virtual GFXColor	endBorderColor (void)
virtual void	setEndBorderColor (const GFXColor &c)
virtual void	draw (void)
virtual bool	processMouseDown (const InputEvent &event)
virtual bool	processMouseUp (const InputEvent &event)
	NewButton (void)
virtual	~NewButton (void)
Public Member Functions inherited from Control
virtual Rect	rect (void)
virtual void	setRect (const Rect &r)
virtual bool	hitTest (const Point &p)
virtual bool	hidden (void)
virtual void	setHidden (bool h=true)
virtual const std::string &	id (void)
virtual void	setId (const std::string &newId)
virtual GFXColor	color (void)
virtual void	setColor (const GFXColor &c)
virtual GFXColor	outlineColor (void)
virtual void	setOutlineColor (const GFXColor &c)
virtual GFXColor	textColor (void)
virtual void	setTextColor (const GFXColor &c)
virtual Font	font (void)
virtual void	setFont (const Font &f)
virtual bool	hasGroupChildren (void)
	Control (void)
virtual	~Control (void)
Public Member Functions inherited from EventResponder
virtual bool	processCommand (const EventCommandId &command, Control *control)
virtual bool	processKeyDown (const InputEvent &event)
virtual bool	processKeyUp (const InputEvent &event)
virtual void	processUnfocus (const InputEvent &event)
virtual bool	processMouseMove (const InputEvent &event)
virtual bool	processMouseDrag (const InputEvent &event)
virtual void	sendCommand (const EventCommandId &command, Control *control)
virtual void	setCommandTarget (EventResponder *responder)
virtual void	setModal (bool modal)
	EventResponder (void)
virtual	~EventResponder (void)

Protected Member Functions
virtual void	sendButtonCommand (void)
virtual void	drawCycleBorder (float lineWidth)
Protected Member Functions inherited from Control
virtual void	drawBackground (void)

Protected Attributes
int	m_drawingState
EventCommandId	m_commandId
std::string	m_label
bool	m_leftPressed
GFXColor	m_highlightColor
GFXColor	m_textHighlightColor
GFXColor	m_downColor
GFXColor	m_downTextColor
float	m_shadowWidth
float	m_variableBorderCycleTime
GFXColor	m_borderColor
GFXColor	m_endBorderColor
PaintText	m_paintText
GFXColor	m_currentCycleColor
int	m_currentCycle
int	m_cycleStepCount
int	m_cycleDirection
GFXColor	m_cycleColorDelta
double	m_lastStepTime
Protected Attributes inherited from Control
Rect	m_rect
std::string	m_id
GFXColor	m_color
GFXColor	m_outlineColor
GFXColor	m_textColor
Font	m_font
bool	m_hidden
Protected Attributes inherited from EventResponder
bool	m_modal
EventResponder *	m_commandTarget

Detailed Description

Definition at line 34 of file newbutton.h.

Member Enumeration Documentation

anonymous enum

Enumerator
NORMAL_STATE
DOWN_STATE
HIGHLIGHT_STATE
DISABLED_STATE
FINAL_BUTTON_STATE

Definition at line 38 of file newbutton.h.

    {
        NORMAL_STATE=0,          //Normal state of a button.
        DOWN_STATE,              //Pressed down.
        HIGHLIGHT_STATE,         //Mouse is over button, but not pressed.
        DISABLED_STATE,          //Pressing the button does nothing.
        FINAL_BUTTON_STATE=DISABLED_STATE          //Last value *we've* defined.
    };

Constructor & Destructor Documentation

NewButton::NewButton

(

void

)

Definition at line 199 of file newbutton.cpp.

                           :
    m_drawingState( NewButton::NORMAL_STATE )
    , m_commandId()
    , m_leftPressed( false )
    , m_highlightColor( GUI_OPAQUE_WHITE() )
    , m_textHighlightColor( GUI_CLEAR )
    , m_downColor( GUI_CLEAR )
    , m_downTextColor( GUI_CLEAR )
    , m_shadowWidth( 1.0 )
    , m_variableBorderCycleTime( 0.0 )
    , m_borderColor( GUI_OPAQUE_BLACK() )
    , m_endBorderColor( GUI_OPAQUE_WHITE() )
    , m_currentCycleColor( GUI_OPAQUE_BLACK() )
    , m_currentCycle( 0 )
    , m_cycleStepCount( -1 )
    , m_cycleDirection( 0 )
    , m_cycleColorDelta()
    , m_lastStepTime( 0.0 )
{}

virtual NewButton::~NewButton ( void  )

inlinevirtual

Definition at line 163 of file newbutton.h.

{}

Member Function Documentation

virtual GFXColor NewButton::borderColor ( void  )

inlinevirtual

Definition at line 135 of file newbutton.h.

References m_borderColor.

    {
        return m_borderColor;
    }

virtual EventCommandId NewButton::command ( void  )

inlinevirtual

Definition at line 54 of file newbutton.h.

References m_commandId.

    {
        return m_commandId;
    }

virtual GFXColor NewButton::downColor ( void  )

inlinevirtual

Definition at line 94 of file newbutton.h.

References m_downColor.

Referenced by draw().

    {
        return m_downColor;
    }

virtual GFXColor NewButton::downTextColor ( void  )

inlinevirtual

Definition at line 104 of file newbutton.h.

References m_downTextColor.

Referenced by draw().

    {
        return m_downTextColor;
    }

void NewButton::draw ( void  )

virtual

Implements Control.

Reimplemented in ScrollerButton.

Definition at line 38 of file newbutton.cpp.

References CENTER_JUSTIFY, Control::color(), DISABLED_STATE, DOWN_STATE, downColor(), downTextColor(), PaintText::draw(), drawCycleBorder(), drawLowRightShadow(), drawRect(), drawUpLeftShadow(), Control::font(), GUI_OPAQUE_BLACK(), GUI_OPAQUE_WHITE(), HIGHLIGHT_STATE, highlightColor(), isClear(), label(), m_drawingState, m_paintText, Control::m_rect, m_variableBorderCycleTime, NORMAL_STATE, PaintText::setColor(), PaintText::setFont(), PaintText::setJustification(), PaintText::setRect(), PaintText::setText(), shadowWidth(), Control::textColor(), and textHighlightColor().

Referenced by ScrollerButton::draw(), and setDrawingState().

{
    const float lineWidth = shadowWidth();

    GFXColor    currentTextColor;                       //Color of label text.
    switch (m_drawingState)
    {
    case NORMAL_STATE:
        drawRect( m_rect, color() );
        if (m_variableBorderCycleTime > 0.0) {
            drawCycleBorder( lineWidth );
        } else {
            drawLowRightShadow( m_rect, GUI_OPAQUE_BLACK(), lineWidth );
            drawUpLeftShadow( m_rect, GUI_OPAQUE_WHITE(), lineWidth );
        }
        currentTextColor = textColor();
        break;
    case DOWN_STATE:
        {
            GFXColor currentDownColor = downColor();
            if ( isClear( currentDownColor ) )
                currentDownColor = color();
            drawRect( m_rect, currentDownColor );

            currentTextColor = downTextColor();
            if ( isClear( currentTextColor ) )
                currentTextColor = textColor();
            if (m_variableBorderCycleTime > 0.0) {
                drawCycleBorder( lineWidth );
            } else {
                drawUpLeftShadow( m_rect, GUI_OPAQUE_BLACK(), lineWidth );
                drawLowRightShadow( m_rect, GUI_OPAQUE_WHITE(), lineWidth );
            }
            break;
        }
    case HIGHLIGHT_STATE:
        drawRect( m_rect, highlightColor() );

        currentTextColor = textHighlightColor();
        if ( isClear( currentTextColor ) )
            currentTextColor = textColor();
        if (m_variableBorderCycleTime > 0.0) {
            drawCycleBorder( lineWidth );
        } else {
            drawLowRightShadow( m_rect, GUI_OPAQUE_BLACK(), lineWidth );
            drawUpLeftShadow( m_rect, GUI_OPAQUE_WHITE(), lineWidth );
        }
        break;
    case DISABLED_STATE:
        //Just the button -- no shadows.
        if (m_variableBorderCycleTime > 0.0)
            drawCycleBorder( lineWidth );
        else
            drawRect( m_rect, color() );
        currentTextColor = textColor();
        break;
    }
    //Draw the button label.
    m_paintText.setRect( m_rect );
    m_paintText.setText( label() );
    m_paintText.setFont( font() );
    m_paintText.setJustification( CENTER_JUSTIFY );
    m_paintText.setColor( currentTextColor );
    m_paintText.draw();
}

void NewButton::drawCycleBorder ( float  lineWidth)

protectedvirtual

Definition at line 105 of file newbutton.cpp.

References GFXColor::a, GFXColor::b, CYCLE_STEPS_PER_SECOND, drawRectOutline(), float_to_int(), GFXColor::g, getNewTime(), m_borderColor, m_currentCycle, m_currentCycleColor, m_cycleColorDelta, m_cycleDirection, m_cycleStepCount, m_endBorderColor, m_lastStepTime, Control::m_rect, m_variableBorderCycleTime, and GFXColor::r.

Referenced by draw().

{
    if (m_cycleStepCount <= 0)
        //We need to figure out how many steps to use.
        m_cycleStepCount = float_to_int( m_variableBorderCycleTime*CYCLE_STEPS_PER_SECOND );
    const double elapsedTime = getNewTime();
    if (elapsedTime-m_lastStepTime >= m_variableBorderCycleTime/m_cycleStepCount) {
        m_lastStepTime  = elapsedTime;

        //It's time.  Change the step in the cycle.
        m_currentCycle += m_cycleDirection;
        if (m_currentCycle <= 0) {
            //At the bottom of the cycle.
            m_currentCycleColor = m_borderColor;
            m_cycleDirection    = 1;
            m_cycleColorDelta.r = (m_endBorderColor.r-m_borderColor.r)/m_cycleStepCount;
            m_cycleColorDelta.g = (m_endBorderColor.g-m_borderColor.g)/m_cycleStepCount;
            m_cycleColorDelta.b = (m_endBorderColor.b-m_borderColor.b)/m_cycleStepCount;
            m_cycleColorDelta.a = (m_endBorderColor.a-m_borderColor.a)/m_cycleStepCount;
        } else if (m_currentCycle >= m_cycleStepCount) {
            //At the top of the cycle.
            m_currentCycleColor = m_endBorderColor;
            m_cycleDirection    = (-1);
            m_cycleColorDelta.r = (m_borderColor.r-m_endBorderColor.r)/m_cycleStepCount;
            m_cycleColorDelta.g = (m_borderColor.g-m_endBorderColor.g)/m_cycleStepCount;
            m_cycleColorDelta.b = (m_borderColor.b-m_endBorderColor.b)/m_cycleStepCount;
            m_cycleColorDelta.a = (m_borderColor.a-m_endBorderColor.a)/m_cycleStepCount;
        } else {
            //Somewhere in the middle of the cycle.
            m_currentCycleColor.r += m_cycleColorDelta.r;
            m_currentCycleColor.g += m_cycleColorDelta.g;
            m_currentCycleColor.b += m_cycleColorDelta.b;
            m_currentCycleColor.a += m_cycleColorDelta.a;
        }
    }
    //Whew!  Now actually draw it.
    drawRectOutline( m_rect, m_currentCycleColor, lineWidth );
}

int NewButton::drawingState ( void  )

virtual

Definition at line 153 of file newbutton.cpp.

References m_drawingState.

{
    return m_drawingState;
}

virtual GFXColor NewButton::endBorderColor ( void  )

inlinevirtual

Definition at line 145 of file newbutton.h.

References m_endBorderColor.

    {
        return m_endBorderColor;
    }

virtual GFXColor NewButton::highlightColor ( void  )

inlinevirtual

Definition at line 74 of file newbutton.h.

References m_highlightColor.

Referenced by draw().

    {
        return m_highlightColor;
    }

virtual std::string NewButton::label ( void  )

inlinevirtual

Definition at line 64 of file newbutton.h.

References m_label.

Referenced by ScrollerButton::draw(), and draw().

    {
        return m_label;
    }

bool NewButton::processMouseDown ( const InputEvent &  event)

virtual

Reimplemented from EventResponder.

Definition at line 165 of file newbutton.cpp.

References InputEvent::code, DOWN_STATE, globalEventManager(), LEFT_MOUSE_BUTTON, m_leftPressed, EventResponder::processMouseDown(), EventManager::pushResponder(), setDrawingState(), and EventResponder::setModal().

{
    if (event.code == LEFT_MOUSE_BUTTON) {
        m_leftPressed = true;             //Remember this for mouse-up.
        setModal( true );                 //Make sure we don't miss anything.
        //Make sure we see mouse events *first* until we get a mouse-up.
        globalEventManager().pushResponder( this );
        setDrawingState( DOWN_STATE );
        return true;
    }
    return Control::processMouseDown( event );
}

bool NewButton::processMouseUp ( const InputEvent &  event)

virtual

Reimplemented from EventResponder.

Definition at line 178 of file newbutton.cpp.

References InputEvent::code, globalEventManager(), Control::hitTest(), LEFT_MOUSE_BUTTON, InputEvent::loc, m_leftPressed, NORMAL_STATE, EventResponder::processMouseUp(), EventManager::removeResponder(), sendButtonCommand(), setDrawingState(), and EventResponder::setModal().

{
    if (m_leftPressed && event.code == LEFT_MOUSE_BUTTON) {
        //Send the button command if the button goes up inside the button.
        //If not, consider the button action cancelled.
        const bool doCommand = ( hitTest( event.loc ) );

        setDrawingState( NORMAL_STATE );

        //Make sure we get off the event chain.
        globalEventManager().removeResponder( this, true );
        setModal( false );
        m_leftPressed = false;
        //Send the command now, after we've cleaned up the event handling.
        if (doCommand) sendButtonCommand();
        return Control::processMouseUp( event );
    }
    return false;
}

void NewButton::sendButtonCommand ( void  )

protectedvirtual

Definition at line 160 of file newbutton.cpp.

References m_commandId, and EventResponder::sendCommand().

Referenced by processMouseUp().

{
    sendCommand( m_commandId, this );
}

virtual void NewButton::setBorderColor ( const GFXColor &  c)

inlinevirtual

Definition at line 139 of file newbutton.h.

References c, and m_borderColor.

Referenced by NavComputer::constructControls(), and BaseComputer::constructControls().

    {
        m_borderColor = c;
    }

virtual void NewButton::setCommand ( EventCommandId  id)

inlinevirtual

Definition at line 58 of file newbutton.h.

References Control::id(), and m_commandId.

Referenced by Scroller::calcLayout(), BaseComputer::configureCargoCommitControls(), BaseComputer::configureUpgradeCommitControls(), NavComputer::constructControls(), BaseComputer::constructControls(), GameMenu::createControls(), Scroller::createControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), CreateControlsForYesNoWindow(), BaseComputer::createModeButtons(), GameMenu::createNetworkControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), BaseComputer::LoadSaveQuitConfirm::init(), and BaseComputer::updateTransactionControlsForSelection().

    {
        m_commandId = id;
    }

virtual void NewButton::setDownColor ( const GFXColor &  c)

inlinevirtual

Definition at line 98 of file newbutton.h.

References c, and m_downColor.

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), GameMenu::createControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), CreateControlsForYesNoWindow(), GameMenu::createNetworkControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), and BaseComputer::LoadSaveQuitConfirm::init().

    {
        m_downColor = c;
    }

virtual void NewButton::setDownTextColor ( const GFXColor &  c)

inlinevirtual

Definition at line 108 of file newbutton.h.

References c, and m_downTextColor.

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), GameMenu::createControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), CreateControlsForYesNoWindow(), GameMenu::createNetworkControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), and BaseComputer::LoadSaveQuitConfirm::init().

    {
        m_downTextColor = c;
    }

void NewButton::setDrawingState ( int  newState)

virtual

Definition at line 145 of file newbutton.cpp.

References draw(), and m_drawingState.

Referenced by processMouseDown(), and processMouseUp().

{
    if (m_drawingState != newState) {
        m_drawingState = newState;
        draw();
    }
}

virtual void NewButton::setEndBorderColor ( const GFXColor &  c)

inlinevirtual

Definition at line 149 of file newbutton.h.

References c, and m_endBorderColor.

Referenced by NavComputer::constructControls(), and BaseComputer::constructControls().

    {
        m_endBorderColor = c;
    }

virtual void NewButton::setHighlightColor ( const GFXColor &  c)

inlinevirtual

Definition at line 78 of file newbutton.h.

References c, and m_highlightColor.

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), CreateControlsForYesNoWindow(), GameMenu::createNetworkControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), and BaseComputer::LoadSaveQuitConfirm::init().

    {
        m_highlightColor = c;
    }

virtual void NewButton::setLabel ( std::string  l)

inlinevirtual

Definition at line 68 of file newbutton.h.

References m_label.

Referenced by BaseComputer::configureCargoCommitControls(), BaseComputer::configureUpgradeCommitControls(), NavComputer::constructControls(), BaseComputer::constructControls(), GameMenu::createControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), CreateControlsForYesNoWindow(), BaseComputer::createModeButtons(), GameMenu::createNetworkControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), BaseComputer::LoadSaveQuitConfirm::init(), NavComputer::loadAbsoluteButton(), and BaseComputer::updateTransactionControlsForSelection().

    {
        m_label = l;
    }

virtual void NewButton::setShadowWidth ( float  width)

inlinevirtual

Definition at line 118 of file newbutton.h.

References m_shadowWidth, and width.

Referenced by NavComputer::constructControls(), and BaseComputer::constructControls().

    {
        m_shadowWidth = width;
    }

virtual void NewButton::setTextHighlightColor ( const GFXColor &  c)

inlinevirtual

Definition at line 88 of file newbutton.h.

References c, and m_textHighlightColor.

    {
        m_textHighlightColor = c;
    }

virtual void NewButton::setVariableBorderCycleTime ( float  cycleTime)

inlinevirtual

Definition at line 128 of file newbutton.h.

References m_cycleStepCount, and m_variableBorderCycleTime.

Referenced by NavComputer::constructControls(), and BaseComputer::constructControls().

    {
        m_variableBorderCycleTime = cycleTime;
        m_cycleStepCount = (-1);
    }

virtual float NewButton::shadowWidth ( void  )

inlinevirtual

Definition at line 114 of file newbutton.h.

References m_shadowWidth.

Referenced by draw().

    {
        return m_shadowWidth;
    }

virtual GFXColor NewButton::textHighlightColor ( void  )

inlinevirtual

Definition at line 84 of file newbutton.h.

References m_textHighlightColor.

Referenced by draw().

    {
        return m_textHighlightColor;
    }

virtual float NewButton::variableBorderCycleTime ( void  )

inlinevirtual

Definition at line 124 of file newbutton.h.

References m_variableBorderCycleTime.

    {
        return m_variableBorderCycleTime;
    }

Member Data Documentation

GFXColor NewButton::m_borderColor

protected

Definition at line 187 of file newbutton.h.

Referenced by borderColor(), drawCycleBorder(), and setBorderColor().

EventCommandId NewButton::m_commandId

protected

Definition at line 178 of file newbutton.h.

Referenced by command(), sendButtonCommand(), and setCommand().

int NewButton::m_currentCycle

protected

Definition at line 193 of file newbutton.h.

Referenced by drawCycleBorder().

GFXColor NewButton::m_currentCycleColor

protected

Definition at line 192 of file newbutton.h.

Referenced by drawCycleBorder().

GFXColor NewButton::m_cycleColorDelta

protected

Definition at line 196 of file newbutton.h.

Referenced by drawCycleBorder().

int NewButton::m_cycleDirection

protected

Definition at line 195 of file newbutton.h.

Referenced by drawCycleBorder().

int NewButton::m_cycleStepCount

protected

Definition at line 194 of file newbutton.h.

Referenced by drawCycleBorder(), and setVariableBorderCycleTime().

GFXColor NewButton::m_downColor

protected

Definition at line 183 of file newbutton.h.

Referenced by downColor(), and setDownColor().

GFXColor NewButton::m_downTextColor

protected

Definition at line 184 of file newbutton.h.

Referenced by downTextColor(), and setDownTextColor().

int NewButton::m_drawingState

protected

Definition at line 177 of file newbutton.h.

Referenced by draw(), drawingState(), and setDrawingState().

GFXColor NewButton::m_endBorderColor

protected

Definition at line 188 of file newbutton.h.

Referenced by drawCycleBorder(), endBorderColor(), and setEndBorderColor().

GFXColor NewButton::m_highlightColor

protected

Definition at line 181 of file newbutton.h.

Referenced by highlightColor(), and setHighlightColor().

std::string NewButton::m_label

protected

Definition at line 179 of file newbutton.h.

Referenced by label(), and setLabel().

double NewButton::m_lastStepTime

protected

Definition at line 197 of file newbutton.h.

Referenced by drawCycleBorder().

bool NewButton::m_leftPressed

protected

Definition at line 180 of file newbutton.h.

Referenced by processMouseDown(), and processMouseUp().

PaintText NewButton::m_paintText

protected

Definition at line 189 of file newbutton.h.

Referenced by draw().

float NewButton::m_shadowWidth

protected

Definition at line 185 of file newbutton.h.

Referenced by setShadowWidth(), and shadowWidth().

GFXColor NewButton::m_textHighlightColor

protected

Definition at line 182 of file newbutton.h.

Referenced by setTextHighlightColor(), and textHighlightColor().

float NewButton::m_variableBorderCycleTime

protected

Definition at line 186 of file newbutton.h.

Referenced by draw(), drawCycleBorder(), setVariableBorderCycleTime(), and variableBorderCycleTime().

---

The documentation for this class was generated from the following files:

• src/gui/newbutton.h
• src/gui/newbutton.cpp