Updating GUI elements in common ways (hovering, changing content, inputting text) no longer triggers a layout update

BansheeEditor/Source/BsGUIColor.cpp

@@ -49,14 +49,14 @@ namespace BansheeEngine
 	{
 		mColor = color;
 
-		_markLayoutAsDirty();
+		_markContentAsDirty();
 	}
 
 	void GUIColor::setTint(const Color& color)
 	{
 		mTint = color;
 
-		_markLayoutAsDirty();
+		_markContentAsDirty();
 	}
 
 	UINT32 GUIColor::_getNumRenderElements() const

BansheeEditor/Source/BsGUIComponentFoldout.cpp

@@ -57,8 +57,6 @@ namespace BansheeEngine
 			else
 				mToggle->toggleOff();
 
-			_markLayoutAsDirty();
-
 			if(!onStateChanged.empty())
 				onStateChanged(mIsExpanded);
 		}
@@ -78,8 +76,6 @@ namespace BansheeEngine
 	{
 		mIsExpanded = value;
 
-		_markLayoutAsDirty();
-
 		onStateChanged(value);
 	}
 

BansheeEditor/Source/BsGUIFoldout.cpp

@@ -59,8 +59,6 @@ namespace BansheeEngine
 			else
 				mToggle->toggleOff();
 
-			_markLayoutAsDirty();
-
 			if (!onStateChanged.empty())
 				onStateChanged(mIsExpanded);
 		}
@@ -81,8 +79,6 @@ namespace BansheeEngine
 	{
 		mIsExpanded = value;
 
-		_markLayoutAsDirty();
-
 		onStateChanged(value);
 	}
 

BansheeEditor/Source/BsGUIWindowFrame.cpp

@@ -39,11 +39,18 @@ namespace BansheeEngine
 
 	void GUIWindowFrame::setFocused(bool focused)
 	{
+		Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
 		if(focused)
 			mActiveTexture = _getStyle()->focused.texture;
 		else
 			mActiveTexture = _getStyle()->normal.texture;
 
-		_markLayoutAsDirty();
+		Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
+		if (origSize != newSize)
+			_markLayoutAsDirty();
+		else
+			_markContentAsDirty();
 	}
 }

BansheeEngine/Include/BsGUIButtonBase.h

@@ -38,7 +38,7 @@ namespace BansheeEngine
 		/**
 		 * @copydoc	GUIElement::setTint
 		 */
-		virtual void setTint(const Color& color);
+		virtual void setTint(const Color& color) override;
 
 		/**
 		 * @brief	Change the button "on" state. This state determines

BansheeEngine/Include/BsGUIElementBase.h

@@ -294,15 +294,23 @@ namespace BansheeEngine
 		virtual bool _isDestroyed() const { return false; }
 
 		/**
-		 * @brief	Marks the elements contents as dirty, which causes the sprite meshes to be recreated from scratch.
+		 * @brief	Marks the element's dimensions as dirty, triggering a layout rebuild.
 		 *
 		 * @note	Internal method.
 		 */
 		void _markLayoutAsDirty();
 
+		/**
+		 * @brief	Marks the element's contents as dirty, which causes the sprite meshes to be recreated from scratch.
+		 *
+		 * @note	Internal method.
+		 */
+		void _markContentAsDirty();
+
 		/**
 		 * @brief	Mark only the elements that operate directly on the sprite mesh without requiring the mesh
-		 * 			to be recreated as dirty. This includes position, depth and clip rectangle.
+		 * 			to be recreated as dirty. This includes position, depth and clip rectangle. This will cause
+		 *			the parent widget mesh to be rebuilt from its child element's meshes.
 		 *
 		 * @note	Internal method.
 		 */

BansheeEngine/Source/BsGUIButtonBase.cpp

@@ -40,6 +40,7 @@ namespace BansheeEngine
 		mLocStringUpdatedConn.disconnect();
 		mLocStringUpdatedConn = content.getText().addOnStringModifiedCallback(std::bind(&GUIButtonBase::_markLayoutAsDirty, this));
 
+		Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 		mContent = content;
 
 		HSpriteTexture contentTex = content.getImage();
