BsGUITreeView.cpp 35 KB

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