BsGUITreeView.cpp 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365
  1. #include "BsGUITreeView.h"
  2. #include "BsGUILayout.h"
  3. #include "BsGUITexture.h"
  4. #include "BsGUIButton.h"
  5. #include "BsGUILabel.h"
  6. #include "BsGUISpace.h"
  7. #include "BsGUIWidget.h"
  8. #include "BsGUIToggle.h"
  9. #include "BsGUITreeViewEditBox.h"
  10. #include "BsGUIMouseEvent.h"
  11. #include "BsGUISkin.h"
  12. #include "BsGUICommandEvent.h"
  13. #include "BsGUIVirtualButtonEvent.h"
  14. #include "BsGUIScrollArea.h"
  15. #include "BsDragAndDropManager.h"
  16. #include "BsTime.h"
  17. using namespace std::placeholders;
  18. namespace BansheeEngine
  19. {
  20. const UINT32 GUITreeView::ELEMENT_EXTRA_SPACING = 3;
  21. const UINT32 GUITreeView::INDENT_SIZE = 10;
  22. const UINT32 GUITreeView::INITIAL_INDENT_OFFSET = 16;
  23. const UINT32 GUITreeView::DRAG_MIN_DISTANCE = 3;
  24. const float GUITreeView::AUTO_EXPAND_DELAY_SEC = 0.5f;
  25. const float GUITreeView::SCROLL_AREA_HEIGHT_PCT = 0.1f;
  26. const UINT32 GUITreeView::SCROLL_SPEED_PX_PER_SEC = 100;
  27. 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->disableRecursively();
  98. mNameEditBox->onInputConfirmed.connect(std::bind(&GUITreeView::onEditAccepted, this));
  99. mNameEditBox->onInputCanceled.connect(std::bind(&GUITreeView::onEditCanceled, this));
  100. mDragHighlight = GUITexture::create(mDragHighlightStyle);
  101. mDragSepHighlight = GUITexture::create(mDragSepHighlightStyle);
  102. mDragHighlight->disableRecursively();
  103. mDragSepHighlight->disableRecursively();
  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 GUITreeView::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. }
  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 GUITreeView::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 GUITreeView::InteractableElement* element = findElementUnderCoord(mDragStartPosition);
  295. TreeElement* treeElement = nullptr;
  296. if(element != nullptr && element->isTreeElement())
  297. {
  298. // If element we are trying to drag isn't selected, select it
  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. unselectAll();
  305. selectElement(element->getTreeElement());
  306. }
  307. }
  308. dragAndDropStart();
  309. mDragPosition = event.getPosition();
  310. mDragInProgress = true;
  311. mScrollState = ScrollState::None;
  312. _markLayoutAsDirty();
  313. }
  314. }
  315. }
  316. else if(event.getType() == GUIMouseEventType::MouseDragAndDropDragged)
  317. {
  318. if(acceptDragAndDrop())
  319. {
  320. clearPing();
  321. mDragPosition = event.getPosition();
  322. mDragInProgress = true;
  323. _markLayoutAsDirty();
  324. if(mBottomScrollBounds.contains(mDragPosition))
  325. {
  326. if(mScrollState != ScrollState::Down)
  327. mScrollState = ScrollState::TransitioningDown;
  328. }
  329. else if(mTopScrollBounds.contains(mDragPosition))
  330. {
  331. if(mScrollState != ScrollState::Up)
  332. mScrollState = ScrollState::TransitioningUp;
  333. }
  334. else
  335. mScrollState = ScrollState::None;
  336. return true;
  337. }
  338. }
  339. else if(event.getType() == GUIMouseEventType::MouseDragAndDropDropped)
  340. {
  341. if(acceptDragAndDrop())
  342. {
  343. const GUITreeView::InteractableElement* element = findElementUnderCoord(event.getPosition());
  344. TreeElement* treeElement = nullptr;
  345. if(element != nullptr)
  346. {
  347. if(element->isTreeElement())
  348. treeElement = element->getTreeElement();
  349. else
  350. treeElement = element->parent;
  351. }
  352. dragAndDropEnded(treeElement);
  353. unselectAll();
  354. return true;
  355. }
  356. }
  357. else if(event.getType() == GUIMouseEventType::MouseOut)
  358. {
  359. mDragInProgress = false;
  360. _markLayoutAsDirty();
  361. }
  362. return false;
  363. }
  364. bool GUITreeView::_commandEvent(const GUICommandEvent& ev)
  365. {
  366. if(ev.getType() == GUICommandEventType::MoveUp || ev.getType() == GUICommandEventType::SelectUp)
  367. {
  368. TreeElement* topMostElement = getTopMostSelectedElement();
  369. auto topMostIter = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  370. [&] (const InteractableElement& x) { return x.getTreeElement() == topMostElement; });
  371. if(topMostIter != mVisibleElements.end() && topMostIter != mVisibleElements.begin())
  372. {
  373. do
  374. {
  375. topMostIter--;
  376. } while (!topMostIter->isTreeElement() && topMostIter != mVisibleElements.begin());
  377. if(topMostIter->isTreeElement())
  378. {
  379. if(ev.getType() == GUICommandEventType::MoveUp)
  380. unselectAll();
  381. TreeElement* treeElement = topMostIter->getTreeElement();
  382. selectElement(treeElement);
  383. scrollToElement(treeElement, false);
  384. }
  385. }
  386. }
  387. else if(ev.getType() == GUICommandEventType::MoveDown || ev.getType() == GUICommandEventType::SelectDown)
  388. {
  389. TreeElement* bottoMostElement = getBottomMostSelectedElement();
  390. auto bottomMostIter = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  391. [&] (const InteractableElement& x) { return x.getTreeElement() == bottoMostElement; });
  392. if(bottomMostIter != mVisibleElements.end())
  393. {
  394. do
  395. {
  396. bottomMostIter++;
  397. } while (bottomMostIter != mVisibleElements.end() && !bottomMostIter->isTreeElement());
  398. if(bottomMostIter != mVisibleElements.end() && bottomMostIter->isTreeElement())
  399. {
  400. if(ev.getType() == GUICommandEventType::MoveDown)
  401. unselectAll();
  402. TreeElement* treeElement = bottomMostIter->getTreeElement();
  403. selectElement(treeElement);
  404. scrollToElement(treeElement, false);
  405. }
  406. }
  407. }
  408. return GUIElementContainer::_commandEvent(ev);
  409. }
  410. bool GUITreeView::_virtualButtonEvent(const GUIVirtualButtonEvent& ev)
  411. {
  412. if(ev.getButton() == mRenameVB)
  413. {
  414. renameSelected();
  415. return true;
  416. }
  417. else if(ev.getButton() == mDeleteVB)
  418. {
  419. deleteSelection();
  420. }
  421. else if (ev.getButton() == mDuplicateVB)
  422. {
  423. duplicateSelection();
  424. return true;
  425. }
  426. else if (ev.getButton() == mCutVB)
  427. {
  428. cutSelection();
  429. return true;
  430. }
  431. else if (ev.getButton() == mCopyVB)
  432. {
  433. copySelection();
  434. return true;
  435. }
  436. else if (ev.getButton() == mPasteVB)
  437. {
  438. paste();
  439. return true;
  440. }
  441. return false;
  442. }
  443. bool GUITreeView::isSelectionActive() const
  444. {
  445. return mIsElementSelected && mSelectedElements.size() > 0;
  446. }
  447. void GUITreeView::selectElement(TreeElement* element)
  448. {
  449. clearPing();
  450. auto iterFind = std::find_if(mSelectedElements.begin(), mSelectedElements.end(),
  451. [&] (const SelectedElement& x) { return x.element == element; });
  452. if(iterFind == mSelectedElements.end())
  453. {
  454. GUITexture* background = GUITexture::create(mSelectionBackgroundStyle);
  455. background->_setElementDepth(3);
  456. _registerChildElement(background);
  457. element->mIsSelected = true;
  458. mSelectedElements.push_back(SelectedElement(element, background));
  459. mIsElementSelected = true;
  460. selectionChanged();
  461. }
  462. }
  463. void GUITreeView::unselectElement(TreeElement* element)
  464. {
  465. clearPing();
  466. auto iterFind = std::find_if(mSelectedElements.begin(), mSelectedElements.end(),
  467. [&] (const SelectedElement& x) { return x.element == element; });
  468. if(iterFind != mSelectedElements.end())
  469. {
  470. iterFind->element->mIsSelected = false;
  471. GUIElement::destroy(iterFind->background);
  472. mSelectedElements.erase(iterFind);
  473. _markLayoutAsDirty();
  474. selectionChanged();
  475. }
  476. mIsElementSelected = mSelectedElements.size() > 0;
  477. }
  478. void GUITreeView::unselectAll()
  479. {
  480. clearPing();
  481. for(auto& selectedElem : mSelectedElements)
  482. {
  483. selectedElem.element->mIsSelected = false;
  484. GUIElement::destroy(selectedElem.background);
  485. }
  486. mSelectedElements.clear();
  487. mIsElementSelected = false;
  488. _markLayoutAsDirty();
  489. selectionChanged();
  490. }
  491. void GUITreeView::renameSelected()
  492. {
  493. if (isSelectionActive() && mEditElement == nullptr)
  494. {
  495. clearPing();
  496. enableEdit(mSelectedElements[0].element);
  497. unselectAll();
  498. }
  499. }
  500. void GUITreeView::deleteSelection()
  501. {
  502. if (isSelectionActive())
  503. {
  504. auto isChildOf = [&](const TreeElement* parent, const TreeElement* child)
  505. {
  506. const TreeElement* elem = child;
  507. while (elem != nullptr && elem != parent)
  508. elem = child->mParent;
  509. return elem == parent;
  510. };
  511. // Ensure we don't unnecessarily try to delete children if their
  512. // parent is getting deleted anyway
  513. Vector<TreeElement*> elementsToDelete;
  514. for (UINT32 i = 0; i < (UINT32)mSelectedElements.size(); i++)
  515. {
  516. bool hasDeletedParent = false;
  517. for (UINT32 j = 0; j < (UINT32)mSelectedElements.size(); j++)
  518. {
  519. if (i == j)
  520. continue;
  521. if (isChildOf(mSelectedElements[j].element, mSelectedElements[i].element))
  522. {
  523. hasDeletedParent = true;
  524. break;
  525. }
  526. }
  527. if (!hasDeletedParent)
  528. elementsToDelete.push_back(mSelectedElements[i].element);
  529. }
  530. clearPing();
  531. unselectAll();
  532. for (auto& elem : elementsToDelete)
  533. deleteTreeElement(elem);
  534. }
  535. }
  536. void GUITreeView::ping(TreeElement* element)
  537. {
  538. clearPing();
  539. expandToElement(element);
  540. scrollToElement(element, true);
  541. GUITexture* background = GUITexture::create(mHighlightBackgroundStyle);
  542. background->_setElementDepth(2);
  543. _registerChildElement(background);
  544. element->mIsHighlighted = true;
  545. mHighlightedElement.element = element;
  546. mHighlightedElement.background = background;
  547. mIsElementHighlighted = true;
  548. _markLayoutAsDirty();
  549. }
  550. void GUITreeView::clearPing()
  551. {
  552. if (!mIsElementHighlighted)
  553. return;
  554. mHighlightedElement.element->mIsHighlighted = false;
  555. GUIElement::destroy(mHighlightedElement.background);
  556. mHighlightedElement.element = nullptr;
  557. mHighlightedElement.background = nullptr;
  558. mIsElementHighlighted = false;
  559. _markLayoutAsDirty();
  560. }
  561. void GUITreeView::expandToElement(TreeElement* element)
  562. {
  563. if (element->mIsVisible || element->mParent == nullptr)
  564. return;
  565. Stack<TreeElement*> todo;
  566. TreeElement* parent = element->mParent;
  567. while (parent != nullptr)
  568. {
  569. if (!parent->mIsExpanded)
  570. todo.push(parent);
  571. if (parent->mIsVisible)
  572. break;
  573. parent = parent->mParent;
  574. }
  575. while (!todo.empty())
  576. {
  577. TreeElement* curElement = todo.top();
  578. todo.pop();
  579. expandElement(curElement);
  580. }
  581. }
  582. void GUITreeView::expandElement(TreeElement* element)
  583. {
  584. if(element->mIsExpanded)
  585. return;
  586. element->mIsExpanded = true;
  587. if(element->mParent == nullptr || (element->mParent->mIsVisible && element->mParent->mIsExpanded))
  588. {
  589. Stack<TreeElement*> todo;
  590. todo.push(element);
  591. while(!todo.empty())
  592. {
  593. TreeElement* curElem = todo.top();
  594. todo.pop();
  595. curElem->mIsVisible = true;
  596. updateElementGUI(curElem);
  597. if(curElem->mIsExpanded)
  598. {
  599. for(auto& child : curElem->mChildren)
  600. todo.push(child);
  601. }
  602. }
  603. }
  604. }
  605. void GUITreeView::collapseElement(TreeElement* element)
  606. {
  607. if(!element->mIsExpanded)
  608. return;
  609. element->mIsExpanded = false;
  610. updateElementGUI(element);
  611. if(element->mParent == nullptr || (element->mParent->mIsVisible && element->mParent->mIsExpanded))
  612. {
  613. Stack<TreeElement*> todo;
  614. for(auto& child : element->mChildren)
  615. todo.push(child);
  616. while(!todo.empty())
  617. {
  618. TreeElement* curElem = todo.top();
  619. todo.pop();
  620. curElem->mIsVisible = false;
  621. if(curElem->mIsSelected)
  622. unselectElement(curElem);
  623. updateElementGUI(curElem);
  624. if(curElem->mIsExpanded)
  625. {
  626. for(auto& child : curElem->mChildren)
  627. todo.push(child);
  628. }
  629. }
  630. }
  631. }
  632. void GUITreeView::updateElementGUI(TreeElement* element)
  633. {
  634. if(element == &getRootElement())
  635. return;
  636. if(element->mIsVisible)
  637. {
  638. HString name(toWString(element->mName));
  639. if(element->mElement == nullptr)
  640. {
  641. element->mElement = GUILabel::create(name, mElementBtnStyle);
  642. _registerChildElement(element->mElement);
  643. }
  644. element->mElement->setTint(element->mIsGrayedOut ? GRAYED_OUT_COLOR : Color::White);
  645. if(element->mChildren.size() > 0)
  646. {
  647. if(element->mFoldoutBtn == nullptr)
  648. {
  649. element->mFoldoutBtn = GUIToggle::create(GUIContent(HString(L"")), mFoldoutBtnStyle);
  650. _registerChildElement(element->mFoldoutBtn);
  651. element->mFoldoutBtn->onToggled.connect(std::bind(&GUITreeView::elementToggled, this, element, _1));
  652. if(element->mIsExpanded)
  653. element->mFoldoutBtn->toggleOn();
  654. }
  655. }
  656. else
  657. {
  658. if(element->mFoldoutBtn != nullptr)
  659. {
  660. GUIElement::destroy(element->mFoldoutBtn);
  661. element->mFoldoutBtn = nullptr;
  662. }
  663. }
  664. element->mElement->setContent(GUIContent(name));
  665. }
  666. else
  667. {
  668. if(element->mElement != nullptr)
  669. {
  670. GUIElement::destroy(element->mElement);
  671. element->mElement = nullptr;
  672. }
  673. if(element->mFoldoutBtn != nullptr)
  674. {
  675. GUIElement::destroy(element->mFoldoutBtn);
  676. element->mFoldoutBtn = nullptr;
  677. }
  678. if(element->mIsSelected && element->mIsExpanded)
  679. unselectElement(element);
  680. }
  681. _markLayoutAsDirty();
  682. }
  683. void GUITreeView::elementToggled(TreeElement* element, bool toggled)
  684. {
  685. clearPing();
  686. if(toggled)
  687. expandElement(element);
  688. else
  689. collapseElement(element);
  690. }
  691. void GUITreeView::onEditAccepted()
  692. {
  693. disableEdit(true);
  694. }
  695. void GUITreeView::onEditCanceled()
  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->enableRecursively();
  705. mNameEditBox->setText(toWString(element->mName));
  706. mNameEditBox->setFocus(true);
  707. if(element->mElement != nullptr)
  708. element->mElement->disableRecursively();
  709. }
  710. void GUITreeView::disableEdit(bool applyChanges)
  711. {
  712. assert(mEditElement != nullptr);
  713. if(mEditElement->mElement != nullptr)
  714. mEditElement->mElement->enableRecursively();
  715. if(applyChanges)
  716. {
  717. WString newName = mNameEditBox->getText();
  718. renameTreeElement(mEditElement, newName);
  719. }
  720. mNameEditBox->setFocus(false);
  721. mNameEditBox->disableRecursively();
  722. selectElement(mEditElement);
  723. mEditElement = nullptr;
  724. }
  725. Vector2I GUITreeView::_getOptimalSize() const
  726. {
  727. struct UpdateTreeElement
  728. {
  729. UpdateTreeElement(const TreeElement* element, UINT32 indent)
  730. :element(element), indent(indent)
  731. { }
  732. const TreeElement* element;
  733. UINT32 indent;
  734. };
  735. Vector2I optimalSize;
  736. if (_getDimensions().fixedWidth() && _getDimensions().fixedHeight())
  737. {
  738. optimalSize.x = _getDimensions().minWidth;
  739. optimalSize.y = _getDimensions().minHeight;
  740. }
  741. else
  742. {
  743. Stack<UpdateTreeElement> todo;
  744. todo.push(UpdateTreeElement(&getRootElementConst(), 0));
  745. while(!todo.empty())
  746. {
  747. UpdateTreeElement currentUpdateElement = todo.top();
  748. const TreeElement* current = currentUpdateElement.element;
  749. todo.pop();
  750. INT32 yOffset = 0;
  751. if(current->mElement != nullptr)
  752. {
  753. Vector2I curOptimalSize = current->mElement->_getOptimalSize();
  754. optimalSize.x = std::max(optimalSize.x,
  755. (INT32)(INITIAL_INDENT_OFFSET + curOptimalSize.x + currentUpdateElement.indent * INDENT_SIZE));
  756. yOffset = curOptimalSize.y + ELEMENT_EXTRA_SPACING;
  757. }
  758. optimalSize.y += yOffset;
  759. for(auto& child : current->mChildren)
  760. {
  761. if(!child->mIsVisible)
  762. continue;
  763. todo.push(UpdateTreeElement(child, currentUpdateElement.indent + 1));
  764. }
  765. }
  766. if(_getDimensions().fixedWidth())
  767. optimalSize.x = _getDimensions().minWidth;
  768. else
  769. {
  770. if(_getDimensions().minWidth > 0)
  771. optimalSize.x = std::max((INT32)_getDimensions().minWidth, optimalSize.x);
  772. if(_getDimensions().maxWidth > 0)
  773. optimalSize.x = std::min((INT32)_getDimensions().maxWidth, optimalSize.x);
  774. }
  775. if (_getDimensions().fixedHeight())
  776. optimalSize.y = _getDimensions().minHeight;
  777. else
  778. {
  779. if(_getDimensions().minHeight > 0)
  780. optimalSize.y = std::max((INT32)_getDimensions().minHeight, optimalSize.y);
  781. if(_getDimensions().maxHeight > 0)
  782. optimalSize.y = std::min((INT32)_getDimensions().maxHeight, optimalSize.y);
  783. }
  784. }
  785. return optimalSize;
  786. }
  787. void GUITreeView::updateClippedBounds()
  788. {
  789. mClippedBounds = mLayoutData.area;
  790. mClippedBounds.clip(mLayoutData.clipRect);
  791. }
  792. void GUITreeView::_updateLayoutInternal(const GUILayoutData& data)
  793. {
  794. struct UpdateTreeElement
  795. {
  796. UpdateTreeElement(TreeElement* element, UINT32 indent)
  797. :element(element), indent(indent)
  798. { }
  799. TreeElement* element;
  800. UINT32 indent;
  801. };
  802. mVisibleElements.clear();
  803. Stack<UpdateTreeElement> todo;
  804. todo.push(UpdateTreeElement(&getRootElement(), 0));
  805. // NOTE - Instead of iterating through all elements, try to find those within the clip rect
  806. // and only iterate through those. Others should somehow be marked in-active (similar to GUIElement::isDisabled()?)
  807. Vector<TreeElement*> tempOrderedElements;
  808. Vector2I offset(data.area.x, data.area.y);
  809. while(!todo.empty())
  810. {
  811. UpdateTreeElement currentUpdateElement = todo.top();
  812. TreeElement* current = currentUpdateElement.element;
  813. UINT32 indent = currentUpdateElement.indent;
  814. todo.pop();
  815. INT32 btnHeight = 0;
  816. INT32 yOffset = 0;
  817. if(current->mElement != nullptr)
  818. {
  819. Vector2I elementSize = current->mElement->_getOptimalSize();
  820. btnHeight = elementSize.y;
  821. mVisibleElements.push_back(InteractableElement(current->mParent, current->mSortedIdx * 2 + 0, Rect2I(data.area.x, offset.y, data.area.width, ELEMENT_EXTRA_SPACING)));
  822. mVisibleElements.push_back(InteractableElement(current->mParent, current->mSortedIdx * 2 + 1, Rect2I(data.area.x, offset.y + ELEMENT_EXTRA_SPACING, data.area.width, btnHeight)));
  823. offset.x = data.area.x + INITIAL_INDENT_OFFSET + indent * INDENT_SIZE;
  824. offset.y += ELEMENT_EXTRA_SPACING;
  825. GUILayoutData childData = data;
  826. childData.area.x = offset.x;
  827. childData.area.y = offset.y;
  828. childData.area.width = elementSize.x;
  829. childData.area.height = elementSize.y;
  830. current->mElement->_setLayoutData(childData);
  831. yOffset = btnHeight;
  832. }
  833. if(current->mFoldoutBtn != nullptr)
  834. {
  835. Vector2I elementSize = current->mFoldoutBtn->_getOptimalSize();
  836. offset.x -= std::min((INT32)INITIAL_INDENT_OFFSET, elementSize.x);
  837. Vector2I myOffset = offset;
  838. myOffset.y -= 2; // TODO: Arbitrary offset, I should adjust it based on font baseline so that the button is nicely centered on text
  839. if(elementSize.y > btnHeight)
  840. {
  841. UINT32 diff = elementSize.y - btnHeight;
  842. float half = diff * 0.5f;
  843. myOffset.y -= Math::floorToInt(half);
  844. }
  845. GUILayoutData childData = data;
  846. childData.area.x = myOffset.x;
  847. childData.area.y = myOffset.y;
  848. childData.area.width = elementSize.x;
  849. childData.area.height = elementSize.y;
  850. current->mFoldoutBtn->_setLayoutData(childData);
  851. }
  852. offset.y += yOffset;
  853. tempOrderedElements.resize(current->mChildren.size(), nullptr);
  854. for(auto& child : current->mChildren)
  855. {
  856. tempOrderedElements[child->mSortedIdx] = child;
  857. }
  858. for(auto iter = tempOrderedElements.rbegin(); iter != tempOrderedElements.rend(); ++iter)
  859. {
  860. TreeElement* child = *iter;
  861. if(!child->mIsVisible)
  862. continue;
  863. todo.push(UpdateTreeElement(child, indent + 1));
  864. }
  865. }
  866. UINT32 remainingHeight = (UINT32)std::max(0, (INT32)data.area.height - (offset.y - data.area.y));
  867. if(remainingHeight > 0)
  868. mVisibleElements.push_back(InteractableElement(&getRootElement(), (UINT32)getRootElement().mChildren.size() * 2, Rect2I(data.area.x, offset.y, data.area.width, remainingHeight)));
  869. for(auto selectedElem : mSelectedElements)
  870. {
  871. GUILabel* targetElement = selectedElem.element->mElement;
  872. GUILayoutData childData = data;
  873. childData.area.y = targetElement->_getLayoutData().area.y;
  874. childData.area.height = targetElement->_getLayoutData().area.height;
  875. selectedElem.background->_setLayoutData(childData);
  876. }
  877. if (mIsElementHighlighted)
  878. {
  879. GUILabel* targetElement = mHighlightedElement.element->mElement;
  880. GUILayoutData childData = data;
  881. childData.area.y = targetElement->_getLayoutData().area.y;
  882. childData.area.height = targetElement->_getLayoutData().area.height;
  883. mHighlightedElement.background->_setLayoutData(childData);
  884. }
  885. if(mEditElement != nullptr)
  886. {
  887. GUILabel* targetElement = mEditElement->mElement;
  888. UINT32 remainingWidth = (UINT32)std::max(0, (((INT32)data.area.width) - (offset.x - data.area.x)));
  889. GUILayoutData childData = data;
  890. childData.area = targetElement->_getLayoutData().area;
  891. childData.area.width = remainingWidth;
  892. mNameEditBox->_setLayoutData(childData);
  893. }
  894. if(mDragInProgress)
  895. {
  896. const InteractableElement* interactableElement = findElementUnderCoord(mDragPosition);
  897. if(interactableElement == nullptr)
  898. {
  899. if(!mDragHighlight->_isDisabled())
  900. mDragHighlight->disableRecursively();
  901. if(!mDragSepHighlight->_isDisabled())
  902. mDragSepHighlight->disableRecursively();
  903. }
  904. else
  905. {
  906. if(interactableElement->isTreeElement())
  907. {
  908. if(!mDragSepHighlight->_isDisabled())
  909. mDragSepHighlight->disableRecursively();
  910. if(mDragHighlight->_isDisabled())
  911. mDragHighlight->enableRecursively();
  912. GUILayoutData childData = data;
  913. childData.area = interactableElement->bounds;
  914. mDragHighlight->_setLayoutData(childData);
  915. }
  916. else
  917. {
  918. if(!mDragHighlight->_isDisabled())
  919. mDragHighlight->disableRecursively();
  920. if(mDragSepHighlight->_isDisabled())
  921. mDragSepHighlight->enableRecursively();
  922. GUILayoutData childData = data;
  923. childData.area = interactableElement->bounds;
  924. mDragSepHighlight->_setLayoutData(childData);
  925. }
  926. }
  927. }
  928. else
  929. {
  930. if(!mDragHighlight->_isDisabled())
  931. mDragHighlight->disableRecursively();
  932. if(!mDragSepHighlight->_isDisabled())
  933. mDragSepHighlight->disableRecursively();
  934. }
  935. // Update scroll bounds
  936. UINT32 scrollHeight = (UINT32)Math::roundToInt(data.clipRect.height * SCROLL_AREA_HEIGHT_PCT);
  937. mTopScrollBounds.x = data.clipRect.x;
  938. mTopScrollBounds.y = data.clipRect.y;
  939. mTopScrollBounds.width = data.clipRect.width;
  940. mTopScrollBounds.height = scrollHeight;
  941. mBottomScrollBounds.x = data.clipRect.x;
  942. mBottomScrollBounds.y = data.clipRect.y + data.clipRect.height - scrollHeight;
  943. mBottomScrollBounds.width = data.clipRect.width;
  944. mBottomScrollBounds.height = scrollHeight;
  945. }
  946. const GUITreeView::InteractableElement* GUITreeView::findElementUnderCoord(const Vector2I& coord) const
  947. {
  948. for(auto& element : mVisibleElements)
  949. {
  950. if(element.bounds.contains(coord))
  951. {
  952. return &element;
  953. }
  954. }
  955. return nullptr;
  956. }
  957. GUITreeView::TreeElement* GUITreeView::getTopMostSelectedElement() const
  958. {
  959. auto topMostElement = mVisibleElements.end();
  960. for(auto& selectedElement : mSelectedElements)
  961. {
  962. auto iterFind = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  963. [&] (const InteractableElement& x) { return x.getTreeElement() == selectedElement.element; });
  964. if(iterFind != mVisibleElements.end())
  965. {
  966. if(topMostElement == mVisibleElements.end())
  967. topMostElement = iterFind;
  968. else
  969. {
  970. if(iterFind->bounds.y < topMostElement->bounds.y)
  971. topMostElement = iterFind;
  972. }
  973. }
  974. }
  975. if(topMostElement != mVisibleElements.end())
  976. return topMostElement->getTreeElement();
  977. else
  978. return nullptr;
  979. }
  980. GUITreeView::TreeElement* GUITreeView::getBottomMostSelectedElement() const
  981. {
  982. auto& botMostElement = mVisibleElements.end();
  983. for(auto& selectedElement : mSelectedElements)
  984. {
  985. auto iterFind = std::find_if(mVisibleElements.begin(), mVisibleElements.end(),
  986. [&] (const InteractableElement& x) { return x.getTreeElement() == selectedElement.element; });
  987. if(iterFind != mVisibleElements.end())
  988. {
  989. if(botMostElement == mVisibleElements.end())
  990. botMostElement = iterFind;
  991. else
  992. {
  993. if((iterFind->bounds.y + iterFind->bounds.height) > (botMostElement->bounds.y + botMostElement->bounds.height))
  994. botMostElement = iterFind;
  995. }
  996. }
  997. }
  998. if(botMostElement != mVisibleElements.end())
  999. return botMostElement->getTreeElement();
  1000. else
  1001. return nullptr;
  1002. }
  1003. void GUITreeView::closeTemporarilyExpandedElements()
  1004. {
  1005. temporarilyExpandElement(nullptr);
  1006. }
  1007. void GUITreeView::temporarilyExpandElement(const GUITreeView::InteractableElement* mouseOverElement)
  1008. {
  1009. TreeElement* treeElement = nullptr;
  1010. if(mouseOverElement != nullptr && mouseOverElement->isTreeElement())
  1011. treeElement = mouseOverElement->getTreeElement();
  1012. if(treeElement == nullptr || treeElement != mMouseOverDragElement)
  1013. {
  1014. while(!mAutoExpandedElements.empty())
  1015. {
  1016. TreeElement* autoExpandedElement = mAutoExpandedElements.top();
  1017. bool unexpandElement = false;
  1018. if(mouseOverElement != nullptr && mouseOverElement->parent != nullptr)
  1019. {
  1020. if(mouseOverElement->parent != autoExpandedElement && !mouseOverElement->parent->isParentRec(autoExpandedElement))
  1021. unexpandElement = true;
  1022. else
  1023. break;
  1024. }
  1025. else
  1026. unexpandElement = true;
  1027. if(unexpandElement)
  1028. {
  1029. collapseElement(autoExpandedElement);
  1030. if(autoExpandedElement->mFoldoutBtn != nullptr)
  1031. autoExpandedElement->mFoldoutBtn->toggleOff();
  1032. mAutoExpandedElements.pop();
  1033. }
  1034. }
  1035. mMouseOverDragElement = treeElement;
  1036. mMouseOverDragElementTime = gTime().getTime();
  1037. }
  1038. else
  1039. {
  1040. if(mMouseOverDragElement != nullptr && !mMouseOverDragElement->mIsExpanded)
  1041. {
  1042. float timeDiff = gTime().getTime() - mMouseOverDragElementTime;
  1043. if(timeDiff >= AUTO_EXPAND_DELAY_SEC)
  1044. {
  1045. mAutoExpandedElements.push(mMouseOverDragElement);
  1046. expandElement(mMouseOverDragElement);
  1047. if(mMouseOverDragElement->mFoldoutBtn != nullptr)
  1048. mMouseOverDragElement->mFoldoutBtn->toggleOn();
  1049. }
  1050. }
  1051. }
  1052. }
  1053. void GUITreeView::scrollToElement(TreeElement* element, bool center)
  1054. {
  1055. if(element->mElement == nullptr)
  1056. return;
  1057. GUIScrollArea* scrollArea = findParentScrollArea();
  1058. if(scrollArea == nullptr)
  1059. return;
  1060. if(center)
  1061. {
  1062. Rect2I myBounds = _getClippedBounds();
  1063. INT32 clipVertCenter = myBounds.y + (INT32)Math::roundToInt(myBounds.height * 0.5f);
  1064. INT32 elemVertCenter = element->mElement->_getLayoutData().area.y + (INT32)Math::roundToInt(element->mElement->_getLayoutData().area.height * 0.5f);
  1065. if(elemVertCenter > clipVertCenter)
  1066. scrollArea->scrollDownPx(elemVertCenter - clipVertCenter);
  1067. else
  1068. scrollArea->scrollUpPx(clipVertCenter - elemVertCenter);
  1069. }
  1070. else
  1071. {
  1072. Rect2I myBounds = _getClippedBounds();
  1073. INT32 elemVertTop = element->mElement->_getLayoutData().area.y;
  1074. INT32 elemVertBottom = element->mElement->_getLayoutData().area.y + element->mElement->_getLayoutData().area.height;
  1075. INT32 top = myBounds.y;
  1076. INT32 bottom = myBounds.y + myBounds.height;
  1077. INT32 offset = 0;
  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. }