@@ -57,14 +58,19 @@ namespace BansheeEngine
 			}
 		}
 
-		_markLayoutAsDirty();
+		Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
+		if (origSize != newSize)
+			_markLayoutAsDirty();
+		else
+			_markContentAsDirty();
 	}
 
 	void GUIButtonBase::setTint(const Color& color)
 	{
 		mColor = color;
 
-		_markLayoutAsDirty();
+		_markContentAsDirty();
 	}
 
 	void GUIButtonBase::_setOn(bool on) 
@@ -368,9 +374,14 @@ namespace BansheeEngine
 
 	void GUIButtonBase::setState(GUIButtonState state)
 	{
+		Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 		mActiveState = state;
+		Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 
-		_markLayoutAsDirty();
+		if (origSize != newSize)
+			_markLayoutAsDirty();
+		else
+			_markContentAsDirty();
 	}
 
 	const HSpriteTexture& GUIButtonBase::getActiveTexture() const

BansheeEngine/Source/BsGUIElementBase.cpp

@@ -195,6 +195,15 @@ namespace BansheeEngine
 			mIsDirty = true;
 	}
 
+	void GUIElementBase::_markContentAsDirty()
+	{
+		if (_isDisabled())
+			return;
+
+		if (mParentWidget != nullptr)
+			mParentWidget->_markContentDirty(this);
+	}
+
 	void GUIElementBase::_markMeshAsDirty()
 	{
 		if(_isDisabled())

BansheeEngine/Source/BsGUIInputBox.cpp

@@ -75,6 +75,8 @@ namespace BansheeEngine
 
 		if(filterOkay)
 		{
+			Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
 			WString oldText = mText;
 			mText = text;
 
@@ -91,7 +93,11 @@ namespace BansheeEngine
 
 			scrollTextToCaret();
 
-			_markLayoutAsDirty();
+			Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+			if (origSize != newSize)
+				_markLayoutAsDirty();
+			else
+				_markContentAsDirty();
 		}
 	}
 
@@ -99,7 +105,7 @@ namespace BansheeEngine
 	{
 		mColor = color;
 
-		_markLayoutAsDirty();
+		_markContentAsDirty();
 	}
 
 	UINT32 GUIInputBox::_getNumRenderElements() const
@@ -401,8 +407,14 @@ namespace BansheeEngine
 		{
 			if(!mHasFocus)
 			{
+				Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 				mState = State::Hover;
-				_markLayoutAsDirty();
+				Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
+				if (origSize != newSize)
+					_markLayoutAsDirty();
+				else
+					_markContentAsDirty();
 			}
 
 			mIsMouseOver = true;
@@ -413,8 +425,14 @@ namespace BansheeEngine
 		{
 			if(!mHasFocus)
 			{
+				Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 				mState = State::Normal;
-				_markLayoutAsDirty();
+				Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
+				if (origSize != newSize)
+					_markLayoutAsDirty();
+				else
+					_markContentAsDirty();
 			}
 
 			mIsMouseOver = false;
@@ -426,7 +444,7 @@ namespace BansheeEngine
 			showSelection(0);
 			gGUIManager().getInputSelectionTool()->selectAll();
 
-			_markLayoutAsDirty();
+			_markContentAsDirty();
 			return true;
 		}
 		else if(ev.getType() == GUIMouseEventType::MouseDown && ev.getButton() == GUIMouseButton::Left)
@@ -453,10 +471,9 @@ namespace BansheeEngine
 					gGUIManager().getInputSelectionTool()->moveSelectionToCaret(gGUIManager().getInputCaretTool()->getCaretPos());
 
 				scrollTextToCaret();
+				_markContentAsDirty();
 			}
 
-			_markLayoutAsDirty();
-
 			return true;
 		}
 		else if(ev.getType() == GUIMouseEventType::MouseDragStart)
@@ -468,6 +485,7 @@ namespace BansheeEngine
 				UINT32 caretPos = gGUIManager().getInputCaretTool()->getCaretPos();
 				showSelection(caretPos);
 				gGUIManager().getInputSelectionTool()->selectionDragStart(caretPos);
+				_markContentAsDirty();
 
 				return true;
 			}
