Text Wrap for Gui Controls!

Now you can just turn on TextWrap to have multiple lines of text!

engine/source/gui/containers/guiChainCtrl.cc

@@ -92,7 +92,7 @@ void GuiChainCtrl::onChildRemoved(SimObject *child)
 
 void GuiChainCtrl::calculateExtent()
 {
-	RectI innerRect = getInnerRect(mBounds.point.Zero, getExtent(), NormalState, mProfile);
+	RectI innerRect = getInnerRect(Point2I(mBounds.point.Zero), Point2I(getExtent()), NormalState, mProfile);
 
 	S32 length = positionChildren(innerRect);
 

engine/source/gui/containers/guiGridCtrl.cc

@@ -123,7 +123,7 @@ void GuiGridCtrl::resize(const Point2I &newPosition, const Point2I &newExtent)
 	//call set update both before and after
 	setUpdate();
 
-	RectI innerRect = getInnerRect(mBounds.point.Zero, actualNewExtent, NormalState, mProfile);
+	RectI innerRect = getInnerRect(Point2I(mBounds.point.Zero), actualNewExtent, NormalState, mProfile);
 	if (!innerRect.isValidRect() && !mIsExtentDynamic)
 	{
 		return;

engine/source/gui/containers/guiScrollCtrl.cc

@@ -286,7 +286,7 @@ void GuiScrollCtrl::computeSizes()
 		calcScrollOffset();
 	}
 	// build all the rectangles and such...
-	RectI ctrlRect = applyMargins(mBounds.point.Zero, mBounds.extent, NormalState, mProfile);
+	RectI ctrlRect = applyMargins(Point2I(mBounds.point.Zero), mBounds.extent, NormalState, mProfile);
 	RectI fillRect = applyBorders(ctrlRect.point, ctrlRect.extent, NormalState, mProfile);
 	calcScrollRects(fillRect);
 	calcThumbs();

engine/source/gui/containers/guiWindowCtrl.cc

@@ -756,7 +756,7 @@ RectI GuiWindowCtrl::renderButtons(const Point2I &offset, const RectI &contentRe
 
 RectI GuiWindowCtrl::renderButton(const RectI &contentRect, S32 distanceFromEdge, GuiControlState buttonState, GuiControlProfile *profile, Icon defaultIcon)
 {
-	RectI buttonContent = applyMargins(contentRect.point, contentRect.extent, buttonState, profile);
+	RectI buttonContent = applyMargins(Point2I(contentRect.point), Point2I(contentRect.extent), buttonState, profile);
 	S32 horizMarginSize = contentRect.extent.x - buttonContent.extent.x;
 	RectI finalButtonRect = RectI(contentRect.point, Point2I(buttonContent.extent.y + horizMarginSize, contentRect.extent.y));
 	if (mProfile->mAlignment != GuiControlProfile::AlignmentType::RightAlign)

engine/source/gui/editor/guiMenuBarCtrl.cc

@@ -137,7 +137,7 @@ void GuiMenuBarCtrl::onChildRemoved(SimObject *child)
 
 void GuiMenuBarCtrl::calculateMenus()
 {
-	RectI innerRect = getInnerRect(mBounds.point.Zero, getExtent(), NormalState, mProfile);
+	RectI innerRect = getInnerRect(Point2I(mBounds.point.Zero), Point2I(getExtent()), NormalState, mProfile);
 	iterator i;
 	S32 length = 0;
 	for (i = begin(); i != end(); i++)

engine/source/gui/guiControl.cc

@@ -35,6 +35,11 @@
 #include "string/unicode.h"
 #include "collection/vector.h"
 
+#include <sstream>
+#include <iostream>
+#include <vector>
+#include <string>
+
 #include "guiControl_ScriptBinding.h"
 
 #ifndef _FRAMEALLOCATOR_H_
@@ -87,6 +92,7 @@ GuiControl::GuiControl()
    mTipHoverTime        = 1000;
    mTooltipWidth		= 250;
    mIsContainer         = false;
+   mTextWrap			= false;
 }
 
 GuiControl::~GuiControl()
@@ -194,6 +200,7 @@ void GuiControl::initPersistFields()
    addGroup("Text");
    addProtectedField("text", TypeCaseString, Offset(mText, GuiControl), setTextProperty, getTextProperty, "");
    addField("textID", TypeString, Offset(mTextID, GuiControl));
+   addField("textWrap", TypeBool, Offset(mTextWrap, GuiControl), &writeTextWrapFn, "If true, text will wrap to additional lines.");
    endGroup("Text");
 }
 
@@ -524,7 +531,7 @@ void GuiControl::onRender(Point2I offset, const RectI &updateRect)
 	}
 }
 
