EXT-7104 : WIP : improved processing of buttons to show/hide extend/shrink them. Functionality was not changed.

 * added vector of buttons that can be shown/hidden extended/shrunk on resizing.
 * updated these operation to use iteration over this array.
 * cleaned up container initialization.

This allow to extend this vector to add new buttons in bottom tray.

Reviewed by Vadim Savchuk at https://codereview.productengine.com/secondlife/r/381/

--HG--
branch : product-engine

2 files changed, 120 insertions, 62 deletions

diff --git a/indra/newview/llbottomtray.cpp b/indra/newview/llbottomtray.cpp
index d95b1cfa79..226d5593c9 100644
--- a/indra/newview/llbottomtray.cpp
+++ b/indra/newview/llbottomtray.cpp
@@ -473,16 +473,11 @@ BOOL LLBottomTray::postBuild()
 	// Registering Chat Bar to receive Voice client status change notifications.
 	LLVoiceClient::getInstance()->addObserver(this);
 
-	mObjectDefaultWidthMap[RS_BUTTON_GESTURES] = mGesturePanel->getRect().getWidth();
-	mObjectDefaultWidthMap[RS_BUTTON_MOVEMENT] = mMovementPanel->getRect().getWidth();
-	mObjectDefaultWidthMap[RS_BUTTON_CAMERA]   = mCamPanel->getRect().getWidth();
-	mObjectDefaultWidthMap[RS_BUTTON_SPEAK]	   = mSpeakPanel->getRect().getWidth();
-
 	mNearbyChatBar->getChatBox()->setContextMenu(NULL);
 
 	mChicletPanel = getChild<LLChicletPanel>("chiclet_list");
 
-	initStateProcessedObjectMap();
+	initResizeStateContainers();
 
 	// update wells visibility:
 	showWellButton(RS_IM_WELL, !LLIMWellWindow::getInstance()->isWindowEmpty());
@@ -713,25 +708,7 @@ S32 LLBottomTray::processWidthDecreased(S32 delta_width)
 	{
 		processShrinkButtons(delta_width, buttons_freed_width);
 
-		if (delta_width < 0)
-		{
-			processHideButton(RS_BUTTON_SNAPSHOT, delta_width, buttons_freed_width);
-		}
-
-		if (delta_width < 0)
-		{
-			processHideButton(RS_BUTTON_CAMERA, delta_width, buttons_freed_width);
-		}
-
-		if (delta_width < 0)
-		{
-			processHideButton(RS_BUTTON_MOVEMENT, delta_width, buttons_freed_width);
-		}
-
-		if (delta_width < 0)
-		{
-			processHideButton(RS_BUTTON_GESTURES, delta_width, buttons_freed_width);
-		}
+		processHideButtons(delta_width, buttons_freed_width);
 
 		if (delta_width < 0)
 		{
@@ -776,25 +753,8 @@ void LLBottomTray::processWidthIncreased(S32 delta_width)
 		<< llendl;
 
 	S32 available_width = total_available_width;
-	if (available_width > 0)
-	{
-		processShowButton(RS_BUTTON_GESTURES, available_width);
-	}
-
-	if (available_width > 0)
-	{
-		processShowButton(RS_BUTTON_MOVEMENT, available_width);
-	}
-
-	if (available_width > 0)
-	{
-		processShowButton(RS_BUTTON_CAMERA, available_width);
-	}
 
-	if (available_width > 0)
-	{
-		processShowButton(RS_BUTTON_SNAPSHOT, available_width);
-	}
+	processShowButtons(available_width);
 
 	processExtendButtons(available_width);
 
@@ -853,6 +813,22 @@ void LLBottomTray::processWidthIncreased(S32 delta_width)
 	}
 }
 
