BsGUITreeView.cpp 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355
  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. dragAndDropEnded(treeElement);
  355. mDragInProgress = false;
  356. unselectAll();
  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)
  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. }
  581. void GUITreeView::collapseElement(TreeElement* element)
  582. {
  583. if(!element->mIsExpanded)
  584. return;
  585. element->mIsExpanded = false;
  586. updateElementGUI(element);
  587. if(element->mParent == nullptr || (element->mParent->mIsVisible && element->mParent->mIsExpanded))
  588. {
  589. Stack<TreeElement*> todo;
  590. for(auto& child : element->mChildren)
  591. todo.push(child);
  592. while(!todo.empty())
  593. {
  594. TreeElement* curElem = todo.top();
  595. todo.pop();
  596. curElem->mIsVisible = false;
  597. if(curElem->mIsSelected)
  598. unselectElement(curElem);
  599. updateElementGUI(curElem);
  600. if(curElem->mIsExpanded)
  601. {
  602. for(auto& child : curElem->mChildren)
  603. todo.push(child);
  604. }
  605. }
  606. }
  607. }
  608. void GUITreeView::updateElementGUI(TreeElement* element)
  609. {
  610. if(element == &getRootElement())
  611. return;
  612. if(element->mIsVisible)
  613. {
  614. HString name(element->mName);
  615. if(element->mElement == nullptr)
  616. {
  617. element->mElement = GUILabel::create(name, mElementBtnStyle);
  618. _registerChildElement(element->mElement);
  619. }
  620. if (element->mIsCut)
  621. {
  622. Color cutTint = element->mTint;
  623. cutTint.a = CUT_COLOR.a;
  624. element->mElement->setTint(cutTint);
  625. }
  626. else if(element->mIsDisabled)
  627. {
  628. Color disabledTint = element->mTint;
  629. disabledTint.a = DISABLED_COLOR.a;
  630. element->mElement->setTint(disabledTint);
  631. }
  632. else
  633. element->mElement->setTint(element->mTint);
  634. if(element->mChildren.size() > 0)
  635. {
  636. if(element->mFoldoutBtn == nullptr)
  637. {
  638. element->mFoldoutBtn = GUIToggle::create(GUIContent(HString("")), mFoldoutBtnStyle);
  639. _registerChildElement(element->mFoldoutBtn);
  640. element->mFoldoutBtn->onToggled.connect(std::bind(&GUITreeView::elementToggled, this, element, _1));
  641. if(element->mIsExpanded)
  642. element->mFoldoutBtn->toggleOn();
  643. }
  644. }
  645. else
  646. {
  647. if(element->mFoldoutBtn != nullptr)
  648. {
  649. GUIElement::destroy(element->mFoldoutBtn);
  650. element->mFoldoutBtn = nullptr;
  651. }
  652. }
  653. element->mElement->setContent(GUIContent(name));
  654. }
  655. else
  656. {
  657. if(element->mElement != nullptr)
  658. {
  659. GUIElement::destroy(element->mElement);
  660. element->mElement = nullptr;
  661. }
  662. if(element->mFoldoutBtn != nullptr)
  663. {
  664. GUIElement::destroy(element->mFoldoutBtn);
  665. element->mFoldoutBtn = nullptr;
  666. }
  667. if(element->mIsSelected && element->mIsExpanded)
  668. unselectElement(element);
  669. }
  670. _markLayoutAsDirty();
  671. }
  672. void GUITreeView::elementToggled(TreeElement* element, bool toggled)
  673. {
  674. clearPing();
  675. if(toggled)
  676. expandElement(element);
  677. else
  678. collapseElement(element);
  679. }
  680. void GUITreeView::onEditAccepted()
  681. {
  682. TreeElement* elem = mEditElement;
  683. disableEdit(true);
  684. selectElement(elem);
  685. }
  686. void GUITreeView::onEditCanceled()
  687. {
  688. if (mEditElement != nullptr)
  689. {
  690. TreeElement* elem = mEditElement;
  691. disableEdit(false);
  692. selectElement(elem);
  693. }
  694. }
  695. void GUITreeView::onEditFocusLost()
  696. {
  697. if (mEditElement != nullptr)
  698. disableEdit(false);
  699. }
  700. void GUITreeView::enableEdit(TreeElement* element)
  701. {
  702. assert(mEditElement == nullptr);
  703. mEditElement = element;
  704. mNameEditBox->setVisible(true);
  705. mNameEditBox->setText(element->mName);
  706. mNameEditBox->setFocus(true);
  707. if(element->mElement != nullptr)
  708. element->mElement->setVisible(false);
  709. }
  710. void GUITreeView::disableEdit(bool applyChanges)
  711. {
  712. assert(mEditElement != nullptr);
  713. if(mEditElement->mElement != nullptr)
  714. mEditElement->mElement->setVisible(true);
  715. if(applyChanges)
  716. {
  717. String newName = mNameEditBox->getText();
  718. renameTreeElement(mEditElement, newName);
  719. }
  720. mNameEditBox->setFocus(false);
  721. mNameEditBox->setVisible(false);
  722. mEditElement = nullptr;
  723. }
  724. Vector2I GUITreeView::_getOptimalSize() const
  725. {
  726. struct UpdateTreeElement
  727. {
  728. UpdateTreeElement(const TreeElement* element, UINT32 indent)
  729. :element(element), indent(indent)
  730. { }
  731. const TreeElement* element;
  732. UINT32 indent;
  733. };
  734. Vector2I optimalSize;
  735. if (_getDimensions().fixedWidth() && _getDimensions().fixedHeight())
  736. {
  737. optimalSize.x = _getDimensions().minWidth;
  738. optimalSize.y = _getDimensions().minHeight;
  739. }
  740. else
  741. {
  742. Stack<UpdateTreeElement> todo;
  743. todo.push(UpdateTreeElement(&getRootElementConst(), 0));
  744. while(!todo.empty())
  745. {
  746. UpdateTreeElement currentUpdateElement = todo.top();
  747. const TreeElement* current = currentUpdateElement.element;
  748. todo.pop();
  749. INT32 yOffset = 0;
  750. if(current->mElement != nullptr)
  751. {
  752. Vector2I curOptimalSize = current->mElement->_getOptimalSize();
  753. optimalSize.x = std::max(optimalSize.x,
  754. (INT32)(INITIAL_INDENT_OFFSET + curOptimalSize.x + currentUpdateElement.indent * INDENT_SIZE));
  755. yOffset = curOptimalSize.y + ELEMENT_EXTRA_SPACING;
  756. }
  757. optimalSize.y += yOffset;
  758. for(auto& child : current->mChildren)
  759. {
  760. if(!child->mIsVisible)
  761. continue;
  762. todo.push(UpdateTreeElement(child, currentUpdateElement.indent + 1));
  763. }
  764. }
  765. if(_getDimensions().fixedWidth())
  766. optimalSize.x = _getDimensions().minWidth;
  767. else
  768. {
  769. if(_getDimensions().minWidth > 0)
  770. optimalSize.x = std::max((INT32)_getDimensions().minWidth, optimalSize.x);
  771. if(_getDimensions().maxWidth > 0)
  772. optimalSize.x = std::min((INT32)_getDimensions().maxWidth, optimalSize.x);
  773. }
  774. if (_getDimensions().fixedHeight())
  775. optimalSize.y = _getDimensions().minHeight;
  776. else
  777. {
  778. if(_getDimensions().minHeight > 0)
  779. optimalSize.y = std::max((INT32)_getDimensions().minHeight, optimalSize.y);
  780. if(_getDimensions().maxHeight > 0)
  781. optimalSize.y = std::min((INT32)_getDimensions().maxHeight, optimalSize.y);
  782. }
  783. }
  784. return optimalSize;
  785. }
  786. void GUITreeView::updateClippedBounds()
  787. {
  788. mClippedBounds = mLayoutData.area;
  789. mClippedBounds.clip(mLayoutData.clipRect);
  790. }
  791. void GUITreeView::_updateLayoutInternal(const GUILayoutData& data)
  792. {
  793. struct UpdateTreeElement
  794. {
  795. UpdateTreeElement(TreeElement* element, UINT32 indent)
  796. :element(element), indent(indent)
  797. { }
  798. TreeElement* element;
  799. UINT32 indent;
  800. };
  801. mVisibleElements.clear();
  802. Stack<UpdateTreeElement> todo;
  803. todo.push(UpdateTreeElement(&getRootElement(), 0));
  804. // NOTE - Instead of iterating through all elements, try to find those within the clip rect
  805. // and only iterate through those. Others should somehow be marked in-active (similar to GUIElement::isDisabled()?)
  806. Vector<TreeElement*> tempOrderedElements;
  807. Vector2I offset(data.area.x, data.area.y);
  808. while(!todo.empty())
  809. {
  810. UpdateTreeElement currentUpdateElement = todo.top();
  811. TreeElement* current = currentUpdateElement.element;
  812. UINT32 indent = currentUpdateElement.indent;
  813. todo.pop();
  814. INT32 btnHeight = 0;
  815. INT32 yOffset = 0;
  816. if(current->mElement != nullptr)
  817. {
  818. Vector2I elementSize = current->mElement->_getOptimalSize();
  819. btnHeight = elementSize.y;
  820. mVisibleElements.push_back(InteractableElement(current->mParent, current->mSortedIdx * 2 + 0, Rect2I(data.area.x, offset.y, data.area.width, ELEMENT_EXTRA_SPACING)));
  821. mVisibleElements.push_back(InteractableElement(current->mParent, current->mSortedIdx * 2 + 1, Rect2I(data.area.x, offset.y + ELEMENT_EXTRA_SPACING, data.area.width, btnHeight)));
  822. offset.x = data.area.x + INITIAL_INDENT_OFFSET + indent * INDENT_SIZE;
  823. offset.y += ELEMENT_EXTRA_SPACING;
  824. GUILayoutData childData = data;
  825. childData.area.x = offset.x;
  826. childData.area.y = offset.y;
  827. childData.area.width = elementSize.x;
  828. childData.area.height = elementSize.y;
  829. current->mElement->_setLayoutData(childData);
  830. yOffset = btnHeight;
  831. }
  832. if(current->mFoldoutBtn != nullptr)
  833. {
  834. Vector2I elementSize = current->mFoldoutBtn->_getOptimalSize();
  835. offset.x -= std::min((INT32)INITIAL_INDENT_OFFSET, elementSize.x + 2);
  836. Vector2I myOffset = offset;
  837. myOffset.y += 1;
  838. if(elementSize.y > btnHeight)
  839. {
  840. UINT32 diff = elementSize.y - btnHeight;
  841. float half = diff * 0.5f;
  842. myOffset.y -= Math::floorToInt(half);
  843. }
  844. GUILayoutData childData = data;
  845. childData.area.x = myOffset.x;
  846. childData.area.y = myOffset.y;
  847. childData.area.width = elementSize.x;
  848. childData.area.height = elementSize.y;
  849. current->mFoldoutBtn->_setLayoutData(childData);
  850. }
  851. offset.y += yOffset;
  852. tempOrderedElements.resize(current->mChildren.size(), nullptr);
  853. for(auto& child : current->mChildren)
  854. {
  855. tempOrderedElements[child->mSortedIdx] = child;
  856. }
  857. for(auto iter = tempOrderedElements.rbegin(); iter != tempOrderedElements.rend(); ++iter)
  858. {
  859. TreeElement* child = *iter;
  860. if(!child->mIsVisible)
  861. continue;
  862. todo.push(UpdateTreeElement(child, indent + 1));
  863. }
  864. }
  865. UINT32 remainingHeight = (UINT32)std::max(0, (INT32)data.area.height - (offset.y - data.area.y));
  866. if(remainingHeight > 0)
  867. mVisibleElements.push_back(InteractableElement(&getRootElement(), (UINT32)getRootElement().mChildren.size() * 2, Rect2I(data.area.x, offset.y, data.area.width, remainingHeight)));
  868. for(auto selectedElem : mSelectedElements)
  869. {
  870. GUILabel* targetElement = selectedElem.element->mElement;
  871. if (targetElement == nullptr)
  872. continue;
  873. GUILayoutData childData = data;
  874. childData.area.y = targetElement->_getLayoutData().area.y;
  875. childData.area.height = targetElement->_getLayoutData().area.height;
  876. selectedElem.background->_setLayoutData(childData);
  877. }
  878. if (mIsElementHighlighted)
  879. {
  880. GUILabel* targetElement = mHighlightedElement.element->mElement;
  881. if (targetElement != nullptr)
  882. {
  883. GUILayoutData childData = data;
  884. childData.area.y = targetElement->_getLayoutData().area.y;
  885. childData.area.height = targetElement->_getLayoutData().area.height;
  886. mHighlightedElement.background->_setLayoutData(childData);
  887. }
  888. }
  889. if(mEditElement != nullptr)
  890. {
  891. GUILabel* targetElement = mEditElement->mElement;
  892. if (targetElement != nullptr)
  893. {
  894. UINT32 remainingWidth = (UINT32)std::max(0, (((INT32)data.area.width) - (offset.x - data.area.x)));
  895. GUILayoutData childData = data;
  896. childData.area = targetElement->_getLayoutData().area;
  897. childData.area.width = remainingWidth;
  898. mNameEditBox->_setLayoutData(childData);
  899. }
  900. }
  901. if(mDragInProgress)
  902. {
  903. const InteractableElement* interactableElement = findElementUnderCoord(mDragPosition);
  904. if(interactableElement == nullptr)
  905. {
  906. mDragHighlight->setVisible(false);
  907. mDragSepHighlight->setVisible(false);
  908. }
  909. else
  910. {
  911. if(interactableElement->isTreeElement())
  912. {
  913. mDragSepHighlight->setVisible(false);
  914. mDragHighlight->setVisible(true);
  915. GUILayoutData childData = data;
  916. childData.area = interactableElement->bounds;
  917. mDragHighlight->_setLayoutData(childData);
  918. }
  919. else
  920. {
  921. mDragHighlight->setVisible(false);
  922. mDragSepHighlight->setVisible(true);
  923. GUILayoutData childData = data;
  924. childData.area = interactableElement->bounds;
  925. mDragSepHighlight->_setLayoutData(childData);
  926. }
  927. }
  928. }
  929. else
  930. {
  931. mDragHighlight->setVisible(false);
  932. mDragSepHighlight->setVisible(false);
  933. }
  934. // Update scroll bounds
  935. UINT32 scrollHeight = (UINT32)Math::roundToInt(data.clipRect.height * SCROLL_AREA_HEIGHT_PCT);
  936. mTopScrollBounds.x = data.clipRect.x;
  937. mTopScrollBounds.y = data.clipRect.y;
  938. mTopScrollBounds.width = data.clipRect.width;
  939. mTopScrollBounds.height = scrollHeight;
  940. mBottomScrollBounds.x = data.clipRect.x;
  941. mBottomScrollBounds.y = data.clipRect.y + data.clipRect.height - scrollHeight;
  942. mBottomScrollBounds.width = data.clipRect.width;
  943. mBottomScrollBounds.height = scrollHeight;
  944. }
  945. const GUITreeView::InteractableElement* GUITreeView::findElementUnderCoord(const Vector2I& coord) const
  946. {
  947. for(auto& element : mVisibleElements)
  948. {
  949. if(element.bounds.contains(coord))
  950. {
  951. return &element;
  952. }
  953. }
  954. return nullptr;
  955. }
  956. GUITreeView::TreeElement* GUITreeView::getTopMostSelectedElement() const
  957. {
  958. auto topMostElement = mVisibleElements.end();
  959. for(auto& selectedElement : mSelectedElements)
  960. {
  961. auto iterFind = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  962. [&] (const InteractableElement& x) { return x.getTreeElement() == selectedElement.element; });
  963. if(iterFind != mVisibleElements.end())
  964. {
  965. if(topMostElement == mVisibleElements.end())
  966. topMostElement = iterFind;
  967. else
  968. {
  969. if(iterFind->bounds.y < topMostElement->bounds.y)
  970. topMostElement = iterFind;
  971. }
  972. }
  973. }
  974. if(topMostElement != mVisibleElements.end())
  975. return topMostElement->getTreeElement();
  976. else
  977. return nullptr;
  978. }
  979. GUITreeView::TreeElement* GUITreeView::getBottomMostSelectedElement() const
  980. {
  981. auto botMostElement = mVisibleElements.end();
  982. for(auto& selectedElement : mSelectedElements)
  983. {
  984. auto iterFind = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  985. [&] (const InteractableElement& x) { return x.getTreeElement() == selectedElement.element; });
  986. if(iterFind != mVisibleElements.end())
  987. {
  988. if(botMostElement == mVisibleElements.end())
  989. botMostElement = iterFind;
  990. else
  991. {
  992. if((iterFind->bounds.y + iterFind->bounds.height) > (botMostElement->bounds.y + botMostElement->bounds.height))
  993. botMostElement = iterFind;
  994. }
  995. }
  996. }
  997. if(botMostElement != mVisibleElements.end())
  998. return botMostElement->getTreeElement();
  999. else
  1000. return nullptr;
  1001. }
  1002. void GUITreeView::closeTemporarilyExpandedElements()
  1003. {
  1004. temporarilyExpandElement(nullptr);
  1005. }
  1006. void GUITreeView::temporarilyExpandElement(const InteractableElement* mouseOverElement)
  1007. {
  1008. TreeElement* treeElement = nullptr;
  1009. if(mouseOverElement != nullptr && mouseOverElement->isTreeElement())
  1010. treeElement = mouseOverElement->getTreeElement();
  1011. if(treeElement == nullptr || treeElement != mMouseOverDragElement)
  1012. {
  1013. while(!mAutoExpandedElements.empty())
  1014. {
  1015. TreeElement* autoExpandedElement = mAutoExpandedElements.top();
  1016. bool unexpandElement = false;
  1017. if(mouseOverElement != nullptr && mouseOverElement->parent != nullptr)
  1018. {
  1019. if(mouseOverElement->parent != autoExpandedElement && !mouseOverElement->parent->isParentRec(autoExpandedElement))
  1020. unexpandElement = true;
  1021. else
  1022. break;
  1023. }
  1024. else
  1025. unexpandElement = true;
  1026. if(unexpandElement)
  1027. {
  1028. collapseElement(autoExpandedElement);
  1029. if(autoExpandedElement->mFoldoutBtn != nullptr)
  1030. autoExpandedElement->mFoldoutBtn->toggleOff();
  1031. mAutoExpandedElements.pop();
  1032. }
  1033. }
  1034. mMouseOverDragElement = treeElement;
  1035. mMouseOverDragElementTime = gTime().getTime();
  1036. }
  1037. else
  1038. {
  1039. if(mMouseOverDragElement != nullptr && !mMouseOverDragElement->mIsExpanded)
  1040. {
  1041. float timeDiff = gTime().getTime() - mMouseOverDragElementTime;
  1042. if(timeDiff >= AUTO_EXPAND_DELAY_SEC)
  1043. {
  1044. mAutoExpandedElements.push(mMouseOverDragElement);
  1045. expandElement(mMouseOverDragElement);
  1046. if(mMouseOverDragElement->mFoldoutBtn != nullptr)
  1047. mMouseOverDragElement->mFoldoutBtn->toggleOn();
  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. }