BsGUITreeView.cpp 35 KB

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