BsGUITreeView.cpp 37 KB

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