AaronCameron.net

No ads. No Profit. No Master, But Truth.

• 
• 
• 
• 
• 

Not a Member? - Login or Create an Account

Sunday the 20th of May 2012 @ 04:45pm

Front Page Journal Projects Your Profile About

LibN2L N2L Home Older News Downloads Documentation (n2l5) Class Hierarchy Compound List File List n2l:: Members Functions Whole n2l:: Ref Documentation (libN2L-4) Class Hierarchy Compound List File List n2l:: Members Functions Whole n2l:: Ref Bugtracker Project Page Report a Bug Bug List Related Things Life 2130 Devel Game Journal

LibN2L-4 Library Code Reference Classes Compounds Files Members Method Index Full Reference cGuiElement.cpp Go to the documentation of this file. /************************************************************************ Nova-2 Library (libN2L, or simply n2l) Game development C++ Library Copyright (C) 2003 Aaron Cameron This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA A copy of the GNU Lesser General Public License has been provided with this library in the file 'COPYING'. Contact information for the author of this library has been provided with this library in the file 'AUTHOR'. ************************************************************************/ #include "gui/cGuiElement.h" #include "n2l/vfs.h" #include "n2l/dynVars.h" #include "n2l/events.h" #include "gui/cGuiCanvas.h" #include "gui/cGuiFactory.h" #include "gui/cGuiACInt.h" #include "gui/cGuiSEInt.h" #include "gui/cGuiACFactory.h" namespace n2l { tUint cGuiElement::smNextElementNumber = 0; const tActionBindingID cGuiElement::FirstSystemActionID( 0 ); const tActionBindingID cGuiElement::FirstUserActionID( 1000 ); /**************************************************************************/ cGuiElement::cGuiElement() : mPos(0.0f,0.0f), mSize(0.0f,0.0f), mTopLeftPadding(0.0f,0.0f), mBottomRightPadding(0.0f,0.0f), mHasFocus(false), mName("Element "), mRenderOrder(0), mMyCanvas(0), mNextSystemActionID( FirstSystemActionID ), mNextUserActionID( FirstUserActionID ), mFirstUpdateDone(false), mSuicide(false) { mName += asString(nextElementNumber()); // Force call our own, since any children classes haven't // been constructed yet, and this could play havoc with // their members. cGuiElement::dimensionChanged(); } /**************************************************************************/ cGuiElement::cGuiElement( const tGuiPos &iPos, const tGuiPos &iSize, const tString &iName ) : mPos(iPos), mSize(iSize), mHasFocus(false), mName(iName), mRenderOrder(0), mMyCanvas(0), mNextSystemActionID( FirstSystemActionID ), mNextUserActionID( FirstUserActionID ), mFirstUpdateDone(false), mSuicide(false) { if (mName.empty()) { mName = "Element "; mName += asString(nextElementNumber()); } dimensionChanged(); } /**************************************************************************/ cGuiElement::~cGuiElement() { } /**************************************************************************/ void cGuiElement::load( const cVfsNodeInterface &iNode ) { cDynVar def; validateAndDecode( def, iNode, "n2l::cGuiElement" ); load(def); } /**************************************************************************/ void cGuiElement::load( const cDynVar &iDef ) { if (iDef["pos"]) pos( tGuiPos( iDef["pos"][0],iDef["pos"][1] ) ); if (iDef["size"]) size( tGuiPos( iDef["size"][0],iDef["size"][1] ) ); if (iDef.keyExistsAsArray("padding") && iDef["padding"].size()==2) { padding( tGuiPos( iDef["padding"][0][0], iDef["padding"][0][1] ), tGuiPos( iDef["padding"][1][0], iDef["padding"][1][1] ) ); } else if (iDef.keyExistsAsArray("padding")) { padding( tGuiPos(iDef["padding"][0],iDef["padding"][1] ), tGuiPos(iDef["padding"][2],iDef["padding"][3] ) ); } else if (iDef.keyExists("padding")) { const tFloat Padding = iDef["padding"]; padding( tGuiPos(Padding,Padding), tGuiPos(Padding,Padding) ); } renderOrder( iDef.keyValueOr( "renderOrder", 0 ) ); if (iDef.keyExistsAsArray("actions")) { const cDynVar::tConstIterator Last = iDef["actions"].end(); for (cDynVar::tConstIterator i = iDef["actions"].begin(); i!=Last; ++i) { boundCheckActionType(asUint(i->first)); bindUserAction( tGuiActionType(asUint(i->first)), cGuiACFactory::current().load( i->second ) ); } } } /**************************************************************************/ const cAutoPtr<cGuiElement> cGuiElement::get( const tGuiName &iName ) { return 0; } /**************************************************************************/ const cAutoPtr<cGuiElement> cGuiElement::mustGet( const tGuiName &iName ) { const cAutoPtr<cGuiElement> Element( get(iName) ); if (!Element.isSet()) throw cOutOfBoundsException("cGuiElement::mustGet", tString("Failed to find required element: \"") + iName + "\""); return Element; } /**************************************************************************/ const tGuiPos & cGuiElement::pos() const { return mPos; } /**************************************************************************/ const tGuiPos & cGuiElement::size() const { return mSize; } /**************************************************************************/ const tGuiPos & cGuiElement::topLeftPadding() const { return mTopLeftPadding; } /**************************************************************************/ const tGuiPos & cGuiElement::bottomRightPadding() const { return mBottomRightPadding; } /**************************************************************************/ const tString & cGuiElement::name() const { return mName; } /**************************************************************************/ void cGuiElement::renderOrder( const tSint iOrder ) { if (mMyCanvas) throw cUnsupportedMethodException( "cGuiElement::renderOrder", "Unable to change render order after being added to a " "canvas. FIX ME!" ); mRenderOrder = iOrder; } /**************************************************************************/ const tSint &cGuiElement::renderOrder() const { return mRenderOrder; } /**************************************************************************/ void cGuiElement::prop( const tString &iName, const cDynVar &iVal, const tString &iInnerKey ) { if (iName == "pos") pos( tGuiPos( iVal[0],iVal[1] ) ); else if (iName == "size") size( tGuiPos( iVal[0],iVal[1] ) ); else if (iName == "padding") { if (iVal.isArray() && iVal["padding"].size()==2) { padding( tGuiPos( iVal[0][0], iVal[0][1] ), tGuiPos( iVal[1][0], iVal[1][1] ) ); } else if (iVal.isArray()) { padding( tGuiPos(iVal[0],iVal[1] ), tGuiPos(iVal[2],iVal[3] ) ); } else { const tFloat Padding = iVal["padding"]; padding( tGuiPos(Padding,Padding), tGuiPos(Padding,Padding) ); } } else if ( iName == "renderOrder" ) renderOrder( iVal ); } /**************************************************************************/ const cDynVar cGuiElement::prop( const tString &iName, const tString &iInnerKey ) const { cDynVar oVal = cDynVar::Null; if (iName == "name") oVal = mName; else if (iName == "size") { oVal = cDynVar::Array; oVal[0] = size().x(); oVal[1] = size().y(); } else if (iName == "padding") { oVal = cDynVar::Array; oVal[0] = topLeftPadding().x(); oVal[1] = topLeftPadding().y(); oVal[2] = bottomRightPadding().x(); oVal[3] = bottomRightPadding().y(); } else if ( iName == "renderOrder" ) oVal = renderOrder(); return oVal; } /**************************************************************************/ void cGuiElement::pos( const tGuiPos & iPos ) { if (mPos!=iPos) { mPos = iPos; dimensionChanged(); } } /**************************************************************************/ void cGuiElement::size( const tGuiPos &iSize ) { mSize = iSize; dimensionChanged(); } /**************************************************************************/ void cGuiElement::padding( const tGuiPos &iTopLeft, const tGuiPos &iBottomRight ) { mTopLeftPadding = iTopLeft; mBottomRightPadding = iBottomRight; dimensionChanged(); } /**************************************************************************/ void cGuiElement::name( const tString &iName ) { mName = iName; stateChanged(); } /**************************************************************************/ void cGuiElement::systemEvent( const cAutoPtr<const cEventInterface> &i_Event ) { } /**************************************************************************/ void cGuiElement::systemEventOutside( const cAutoPtr<const cEventInterface> &i_Event ) { } /**************************************************************************/ void cGuiElement::update( const tUint iTimePassed ) { if (!mFirstUpdateDone) { cDynVar data = cDynVar::Array; data.insert( "name", name() ); broadcastAction( GuiActionType_FirstUpdate, data ); mFirstUpdateDone = true; } tSpecialEffectContainer::iterator effect( mEffects.begin() ); while (effect!=mEffects.end()) { if (!(*effect)->actOn(this,iTimePassed)) { // Send an event that the effect is complete tActionData actionData( tActionData::Array ); actionData.insert("effectName",(*effect)->name()); broadcastAction( GuiActionType_EffectComplete, actionData ); # ifdef N2L_SLOPPY_SE_ALIVE_STATUS (*effect)->alive( false ); # else if ((*effect)->alive()!=false) throw cUnsupportedMethodException( "cGuiElement::update", "Special effect called \"" + effect->name() + "\" didn\'t set its alive " "status properly." ); # endif // Remove it. effect = mEffects.erase(effect); } else ++effect; } } /**************************************************************************/ void cGuiElement::draw() const { } /**************************************************************************/ cGuiElement::tOElementList cGuiElement::getByType( const type_info &iType ) { tOElementList tmp; return getByType( tmp, iType ); } /**************************************************************************/ cGuiElement::tOElementList &cGuiElement::getByType( tOElementList &oList, const type_info &iType ) { return oList; } /**************************************************************************/ const tBool cGuiElement::focus() const { return mHasFocus; } /**************************************************************************/ void cGuiElement::focus( const tBool iFocus ) { if (iFocus==mHasFocus) return; if (canvas() && iFocus) canvas()->dropAllFocus( this ); mHasFocus = iFocus; stateChanged(); } /**************************************************************************/ const tBool cGuiElement::wantsFocus() const { return false; } /**************************************************************************/ const tUint cGuiElement::nextElementNumber() { return smNextElementNumber++; } /**************************************************************************/ void cGuiElement::canvas( cGuiCanvas *const iCanvas ) { mMyCanvas = iCanvas; } /**************************************************************************/ cGuiCanvas *const cGuiElement::canvas() { return mMyCanvas; } /**************************************************************************/ void cGuiElement::dimensionChanged() { mInnerPos = mPos+mTopLeftPadding; mInnerSize = mSize-mTopLeftPadding-mBottomRightPadding; } /**************************************************************************/ void cGuiElement::stateChanged() { } /**************************************************************************/ void cGuiElement::propertyChanged() { } /**************************************************************************/ void cGuiElement::cloneInto( const cAutoPtr<cGuiElement> &i_ioElement ) const { i_ioElement->name( name() ); i_ioElement->pos( pos() ); i_ioElement->size( size() ); i_ioElement->renderOrder( renderOrder() ); i_ioElement->padding( topLeftPadding(),bottomRightPadding() ); // Clone across actions for (tUint i = 0; i<GuiActionType_NumActionTypes; i++) { const tActionList::const_iterator Last = mActions[i].end(); for (tActionList::const_iterator i2 = mActions[i].begin(); i2!=Last; ++i2) { if (i2->first>=FirstUserActionID) i_ioElement->bindUserAction( tGuiActionType(i), i2->second->clone() ); } } } /**************************************************************************/ void cGuiElement::validateAndDecode( cDynVar &oDefinition, const cVfsNodeInterface &iNode, const tString &iRequiredHeader ) { if (!iNode.likeFile()) throw cBadDataUseException( "cGuiElement::validateAndDecode", "Provided node isn\'t like a file" ); // Load it. if (iNode.firstLine()!=iRequiredHeader) throw cParsingException("cGuiElement::validateAndDecode", tString("This file isn\'t the right type. Wanted: ") + iRequiredHeader + " got: " + iNode.firstLine() ); if (iNode.buffer().size()<=(iNode.firstLine().size()+1)) throw cParsingException("cGuiElement::validateAndDecode", "No data after header" ); // The type is ok, unserialize it for the caller to work with. oDefinition.unserialize( iNode.buffer().c_str() + iNode.firstLine().size()+1 ); } /**************************************************************************/ const tBool cGuiElement::hasChildren() const { return false; } /**************************************************************************/ void cGuiElement::addEffect( const cAutoPtr<cGuiSEInt> &i_ioEffect ) { mEffects.push_back( i_ioEffect ); } /**************************************************************************/ void cGuiElement::clearEffects() { tSpecialEffectContainer::iterator effect( mEffects.begin() ); while (effect!=mEffects.end()) { (*effect)->alive(false); ++effect; } } /**************************************************************************/ const tUint cGuiElement::numEffects() const { return mEffects.size(); } /**************************************************************************/ const tActionBindingID cGuiElement::bindUserAction( const tGuiActionType iType, const cAutoPtr<cGuiACInt> &i_ioAction ) { return bindAction( iType, i_ioAction, true ); } /**************************************************************************/ void cGuiElement::unbindUserAction( const tActionBindingID iID ) { unbindAction( iID, true ); } /**************************************************************************/ void cGuiElement::clearUserActions() { for (tUint a=0; a<GuiActionType_NumActionTypes; ++a) { tActionList::iterator aIT = mActions[a].begin(); while (aIT!=mActions[a].end()) { tActionList::iterator nextIT = aIT; ++nextIT; if (aIT->first>=FirstUserActionID) mActions[a].erase( aIT ); aIT = nextIT; } } } /**************************************************************************/ const tActionBindingID cGuiElement::bindAction( const tGuiActionType iType, const cAutoPtr<cGuiACInt> &i_ioAction, const tBool iUser ) { if (iType<0 || iType>=GuiActionType_NumActionTypes) throw cOutOfBoundsException("cGuiElement::bindAction", tString("No Such action type: ") + asString(tUint(iType)) ); tActionBindingID newID; if (iUser) newID = mNextUserActionID++; else newID = mNextSystemActionID++; tActionList::value_type newAction( newID, i_ioAction ); mActions[iType].insert( newAction ); return newID; } /**************************************************************************/ void cGuiElement::unbindAction( const tActionBindingID iID, const tBool iUser ) { if (iUser && iID<FirstUserActionID) throw cOutOfBoundsException( "cGuiElement::unbindAction", tString("May not unbind system actions: ")+ asString(tUint(iID)) ); // Check to make sure the action exists for (tUint i=GuiActionType_None; i<GuiActionType_NumActionTypes; ++i) { const tActionList::iterator ActionIT( mActions[i].find(iID) ); if (ActionIT!=mActions[i].end()) { // Unbind it and be done with the stupid thing. mActions[i].erase( ActionIT ); return; } } throw cOutOfBoundsException( "cGuiElement::unbindAction", tString("No such action ID to unbind: ") + asString(tUint(iID)) ); } /**************************************************************************/ void cGuiElement::broadcastAction( const tGuiActionType iType, const tActionData & iData ) { if (iType<0 || iType>=GuiActionType_NumActionTypes) throw cOutOfBoundsException( "cGuiElement::bindAction", tString("No Such action type: ") + asString(tUint(iType)) ); const tActionList::iterator EndActionIT( mActions[iType].end() ); tActionList::iterator it = mActions[iType].begin(); while (it!=EndActionIT) { tActionList::iterator nextIT( it ); ++nextIT; it->second->execute( this, iType, iData ); if (!it->second->preserveAction()) mActions[iType].erase(it); it = nextIT; } } /**************************************************************************/ void cGuiElement::boundCheckActionType( const tUint &iType ) const { if (iType<=GuiActionType_None || iType>=GuiActionType_NumActionTypes) throw cOutOfBoundsException( "cGuiInteractive::boundCheckActionType", "Provided action type is out of bounds.", asString(iType) ); } } // namespace n2l

©2012 Aaron Cameron