@@ -479,7 +497,7 @@ namespace BansheeEngine
 				mDragInProgress = false;
 
 				gGUIManager().getInputSelectionTool()->selectionDragEnd();
-
+				_markContentAsDirty();
 				return true;
 			}
 		}
@@ -495,8 +513,7 @@ namespace BansheeEngine
 				gGUIManager().getInputSelectionTool()->selectionDragUpdate(gGUIManager().getInputCaretTool()->getCaretPos());
 
 				scrollTextToCaret();
-
-				_markLayoutAsDirty();
+				_markContentAsDirty();
 				return true;
 			}
 		}
@@ -506,6 +523,8 @@ namespace BansheeEngine
 
 	bool GUIInputBox::_textInputEvent(const GUITextInputEvent& ev)
 	{
+		Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
 		if(mSelectionShown)
 			deleteSelectedText();
 
@@ -527,12 +546,16 @@ namespace BansheeEngine
 			gGUIManager().getInputCaretTool()->moveCaretToChar(charIdx, CARET_AFTER);
 			scrollTextToCaret();
 
-			_markLayoutAsDirty();
-
 			if(!onValueChanged.empty())
 				onValueChanged(mText);
 		}
 
+		Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+		if (origSize != newSize)
+			_markLayoutAsDirty();
+		else
+			_markContentAsDirty();
+
 		return true;
 	}
 
@@ -542,20 +565,26 @@ namespace BansheeEngine
 
 		if(ev.getType() == GUICommandEventType::Redraw)
 		{
-			_markLayoutAsDirty();
+			_markContentAsDirty();
 			return true;
 		}
 
 		if(ev.getType() == GUICommandEventType::FocusGained)
 		{
+			Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 			mState = State::Focused;
 
 			showSelection(0);
 			gGUIManager().getInputSelectionTool()->selectAll();
-			_markLayoutAsDirty();
 
 			mHasFocus = true;
 
+			Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+			if (origSize != newSize)
+				_markLayoutAsDirty();
+			else
+				_markContentAsDirty();
+
 			if(!onFocusGained.empty())
 				onFocusGained();
 
@@ -564,14 +593,20 @@ namespace BansheeEngine
 		
 		if(ev.getType() == GUICommandEventType::FocusLost)
 		{
+			Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 			mState = State::Normal;
 
 			hideCaret();
 			clearSelection();
-			_markLayoutAsDirty();
 
 			mHasFocus = false;
 
+			Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+			if (origSize != newSize)
+				_markLayoutAsDirty();
+			else
+				_markContentAsDirty();
+
 			if(!onFocusLost.empty())
 				onFocusLost();
 
@@ -582,6 +617,7 @@ namespace BansheeEngine
 		{
 			if(mText.size() > 0)
 			{
+				Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 				if(mSelectionShown)
 				{
 					deleteSelectedText();
@@ -618,7 +654,11 @@ namespace BansheeEngine
 					}
 				}
 
-				_markLayoutAsDirty();
+				Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+				if (origSize != newSize)
+					_markLayoutAsDirty();
+				else
+					_markContentAsDirty();
 			}
 
 			return true;
@@ -628,6 +668,7 @@ namespace BansheeEngine
 		{
 			if(mText.size() > 0)
 			{
+				Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 				if(mSelectionShown)
 				{
 					deleteSelectedText();
@@ -663,7 +704,11 @@ namespace BansheeEngine
 					}
 				}
 
-				_markLayoutAsDirty();
+				Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+				if (origSize != newSize)
+					_markLayoutAsDirty();
+				else
+					_markContentAsDirty();
 			}
 
 			return true;
@@ -688,7 +733,7 @@ namespace BansheeEngine
 				gGUIManager().getInputCaretTool()->moveCaretLeft();
 
 			scrollTextToCaret();
-			_markLayoutAsDirty();
+			_markContentAsDirty();
 			return true;
 		}
 
@@ -701,7 +746,7 @@ namespace BansheeEngine
 			gGUIManager().getInputSelectionTool()->moveSelectionToCaret(gGUIManager().getInputCaretTool()->getCaretPos());
 
 			scrollTextToCaret();
-			_markLayoutAsDirty();
+			_markContentAsDirty();
 			return true;
 		}
 
