BsScriptEditorWindow.cpp 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494
  1. #include "BsScriptEditorWindow.h"
  2. #include "BsScriptMeta.h"
  3. #include "BsMonoField.h"
  4. #include "BsMonoClass.h"
  5. #include "BsMonoMethod.h"
  6. #include "BsMonoManager.h"
  7. #include "BsMonoUtil.h"
  8. #include "BsEditorWindow.h"
  9. #include "BsEditorWidget.h"
  10. #include "BsEditorWidgetManager.h"
  11. #include "BsEditorWidgetContainer.h"
  12. #include "BsMonoAssembly.h"
  13. #include "BsScriptObjectManager.h"
  14. #include "BsScriptGUILayout.h"
  15. #include "BsScriptHString.h"
  16. #include "BsPlatform.h"
  17. #include "BsInput.h"
  18. using namespace std::placeholders;
  19. namespace BansheeEngine
  20. {
  21. UnorderedMap<String, ScriptEditorWindow::EditorWindowHandle> ScriptEditorWindow::OpenScriptEditorWindows;
  22. Vector<String> ScriptEditorWindow::AvailableWindowTypes;
  23. MonoMethod* ScriptEditorWindow::onResizedMethod = nullptr;
  24. MonoMethod* ScriptEditorWindow::onFocusChangedMethod = nullptr;
  25. MonoField* ScriptEditorWindow::guiPanelField = nullptr;
  26. ScriptEditorWindow::ScriptEditorWindow(ScriptEditorWidget* editorWidget)
  27. :ScriptObject(editorWidget->getManagedInstance()), mName(editorWidget->getName()), mEditorWidget(editorWidget),
  28. mRefreshInProgress(false), mIsDestroyed(false)
  29. {
  30. mOnWidgetResizedConn = editorWidget->onResized.connect(std::bind(&ScriptEditorWindow::onWidgetResized, this, _1, _2));
  31. mOnFocusChangedConn = editorWidget->onFocusChanged.connect(std::bind(&ScriptEditorWindow::onFocusChanged, this, _1));
  32. mOnAssemblyRefreshStartedConn = ScriptObjectManager::instance().onRefreshStarted.connect(std::bind(&ScriptEditorWindow::onAssemblyRefreshStarted, this));
  33. }
  34. ScriptEditorWindow::~ScriptEditorWindow()
  35. {
  36. // TODO - This probably need to be called whenever we close a window, and not when script class is destructed
  37. mOnWidgetResizedConn.disconnect();
  38. mOnFocusChangedConn.disconnect();
  39. mOnAssemblyRefreshStartedConn.disconnect();
  40. }
  41. void ScriptEditorWindow::initRuntimeData()
  42. {
  43. metaData.scriptClass->addInternalCall("Internal_CreateOrGetInstance", &ScriptEditorWindow::internal_createOrGetInstance);
  44. metaData.scriptClass->addInternalCall("Internal_GetInstance", &ScriptEditorWindow::internal_getInstance);
  45. metaData.scriptClass->addInternalCall("Internal_GetWidth", &ScriptEditorWindow::internal_getWidth);
  46. metaData.scriptClass->addInternalCall("Internal_GetHeight", &ScriptEditorWindow::internal_getHeight);
  47. metaData.scriptClass->addInternalCall("Internal_GetBounds", &ScriptEditorWindow::internal_getBounds);
  48. metaData.scriptClass->addInternalCall("Internal_HasFocus", &ScriptEditorWindow::internal_hasFocus);
  49. metaData.scriptClass->addInternalCall("Internal_IsActive", &ScriptEditorWindow::internal_isActive);
  50. metaData.scriptClass->addInternalCall("Internal_IsPointerHovering", &ScriptEditorWindow::internal_isPointerHovering);
  51. metaData.scriptClass->addInternalCall("Internal_ScreenToWindowPos", &ScriptEditorWindow::internal_screenToWindowPos);
  52. metaData.scriptClass->addInternalCall("Internal_WindowToScreenPos", &ScriptEditorWindow::internal_windowToScreenPos);
  53. onResizedMethod = metaData.scriptClass->getMethod("WindowResized", 2);
  54. onFocusChangedMethod = metaData.scriptClass->getMethod("FocusChanged", 1);
  55. guiPanelField = metaData.scriptClass->getField("GUI");
  56. }
  57. MonoObject* ScriptEditorWindow::internal_createOrGetInstance(MonoString* ns, MonoString* typeName)
  58. {
  59. String strTypeName = toString(MonoUtil::monoToWString(typeName));
  60. String strNamespace = toString(MonoUtil::monoToWString(ns));
  61. String fullName = strNamespace + "." + strTypeName;
  62. auto findIter = OpenScriptEditorWindows.find(fullName);
  63. if(findIter != OpenScriptEditorWindows.end())
  64. return findIter->second.nativeObj->mManagedInstance;
  65. EditorWidgetManager::instance().open(fullName); // This will trigger openEditorWidgetCallback and update OpenScriptEditorWindows
  66. auto findIter2 = OpenScriptEditorWindows.find(fullName);
  67. if(findIter2 != OpenScriptEditorWindows.end())
  68. return findIter2->second.nativeObj->mManagedInstance;
  69. return nullptr;
  70. }
  71. MonoObject* ScriptEditorWindow::internal_getInstance(MonoString* ns, MonoString* typeName)
  72. {
  73. String strTypeName = toString(MonoUtil::monoToWString(typeName));
  74. String strNamespace = toString(MonoUtil::monoToWString(ns));
  75. String fullName = strNamespace + "." + strTypeName;
  76. auto findIter = OpenScriptEditorWindows.find(fullName);
  77. if (findIter != OpenScriptEditorWindows.end())
  78. return findIter->second.nativeObj->mManagedInstance;
  79. return nullptr;
  80. }
  81. EditorWidgetBase* ScriptEditorWindow::getEditorWidget() const
  82. {
  83. return mEditorWidget;
  84. }
  85. void ScriptEditorWindow::_onManagedInstanceDeleted()
  86. {
  87. if (!mRefreshInProgress)
  88. ScriptObject::_onManagedInstanceDeleted();
  89. else
  90. mManagedInstance = nullptr;
  91. }
  92. ScriptObjectBackup ScriptEditorWindow::beginRefresh()
  93. {
  94. mRefreshInProgress = true;
  95. auto iterFind = OpenScriptEditorWindows.find(mName);
  96. if (iterFind != OpenScriptEditorWindows.end())
  97. {
  98. EditorWindowHandle handle = iterFind->second;
  99. mono_gchandle_free(handle.gcHandle);
  100. iterFind->second.gcHandle = 0;
  101. }
  102. return PersistentScriptObjectBase::beginRefresh();
  103. }
  104. void ScriptEditorWindow::endRefresh(const ScriptObjectBackup& backupData)
  105. {
  106. mRefreshInProgress = false;
  107. if (!isDestroyed())
  108. mManagedInstance = mEditorWidget->getManagedInstance();
  109. else
  110. mManagedInstance = nullptr;
  111. if (mManagedInstance != nullptr)
  112. {
  113. auto iterFind = OpenScriptEditorWindows.find(mName);
  114. if (iterFind != OpenScriptEditorWindows.end())
  115. iterFind->second.gcHandle = mono_gchandle_new(mManagedInstance, false);
  116. }
  117. else
  118. {
  119. // We couldn't restore managed instance because window class cannot be found
  120. _onManagedInstanceDeleted();
  121. }
  122. PersistentScriptObjectBase::endRefresh(backupData);
  123. }
  124. void ScriptEditorWindow::onAssemblyRefreshStarted()
  125. {
  126. if (!isDestroyed())
  127. mEditorWidget->triggerOnDestroy();
  128. }
  129. MonoObject* ScriptEditorWindow::_createManagedInstance(bool construct)
  130. {
  131. if (!isDestroyed())
  132. {
  133. mEditorWidget->createManagedInstance();
  134. return mEditorWidget->getManagedInstance();
  135. }
  136. else
  137. return nullptr;
  138. }
  139. bool ScriptEditorWindow::internal_hasFocus(ScriptEditorWindow* thisPtr)
  140. {
  141. if (!thisPtr->isDestroyed())
  142. return thisPtr->getEditorWidget()->hasFocus();
  143. else
  144. return false;
  145. }
  146. bool ScriptEditorWindow::internal_isActive(ScriptEditorWindow* thisPtr)
  147. {
  148. if (!thisPtr->isDestroyed())
  149. return thisPtr->getEditorWidget()->isActive();
  150. else
  151. return false;
  152. }
  153. bool ScriptEditorWindow::internal_isPointerHovering(ScriptEditorWindow* thisPtr)
  154. {
  155. if (!thisPtr->isDestroyed())
  156. {
  157. EditorWidgetBase* widget = thisPtr->getEditorWidget();
  158. EditorWindowBase* window = widget->getParentWindow();
  159. if (window == nullptr)
  160. return false;
  161. RenderWindowPtr renderWindow = window->getRenderWindow();
  162. Vector2I pointerPos = gInput().getPointerPosition();
  163. if(Platform::isPointOverWindow(*renderWindow, pointerPos))
  164. {
  165. Rect2I bounds = thisPtr->getEditorWidget()->getBounds();
  166. Vector2I widgetPos(bounds.x, bounds.y);
  167. Vector2I screenPos = widget->widgetToScreenPos(widgetPos);
  168. bounds.x = screenPos.x;
  169. bounds.y = screenPos.y;
  170. return bounds.contains(pointerPos);
  171. }
  172. }
  173. return false;
  174. }
  175. void ScriptEditorWindow::internal_screenToWindowPos(ScriptEditorWindow* thisPtr, Vector2I* screenPos, Vector2I* windowPos)
  176. {
  177. if (!thisPtr->isDestroyed())
  178. *windowPos = thisPtr->getEditorWidget()->screenToWidgetPos(*screenPos);
  179. else
  180. *windowPos = *screenPos;
  181. }
  182. void ScriptEditorWindow::internal_windowToScreenPos(ScriptEditorWindow* thisPtr, Vector2I* windowPos, Vector2I* screenPos)
  183. {
  184. if (!thisPtr->isDestroyed())
  185. *screenPos = thisPtr->getEditorWidget()->widgetToScreenPos(*windowPos);
  186. else
  187. *screenPos = *windowPos;
  188. }
  189. UINT32 ScriptEditorWindow::internal_getWidth(ScriptEditorWindow* thisPtr)
  190. {
  191. if (!thisPtr->isDestroyed())
  192. return thisPtr->mEditorWidget->getWidth();
  193. else
  194. return 0;
  195. }
  196. UINT32 ScriptEditorWindow::internal_getHeight(ScriptEditorWindow* thisPtr)
  197. {
  198. if (!thisPtr->isDestroyed())
  199. return thisPtr->mEditorWidget->getHeight();
  200. else
  201. return 0;
  202. }
  203. void ScriptEditorWindow::internal_getBounds(ScriptEditorWindow* thisPtr, Rect2I* bounds)
  204. {
  205. if (!thisPtr->isDestroyed())
  206. {
  207. EditorWidgetBase* widget = thisPtr->getEditorWidget();
  208. *bounds = thisPtr->getEditorWidget()->getBounds();
  209. Vector2I widgetPos(bounds->x, bounds->y);
  210. Vector2I screenPos = widget->widgetToScreenPos(widgetPos);
  211. bounds->x = screenPos.x;
  212. bounds->y = screenPos.y;
  213. }
  214. else
  215. *bounds = Rect2I();
  216. }
  217. void ScriptEditorWindow::onWidgetResized(UINT32 width, UINT32 height)
  218. {
  219. if (isDestroyed() || !mEditorWidget->isInitialized() || mManagedInstance == nullptr)
  220. return;
  221. void* params[2] = { &width, &height };
  222. onResizedMethod->invokeVirtual(mManagedInstance, params);
  223. }
  224. void ScriptEditorWindow::onFocusChanged(bool inFocus)
  225. {
  226. if (isDestroyed() || mManagedInstance == nullptr)
  227. return;
  228. void* params[1] = { &inFocus};
  229. onFocusChangedMethod->invokeVirtual(mManagedInstance, params);
  230. }
  231. void ScriptEditorWindow::registerManagedEditorWindows()
  232. {
  233. MonoAssembly* assembly = MonoManager::instance().getAssembly(EDITOR_ASSEMBLY);
  234. if(assembly != nullptr)
  235. {
  236. MonoClass* defaultSizeAttrib = assembly->getClass("BansheeEditor", "DefaultSize");
  237. if (defaultSizeAttrib == nullptr)
  238. BS_EXCEPT(InternalErrorException, "Cannot find DefaultSize managed class.");
  239. MonoField* defaultWidthField = defaultSizeAttrib->getField("width");
  240. MonoField* defaultHeightField = defaultSizeAttrib->getField("height");
  241. MonoClass* editorWindowClass = assembly->getClass("BansheeEditor", "EditorWindow");
  242. const Vector<MonoClass*>& allClasses = assembly->getAllClasses();
  243. for(auto& curClass : allClasses)
  244. {
  245. if(curClass->isSubClassOf(editorWindowClass) && curClass != editorWindowClass)
  246. {
  247. UINT32 width = 400;
  248. UINT32 height = 400;
  249. MonoObject* defaultSize = curClass->getAttribute(defaultSizeAttrib);
  250. if (defaultSize != nullptr)
  251. {
  252. defaultWidthField->getValue(defaultSize, &width);
  253. defaultHeightField->getValue(defaultSize, &height);
  254. }
  255. const String& className = curClass->getFullName();
  256. EditorWidgetManager::instance().registerWidget(className,
  257. std::bind(&ScriptEditorWindow::openEditorWidgetCallback, curClass->getNamespace(),
  258. curClass->getTypeName(), width, height, _1));
  259. AvailableWindowTypes.push_back(className);
  260. }
  261. }
  262. }
  263. }
  264. void ScriptEditorWindow::clearRegisteredEditorWindow()
  265. {
  266. for (auto& windowType : AvailableWindowTypes)
  267. {
  268. EditorWidgetManager::instance().unregisterWidget(windowType);
  269. }
  270. AvailableWindowTypes.clear();
  271. }
  272. EditorWidgetBase* ScriptEditorWindow::openEditorWidgetCallback(String ns, String type, UINT32 width,
  273. UINT32 height, EditorWidgetContainer& parentContainer)
  274. {
  275. ScriptEditorWidget* editorWidget = bs_new<ScriptEditorWidget>(ns, type, width, height, parentContainer);
  276. ScriptEditorWindow* nativeInstance = new (bs_alloc<ScriptEditorWindow>()) ScriptEditorWindow(editorWidget);
  277. ScriptEditorWindow::registerScriptEditorWindow(nativeInstance);
  278. mono_runtime_object_init(editorWidget->getManagedInstance()); // Construct it
  279. editorWidget->setScriptOwner(nativeInstance);
  280. return editorWidget;
  281. }
  282. void ScriptEditorWindow::registerScriptEditorWindow(ScriptEditorWindow* editorWindow)
  283. {
  284. if(editorWindow == nullptr)
  285. return;
  286. auto findIter = OpenScriptEditorWindows.find(editorWindow->mName);
  287. if(findIter == OpenScriptEditorWindows.end())
  288. {
  289. EditorWindowHandle newHandle;
  290. newHandle.nativeObj = editorWindow;
  291. newHandle.gcHandle = mono_gchandle_new(editorWindow->mManagedInstance, false);
  292. OpenScriptEditorWindows[editorWindow->mName] = newHandle;
  293. }
  294. }
  295. void ScriptEditorWindow::unregisterScriptEditorWindow(const String& windowTypeName)
  296. {
  297. auto findIter = OpenScriptEditorWindows.find(windowTypeName);
  298. if(findIter != OpenScriptEditorWindows.end())
  299. {
  300. EditorWindowHandle& foundHandle = findIter->second;
  301. mono_gchandle_free(foundHandle.gcHandle);
  302. OpenScriptEditorWindows.erase(findIter);
  303. }
  304. }
  305. ScriptEditorWidget::ScriptEditorWidget(const String& ns, const String& type, UINT32 defaultWidth,
  306. UINT32 defaultHeight, EditorWidgetContainer& parentContainer)
  307. :EditorWidgetBase(HString(toWString(type)), ns + "." + type, defaultWidth, defaultHeight, parentContainer),
  308. mNamespace(ns), mTypename(type), mUpdateThunk(nullptr), mManagedInstance(nullptr), mOnInitializeThunk(nullptr),
  309. mOnDestroyThunk(nullptr), mContentsPanel(nullptr), mScriptOwner(nullptr), mGetDisplayName(nullptr), mIsInitialized(false)
  310. {
  311. if(createManagedInstance())
  312. {
  313. if (mGetDisplayName != nullptr)
  314. {
  315. MonoObject* displayNameMono = mGetDisplayName->invokeVirtual(mManagedInstance, nullptr);
  316. ScriptHString* scriptHString = ScriptHString::toNative(displayNameMono);
  317. if (scriptHString != nullptr)
  318. {
  319. mDisplayName = HString(scriptHString->getInternalValue());
  320. parentContainer.refreshWidgetNames();
  321. }
  322. }
  323. }
  324. }
  325. ScriptEditorWidget::~ScriptEditorWidget()
  326. {
  327. mScriptOwner->mIsDestroyed = true;
  328. mScriptOwner->mEditorWidget = nullptr;
  329. mContentsPanel->destroy();
  330. mContentsPanel = nullptr;
  331. triggerOnDestroy();
  332. ScriptEditorWindow::unregisterScriptEditorWindow(getName());
  333. }
  334. bool ScriptEditorWidget::createManagedInstance()
  335. {
  336. const char* assemblies[2] = { EDITOR_ASSEMBLY, SCRIPT_EDITOR_ASSEMBLY };
  337. UINT32 numAssemblies = sizeof(assemblies) / sizeof(assemblies[0]);
  338. for (UINT32 i = 0; i < numAssemblies; i++)
  339. {
  340. MonoAssembly* assembly = MonoManager::instance().getAssembly(assemblies[i]);
  341. if (assembly != nullptr)
  342. {
  343. MonoClass* editorWindowClass = assembly->getClass(mNamespace, mTypename);
  344. if (editorWindowClass != nullptr)
  345. {
  346. mManagedInstance = editorWindowClass->createInstance();
  347. MonoObject* guiPanel = ScriptGUIPanel::createFromExisting(mContent);
  348. mContentsPanel = ScriptGUILayout::toNative(guiPanel);
  349. ScriptEditorWindow::guiPanelField->setValue(mManagedInstance, guiPanel);
  350. reloadMonoTypes(editorWindowClass);
  351. return true;
  352. }
  353. }
  354. }
  355. return false;
  356. }
  357. void ScriptEditorWidget::triggerOnInitialize()
  358. {
  359. if (mOnInitializeThunk != nullptr && mManagedInstance != nullptr)
  360. {
  361. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  362. // for some extra speed.
  363. MonoUtil::invokeThunk(mOnInitializeThunk, mManagedInstance);
  364. }
  365. mIsInitialized = true;
  366. }
  367. void ScriptEditorWidget::triggerOnDestroy()
  368. {
  369. if (mOnDestroyThunk != nullptr && mManagedInstance != nullptr)
  370. {
  371. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  372. // for some extra speed.
  373. MonoUtil::invokeThunk(mOnDestroyThunk, mManagedInstance);
  374. }
  375. mIsInitialized = false;
  376. }
  377. void ScriptEditorWidget::update()
  378. {
  379. if (!mIsInitialized)
  380. triggerOnInitialize();
  381. if (mUpdateThunk != nullptr && mManagedInstance != nullptr)
  382. {
  383. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  384. // for some extra speed.
  385. MonoUtil::invokeThunk(mUpdateThunk, mManagedInstance);
  386. }
  387. }
  388. void ScriptEditorWidget::reloadMonoTypes(MonoClass* windowClass)
  389. {
  390. MonoMethod* updateMethod = windowClass->getMethod("OnEditorUpdate", 0);
  391. if (updateMethod != nullptr)
  392. mUpdateThunk = (UpdateThunkDef)updateMethod->getThunk();
  393. MonoMethod* onInitializeMethod = windowClass->getMethod("OnInitialize", 0);
  394. if (onInitializeMethod != nullptr)
  395. mOnInitializeThunk = (OnInitializeThunkDef)onInitializeMethod->getThunk();
  396. MonoMethod* onDestroyMethod = windowClass->getMethod("OnDestroy", 0);
  397. if (onDestroyMethod != nullptr)
  398. mOnDestroyThunk = (OnDestroyThunkDef)onDestroyMethod->getThunk();
  399. mGetDisplayName = windowClass->getMethod("GetDisplayName", 0);
  400. }
  401. }