+void LLBottomTray::processShowButtons(S32& available_width)
+{
+	// process buttons from left to right
+	resize_state_vec_t::const_iterator it = mButtonsProcessOrder.begin();
+	const resize_state_vec_t::const_iterator it_end = mButtonsProcessOrder.end();
+
+	for (; it != it_end; ++it)
+	{
+		// is there available space?
+		if (available_width <= 0) break;
+
+		// try to show next button
+		processShowButton(*it, available_width);
+	}
+}
+
 bool LLBottomTray::processShowButton(EResizeState shown_object_type, S32& available_width)
 {
 	lldebugs << "Trying to show object type: " << shown_object_type << llendl;
@@ -885,6 +861,22 @@ bool LLBottomTray::processShowButton(EResizeState shown_object_type, S32& availa
 	return can_be_shown;
 }
 
+void LLBottomTray::processHideButtons(S32& required_width, S32& buttons_freed_width)
+{
+	// process buttons from right to left
+	resize_state_vec_t::const_reverse_iterator it = mButtonsProcessOrder.rbegin();
+	const resize_state_vec_t::const_reverse_iterator it_end = mButtonsProcessOrder.rend();
+
+	for (; it != it_end; ++it)
+	{
+		// is it still necessary to hide a button?
+		if (required_width >= 0) break;
+
+		// try to hide next button
+		processHideButton(*it, required_width, buttons_freed_width);
+	}
+}
+
 void LLBottomTray::processHideButton(EResizeState processed_object_type, S32& required_width, S32& buttons_freed_width)
 {
 	lldebugs << "Trying to hide object type: " << processed_object_type << llendl;
@@ -918,16 +910,21 @@ void LLBottomTray::processHideButton(EResizeState processed_object_type, S32& re
 
 void LLBottomTray::processShrinkButtons(S32& required_width, S32& buttons_freed_width)
 {
-	processShrinkButton(RS_BUTTON_CAMERA, required_width);
+	// process buttons from right to left
+	resize_state_vec_t::const_reverse_iterator it = mButtonsProcessOrder.rbegin();
+	const resize_state_vec_t::const_reverse_iterator it_end = mButtonsProcessOrder.rend();
 
-	if (required_width < 0)
+	// iterate through buttons in the mButtonsProcessOrder first
+	for (; it != it_end; ++it)
 	{
-		processShrinkButton(RS_BUTTON_MOVEMENT, required_width);
-	}
-	if (required_width < 0)
-	{
-		processShrinkButton(RS_BUTTON_GESTURES, required_width);
+		// is it still necessary to hide a button?
+		if (required_width >= 0) break;
+
+		// try to shrink next button
+		processShrinkButton(*it, required_width);
 	}
+
+	// then shrink Speak button
 	if (required_width < 0)
 	{
 
@@ -955,7 +952,7 @@ void LLBottomTray::processShrinkButtons(S32& required_width, S32& buttons_freed_
 					buttons_freed_width += required_width;
 				}
 
-				lldebugs << "Shrunk panel: " << panel_name
+				lldebugs << "Shrunk Speak button panel: " << panel_name
 					<< ", shrunk width: " << possible_shrink_width
 					<< ", rest width to process: " << required_width
 					<< llendl;
@@ -1014,19 +1011,24 @@ void LLBottomTray::processShrinkButton(EResizeState processed_object_type, S32&
 
 void LLBottomTray::processExtendButtons(S32& available_width)
 {
-	// do not allow extending any buttons if we have some buttons hidden
+	// do not allow extending any buttons if we have some buttons hidden via resize
 	if (mResizeState & RS_BUTTONS_CAN_BE_HIDDEN) return;
 
-	processExtendButton(RS_BUTTON_GESTURES, available_width);
+	// process buttons from left to right
+	resize_state_vec_t::const_iterator it = mButtonsProcessOrder.begin();
+	const resize_state_vec_t::const_iterator it_end = mButtonsProcessOrder.end();
 
-	if (available_width > 0)
-	{
-		processExtendButton(RS_BUTTON_MOVEMENT, available_width);
-	}
-	if (available_width > 0)
+	// iterate through buttons in the mButtonsProcessOrder first
+	for (; it != it_end; ++it)
 	{
-		processExtendButton(RS_BUTTON_CAMERA, available_width);
+		// is there available space?
+		if (available_width <= 0) break;
+
+		// try to extend next button
+		processExtendButton(*it, available_width);
 	}
+
+	// then try to extend Speak button
 	if (available_width > 0)
 	{
 		S32 panel_max_width = mObjectDefaultWidthMap[RS_BUTTON_SPEAK];
@@ -1040,7 +1042,7 @@ void LLBottomTray::processExtendButtons(S32& available_width)
 
 			available_width -= possible_extend_width;
 
-			lldebugs << "Extending panel: " << mSpeakPanel->getName()
+			lldebugs << "Extending Speak button panel: " << mSpeakPanel->getName()
 				<< ", extended width: " << possible_extend_width
 				<< ", rest width to process: " << available_width
 				<< llendl;
@@ -1116,12 +1118,25 @@ bool LLBottomTray::canButtonBeShown(EResizeState processed_object_type) const
 	return can_be_shown;
 }
 
-void LLBottomTray::initStateProcessedObjectMap()
+void LLBottomTray::initResizeStateContainers()
 {
+	// init map with objects should be processed for each type
 	mStateProcessedObjectMap.insert(std::make_pair(RS_BUTTON_GESTURES, mGesturePanel));
 	mStateProcessedObjectMap.insert(std::make_pair(RS_BUTTON_MOVEMENT, mMovementPanel));
 	mStateProcessedObjectMap.insert(std::make_pair(RS_BUTTON_CAMERA, mCamPanel));
 	mStateProcessedObjectMap.insert(std::make_pair(RS_BUTTON_SNAPSHOT, mSnapshotPanel));
+
+	// init default widths
+	mObjectDefaultWidthMap[RS_BUTTON_GESTURES] = mGesturePanel->getRect().getWidth();
+	mObjectDefaultWidthMap[RS_BUTTON_MOVEMENT] = mMovementPanel->getRect().getWidth();
+	mObjectDefaultWidthMap[RS_BUTTON_CAMERA]   = mCamPanel->getRect().getWidth();
+	mObjectDefaultWidthMap[RS_BUTTON_SPEAK]	   = mSpeakPanel->getRect().getWidth();
+
+	// init an order of processed buttons
+	mButtonsProcessOrder.push_back(RS_BUTTON_GESTURES);
+	mButtonsProcessOrder.push_back(RS_BUTTON_MOVEMENT);
+	mButtonsProcessOrder.push_back(RS_BUTTON_CAMERA);
+	mButtonsProcessOrder.push_back(RS_BUTTON_SNAPSHOT);
 }
 
 void LLBottomTray::setTrayButtonVisible(EResizeState shown_object_type, bool visible)
diff --git a/indra/newview/llbottomtray.h b/indra/newview/llbottomtray.h
index ed8ad9db10..e9d59e82ba 100644
--- a/indra/newview/llbottomtray.h
+++ b/indra/newview/llbottomtray.h
@@ -163,6 +163,16 @@ private:
 	void log(LLView* panel, const std::string& descr);
 
 	/**
+	 * Tries to show hidden by resize buttons using available width.
+	 *
+	 * Gets buttons visible if there is enough space. Reduces available_width in this case.
+	 *
+	 * @params[in, out] available_width - reference to available width to be used to show buttons.
+	 * @see processShowButton()
+	 */
+	void processShowButtons(S32& available_width);
+
+	/**
 	 * Tries to show panel with specified button using available width.
 	 *
 	 * Shows button specified by type if there is enough space. Reduces available_width in this case.
@@ -175,6 +185,20 @@ private:
 	bool processShowButton(EResizeState shown_object_type, S32& available_width);
 
 	/**
+	 * Hides visible panels with all buttons that may be hidden by resize if it is necessary.
+	 *
+	 * When button gets hidden some space is released in bottom tray.
+	 * This space is taken into account for several consecutive calls for several buttons.
+	 *
+	 * @params[in, out] required_width - reference to required width to be released. This is a negative value.
+	 *			Its absolute value is decreased by shown panel width.
+	 * @params[in, out] buttons_freed_width - reference to value released over required one.
+	 *			If panel's width is more than required difference is added to buttons_freed_width.
+	 * @see processHideButton()
+	 */
+	void processHideButtons(S32& required_width, S32& buttons_freed_width);
+
+	/**
 	 * Hides panel with specified button if it is visible.
 	 *
 	 * When button gets hidden some space is released in bottom tray.
@@ -191,6 +215,8 @@ private:
 	/**
 	 * Shrinks shown buttons to reduce total taken space.
 	 *
+	 * Shrinks buttons that may be shrunk smoothly first. Then shrinks Speak button.
+	 *
 	 * @param[in, out] required_width - reference to width value which should be released when buttons are shrunk. It is a negative value.
 	 * It is increased on the value processed by buttons.
 	 * @params[in, out] buttons_freed_width - reference to value released over required one.
@@ -212,6 +238,8 @@ private:
 	/**
 	 * Extends shown buttons to increase total taken space.
 	 *
+	 * Extends buttons that may be extended smoothly first. Then extends Speak button.
+	 *
 	 * @param[in, out] available_width - reference to width value which buttons can use to be extended.
 	 *		It is a positive value. It is decreased on the value processed by buttons.
 	 */
@@ -233,7 +261,15 @@ private:
 	 *   - Gestures, Move, View, Snapshot
 	 */
 	bool canButtonBeShown(EResizeState processed_object_type) const;
-	void initStateProcessedObjectMap();
+
+	/**
+	 * Initializes all containers stored data related to children resize state.
+	 *
+	 * @see mStateProcessedObjectMap
+	 * @see mObjectDefaultWidthMap
+	 * @see mButtonsProcessOrder
+	 */
+	void initResizeStateContainers();
 
 	/**
 	 * Sets passed visibility to object specified by resize type.
@@ -279,6 +315,13 @@ private:
 	typedef std::map<EResizeState, S32> state_object_width_map_t;
 	state_object_width_map_t mObjectDefaultWidthMap;
 
+	typedef std::vector<EResizeState> resize_state_vec_t;
+
+	/**
+	 * Contains order in which child buttons should be processed in show/hide, extend/shrink methods.
+	 */
+	resize_state_vec_t mButtonsProcessOrder;
+
 protected:
 
 	LLBottomTray(const LLSD& key = LLSD());