@@ -724,7 +769,7 @@ namespace BansheeEngine
 				gGUIManager().getInputCaretTool()->moveCaretRight();
 
 			scrollTextToCaret();
-			_markLayoutAsDirty();
+			_markContentAsDirty();
 			return true;
 		}
 
@@ -737,7 +782,7 @@ namespace BansheeEngine
 			gGUIManager().getInputSelectionTool()->moveSelectionToCaret(gGUIManager().getInputCaretTool()->getCaretPos());
 
 			scrollTextToCaret();
-			_markLayoutAsDirty();
+			_markContentAsDirty();
 			return true;
 		}
 
@@ -752,7 +797,7 @@ namespace BansheeEngine
 			gGUIManager().getInputCaretTool()->moveCaretUp();
 
 			scrollTextToCaret();
-			_markLayoutAsDirty();
+			_markContentAsDirty();
 			return true;
 		}
 
@@ -765,7 +810,7 @@ namespace BansheeEngine
 			gGUIManager().getInputSelectionTool()->moveSelectionToCaret(gGUIManager().getInputCaretTool()->getCaretPos());
 
 			scrollTextToCaret();
-			_markLayoutAsDirty();
+			_markContentAsDirty();
 			return true;
 		}
 
@@ -780,7 +825,7 @@ namespace BansheeEngine
 			gGUIManager().getInputCaretTool()->moveCaretDown();
 
 			scrollTextToCaret();
-			_markLayoutAsDirty();
+			_markContentAsDirty();
 			return true;
 		}
 
@@ -793,7 +838,7 @@ namespace BansheeEngine
 			gGUIManager().getInputSelectionTool()->moveSelectionToCaret(gGUIManager().getInputCaretTool()->getCaretPos());
 
 			scrollTextToCaret();
-			_markLayoutAsDirty();
+			_markContentAsDirty();
 			return true;
 		}
 
@@ -801,6 +846,8 @@ namespace BansheeEngine
 		{
 			if(mIsMultiline)
 			{
+				Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
 				if(mSelectionShown)
 					deleteSelectedText();
 
@@ -822,12 +869,16 @@ namespace BansheeEngine
 					gGUIManager().getInputCaretTool()->moveCaretRight();
 					scrollTextToCaret();
 
-					_markLayoutAsDirty();
-
 					if(!onValueChanged.empty())
 						onValueChanged(mText);
 				}
 
+				Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+				if (origSize != newSize)
+					_markLayoutAsDirty();
+				else
+					_markContentAsDirty();
+
 				return true;
 			}
 
@@ -842,7 +893,6 @@ namespace BansheeEngine
 		{
 			cutText();
 
-			_markLayoutAsDirty();
 			return true;
 		}
 		else if(ev.getButton() == mCopyVB)
@@ -854,16 +904,14 @@ namespace BansheeEngine
 		else if(ev.getButton() == mPasteVB)
 		{
 			pasteText();
-
-			_markLayoutAsDirty();
 			return true;
 		}
 		else if(ev.getButton() == mSelectAllVB)
 		{
 			showSelection(0);
 			gGUIManager().getInputSelectionTool()->selectAll();
+			_markContentAsDirty();
 
-			_markLayoutAsDirty();
 			return true;
 		}
 
@@ -877,14 +925,11 @@ namespace BansheeEngine
 		TEXT_SPRITE_DESC textDesc = getTextDesc();
 		Vector2I offset = getTextOffset();
 		gGUIManager().getInputCaretTool()->updateText(this, textDesc);
-		_markLayoutAsDirty();
 	}
 
-
 	void GUIInputBox::hideCaret()
 	{
 		mCaretShown = false;
-		_markLayoutAsDirty();
 	}
 
 	void GUIInputBox::showSelection(UINT32 anchorCaretPos)
@@ -895,14 +940,12 @@ namespace BansheeEngine
 
 		gGUIManager().getInputSelectionTool()->showSelection(anchorCaretPos);
 		mSelectionShown = true;