-RectI GuiControl::applyMargins(Point2I offset, Point2I extent, GuiControlState currentState, GuiControlProfile *profile)
+RectI GuiControl::applyMargins(Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
 {
 	//Get the border profiles
 	GuiBorderProfile *leftProfile = profile->getLeftBorder();
@@ -540,7 +547,7 @@ RectI GuiControl::applyMargins(Point2I offset, Point2I extent, GuiControlState c
 	return RectI(offset.x + leftSize, offset.y + topSize, (extent.x - leftSize) - rightSize, (extent.y - topSize) - bottomSize);
 }
 
-RectI GuiControl::applyBorders(Point2I offset, Point2I extent, GuiControlState currentState, GuiControlProfile *profile)
+RectI GuiControl::applyBorders(Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
 {
 	//Get the border profiles
 	GuiBorderProfile *leftProfile = profile->getLeftBorder();
@@ -556,7 +563,7 @@ RectI GuiControl::applyBorders(Point2I offset, Point2I extent, GuiControlState c
 	return RectI(offset.x + leftSize, offset.y + topSize, (extent.x - leftSize) - rightSize, (extent.y - topSize) - bottomSize);
 }
 
-RectI GuiControl::applyPadding(Point2I offset, Point2I extent, GuiControlState currentState, GuiControlProfile *profile)
+RectI GuiControl::applyPadding(Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
 {
 	//Get the border profiles
 	GuiBorderProfile *leftProfile = profile->getLeftBorder();
@@ -572,7 +579,7 @@ RectI GuiControl::applyPadding(Point2I offset, Point2I extent, GuiControlState c
 	return RectI(offset.x + leftSize, offset.y + topSize, (extent.x - leftSize) - rightSize, (extent.y - topSize) - bottomSize);
 }
 
-RectI GuiControl::getInnerRect(Point2I offset, Point2I extent, GuiControlState currentState, GuiControlProfile *profile)
+RectI GuiControl::getInnerRect(Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
 {
 	//Get the border profiles
 	GuiBorderProfile *leftProfile = profile->getLeftBorder();
@@ -588,7 +595,7 @@ RectI GuiControl::getInnerRect(Point2I offset, Point2I extent, GuiControlState c
 	return RectI(offset.x + leftSize, offset.y + topSize, (extent.x - leftSize) - rightSize, (extent.y - topSize) - bottomSize);
 }
 
-Point2I GuiControl::getOuterExtent(Point2I innerExtent, GuiControlState currentState, GuiControlProfile *profile)
+Point2I GuiControl::getOuterExtent(Point2I &innerExtent, GuiControlState currentState, GuiControlProfile *profile)
 {
 	//Get the border profiles
 	GuiBorderProfile *leftProfile = profile->getLeftBorder();
@@ -604,7 +611,7 @@ Point2I GuiControl::getOuterExtent(Point2I innerExtent, GuiControlState currentS
 	return Point2I(innerExtent.x + leftSize + rightSize, innerExtent.y + topSize + bottomSize);
 }
 
-bool GuiControl::renderTooltip(Point2I cursorPos, const char* tipText )
+bool GuiControl::renderTooltip(Point2I &cursorPos, const char* tipText )
 {
 #if !defined(TORQUE_OS_IOS) && !defined(TORQUE_OS_ANDROID) && !defined(TORQUE_OS_EMSCRIPTEN)
     // Short Circuit.
@@ -1665,79 +1672,153 @@ void GuiControl::getScrollLineSizes(U32 *rowHeight, U32 *columnWidth)
     *rowHeight = 30;
 }
 
-void GuiControl::renderText(Point2I offset, Point2I extent, const char *text, GuiControlProfile *profile, TextRotationOptions rot)
+void GuiControl::renderText(Point2I &offset, Point2I &extent, const char *text, GuiControlProfile *profile, TextRotationOptions rot)
 {
-   GFont *font = profile->mFont;
-   S32 textWidth = font->getStrWidth((const UTF8*)text);
-   S32 textHeight = font->getHeight();
-   S32 totalWidth = extent.x;
-   S32 totalHeight = extent.y;
+	RectI old = dglGetClipRect();
+	RectI clipRect = RectI(offset, extent);
+	if (clipRect.intersect(old))
+	{
+		dglSetClipRect(clipRect);
 
-   if (rot != tRotateNone)
-   {
-	   totalWidth = extent.y;
-	   totalHeight = extent.x;
-   }
+	   GFont *font = profile->mFont;
+	   S32 textWidth = 0;
+	   const S32 textHeight = font->getHeight();
+	   S32 totalWidth = extent.x;
+	   S32 totalHeight = extent.y;
 
-   Point2I startOffset = Point2I(0,0);
-   // align the horizontal
-   if(textWidth < totalWidth)
-   {
-	   if (profile->mAlignment == GuiControlProfile::RightAlign)
+	   if (rot != tRotateNone)
 	   {
-		   startOffset.x = totalWidth - textWidth;
+		   totalWidth = extent.y;
+		   totalHeight = extent.x;
 	   }
-	   else if (profile->mAlignment == GuiControlProfile::CenterAlign)
+
+	   Point2I startOffset = Point2I(0,0);
+
+	   vector<string> lineList = vector<string>();
+
+	   if (!mTextWrap)
 	   {
-		   startOffset.x = (totalWidth - textWidth) / 2;
+		   lineList.push_back(text);
+	   }
+	   else
+	   {
+			vector<string> paragraphList = vector<string>();
+			istringstream f(text);
+			string s;
+			while(getline(f, s)) {
+				paragraphList.push_back(s);
+			}
+
+			for (string &paragraph : paragraphList)
+			{
+				vector<string> wordList = vector<string>();
+				istringstream f2(paragraph);
+				string s2;
+				while (getline(f2, s2, ' ')) {
+					wordList.push_back(s2);
+				}
+
+				//now process the word list
+				string line;
+				line.clear();
+				for (string &word : wordList)
+				{
+					if (font->getStrWidth(word.c_str()) >= totalWidth)
+					{
+						if (line.size() > 0)
+						{
+							lineList.push_back(string(line));
+							line.clear();
+						}
+						lineList.push_back(word);
+						continue;
+					}
+
+					string prevLine = string(line);
+					line += (line.size() > 0) ? " " + word : word;
+					if (font->getStrWidth(line.c_str()) >= totalWidth)
+					{
+						lineList.push_back(prevLine);
+						line = word;
+					}
+				}
+				lineList.push_back(string(line));
+			}
 	   }
-   }
 
-	// align the vertical
-	if (textHeight < totalHeight)
-	{
-		if (profile->mVAlignment == GuiControlProfile::MiddleVAlign)
+	   //first align vertical
+	   S32 blockHeight = textHeight * lineList.size();
+		if (blockHeight < totalHeight)
 		{
-			startOffset.y = (totalHeight - textHeight) / 2;
+			startOffset.y = getTextVerticalOffset(blockHeight, totalHeight, profile->mVAlignment);
 		}
-		else if (profile->mVAlignment == GuiControlProfile::BottomVAlign)
+		else
 		{
-			startOffset.y = (totalHeight - textHeight);
+			startOffset.y = getTextVerticalOffset(blockHeight, totalHeight, GuiControlProfile::VertAlignmentType::MiddleVAlign);
 		}
+
+	   //Now print each line
+	   for(string &line : lineList)
+	   {
+		   // align the horizontal
+		   textWidth = font->getStrWidth(line.c_str());
+		   if(textWidth < totalWidth)
+		   {
+				startOffset.x = getTextHorizontalOffset(textWidth, totalWidth, profile->mAlignment);
+		   }
+
+			Point2I start = Point2I(0, 0);
+			F32 rotation;
+			if (rot == tRotateNone)
+			{
+				start += startOffset;
+				rotation = 0.0f;
+			}
+			else if (rot == tRotateLeft)
+			{
+				start.x = startOffset.y;
+				start.y = extent.y + startOffset.x;
+				rotation = 90.0f;
+			}
+			else if (rot == tRotateRight)
+			{
+				start.x = extent.x - startOffset.y;
+				start.y = startOffset.x;
+				rotation = -90.0f;
+			}
+
+			dglDrawText( font, start + offset + profile->mTextOffset, line.c_str(), profile->mFontColors, 9, rotation );
+			
+			startOffset.y += textHeight;
+		}
+		dglSetClipRect(old);
 	}
-	else
-	{
-		startOffset.y = -((textHeight - totalHeight) / 2);
-	}
+}
 
-	Point2I start = Point2I(0, 0);
-	F32 rotation;
-	if (rot == tRotateNone)
+S32 GuiControl::getTextHorizontalOffset(S32 textWidth, S32 totalWidth, GuiControlProfile::AlignmentType align)
+{
+	if (align == GuiControlProfile::RightAlign)
 	{
-		start += startOffset;
-		rotation = 0.0f;
+		return totalWidth - textWidth;
 	}
-	else if (rot == tRotateLeft)
+	else if (align == GuiControlProfile::CenterAlign)
 	{
-		start.x = startOffset.y;
-		start.y = extent.y + startOffset.x;
-		rotation = 90.0f;
+		return (totalWidth - textWidth) / 2;
 	}
-	else if (rot == tRotateRight)
+	return 0;//left aligned
+}
+
+S32 GuiControl::getTextVerticalOffset(S32 textHeight, S32 totalHeight, GuiControlProfile::VertAlignmentType align)
+{
+	if (align == GuiControlProfile::MiddleVAlign)
 	{
-		start.x = extent.x - startOffset.y;
-		start.y = startOffset.x;
-		rotation = -90.0f;
+		return (totalHeight - textHeight) / 2;
 	}
-
-	RectI old = dglGetClipRect();
-	RectI clipRect = RectI(offset, extent);
-	if(clipRect.intersect(old))
+	else if (align == GuiControlProfile::BottomVAlign)
 	{
-		dglSetClipRect(clipRect);
-		dglDrawText( font, start + offset + profile->mTextOffset, text, profile->mFontColors, 9, rotation );
-		dglSetClipRect(old);
+		return totalHeight - textHeight;
 	}
+	return 0;
 }
 
 void GuiControl::getCursor(GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)

engine/source/gui/guiControl.h

@@ -206,6 +206,7 @@ protected:
 
 	StringTableEntry    mText;
 	StringTableEntry    mTextID;
+	bool				mTextWrap;
 
     /// @}
 
@@ -309,10 +310,13 @@ public:
 	virtual void             setTextID(S32 id);
 	virtual void             setTextID(const char *id);
 	virtual const char*      getText();
+	inline void				 setTextWrap(const bool wrap) { mTextWrap = wrap; }
+	inline bool				 getTextWrap() { return mTextWrap; }
 
 	// Text Property Accessors
 	static bool setTextProperty(void* obj, const char* data) { static_cast<GuiControl*>(obj)->setText(data); return false; }
 	static const char* getTextProperty(void* obj, const char* data) { return static_cast<GuiControl*>(obj)->getText(); }
+	static bool writeTextWrapFn(void* obj, const char* data) { return static_cast<GuiControl*>(obj)->getTextWrap(); }
 
 	static bool setExtentFn(void* obj, const char* data) { GuiControl* ctrl = static_cast<GuiControl*>(obj); Vector2 v = Vector2(data); ctrl->setExtent(Point2I(v.x, v.y)); ctrl->resetStoredExtent(); return false; }
 	static bool setMinExtentFn(void* obj, const char* data) { GuiControl* ctrl = static_cast<GuiControl*>(obj); Vector2 v = Vector2(data); ctrl->mMinExtent.set(v.x, v.y); ctrl->resetStoredExtent(); return false; }
@@ -435,7 +439,7 @@ public:
     /// Render a tooltip at the specified cursor position for this control
     /// @param   cursorPos   position of cursor to display the tip near
     /// @param   tipText     optional alternate tip to be rendered
-    virtual bool renderTooltip(Point2I cursorPos, const char* tipText = NULL );
+    virtual bool renderTooltip(Point2I &cursorPos, const char* tipText = NULL );
 
     /// Called when this control should render its children
     /// @param   offset   The top left of the parent control
@@ -718,22 +722,22 @@ public:
     /// Renders justified text using the profile.
     ///
     /// @note This should move into the graphics library at some point
-    void renderText(Point2I offset, Point2I extent, const char *text, GuiControlProfile *profile, TextRotationOptions rot = tRotateNone);
+    void renderText(Point2I &offset, Point2I &extent, const char *text, GuiControlProfile *profile, TextRotationOptions rot = tRotateNone);
 
 	/// Returns a new rect based on the margins.
-	RectI applyMargins(Point2I offset, Point2I extent, GuiControlState currentState, GuiControlProfile *profile);
+	RectI applyMargins(Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile);
 
 	/// Returns the bounds of the rect after considering the borders.
-	RectI applyBorders(Point2I offset, Point2I extent, GuiControlState currentState, GuiControlProfile *profile);
+	RectI applyBorders(Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile);
 
 	/// Returns the bounds of the rect this time with padding.
-	RectI applyPadding(Point2I offset, Point2I extent, GuiControlState currentState, GuiControlProfile *profile);
+	RectI applyPadding(Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile);
 
 	/// Returns the bounds of the rect with margin, borders, and padding applied.
-	RectI getInnerRect(Point2I offset, Point2I extent, GuiControlState currentState, GuiControlProfile *profile);
+	RectI getInnerRect(Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile);
 
 	/// Returns the extent of the outer rect given the extent of the inner rect.
-	Point2I getOuterExtent(Point2I innerExtent, GuiControlState currentState, GuiControlProfile *profile);
+	Point2I getOuterExtent(Point2I &innerExtent, GuiControlState currentState, GuiControlProfile *profile);
 
     virtual void inspectPostApply();
     virtual void inspectPreApply();
@@ -748,6 +752,9 @@ protected:
 	virtual void interpolateTick(F32 delta) {};
 	virtual void processTick() {};
 	virtual void advanceTime(F32 timeDelta) {};
+
+	S32 getTextHorizontalOffset(S32 textWidth, S32 totalWidth, GuiControlProfile::AlignmentType align);
+	S32 getTextVerticalOffset(S32 textHeight, S32 totalHeight, GuiControlProfile::VertAlignmentType align);
 };
 /// @}