BsGUITreeView.cpp 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354
  1. //********************************** Banshee Engine (www.banshee3d.com) **************************************************//
  2. //**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
  3. #include "GUI/BsGUITreeView.h"
  4. #include "GUI/BsGUILayout.h"
  5. #include "GUI/BsGUITexture.h"
  6. #include "GUI/BsGUIButton.h"
  7. #include "GUI/BsGUILabel.h"
  8. #include "GUI/BsGUISpace.h"
  9. #include "GUI/BsCGUIWidget.h"
  10. #include "GUI/BsGUIToggle.h"
  11. #include "GUI/BsGUITreeViewEditBox.h"
  12. #include "GUI/BsGUIMouseEvent.h"
  13. #include "GUI/BsGUISkin.h"
  14. #include "GUI/BsGUICommandEvent.h"
  15. #include "GUI/BsGUIVirtualButtonEvent.h"
  16. #include "GUI/BsGUIScrollArea.h"
  17. #include "GUI/BsDragAndDropManager.h"
  18. #include "Utility/BsTime.h"
  19. using namespace std::placeholders;
  20. namespace bs
  21. {
  22. const UINT32 GUITreeView::ELEMENT_EXTRA_SPACING = 3;
  23. const UINT32 GUITreeView::INDENT_SIZE = 10;
  24. const UINT32 GUITreeView::INITIAL_INDENT_OFFSET = 16;
  25. const UINT32 GUITreeView::DRAG_MIN_DISTANCE = 3;
  26. const float GUITreeView::AUTO_EXPAND_DELAY_SEC = 0.5f;
  27. const float GUITreeView::SCROLL_AREA_HEIGHT_PCT = 0.1f;
  28. const UINT32 GUITreeView::SCROLL_SPEED_PX_PER_SEC = 100;
  29. const Color GUITreeView::CUT_COLOR = Color(1.0f, 1.0f, 1.0f, 0.3f);
  30. const Color GUITreeView::DISABLED_COLOR = Color(1.0f, 1.0f, 1.0f, 0.6f);
  31. GUITreeView::TreeElement::TreeElement()
  32. : mParent(nullptr), mFoldoutBtn(nullptr), mElement(nullptr), mSortedIdx(0), mIsExpanded(false), mIsSelected(false)
  33. , mIsHighlighted(false), mIsVisible(true), mIsCut(false), mIsDisabled(false)
  34. { }
  35. GUITreeView::TreeElement::~TreeElement()
  36. {
  37. assert(mChildren.empty());
  38. if(mFoldoutBtn != nullptr)
  39. GUIElement::destroy(mFoldoutBtn);
  40. if(mElement != nullptr)
  41. GUIElement::destroy(mElement);
  42. }
  43. bool GUITreeView::TreeElement::isParentRec(TreeElement* element) const
  44. {
  45. TreeElement* curParent = mParent;
  46. while(curParent != nullptr)
  47. {
  48. if(curParent == element)
  49. return true;
  50. curParent = curParent->mParent;
  51. }
  52. return false;
  53. }
  54. GUITreeView::TreeElement* GUITreeView::InteractableElement::getTreeElement() const
  55. {
  56. if(!isTreeElement())
  57. return nullptr;
  58. UINT32 sortedIdx = (index - 1) / 2;
  59. auto findIter = std::find_if(parent->mChildren.begin(), parent->mChildren.end(),
  60. [&](const TreeElement* x) { return x->mSortedIdx == sortedIdx; });
  61. if(findIter != parent->mChildren.end())
  62. return *findIter;
  63. return nullptr;
  64. }
  65. GUITreeView::GUITreeView(const String& backgroundStyle, const String& elementBtnStyle,
  66. const String& foldoutBtnStyle, const String& selectionBackgroundStyle, const String& highlightBackgroundStyle,
  67. const String& editBoxStyle, const String& dragHighlightStyle, const String& dragSepHighlightStyle, const GUIDimensions& dimensions)
  68. : GUIElementContainer(dimensions), mBackgroundStyle(backgroundStyle), mElementBtnStyle(elementBtnStyle)
  69. , mFoldoutBtnStyle(foldoutBtnStyle), mSelectionBackgroundStyle(selectionBackgroundStyle)
  70. , mHighlightBackgroundStyle(highlightBackgroundStyle), mEditBoxStyle(editBoxStyle)
  71. , mDragHighlightStyle(dragHighlightStyle), mDragSepHighlightStyle(dragSepHighlightStyle), mIsElementSelected(false)
  72. , mIsElementHighlighted(false), mEditElement(nullptr), mNameEditBox(nullptr), mDragInProgress(false)
  73. , mDragHighlight(nullptr), mDragSepHighlight(nullptr), mScrollState(ScrollState::None), mLastScrollTime(0.0f)
  74. , mMouseOverDragElement(nullptr), mMouseOverDragElementTime(0.0f)
  75. {
  76. if(mBackgroundStyle == StringUtil::BLANK)
  77. mBackgroundStyle = "TreeViewBackground";
  78. if(mElementBtnStyle == StringUtil::BLANK)
  79. mElementBtnStyle = "TreeViewElementBtn";
  80. if(mFoldoutBtnStyle == StringUtil::BLANK)
  81. mFoldoutBtnStyle = "Expand";
  82. if(mSelectionBackgroundStyle == StringUtil::BLANK)
  83. mSelectionBackgroundStyle = "TreeViewSelectionBackground";
  84. if (mHighlightBackgroundStyle == StringUtil::BLANK)
  85. mHighlightBackgroundStyle = "TreeViewHighlightBackground";
  86. if(mEditBoxStyle == StringUtil::BLANK)
  87. mEditBoxStyle = "TreeViewEditBox";
  88. if(mDragHighlightStyle == StringUtil::BLANK)
  89. mDragHighlightStyle = "TreeViewElementHighlight";
  90. if(mDragSepHighlightStyle == StringUtil::BLANK)
  91. mDragSepHighlightStyle = "TreeViewElementSepHighlight";
  92. mBackgroundImage = GUITexture::create(mBackgroundStyle);
  93. mNameEditBox = GUITreeViewEditBox::create(mEditBoxStyle);
  94. mNameEditBox->setVisible(false);
  95. mNameEditBox->onInputConfirmed.connect(std::bind(&GUITreeView::onEditAccepted, this));
  96. mNameEditBox->onInputCanceled.connect(std::bind(&GUITreeView::onEditCanceled, this));
  97. mNameEditBox->onFocusLost.connect(std::bind(&GUITreeView::onEditFocusLost, this));
  98. mDragHighlight = GUITexture::create(mDragHighlightStyle);
  99. mDragSepHighlight = GUITexture::create(mDragSepHighlightStyle);
  100. mDragHighlight->setVisible(false);
  101. mDragSepHighlight->setVisible(false);
  102. mDragHighlight->_setElementDepth(2);
  103. mDragSepHighlight->_setElementDepth(2);
  104. _registerChildElement(mBackgroundImage);
  105. _registerChildElement(mNameEditBox);
  106. _registerChildElement(mDragHighlight);
  107. _registerChildElement(mDragSepHighlight);
  108. }
  109. GUITreeView::~GUITreeView()
  110. {
  111. }
  112. void GUITreeView::_update()
  113. {
  114. // Attempt to auto-expand elements we are dragging over
  115. if(acceptDragAndDrop())
  116. {
  117. const InteractableElement* element = findElementUnderCoord(mDragPosition);
  118. temporarilyExpandElement(element);
  119. }
  120. // NOTE - Instead of iterating through every visible element and comparing it with internal values,
  121. // I might just want to add callbacks to SceneManager that notify me of any changes and then only perform
  122. // update if anything is actually dirty
  123. updateTreeElementHierarchy();
  124. // Attempt to scroll if needed
  125. if(mScrollState != ScrollState::None)
  126. {
  127. GUIScrollArea* scrollArea = findParentScrollArea();
  128. if(scrollArea != nullptr)
  129. {
  130. float curTime = gTime().getTime();
  131. float timeDiff = curTime - mLastScrollTime;
  132. float secondsPerPixel = 1.0f / SCROLL_SPEED_PX_PER_SEC;
  133. switch(mScrollState)
  134. {
  135. case ScrollState::TransitioningUp:
  136. mScrollState = ScrollState::Up;
  137. mLastScrollTime = curTime;
  138. break;
  139. case ScrollState::TransitioningDown:
  140. mScrollState = ScrollState::Down;
  141. mLastScrollTime = curTime;
  142. break;
  143. case ScrollState::Up:
  144. {
  145. UINT32 scrollAmount = (UINT32)Math::floorToInt(timeDiff / secondsPerPixel);
  146. mLastScrollTime += scrollAmount * secondsPerPixel;
  147. scrollArea->scrollUpPx(scrollAmount);
  148. }
  149. break;
  150. case ScrollState::Down:
  151. {
  152. UINT32 scrollAmount = (UINT32)Math::floorToInt(timeDiff / secondsPerPixel);
  153. mLastScrollTime += scrollAmount * secondsPerPixel;
  154. scrollArea->scrollDownPx(scrollAmount);
  155. }
  156. break;
  157. case ScrollState::None:
  158. break;
  159. }
  160. }
  161. }
  162. }
  163. bool GUITreeView::_mouseEvent(const GUIMouseEvent& event)
  164. {
  165. if(event.getType() == GUIMouseEventType::MouseUp)
  166. {
  167. if(DragAndDropManager::instance().isDragInProgress())
  168. return false;
  169. const InteractableElement* element = findElementUnderCoord(event.getPosition());
  170. TreeElement* treeElement = nullptr;
  171. if(element != nullptr && element->isTreeElement())
  172. {
  173. treeElement = element->getTreeElement();
  174. }
  175. if (treeElement != nullptr)
  176. {
  177. bool onFoldout = false;
  178. if (treeElement->mFoldoutBtn != nullptr)
  179. onFoldout = treeElement->mFoldoutBtn->_getClippedBounds().contains(event.getPosition());
  180. bool onEditElement = false;
  181. if (mEditElement != nullptr)
  182. onEditElement = treeElement == mEditElement;
  183. if (!onFoldout && !onEditElement)
  184. {
  185. if (event.getButton() == GUIMouseButton::Left)
  186. {
  187. if (event.isCtrlDown())
  188. {
  189. selectElement(treeElement);
  190. }
  191. else if (event.isShiftDown())
  192. {
  193. if (isSelectionActive())
  194. {
  195. TreeElement* selectionRoot = mSelectedElements[0].element;
  196. unselectAll();
  197. auto iterStartFind = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  198. [&](const InteractableElement& x) { return x.parent == selectionRoot->mParent; });
  199. bool foundStart = false;
  200. bool foundEnd = false;
  201. for (; iterStartFind != mVisibleElements.end(); ++iterStartFind)
  202. {
  203. if (!iterStartFind->isTreeElement())
  204. continue;
  205. TreeElement* curElem = iterStartFind->getTreeElement();
  206. if (curElem == selectionRoot)
  207. {
  208. foundStart = true;
  209. break;
  210. }
  211. }
  212. auto iterEndFind = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  213. [&](const InteractableElement& x) { return &x == element; });
  214. if (iterEndFind != mVisibleElements.end())
  215. foundEnd = true;
  216. if (foundStart && foundEnd)
  217. {
  218. if (iterStartFind < iterEndFind)
  219. {
  220. for (; iterStartFind != (iterEndFind + 1); ++iterStartFind)
  221. {
  222. if (iterStartFind->isTreeElement())
  223. selectElement(iterStartFind->getTreeElement());
  224. }
  225. }
  226. else if (iterEndFind < iterStartFind)
  227. {
  228. for (; iterEndFind != (iterStartFind + 1); ++iterEndFind)
  229. {
  230. if (iterEndFind->isTreeElement())
  231. selectElement(iterEndFind->getTreeElement());
  232. }
  233. }
  234. else
  235. selectElement(treeElement);
  236. }
  237. if (!foundStart || !foundEnd)
  238. selectElement(treeElement);
  239. }
  240. else
  241. {
  242. selectElement(treeElement);
  243. }
  244. }
  245. else
  246. {
  247. bool doRename = false;
  248. if (isSelectionActive())
  249. {
  250. for (auto& selectedElem : mSelectedElements)
  251. {
  252. if (selectedElem.element == treeElement)
  253. {
  254. doRename = true;
  255. break;
  256. }
  257. }
  258. }
  259. unselectAll();
  260. selectElement(treeElement);
  261. if (doRename)
  262. renameSelected();
  263. }
  264. _markLayoutAsDirty();
  265. return true;
  266. }
  267. else if (event.getButton() == GUIMouseButton::Right)
  268. {
  269. unselectAll();
  270. selectElement(treeElement);
  271. _markLayoutAsDirty();
  272. return true;
  273. }
  274. }
  275. }
  276. else
  277. {
  278. unselectAll();
  279. return true;
  280. }
  281. }
  282. else if(event.getType() == GUIMouseEventType::MouseDragStart)
  283. {
  284. clearPing();
  285. mDragStartPosition = event.getPosition();
  286. }
  287. else if(event.getType() == GUIMouseEventType::MouseDrag)
  288. {
  289. UINT32 dist = mDragStartPosition.manhattanDist(event.getPosition());
  290. if(!DragAndDropManager::instance().isDragInProgress())
  291. {
  292. if(dist > DRAG_MIN_DISTANCE && mEditElement == nullptr)
  293. {
  294. const InteractableElement* element = findElementUnderCoord(mDragStartPosition);
  295. Vector<TreeElement*> draggedElements;
  296. if(element != nullptr && element->isTreeElement())
  297. {
  298. // If multiple elements are selected, drag all of them
  299. TreeElement* treeElement = element->getTreeElement();
  300. auto iterFind = std::find_if(mSelectedElements.begin(), mSelectedElements.end(),
  301. [&] (const SelectedElement& x) { return x.element == treeElement; });
  302. if (iterFind != mSelectedElements.end())
  303. {
  304. for (auto& entry : mSelectedElements)
  305. draggedElements.push_back(entry.element);
  306. }
  307. else
  308. draggedElements.push_back(treeElement);
  309. }
  310. dragAndDropStart(draggedElements);
  311. mDragPosition = event.getPosition();
  312. mDragInProgress = true;
  313. mScrollState = ScrollState::None;
  314. _markLayoutAsDirty();
  315. }
  316. }
  317. }
  318. else if(event.getType() == GUIMouseEventType::MouseDragAndDropDragged)
  319. {
  320. if(acceptDragAndDrop())
  321. {
  322. clearPing();
  323. mDragPosition = event.getPosition();
  324. mDragInProgress = true;
  325. _markLayoutAsDirty();
  326. if(mBottomScrollBounds.contains(mDragPosition))
  327. {
  328. if(mScrollState != ScrollState::Down)
  329. mScrollState = ScrollState::TransitioningDown;
  330. }
  331. else if(mTopScrollBounds.contains(mDragPosition))
  332. {
  333. if(mScrollState != ScrollState::Up)
  334. mScrollState = ScrollState::TransitioningUp;
  335. }
  336. else
  337. mScrollState = ScrollState::None;
  338. return true;
  339. }
  340. }
  341. else if(event.getType() == GUIMouseEventType::MouseDragAndDropDropped)
  342. {
  343. if(acceptDragAndDrop())
  344. {
  345. const InteractableElement* element = findElementUnderCoord(event.getPosition());
  346. TreeElement* treeElement = nullptr;
  347. if(element != nullptr)
  348. {
  349. if(element->isTreeElement())
  350. treeElement = element->getTreeElement();
  351. else
  352. treeElement = element->parent;
  353. }
  354. unselectAll();
  355. dragAndDropEnded(treeElement);
  356. mDragInProgress = false;
  357. return true;
  358. }
  359. }
  360. else if(event.getType() == GUIMouseEventType::MouseOut)
  361. {
  362. mDragInProgress = false;
  363. _markLayoutAsDirty();
  364. }
  365. else if(event.getType() == GUIMouseEventType::MouseDragAndDropLeft)
  366. {
  367. mDragInProgress = false;
  368. _markLayoutAsDirty();
  369. }
  370. return false;
  371. }
  372. bool GUITreeView::_commandEvent(const GUICommandEvent& ev)
  373. {
  374. if(ev.getType() == GUICommandEventType::MoveUp || ev.getType() == GUICommandEventType::SelectUp)
  375. {
  376. TreeElement* topMostElement = getTopMostSelectedElement();
  377. auto topMostIter = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  378. [&] (const InteractableElement& x) { return x.getTreeElement() == topMostElement; });
  379. if(topMostIter != mVisibleElements.end() && topMostIter != mVisibleElements.begin())
  380. {
  381. do
  382. {
  383. topMostIter--;
  384. } while (!topMostIter->isTreeElement() && topMostIter != mVisibleElements.begin());
  385. if(topMostIter->isTreeElement())
  386. {
  387. if(ev.getType() == GUICommandEventType::MoveUp)
  388. unselectAll();
  389. TreeElement* treeElement = topMostIter->getTreeElement();
  390. selectElement(treeElement);
  391. scrollToElement(treeElement, false);
  392. }
  393. }
  394. }
  395. else if(ev.getType() == GUICommandEventType::MoveDown || ev.getType() == GUICommandEventType::SelectDown)
  396. {
  397. TreeElement* bottoMostElement = getBottomMostSelectedElement();
  398. auto bottomMostIter = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  399. [&] (const InteractableElement& x) { return x.getTreeElement() == bottoMostElement; });
  400. if(bottomMostIter != mVisibleElements.end())
  401. {
  402. do
  403. {
  404. bottomMostIter++;
  405. } while (bottomMostIter != mVisibleElements.end() && !bottomMostIter->isTreeElement());
  406. if(bottomMostIter != mVisibleElements.end() && bottomMostIter->isTreeElement())
  407. {
  408. if(ev.getType() == GUICommandEventType::MoveDown)
  409. unselectAll();
  410. TreeElement* treeElement = bottomMostIter->getTreeElement();
  411. selectElement(treeElement);
  412. scrollToElement(treeElement, false);
  413. }
  414. }
  415. }
  416. return GUIElementContainer::_commandEvent(ev);
  417. }
  418. bool GUITreeView::isSelectionActive() const
  419. {
  420. return mIsElementSelected && mSelectedElements.size() > 0;
  421. }
  422. void GUITreeView::selectElement(TreeElement* element)
  423. {
  424. clearPing();
  425. auto iterFind = std::find_if(mSelectedElements.begin(), mSelectedElements.end(),
  426. [&] (const SelectedElement& x) { return x.element == element; });
  427. if(iterFind == mSelectedElements.end())
  428. {
  429. GUITexture* background = GUITexture::create(mSelectionBackgroundStyle);
  430. background->_setElementDepth(3);
  431. _registerChildElement(background);
  432. element->mIsSelected = true;
  433. mSelectedElements.push_back(SelectedElement(element, background));
  434. mIsElementSelected = true;
  435. selectionChanged();
  436. }
  437. }
  438. void GUITreeView::unselectElement(TreeElement* element)
  439. {
  440. clearPing();
  441. auto iterFind = std::find_if(mSelectedElements.begin(), mSelectedElements.end(),
  442. [&] (const SelectedElement& x) { return x.element == element; });
  443. if(iterFind != mSelectedElements.end())
  444. {
  445. iterFind->element->mIsSelected = false;
  446. GUIElement::destroy(iterFind->background);
  447. mSelectedElements.erase(iterFind);
  448. _markLayoutAsDirty();
  449. selectionChanged();
  450. }
  451. mIsElementSelected = mSelectedElements.size() > 0;
  452. }
  453. void GUITreeView::unselectAll(bool sendEvent)
  454. {
  455. clearPing();
  456. for(auto& selectedElem : mSelectedElements)
  457. {
  458. selectedElem.element->mIsSelected = false;
  459. GUIElement::destroy(selectedElem.background);
  460. }
  461. mSelectedElements.clear();
  462. mIsElementSelected = false;
  463. _markLayoutAsDirty();
  464. if (sendEvent)
  465. selectionChanged();
  466. }
  467. void GUITreeView::renameSelected()
  468. {
  469. if (isSelectionActive() && mEditElement == nullptr)
  470. {
  471. clearPing();
  472. enableEdit(mSelectedElements[0].element);
  473. unselectAll();
  474. }
  475. }
  476. void GUITreeView::deleteSelection()
  477. {
  478. if (isSelectionActive())
  479. {
  480. auto isChildOf = [&](const TreeElement* parent, const TreeElement* child)
  481. {
  482. const TreeElement* elem = child;
  483. while (elem != nullptr && elem != parent)
  484. elem = elem->mParent;
  485. return elem == parent;
  486. };
  487. // Ensure we don't unnecessarily try to delete children if their
  488. // parent is getting deleted anyway
  489. Vector<TreeElement*> elementsToDelete;
  490. for (UINT32 i = 0; i < (UINT32)mSelectedElements.size(); i++)
  491. {
  492. bool hasDeletedParent = false;
  493. for (UINT32 j = 0; j < (UINT32)mSelectedElements.size(); j++)
  494. {
  495. if (i == j)
  496. continue;
  497. if (isChildOf(mSelectedElements[j].element, mSelectedElements[i].element))
  498. {
  499. hasDeletedParent = true;
  500. break;
  501. }
  502. }
  503. if (!hasDeletedParent)
  504. elementsToDelete.push_back(mSelectedElements[i].element);
  505. }
  506. clearPing();
  507. unselectAll();
  508. for (auto& elem : elementsToDelete)
  509. deleteTreeElement(elem);
  510. }
  511. }
  512. void GUITreeView::ping(TreeElement* element)
  513. {
  514. clearPing();
  515. expandToElement(element);
  516. scrollToElement(element, true);
  517. GUITexture* background = GUITexture::create(mHighlightBackgroundStyle);
  518. background->_setElementDepth(2);
  519. _registerChildElement(background);
  520. element->mIsHighlighted = true;
  521. mHighlightedElement.element = element;
  522. mHighlightedElement.background = background;
  523. mIsElementHighlighted = true;
  524. _markLayoutAsDirty();
  525. }
  526. void GUITreeView::clearPing()
  527. {
  528. if (!mIsElementHighlighted)
  529. return;
  530. mHighlightedElement.element->mIsHighlighted = false;
  531. GUIElement::destroy(mHighlightedElement.background);
  532. mHighlightedElement.element = nullptr;
  533. mHighlightedElement.background = nullptr;
  534. mIsElementHighlighted = false;
  535. _markLayoutAsDirty();
  536. }
  537. void GUITreeView::expandToElement(TreeElement* element)
  538. {
  539. if (element->mIsVisible || element->mParent == nullptr)
  540. return;
  541. Stack<TreeElement*> todo;
  542. TreeElement* parent = element->mParent;
  543. while (parent != nullptr)
  544. {
  545. if (!parent->mIsExpanded)
  546. todo.push(parent);
  547. if (parent->mIsVisible)
  548. break;
  549. parent = parent->mParent;
  550. }
  551. while (!todo.empty())
  552. {
  553. TreeElement* curElement = todo.top();
  554. todo.pop();
  555. expandElement(curElement);
  556. }
  557. }
  558. void GUITreeView::expandElement(TreeElement* element, bool toggleButton)
  559. {
  560. if(element->mIsExpanded)
  561. return;
  562. element->mIsExpanded = true;
  563. if(element->mParent == nullptr || (element->mParent->mIsVisible && element->mParent->mIsExpanded))
  564. {
  565. Stack<TreeElement*> todo;
  566. todo.push(element);
  567. while(!todo.empty())
  568. {
  569. TreeElement* curElem = todo.top();
  570. todo.pop();
  571. curElem->mIsVisible = true;
  572. updateElementGUI(curElem);
  573. if(curElem->mIsExpanded)
  574. {
  575. for(auto& child : curElem->mChildren)
  576. todo.push(child);
  577. }
  578. }
  579. }
  580. if (toggleButton && element->mFoldoutBtn != nullptr)
  581. element->mFoldoutBtn->toggleOn();
  582. }
  583. void GUITreeView::collapseElement(TreeElement* element, bool toggleButton)
  584. {
  585. if(!element->mIsExpanded)
  586. return;
  587. element->mIsExpanded = false;
  588. updateElementGUI(element);
  589. if(element->mParent == nullptr || (element->mParent->mIsVisible && element->mParent->mIsExpanded))
  590. {
  591. Stack<TreeElement*> todo;
  592. for(auto& child : element->mChildren)
  593. todo.push(child);
  594. while(!todo.empty())
  595. {
  596. TreeElement* curElem = todo.top();
  597. todo.pop();
  598. curElem->mIsVisible = false;
  599. if(curElem->mIsSelected)
  600. unselectElement(curElem);
  601. updateElementGUI(curElem);
  602. if(curElem->mIsExpanded)
  603. {
  604. for(auto& child : curElem->mChildren)
  605. todo.push(child);
  606. }
  607. }
  608. }
  609. if (toggleButton && element->mFoldoutBtn != nullptr)
  610. element->mFoldoutBtn->toggleOff();
  611. }
  612. void GUITreeView::updateElementGUI(TreeElement* element)
  613. {
  614. if(element == &getRootElement())
  615. return;
  616. if(element->mIsVisible)
  617. {
  618. HString name(element->mName);
  619. if(element->mElement == nullptr)
  620. {
  621. element->mElement = GUILabel::create(name, mElementBtnStyle);
  622. _registerChildElement(element->mElement);
  623. }
  624. if (element->mIsCut)
  625. {
  626. Color cutTint = element->mTint;
  627. cutTint.a = CUT_COLOR.a;
  628. element->mElement->setTint(cutTint);
  629. }
  630. else if(element->mIsDisabled)
  631. {
  632. Color disabledTint = element->mTint;
  633. disabledTint.a = DISABLED_COLOR.a;
  634. element->mElement->setTint(disabledTint);
  635. }
  636. else
  637. element->mElement->setTint(element->mTint);
  638. if(element->mChildren.size() > 0)
  639. {
  640. if(element->mFoldoutBtn == nullptr)
  641. {
  642. element->mFoldoutBtn = GUIToggle::create(GUIContent(HString("")), mFoldoutBtnStyle);
  643. _registerChildElement(element->mFoldoutBtn);
  644. element->mFoldoutBtn->onToggled.connect(std::bind(&GUITreeView::elementToggled, this, element, _1));
  645. if(element->mIsExpanded)
  646. element->mFoldoutBtn->toggleOn();
  647. }
  648. }
  649. else
  650. {
  651. if(element->mFoldoutBtn != nullptr)
  652. {
  653. GUIElement::destroy(element->mFoldoutBtn);
  654. element->mFoldoutBtn = nullptr;
  655. }
  656. }
  657. element->mElement->setContent(GUIContent(name));
  658. }
  659. else
  660. {
  661. if(element->mElement != nullptr)
  662. {
  663. GUIElement::destroy(element->mElement);
  664. element->mElement = nullptr;
  665. }
  666. if(element->mFoldoutBtn != nullptr)
  667. {
  668. GUIElement::destroy(element->mFoldoutBtn);
  669. element->mFoldoutBtn = nullptr;
  670. }
  671. if(element->mIsSelected && element->mIsExpanded)
  672. unselectElement(element);
  673. }
  674. _markLayoutAsDirty();
  675. }
  676. void GUITreeView::elementToggled(TreeElement* element, bool toggled)
  677. {
  678. clearPing();
  679. if(toggled)
  680. expandElement(element, false);
  681. else
  682. collapseElement(element, false);
  683. }
  684. void GUITreeView::onEditAccepted()
  685. {
  686. TreeElement* elem = mEditElement;
  687. disableEdit(true);
  688. selectElement(elem);
  689. }
  690. void GUITreeView::onEditCanceled()
  691. {
  692. if (mEditElement != nullptr)
  693. {
  694. TreeElement* elem = mEditElement;
  695. disableEdit(false);
  696. selectElement(elem);
  697. }
  698. }
  699. void GUITreeView::onEditFocusLost()
  700. {
  701. if (mEditElement != nullptr)
  702. disableEdit(false);
  703. }
  704. void GUITreeView::enableEdit(TreeElement* element)
  705. {
  706. assert(mEditElement == nullptr);
  707. mEditElement = element;
  708. mNameEditBox->setVisible(true);
  709. mNameEditBox->setText(element->mName);
  710. mNameEditBox->setFocus(true);
  711. if(element->mElement != nullptr)
  712. element->mElement->setVisible(false);
  713. }
  714. void GUITreeView::disableEdit(bool applyChanges)
  715. {
  716. assert(mEditElement != nullptr);
  717. if(mEditElement->mElement != nullptr)
  718. mEditElement->mElement->setVisible(true);
  719. if(applyChanges)
  720. {
  721. String newName = mNameEditBox->getText();
  722. renameTreeElement(mEditElement, newName);
  723. }
  724. mNameEditBox->setFocus(false);
  725. mNameEditBox->setVisible(false);
  726. mEditElement = nullptr;
  727. }
  728. Vector2I GUITreeView::_getOptimalSize() const
  729. {
  730. struct UpdateTreeElement
  731. {
  732. UpdateTreeElement(const TreeElement* element, UINT32 indent)
  733. :element(element), indent(indent)
  734. { }
  735. const TreeElement* element;
  736. UINT32 indent;
  737. };
  738. Vector2I optimalSize;
  739. if (_getDimensions().fixedWidth() && _getDimensions().fixedHeight())
  740. {
  741. optimalSize.x = _getDimensions().minWidth;
  742. optimalSize.y = _getDimensions().minHeight;
  743. }
  744. else
  745. {
  746. Stack<UpdateTreeElement> todo;
  747. todo.push(UpdateTreeElement(&getRootElementConst(), 0));
  748. while(!todo.empty())
  749. {
  750. UpdateTreeElement currentUpdateElement = todo.top();
  751. const TreeElement* current = currentUpdateElement.element;
  752. todo.pop();
  753. INT32 yOffset = 0;
  754. if(current->mElement != nullptr)
  755. {
  756. Vector2I curOptimalSize = current->mElement->_getOptimalSize();
  757. optimalSize.x = std::max(optimalSize.x,
  758. (INT32)(INITIAL_INDENT_OFFSET + curOptimalSize.x + currentUpdateElement.indent * INDENT_SIZE));
  759. yOffset = curOptimalSize.y + ELEMENT_EXTRA_SPACING;
  760. }
  761. optimalSize.y += yOffset;
  762. for(auto& child : current->mChildren)
  763. {
  764. if(!child->mIsVisible)
  765. continue;
  766. todo.push(UpdateTreeElement(child, currentUpdateElement.indent + 1));
  767. }
  768. }
  769. if(_getDimensions().fixedWidth())
  770. optimalSize.x = _getDimensions().minWidth;
  771. else
  772. {
  773. if(_getDimensions().minWidth > 0)
  774. optimalSize.x = std::max((INT32)_getDimensions().minWidth, optimalSize.x);
  775. if(_getDimensions().maxWidth > 0)
  776. optimalSize.x = std::min((INT32)_getDimensions().maxWidth, optimalSize.x);
  777. }
  778. if (_getDimensions().fixedHeight())
  779. optimalSize.y = _getDimensions().minHeight;
  780. else
  781. {
  782. if(_getDimensions().minHeight > 0)
  783. optimalSize.y = std::max((INT32)_getDimensions().minHeight, optimalSize.y);
  784. if(_getDimensions().maxHeight > 0)
  785. optimalSize.y = std::min((INT32)_getDimensions().maxHeight, optimalSize.y);
  786. }
  787. }
  788. return optimalSize;
  789. }
  790. void GUITreeView::updateClippedBounds()
  791. {
  792. mClippedBounds = mLayoutData.area;
  793. mClippedBounds.clip(mLayoutData.clipRect);
  794. }
  795. void GUITreeView::_updateLayoutInternal(const GUILayoutData& data)
  796. {
  797. struct UpdateTreeElement
  798. {
  799. UpdateTreeElement(TreeElement* element, UINT32 indent)
  800. :element(element), indent(indent)
  801. { }
  802. TreeElement* element;
  803. UINT32 indent;
  804. };
  805. mVisibleElements.clear();
  806. Stack<UpdateTreeElement> todo;
  807. todo.push(UpdateTreeElement(&getRootElement(), 0));
  808. // NOTE - Instead of iterating through all elements, try to find those within the clip rect
  809. // and only iterate through those. Others should somehow be marked in-active (similar to GUIElement::isDisabled()?)
  810. Vector<TreeElement*> tempOrderedElements;
  811. Vector2I offset(data.area.x, data.area.y);
  812. while(!todo.empty())
  813. {
  814. UpdateTreeElement currentUpdateElement = todo.top();
  815. TreeElement* current = currentUpdateElement.element;
  816. UINT32 indent = currentUpdateElement.indent;
  817. todo.pop();
  818. INT32 btnHeight = 0;
  819. INT32 yOffset = 0;
  820. if(current->mElement != nullptr)
  821. {
  822. Vector2I elementSize = current->mElement->_getOptimalSize();
  823. btnHeight = elementSize.y;
  824. mVisibleElements.push_back(InteractableElement(current->mParent, current->mSortedIdx * 2 + 0, Rect2I(data.area.x, offset.y, data.area.width, ELEMENT_EXTRA_SPACING)));
  825. mVisibleElements.push_back(InteractableElement(current->mParent, current->mSortedIdx * 2 + 1, Rect2I(data.area.x, offset.y + ELEMENT_EXTRA_SPACING, data.area.width, btnHeight)));
  826. offset.x = data.area.x + INITIAL_INDENT_OFFSET + indent * INDENT_SIZE;
  827. offset.y += ELEMENT_EXTRA_SPACING;
  828. GUILayoutData childData = data;
  829. childData.area.x = offset.x;
  830. childData.area.y = offset.y;
  831. childData.area.width = elementSize.x;
  832. childData.area.height = elementSize.y;
  833. current->mElement->_setLayoutData(childData);
  834. yOffset = btnHeight;
  835. }
  836. if(current->mFoldoutBtn != nullptr)
  837. {
  838. Vector2I elementSize = current->mFoldoutBtn->_getOptimalSize();
  839. offset.x -= std::min((INT32)INITIAL_INDENT_OFFSET, elementSize.x + 2);
  840. Vector2I myOffset = offset;
  841. myOffset.y += 1;
  842. if(elementSize.y > btnHeight)
  843. {
  844. UINT32 diff = elementSize.y - btnHeight;
  845. float half = diff * 0.5f;
  846. myOffset.y -= Math::floorToInt(half);
  847. }
  848. GUILayoutData childData = data;
  849. childData.area.x = myOffset.x;
  850. childData.area.y = myOffset.y;
  851. childData.area.width = elementSize.x;
  852. childData.area.height = elementSize.y;
  853. current->mFoldoutBtn->_setLayoutData(childData);
  854. }
  855. offset.y += yOffset;
  856. tempOrderedElements.resize(current->mChildren.size(), nullptr);
  857. for(auto& child : current->mChildren)
  858. {
  859. tempOrderedElements[child->mSortedIdx] = child;
  860. }
  861. for(auto iter = tempOrderedElements.rbegin(); iter != tempOrderedElements.rend(); ++iter)
  862. {
  863. TreeElement* child = *iter;
  864. if(!child->mIsVisible)
  865. continue;
  866. todo.push(UpdateTreeElement(child, indent + 1));
  867. }
  868. }
  869. UINT32 remainingHeight = (UINT32)std::max(0, (INT32)data.area.height - (offset.y - data.area.y));
  870. if(remainingHeight > 0)
  871. mVisibleElements.push_back(InteractableElement(&getRootElement(), (UINT32)getRootElement().mChildren.size() * 2, Rect2I(data.area.x, offset.y, data.area.width, remainingHeight)));
  872. for(auto selectedElem : mSelectedElements)
  873. {
  874. GUILabel* targetElement = selectedElem.element->mElement;
  875. if (targetElement == nullptr)
  876. continue;
  877. GUILayoutData childData = data;
  878. childData.area.y = targetElement->_getLayoutData().area.y;
  879. childData.area.height = targetElement->_getLayoutData().area.height;
  880. selectedElem.background->_setLayoutData(childData);
  881. }
  882. if (mIsElementHighlighted)
  883. {
  884. GUILabel* targetElement = mHighlightedElement.element->mElement;
  885. if (targetElement != nullptr)
  886. {
  887. GUILayoutData childData = data;
  888. childData.area.y = targetElement->_getLayoutData().area.y;
  889. childData.area.height = targetElement->_getLayoutData().area.height;
  890. mHighlightedElement.background->_setLayoutData(childData);
  891. }
  892. }
  893. if(mEditElement != nullptr)
  894. {
  895. GUILabel* targetElement = mEditElement->mElement;
  896. if (targetElement != nullptr)
  897. {
  898. UINT32 remainingWidth = (UINT32)std::max(0, (((INT32)data.area.width) - (offset.x - data.area.x)));
  899. GUILayoutData childData = data;
  900. childData.area = targetElement->_getLayoutData().area;
  901. childData.area.width = remainingWidth;
  902. mNameEditBox->_setLayoutData(childData);
  903. }
  904. }
  905. if(mDragInProgress)
  906. {
  907. const InteractableElement* interactableElement = findElementUnderCoord(mDragPosition);
  908. if(interactableElement == nullptr)
  909. {
  910. mDragHighlight->setVisible(false);
  911. mDragSepHighlight->setVisible(false);
  912. }
  913. else
  914. {
  915. if(interactableElement->isTreeElement())
  916. {
  917. mDragSepHighlight->setVisible(false);
  918. mDragHighlight->setVisible(true);
  919. GUILayoutData childData = data;
  920. childData.area = interactableElement->bounds;
  921. mDragHighlight->_setLayoutData(childData);
  922. }
  923. else
  924. {
  925. mDragHighlight->setVisible(false);
  926. mDragSepHighlight->setVisible(true);
  927. GUILayoutData childData = data;
  928. childData.area = interactableElement->bounds;
  929. mDragSepHighlight->_setLayoutData(childData);
  930. }
  931. }
  932. }
  933. else
  934. {
  935. mDragHighlight->setVisible(false);
  936. mDragSepHighlight->setVisible(false);
  937. }
  938. // Update scroll bounds
  939. UINT32 scrollHeight = (UINT32)Math::roundToInt(data.clipRect.height * SCROLL_AREA_HEIGHT_PCT);
  940. mTopScrollBounds.x = data.clipRect.x;
  941. mTopScrollBounds.y = data.clipRect.y;
  942. mTopScrollBounds.width = data.clipRect.width;
  943. mTopScrollBounds.height = scrollHeight;
  944. mBottomScrollBounds.x = data.clipRect.x;
  945. mBottomScrollBounds.y = data.clipRect.y + data.clipRect.height - scrollHeight;
  946. mBottomScrollBounds.width = data.clipRect.width;
  947. mBottomScrollBounds.height = scrollHeight;
  948. }
  949. const GUITreeView::InteractableElement* GUITreeView::findElementUnderCoord(const Vector2I& coord) const
  950. {
  951. for(auto& element : mVisibleElements)
  952. {
  953. if(element.bounds.contains(coord))
  954. {
  955. return &element;
  956. }
  957. }
  958. return nullptr;
  959. }
  960. GUITreeView::TreeElement* GUITreeView::getTopMostSelectedElement() const
  961. {
  962. auto topMostElement = mVisibleElements.end();
  963. for(auto& selectedElement : mSelectedElements)
  964. {
  965. auto iterFind = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  966. [&] (const InteractableElement& x) { return x.getTreeElement() == selectedElement.element; });
  967. if(iterFind != mVisibleElements.end())
  968. {
  969. if(topMostElement == mVisibleElements.end())
  970. topMostElement = iterFind;
  971. else
  972. {
  973. if(iterFind->bounds.y < topMostElement->bounds.y)
  974. topMostElement = iterFind;
  975. }
  976. }
  977. }
  978. if(topMostElement != mVisibleElements.end())
  979. return topMostElement->getTreeElement();
  980. else
  981. return nullptr;
  982. }
  983. GUITreeView::TreeElement* GUITreeView::getBottomMostSelectedElement() const
  984. {
  985. auto botMostElement = mVisibleElements.end();
  986. for(auto& selectedElement : mSelectedElements)
  987. {
  988. auto iterFind = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  989. [&] (const InteractableElement& x) { return x.getTreeElement() == selectedElement.element; });
  990. if(iterFind != mVisibleElements.end())
  991. {
  992. if(botMostElement == mVisibleElements.end())
  993. botMostElement = iterFind;
  994. else
  995. {
  996. if((iterFind->bounds.y + iterFind->bounds.height) > (botMostElement->bounds.y + botMostElement->bounds.height))
  997. botMostElement = iterFind;
  998. }
  999. }
  1000. }
  1001. if(botMostElement != mVisibleElements.end())
  1002. return botMostElement->getTreeElement();
  1003. else
  1004. return nullptr;
  1005. }
  1006. void GUITreeView::closeTemporarilyExpandedElements()
  1007. {
  1008. temporarilyExpandElement(nullptr);
  1009. }
  1010. void GUITreeView::temporarilyExpandElement(const InteractableElement* mouseOverElement)
  1011. {
  1012. TreeElement* treeElement = nullptr;
  1013. if(mouseOverElement != nullptr && mouseOverElement->isTreeElement())
  1014. treeElement = mouseOverElement->getTreeElement();
  1015. if(treeElement == nullptr || treeElement != mMouseOverDragElement)
  1016. {
  1017. while(!mAutoExpandedElements.empty())
  1018. {
  1019. TreeElement* autoExpandedElement = mAutoExpandedElements.top();
  1020. bool unexpandElement = false;
  1021. if(mouseOverElement != nullptr && mouseOverElement->parent != nullptr)
  1022. {
  1023. if(mouseOverElement->parent != autoExpandedElement && !mouseOverElement->parent->isParentRec(autoExpandedElement))
  1024. unexpandElement = true;
  1025. else
  1026. break;
  1027. }
  1028. else
  1029. unexpandElement = true;
  1030. if(unexpandElement)
  1031. {
  1032. collapseElement(autoExpandedElement);
  1033. mAutoExpandedElements.pop();
  1034. }
  1035. }
  1036. mMouseOverDragElement = treeElement;
  1037. mMouseOverDragElementTime = gTime().getTime();
  1038. }
  1039. else
  1040. {
  1041. if(mMouseOverDragElement != nullptr && !mMouseOverDragElement->mIsExpanded)
  1042. {
  1043. float timeDiff = gTime().getTime() - mMouseOverDragElementTime;
  1044. if(timeDiff >= AUTO_EXPAND_DELAY_SEC)
  1045. {
  1046. mAutoExpandedElements.push(mMouseOverDragElement);
  1047. expandElement(mMouseOverDragElement);
  1048. }
  1049. }
  1050. }
  1051. }
  1052. void GUITreeView::scrollToElement(TreeElement* element, bool center)
  1053. {
  1054. if(element->mElement == nullptr)
  1055. return;
  1056. GUIScrollArea* scrollArea = findParentScrollArea();
  1057. if(scrollArea == nullptr)
  1058. return;
  1059. if(center)
  1060. {
  1061. Rect2I myBounds = _getClippedBounds();
  1062. INT32 clipVertCenter = myBounds.y + (INT32)Math::roundToInt(myBounds.height * 0.5f);
  1063. INT32 elemVertCenter = element->mElement->_getLayoutData().area.y + (INT32)Math::roundToInt(element->mElement->_getLayoutData().area.height * 0.5f);
  1064. if(elemVertCenter > clipVertCenter)
  1065. scrollArea->scrollDownPx(elemVertCenter - clipVertCenter);
  1066. else
  1067. scrollArea->scrollUpPx(clipVertCenter - elemVertCenter);
  1068. }
  1069. else
  1070. {
  1071. Rect2I myBounds = _getClippedBounds();
  1072. INT32 elemVertTop = element->mElement->_getLayoutData().area.y;
  1073. INT32 elemVertBottom = element->mElement->_getLayoutData().area.y + element->mElement->_getLayoutData().area.height;
  1074. INT32 top = myBounds.y;
  1075. INT32 bottom = myBounds.y + myBounds.height;
  1076. if(elemVertTop < top)
  1077. scrollArea->scrollUpPx(top - elemVertTop);
  1078. else if(elemVertBottom > bottom)
  1079. scrollArea->scrollDownPx(elemVertBottom - bottom);
  1080. }
  1081. }
  1082. GUIScrollArea* GUITreeView::findParentScrollArea() const
  1083. {
  1084. GUIElementBase* parent = _getParent();
  1085. while(parent != nullptr)
  1086. {
  1087. if(parent->_getType() == GUIElementBase::Type::Element)
  1088. {
  1089. GUIElement* parentElement = static_cast<GUIElement*>(parent);
  1090. if(parentElement->_getElementType() == GUIElement::ElementType::ScrollArea)
  1091. {
  1092. GUIScrollArea* scrollArea = static_cast<GUIScrollArea*>(parentElement);
  1093. return scrollArea;
  1094. }
  1095. }
  1096. parent = parent->_getParent();
  1097. }
  1098. return nullptr;
  1099. }
  1100. const String& GUITreeView::getGUITypeName()
  1101. {
  1102. static String typeName = "SceneTreeView";
  1103. return typeName;
  1104. }
  1105. }