-		_markLayoutAsDirty();
 	}
 
 	void GUIInputBox::clearSelection()
 	{
 		gGUIManager().getInputSelectionTool()->clearSelection();
 		mSelectionShown = false;
-		_markLayoutAsDirty();
 	}
 
 	void GUIInputBox::scrollTextToCaret()
@@ -946,12 +989,11 @@ namespace BansheeEngine
 
 		gGUIManager().getInputCaretTool()->updateText(this, textDesc);
 		gGUIManager().getInputSelectionTool()->updateText(this, textDesc);
-
-		_markLayoutAsDirty();
 	}
 
 	void GUIInputBox::clampScrollToBounds(Rect2I unclippedTextBounds)
 	{
+		Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 		TEXT_SPRITE_DESC textDesc = getTextDesc();
 
 		Vector2I newTextOffset;
@@ -966,8 +1008,6 @@ namespace BansheeEngine
 
 			gGUIManager().getInputCaretTool()->updateText(this, textDesc);
 			gGUIManager().getInputSelectionTool()->updateText(this, textDesc);
-
-			_markLayoutAsDirty();
 		}
 	}
 
@@ -1141,8 +1181,16 @@ namespace BansheeEngine
 
 	void GUIInputBox::cutText()
 	{
+		Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
 		copyText();
 		deleteSelectedText();
+
+		Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+		if (origSize != newSize)
+			_markLayoutAsDirty();
+		else
+			_markContentAsDirty();
 	}
 
 	void GUIInputBox::copyText()
@@ -1167,6 +1215,7 @@ namespace BansheeEngine
 
 		if(filterOkay)
 		{
+			Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 			insertString(charIdx, textInClipboard);
 
 			if(textInClipboard.size() > 0)
@@ -1174,7 +1223,11 @@ namespace BansheeEngine
 
 			scrollTextToCaret();
 
-			_markLayoutAsDirty();
+			Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+			if (origSize != newSize)
+				_markLayoutAsDirty();
+			else
+				_markContentAsDirty();
 
 			if(!onValueChanged.empty())
 				onValueChanged(mText);

BansheeEngine/Source/BsGUILabel.cpp

@@ -80,16 +80,21 @@ namespace BansheeEngine
 		mLocStringUpdatedConn.disconnect();
 		mLocStringUpdatedConn = content.getText().addOnStringModifiedCallback(std::bind(&GUILabel::_markLayoutAsDirty, this));
 
+		Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
 		mContent = content;
-		
-		_markLayoutAsDirty();
+		Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
+		if (origSize != newSize)
+			_markLayoutAsDirty();
+		else
+			_markContentAsDirty();
 	}
 
 	void GUILabel::setTint(const Color& color)
 	{
 		mColor = color;
 
-		_markLayoutAsDirty();
+		_markContentAsDirty();
 	}
 
 	GUILabel* GUILabel::create(const HString& text, const String& styleName)

BansheeEngine/Source/BsGUITexture.cpp

@@ -107,15 +107,21 @@ namespace BansheeEngine
 	{
 		mColor = color;
 
-		_markLayoutAsDirty();
+		_markContentAsDirty();
 	}
 
 	void GUITexture::setTexture(const HSpriteTexture& texture)
 	{
+		Vector2I origSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+
 		mActiveTexture = texture;
 		mUsingStyleTexture = false;
 
-		_markLayoutAsDirty();
+		Vector2I newSize = mDimensions.calculateSizeRange(_getOptimalSize()).optimal;
+		if (origSize != newSize)
+			_markLayoutAsDirty();
+		else
+			_markContentAsDirty();
 	}
 
 	UINT32 GUITexture::_getNumRenderElements() const

TODO.txt

@@ -71,6 +71,8 @@ Avoid fully recalculating layout for common operations like changing button stat
   - when button state changes, when input box contents change (by user or code), when text field data changes
  - ADDITIONALLY consider marking the mesh not dirty after layout update if size didn't change
 
+GET RID OF CONTENT STRING CALLBACKS - They're messsing with my optimization as I cannot calculate orig bounds before and after their update
+
 GUILabel
  - don't mark as dirty when contents change unless it affects optimal size
 GUIInputBox