2
0

guiIconButtonCtrl.cpp 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415
  1. //-----------------------------------------------------------------------------
  2. // Copyright (c) 2012 GarageGames, LLC
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to
  6. // deal in the Software without restriction, including without limitation the
  7. // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  8. // sell copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19. // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  20. // IN THE SOFTWARE.
  21. //-----------------------------------------------------------------------------
  22. //-------------------------------------
  23. //
  24. // Icon Button Control
  25. // Draws the bitmap within a special button control. Only a single bitmap is used and the
  26. // button will be drawn in a highlighted mode when the mouse hovers over it or when it
  27. // has been clicked.
  28. //
  29. // Use mTextLocation to choose where within the button the text will be drawn, if at all.
  30. // Use mTextMargin to set the text away from the button sides or from the bitmap.
  31. // Use mButtonMargin to set everything away from the button sides.
  32. // Use mErrorBitmapName to set the name of a bitmap to draw if the main bitmap cannot be found.
  33. // Use mFitBitmapToButton to force the bitmap to fill the entire button extent. Usually used
  34. // with no button text defined.
  35. //
  36. //
  37. #include "platform/platform.h"
  38. #include "gui/buttons/guiIconButtonCtrl.h"
  39. #include "console/console.h"
  40. #include "gfx/gfxDevice.h"
  41. #include "gfx/gfxDrawUtil.h"
  42. #include "console/consoleTypes.h"
  43. #include "gui/core/guiCanvas.h"
  44. #include "gui/core/guiDefaultControlRender.h"
  45. #include "console/engineAPI.h"
  46. static const ColorI colorWhite(255,255,255);
  47. static const ColorI colorBlack(0,0,0);
  48. IMPLEMENT_CONOBJECT(GuiIconButtonCtrl);
  49. ConsoleDocClass( GuiIconButtonCtrl,
  50. "@brief Draws the bitmap within a special button control. Only a single bitmap is used and the\n"
  51. "button will be drawn in a highlighted mode when the mouse hovers over it or when it\n"
  52. "has been clicked.\n\n"
  53. "@tsexample\n"
  54. "new GuiIconButtonCtrl(TestIconButton)\n"
  55. "{\n"
  56. " buttonMargin = \"4 4\";\n"
  57. " iconBitmap = \"art/gui/lagIcon.png\";\n"
  58. " iconLocation = \"Center\";\n"
  59. " sizeIconToButton = \"0\";\n"
  60. " makeIconSquare = \"1\";\n"
  61. " textLocation = \"Bottom\";\n"
  62. " textMargin = \"-2\";\n"
  63. " autoSize = \"0\";\n"
  64. " text = \"Lag Icon\";\n"
  65. " textID = \"\"STR_LAG\"\";\n"
  66. " buttonType = \"PushButton\";\n"
  67. " profile = \"GuiIconButtonProfile\";\n"
  68. "};\n"
  69. "@endtsexample\n\n"
  70. "@see GuiControl\n"
  71. "@see GuiButtonCtrl\n\n"
  72. "@ingroup GuiCore\n"
  73. );
  74. GuiIconButtonCtrl::GuiIconButtonCtrl()
  75. {
  76. INIT_ASSET(Bitmap);
  77. mTextLocation = TextLocLeft;
  78. mIconLocation = IconLocLeft;
  79. mTextMargin = 4;
  80. mButtonMargin.set(4,4);
  81. mFitBitmapToButton = false;
  82. mMakeIconSquare = false;
  83. mAutoSize = false;
  84. setExtent(140, 30);
  85. }
  86. ImplementEnumType( GuiIconButtonTextLocation,
  87. "\n\n"
  88. "@ingroup GuiImages" )
  89. { GuiIconButtonCtrl::TextLocNone, "None" },
  90. { GuiIconButtonCtrl::TextLocBottom, "Bottom" },
  91. { GuiIconButtonCtrl::TextLocRight, "Right" },
  92. { GuiIconButtonCtrl::TextLocTop, "Top" },
  93. { GuiIconButtonCtrl::TextLocLeft, "Left" },
  94. { GuiIconButtonCtrl::TextLocCenter, "Center" },
  95. EndImplementEnumType;
  96. ImplementEnumType( GuiIconButtonIconLocation,
  97. "\n\n"
  98. "@ingroup GuiImages" )
  99. { GuiIconButtonCtrl::IconLocNone, "None" },
  100. { GuiIconButtonCtrl::IconLocLeft, "Left" },
  101. { GuiIconButtonCtrl::IconLocRight, "Right" },
  102. { GuiIconButtonCtrl::IconLocCenter, "Center" }
  103. EndImplementEnumType;
  104. void GuiIconButtonCtrl::initPersistFields()
  105. {
  106. addField( "buttonMargin", TypePoint2I, Offset( mButtonMargin, GuiIconButtonCtrl ),"Margin area around the button.\n");
  107. addProtectedField( "iconBitmap", TypeImageFilename, Offset( mBitmapName, GuiIconButtonCtrl ), &_setBitmapData, &defaultProtectedGetFn, "Bitmap file for the icon to display on the button.\n", AbstractClassRep::FIELD_HideInInspectors);
  108. INITPERSISTFIELD_IMAGEASSET(Bitmap, GuiIconButtonCtrl, "Bitmap file for the icon to display on the button.\n");
  109. addField( "iconLocation", TYPEID< IconLocation >(), Offset( mIconLocation, GuiIconButtonCtrl ),"Where to place the icon on the control. Options are 0 (None), 1 (Left), 2 (Right), 3 (Center).\n");
  110. addField( "sizeIconToButton", TypeBool, Offset( mFitBitmapToButton, GuiIconButtonCtrl ),"If true, the icon will be scaled to be the same size as the button.\n");
  111. addField( "makeIconSquare", TypeBool, Offset( mMakeIconSquare, GuiIconButtonCtrl ),"If true, will make sure the icon is square.\n");
  112. addField( "textLocation", TYPEID< TextLocation >(), Offset( mTextLocation, GuiIconButtonCtrl ),"Where to place the text on the control.\n"
  113. "Options are 0 (None), 1 (Bottom), 2 (Right), 3 (Top), 4 (Left), 5 (Center).\n");
  114. addField( "textMargin", TypeS32, Offset( mTextMargin, GuiIconButtonCtrl ),"Margin between the icon and the text.\n");
  115. addField( "autoSize", TypeBool, Offset( mAutoSize, GuiIconButtonCtrl ),"If true, the text and icon will be automatically sized to the size of the control.\n");
  116. Parent::initPersistFields();
  117. }
  118. bool GuiIconButtonCtrl::onWake()
  119. {
  120. if (! Parent::onWake())
  121. return false;
  122. setActive(true);
  123. setBitmap(mBitmapName);
  124. if( mProfile )
  125. mProfile->constructBitmapArray();
  126. return true;
  127. }
  128. void GuiIconButtonCtrl::onSleep()
  129. {
  130. Parent::onSleep();
  131. }
  132. void GuiIconButtonCtrl::inspectPostApply()
  133. {
  134. Parent::inspectPostApply();
  135. }
  136. void GuiIconButtonCtrl::onStaticModified(const char* slotName, const char* newValue)
  137. {
  138. if ( isProperlyAdded() && !dStricmp(slotName, "autoSize") )
  139. resize( getPosition(), getExtent() );
  140. }
  141. bool GuiIconButtonCtrl::resize(const Point2I &newPosition, const Point2I &newExtent)
  142. {
  143. if ( !mAutoSize || !mProfile->mFont )
  144. return Parent::resize( newPosition, newExtent );
  145. Point2I autoExtent( mMinExtent );
  146. if ( mIconLocation != IconLocNone )
  147. {
  148. autoExtent.y = mBitmap.getHeight() + mButtonMargin.y * 2;
  149. autoExtent.x = mBitmap.getWidth() + mButtonMargin.x * 2;
  150. }
  151. if ( mTextLocation != TextLocNone && mButtonText && mButtonText[0] )
  152. {
  153. U32 strWidth = mProfile->mFont->getStrWidthPrecise( mButtonText );
  154. if ( mTextLocation == TextLocLeft || mTextLocation == TextLocRight )
  155. {
  156. autoExtent.x += strWidth + mTextMargin * 2;
  157. }
  158. else // Top, Bottom, Center
  159. {
  160. strWidth += mTextMargin * 2;
  161. if ( strWidth > autoExtent.x )
  162. autoExtent.x = strWidth;
  163. }
  164. }
  165. return Parent::resize( newPosition, autoExtent );
  166. }
  167. void GuiIconButtonCtrl::setBitmap(const char *name)
  168. {
  169. if(!isAwake())
  170. return;
  171. _setBitmap(getBitmap());
  172. // So that extent is recalculated if autoSize is set.
  173. resize( getPosition(), getExtent() );
  174. setUpdate();
  175. }
  176. void GuiIconButtonCtrl::onRender(Point2I offset, const RectI& updateRect)
  177. {
  178. renderButton( offset, updateRect);
  179. }
  180. void GuiIconButtonCtrl::renderButton( Point2I &offset, const RectI& updateRect )
  181. {
  182. bool highlight = mMouseOver;
  183. bool depressed = mDepressed;
  184. ColorI fontColor = mActive ? (highlight ? mProfile->mFontColorHL : mProfile->mFontColor) : mProfile->mFontColorNA;
  185. RectI boundsRect(offset, getExtent());
  186. GFXDrawUtil *drawer = GFX->getDrawUtil();
  187. if (mDepressed || mStateOn)
  188. {
  189. // If there is a bitmap array then render using it.
  190. // Otherwise use a standard fill.
  191. if(mProfile->mUseBitmapArray && mProfile->mBitmapArrayRects.size())
  192. renderBitmapArray(boundsRect, statePressed);
  193. else
  194. renderSlightlyLoweredBox(boundsRect, mProfile);
  195. }
  196. else if(mMouseOver && mActive)
  197. {
  198. // If there is a bitmap array then render using it.
  199. // Otherwise use a standard fill.
  200. if(mProfile->mUseBitmapArray && mProfile->mBitmapArrayRects.size())
  201. renderBitmapArray(boundsRect, stateMouseOver);
  202. else
  203. renderSlightlyRaisedBox(boundsRect, mProfile);
  204. }
  205. else
  206. {
  207. // If there is a bitmap array then render using it.
  208. // Otherwise use a standard fill.
  209. if(mProfile->mUseBitmapArray && mProfile->mBitmapArrayRects.size())
  210. {
  211. if(mActive)
  212. renderBitmapArray(boundsRect, stateNormal);
  213. else
  214. renderBitmapArray(boundsRect, stateDisabled);
  215. }
  216. else
  217. {
  218. drawer->drawRectFill(boundsRect, mProfile->mFillColorNA);
  219. drawer->drawRect(boundsRect, mProfile->mBorderColorNA);
  220. }
  221. }
  222. Point2I textPos = offset;
  223. if(depressed)
  224. textPos += Point2I(1,1);
  225. RectI iconRect( 0, 0, 0, 0 );
  226. // Render the icon
  227. if ( mBitmap && mIconLocation != GuiIconButtonCtrl::IconLocNone )
  228. {
  229. // Render the normal bitmap
  230. drawer->clearBitmapModulation();
  231. // Maintain the bitmap size or fill the button?
  232. if ( !mFitBitmapToButton )
  233. {
  234. Point2I textureSize(mBitmap->getWidth(), mBitmap->getHeight() );
  235. iconRect.set( offset + mButtonMargin, textureSize );
  236. if ( mIconLocation == IconLocRight )
  237. {
  238. iconRect.point.x = ( offset.x + getWidth() ) - ( mButtonMargin.x + textureSize.x );
  239. iconRect.point.y = offset.y + ( getHeight() - textureSize.y ) / 2;
  240. }
  241. else if ( mIconLocation == IconLocLeft )
  242. {
  243. iconRect.point.x = offset.x + mButtonMargin.x;
  244. iconRect.point.y = offset.y + ( getHeight() - textureSize.y ) / 2;
  245. }
  246. else if ( mIconLocation == IconLocCenter )
  247. {
  248. iconRect.point.x = offset.x + ( getWidth() - textureSize.x ) / 2;
  249. iconRect.point.y = offset.y + ( getHeight() - textureSize.y ) / 2;
  250. }
  251. drawer->drawBitmapStretch(mBitmap, iconRect );
  252. }
  253. else
  254. {
  255. iconRect.set( offset + mButtonMargin, getExtent() - (mButtonMargin * 2) );
  256. if ( mMakeIconSquare )
  257. {
  258. // Square the icon to the smaller axis extent.
  259. if ( iconRect.extent.x < iconRect.extent.y )
  260. iconRect.extent.y = iconRect.extent.x;
  261. else
  262. iconRect.extent.x = iconRect.extent.y;
  263. }
  264. drawer->drawBitmapStretch( mBitmap, iconRect );
  265. }
  266. }
  267. // Render text
  268. if ( mTextLocation != TextLocNone )
  269. {
  270. // Clip text to fit (appends ...),
  271. // pad some space to keep it off our border
  272. String text( mButtonText );
  273. S32 textWidth = clipText( text, getWidth() - 4 - mTextMargin );
  274. drawer->setBitmapModulation( fontColor );
  275. if ( mTextLocation == TextLocRight )
  276. {
  277. Point2I start( mTextMargin, ( getHeight() - mProfile->mFont->getHeight() ) / 2 );
  278. if (mBitmap && mIconLocation != IconLocNone )
  279. {
  280. start.x = iconRect.extent.x + mButtonMargin.x + mTextMargin;
  281. }
  282. drawer->drawText( mProfile->mFont, start + offset, text, mProfile->mFontColors );
  283. }
  284. if ( mTextLocation == TextLocLeft )
  285. {
  286. Point2I start( mTextMargin, ( getHeight() - mProfile->mFont->getHeight() ) / 2 );
  287. drawer->drawText( mProfile->mFont, start + offset, text, mProfile->mFontColors );
  288. }
  289. if ( mTextLocation == TextLocCenter )
  290. {
  291. Point2I start;
  292. if (mBitmap && mIconLocation == IconLocLeft )
  293. {
  294. start.set( ( getWidth() - textWidth - iconRect.extent.x ) / 2 + iconRect.extent.x,
  295. ( getHeight() - mProfile->mFont->getHeight() ) / 2 );
  296. }
  297. else
  298. start.set( ( getWidth() - textWidth ) / 2, ( getHeight() - mProfile->mFont->getHeight() ) / 2 );
  299. drawer->setBitmapModulation( fontColor );
  300. drawer->drawText( mProfile->mFont, start + offset, text, mProfile->mFontColors );
  301. }
  302. if ( mTextLocation == TextLocBottom )
  303. {
  304. Point2I start;
  305. start.set( ( getWidth() - textWidth ) / 2, getHeight() - mProfile->mFont->getHeight() - mTextMargin );
  306. // If the text is longer then the box size
  307. // it will get clipped, force Left Justify
  308. if( textWidth > getWidth() )
  309. start.x = 0;
  310. drawer->setBitmapModulation( fontColor );
  311. drawer->drawText( mProfile->mFont, start + offset, text, mProfile->mFontColors );
  312. }
  313. }
  314. renderChildControls( offset, updateRect);
  315. }
  316. // Draw the bitmap array's borders according to the button's state.
  317. void GuiIconButtonCtrl::renderBitmapArray(RectI &bounds, S32 state)
  318. {
  319. switch(state)
  320. {
  321. case stateNormal:
  322. if(mProfile->mBorder == -2)
  323. renderSizableBitmapBordersFilled(bounds, 1, mProfile);
  324. else
  325. renderFixedBitmapBordersFilled(bounds, 1, mProfile);
  326. break;
  327. case stateMouseOver:
  328. if(mProfile->mBorder == -2)
  329. renderSizableBitmapBordersFilled(bounds, 2, mProfile);
  330. else
  331. renderFixedBitmapBordersFilled(bounds, 2, mProfile);
  332. break;
  333. case statePressed:
  334. if(mProfile->mBorder == -2)
  335. renderSizableBitmapBordersFilled(bounds, 3, mProfile);
  336. else
  337. renderFixedBitmapBordersFilled(bounds, 3, mProfile);
  338. break;
  339. case stateDisabled:
  340. if(mProfile->mBorder == -2)
  341. renderSizableBitmapBordersFilled(bounds, 4, mProfile);
  342. else
  343. renderFixedBitmapBordersFilled(bounds, 4, mProfile);
  344. break;
  345. }
  346. }
  347. DEF_ASSET_BINDS(GuiIconButtonCtrl, Bitmap);