Magic Cube

///////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright 2020 Leszek Koltunski                                                               //

//                                                                                               //

// This file is part of Magic Cube.                                                              //

//                                                                                               //

// Magic Cube is free software: you can redistribute it and/or modify                            //

// it under the terms of the GNU General Public License as published by                          //

// the Free Software Foundation, either version 2 of the License, or                             //

// (at your option) any later version.                                                           //

//                                                                                               //

// Magic Cube is distributed in the hope that it will be useful,                                 //

// but WITHOUT ANY WARRANTY; without even the implied warranty of                                //

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                 //

// GNU General Public License for more details.                                                  //

//                                                                                               //

// You should have received a copy of the GNU General Public License                             //

// along with Magic Cube.  If not, see <http://www.gnu.org/licenses/>.                           //

///////////////////////////////////////////////////////////////////////////////////////////////////

package org.distorted.screens;

import android.content.Context;

import android.content.SharedPreferences;

import android.content.res.Resources;

import android.graphics.drawable.BitmapDrawable;

import android.os.Build;

import android.os.Bundle;

import android.util.TypedValue;

import android.view.Gravity;

import android.view.LayoutInflater;

import android.view.View;

import android.widget.Button;

import android.widget.GridLayout;

import android.widget.ImageButton;

import android.widget.LinearLayout;

import android.widget.PopupWindow;

import org.distorted.objectlib.main.ObjectControl;

import org.distorted.objectlib.main.ObjectType;

import org.distorted.main.R;

import org.distorted.main.RubikActivity;

import org.distorted.dialogs.RubikDialogAbout;

import org.distorted.dialogs.RubikDialogPattern;

import org.distorted.dialogs.RubikDialogScores;

import org.distorted.dialogs.RubikDialogTutorial;

import org.distorted.helpers.TransparentButton;

import org.distorted.helpers.TransparentImageButton;

import org.distorted.network.RubikScores;

import static android.view.View.inflate;

import static org.distorted.objectlib.main.ObjectType.NUM_OBJECTS;

///////////////////////////////////////////////////////////////////////////////////////////////////

public class RubikScreenPlay extends RubikScreenBase

  {

  public static final int NUM_COLUMNS  = 4;

  public static final int LEVELS_SHOWN = 10;

  public static int MAX_LEVEL;

  public static final ObjectType DEF_OBJECT= ObjectType.CUBE_3;

  private static final int[] BUTTON_LABELS = { R.string.scores,

                                               R.string.patterns,

                                               R.string.solver,

                                               R.string.tutorials,

                                               R.string.about };

  private static final int NUM_BUTTONS = BUTTON_LABELS.length;

  private static final float LAST_BUTTON = 1.5f;

  private static final int[] mLocation = new int[2];

  private TransparentImageButton mObjButton, mMenuButton, mSolveButton, mScrambleButton;

  private TransparentButton mPlayButton;

  private PopupWindow mObjectPopup, mMenuPopup, mPlayPopup;

  private ObjectType mObject = DEF_OBJECT;

  private int mObjectSize, mMenuLayoutWidth, mMenuLayoutHeight, mPlayLayoutWidth;

  private int mLevelValue;

  private float mButtonSize, mMenuItemSize, mMenuTextSize;

  private int mColCount, mRowCount, mMaxRowCount;

  private LinearLayout mPlayLayout;

  private int mUpperBarHeight;

  private boolean mShouldReactToEndOfScrambling;

  static

    {

    ObjectType[] types = ObjectType.values();

    int max = Integer.MIN_VALUE;

    for (ObjectType type : types)

      {

      int cur = getDBLevel(type);

      if( cur>max ) max = cur;

      }

    MAX_LEVEL = max;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void leaveScreen(RubikActivity act)

    {

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void enterScreen(final RubikActivity act)

    {

    float width = act.getScreenWidthInPixels();

    mUpperBarHeight = act.getHeightUpperBar();

    mMenuTextSize = width*RubikActivity.MENU_MED_TEXT_SIZE;

    mButtonSize   = width*RubikActivity.BUTTON_TEXT_SIZE;

    mMenuItemSize = width*RubikActivity.MENU_ITEM_SIZE;

    mRowCount = (NUM_OBJECTS + NUM_COLUMNS-1) / NUM_COLUMNS;

    mColCount = NUM_COLUMNS;

    // TOP ////////////////////////////

    LinearLayout layoutTop = act.findViewById(R.id.upperBar);

    layoutTop.removeAllViews();

    setupObjectButton(act,width);

    layoutTop.addView(mObjButton);

    setupMenuButton(act,width);

    layoutTop.addView(mMenuButton);

    setupPlayButton(act,width);

    layoutTop.addView(mPlayButton);

    setupSolveButton(act);

    setupScrambleButton(act);

    createBottomPane(act,mSolveButton,mScrambleButton);

    }

//////////////////////////////////////////////////////////////////////////////////////////////////

  private void setupObjectButton(final RubikActivity act, final float width)

    {

    final int margin  = (int)(width*RubikActivity.MARGIN);

    final int icon = RubikActivity.getDrawable(R.drawable.ui_small_cube_menu,R.drawable.ui_medium_cube_menu, R.drawable.ui_big_cube_menu, R.drawable.ui_huge_cube_menu);

    LinearLayout.LayoutParams params = new LinearLayout.LayoutParams(LinearLayout.LayoutParams.MATCH_PARENT,LinearLayout.LayoutParams.MATCH_PARENT,1.0f);

    mObjButton = new TransparentImageButton(act, icon, TransparentImageButton.GRAVITY_MIDDLE, params);

    mObjButton.setOnClickListener( new View.OnClickListener()

      {

      @Override

      public void onClick(View view)

        {

        if( mObjectPopup==null )

          {

          float width = act.getScreenWidthInPixels();

          float height= act.getScreenHeightInPixels();

          setupObjectWindow(act,width,height);

          }

        if( act.getControl().isUINotBlocked())

          {

          int rowCount = Math.min(mMaxRowCount,mRowCount);

          View popupView = mObjectPopup.getContentView();

          popupView.setSystemUiVisibility(RubikActivity.FLAGS);

          displayPopup(act,view,mObjectPopup,mObjectSize*mColCount,mObjectSize*rowCount,margin,margin);

          }

        }

      });

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void setupPlayButton(final RubikActivity act, final float width)

    {

    final int margin = (int)(width*RubikActivity.MARGIN);

    mPlayButton = new TransparentButton(act, R.string.play, mButtonSize);

    mPlayButton.setOnClickListener( new View.OnClickListener()

      {

      @Override

      public void onClick(View view)

        {

         if( mPlayPopup==null )

          {

          float width = act.getScreenWidthInPixels();

          setupPlayWindow(act,width);

          }

        if( act.getControl().isUINotBlocked())

          {

          float height= act.getScreenHeightInPixels();

          final int maxHeight= (int)(0.9f*(height-mUpperBarHeight) );

          View popupView = mPlayPopup.getContentView();

          popupView.setSystemUiVisibility(RubikActivity.FLAGS);

          final int dbLevel = getDBLevel(mObject);

          final int levelsShown = Math.min(dbLevel,LEVELS_SHOWN);

          final int popupHeight = (int)(levelsShown*(mMenuItemSize+margin)+3*margin+mMenuItemSize*(LAST_BUTTON-1.0f));

          final int realHeight = Math.min(popupHeight,maxHeight);

          displayPopup(act,view,mPlayPopup,mPlayLayoutWidth,realHeight,margin,margin);

          }

        }

      });

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void setupMenuButton(final RubikActivity act, final float width)

    {

    final int margin = (int)(width*RubikActivity.MARGIN);

    final int icon = RubikActivity.getDrawable(R.drawable.ui_small_menu,R.drawable.ui_medium_menu, R.drawable.ui_big_menu, R.drawable.ui_huge_menu);

    LinearLayout.LayoutParams params = new LinearLayout.LayoutParams(LinearLayout.LayoutParams.MATCH_PARENT,LinearLayout.LayoutParams.MATCH_PARENT,1.0f);

    mMenuButton = new TransparentImageButton(act, icon, TransparentImageButton.GRAVITY_MIDDLE, params);

    mMenuButton.setOnClickListener( new View.OnClickListener()

      {

      @Override

      public void onClick(View view)

        {

        if( mMenuPopup==null )

          {

          float width = act.getScreenWidthInPixels();

          setupMenuWindow(act,width);

          }

        if( act.getControl().isUINotBlocked())

          {

          View popupView = mMenuPopup.getContentView();

          popupView.setSystemUiVisibility(RubikActivity.FLAGS);

          displayPopup(act,view,mMenuPopup,mMenuLayoutWidth,mMenuLayoutHeight,(int)(-width/12),margin);

          }

        }

      });

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void setupObjectWindow(final RubikActivity act, final float width, final float height)

    {

    int icon = RubikActivity.getDrawable(R.drawable.cube_2s,R.drawable.cube_2m, R.drawable.cube_2b, R.drawable.cube_2h);

    Resources res = act.getResources();

    BitmapDrawable bd = (BitmapDrawable)res.getDrawable(icon);

    int cubeWidth = bd.getIntrinsicWidth();

    int margin = (int)(width*RubikActivity.LARGE_MARGIN);

    mObjectSize = (int)(cubeWidth + 2*margin + 0.5f);

    mMaxRowCount = (int)((height-1.8f*mUpperBarHeight)/mObjectSize);

    LinearLayout view = (LinearLayout)inflate( act, R.layout.popup_object, null);

    GridLayout objectGrid = view.findViewById(R.id.objectGrid);

    GridLayout.Spec[] rowSpecs = new GridLayout.Spec[mRowCount];

    GridLayout.Spec[] colSpecs = new GridLayout.Spec[mColCount];

    objectGrid.setColumnCount(mColCount);

    objectGrid.setRowCount(mRowCount);

    LinearLayout bottomLayout = view.findViewById(R.id.bottomLayout);

    setupBottomLayout(act,bottomLayout,2*mObjectSize,mObjectSize);

    mObjectPopup = new PopupWindow(act);

    mObjectPopup.setFocusable(true);

    mObjectPopup.setContentView(view);

    int[] nextInRow = new int[mRowCount];

    for(int row=0; row<mRowCount; row++)

      {

      rowSpecs[row] = GridLayout.spec(row);

      nextInRow[row]= 0;

      }

    for(int col=0; col<mColCount; col++)

      {

      colSpecs[col] = GridLayout.spec(col);

      }

    for(int object = 0; object< NUM_OBJECTS; object++)

      {

      final ObjectType type = ObjectType.getObject(object);

      int iconSize = RubikActivity.getDrawableSize();

      int icons = type.getIconID(iconSize);

      int row = object/NUM_COLUMNS;

      ImageButton button = new ImageButton(act);

      button.setBackgroundResource(icons);

      button.setOnClickListener( new View.OnClickListener()

        {

        @Override

        public void onClick(View v)

          {

          if( act.getControl().isUINotBlocked() && ScreenList.getCurrentScreen()== ScreenList.PLAY )

            {

            mObject = type;

            act.changeObject(type, true);

            if( mPlayLayout!=null ) adjustLevels(act);

            mMovesController.clearMoves(act);

            }

          mObjectPopup.dismiss();

          }

        });

      GridLayout.LayoutParams params = new GridLayout.LayoutParams(rowSpecs[row],colSpecs[nextInRow[row]]);

      params.bottomMargin = margin;

      params.topMargin    = margin;

      params.leftMargin   = margin;

      params.rightMargin  = margin;

      nextInRow[row]++;

      objectGrid.addView(button, params);

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void setupBottomLayout(final RubikActivity act, final LinearLayout layout, int width, int height)

    {

    int iconD = RubikActivity.getDrawable(R.drawable.ui_small_info,R.drawable.ui_medium_info, R.drawable.ui_big_info, R.drawable.ui_huge_info);

    int iconT = RubikActivity.getDrawable(R.drawable.ui_small_tutorial,R.drawable.ui_medium_tutorial, R.drawable.ui_big_tutorial, R.drawable.ui_huge_tutorial);

    ImageButton buttonTut = layout.findViewById(R.id.buttonTut);

         Button buttonNul = layout.findViewById(R.id.buttonNul);

    ImageButton buttonDet = layout.findViewById(R.id.buttonDet);

    buttonTut.setImageResource(iconT);

    buttonDet.setImageResource(iconD);

    buttonNul.setVisibility(View.INVISIBLE);

    buttonNul.setWidth(width);

    TypedValue outValue = new TypedValue();

    act.getTheme().resolveAttribute(android.R.attr.selectableItemBackgroundBorderless, outValue, true);

    buttonTut.setBackgroundResource(outValue.resourceId);

    buttonDet.setBackgroundResource(outValue.resourceId);

    buttonTut.setOnClickListener( new View.OnClickListener()

      {

      @Override

      public void onClick(View v)

        {

        if( mObjectPopup!=null ) mObjectPopup.dismiss();

        RubikDialogTutorial tDiag = new RubikDialogTutorial();

        tDiag.show( act.getSupportFragmentManager(), RubikDialogTutorial.getDialogTag() );

        }

      });

    buttonDet.setOnClickListener( new View.OnClickListener()

      {

      @Override

      public void onClick(View v)

        {

        act.switchConfig(mObject);

        }

      });

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void setupMenuWindow(final RubikActivity act, final float width)

    {

    LayoutInflater layoutInflater = (LayoutInflater)act.getSystemService(Context.LAYOUT_INFLATER_SERVICE);

    final View layout = layoutInflater.inflate(R.layout.popup_menu, null);

    LinearLayout menuLayout = layout.findViewById(R.id.menuGrid);

    mMenuPopup = new PopupWindow(act);

    mMenuPopup.setContentView(layout);

    mMenuPopup.setFocusable(true);

    int margin  = (int)(width*RubikActivity.MARGIN);

    int padding = (int)(width*RubikActivity.PADDING);

    mMenuLayoutWidth = (int)(width/2);

    mMenuLayoutHeight= (int)(2*margin + NUM_BUTTONS*(mMenuItemSize+margin));

    LinearLayout.LayoutParams p = new LinearLayout.LayoutParams( mMenuLayoutWidth - 2*padding, (int)mMenuItemSize);

    for(int i=0; i<NUM_BUTTONS; i++)

      {

      final int but = i;

      Button button = new Button(act);

      button.setLayoutParams(p);

      button.setText(BUTTON_LABELS[i]);

      button.setTextSize(TypedValue.COMPLEX_UNIT_PX, mMenuTextSize);

      button.setOnClickListener( new View.OnClickListener()

        {

        @Override

        public void onClick(View v)

          {

          mMenuPopup.dismiss();

          MenuAction(act,but);

          }

        });

      menuLayout.addView(button);

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void setupPlayWindow(final RubikActivity act, final float width)

    {

    LayoutInflater layoutInflater = (LayoutInflater)act.getSystemService(Context.LAYOUT_INFLATER_SERVICE);

    final View layout = layoutInflater.inflate(R.layout.popup_play, null);

    mPlayLayout = layout.findViewById(R.id.playGrid);

    mPlayLayoutWidth = (int)(width*0.4f);

    mPlayPopup = new PopupWindow(act);

    mPlayPopup.setContentView(layout);

    mPlayPopup.setFocusable(true);

    adjustLevels(act);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void MenuAction(RubikActivity act, int button)

    {

    switch(button)

      {

      case 0: Bundle sBundle = new Bundle();

              sBundle.putInt("tab", mObject.ordinal() );

              sBundle.putBoolean("submitting", false);

              RubikDialogScores scores = new RubikDialogScores();

              scores.setArguments(sBundle);

              scores.show(act.getSupportFragmentManager(), null);

              break;

      case 1: RubikDialogPattern pDiag = new RubikDialogPattern();

              pDiag.show( act.getSupportFragmentManager(), RubikDialogPattern.getDialogTag() );

              break;

      case 2: ScreenList.switchScreen(act, ScreenList.SVER);

              break;

      case 3: RubikDialogTutorial tDiag = new RubikDialogTutorial();

              tDiag.show( act.getSupportFragmentManager(), RubikDialogTutorial.getDialogTag() );

              break;

      case 4: RubikDialogAbout aDiag = new RubikDialogAbout();

              aDiag.show(act.getSupportFragmentManager(), null);

              break;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void setupSolveButton(final RubikActivity act)

    {

    int icon = RubikActivity.getDrawable(R.drawable.ui_small_cube_solve_new,R.drawable.ui_medium_cube_solve_new, R.drawable.ui_big_cube_solve_new, R.drawable.ui_huge_cube_solve_new);

    LinearLayout.LayoutParams params = new LinearLayout.LayoutParams(LinearLayout.LayoutParams.MATCH_PARENT,LinearLayout.LayoutParams.MATCH_PARENT,1.0f);

    mSolveButton = new TransparentImageButton(act, icon, TransparentImageButton.GRAVITY_END,params);

    mSolveButton.setOnClickListener( new View.OnClickListener()

      {

      @Override

      public void onClick(View v)

        {

        act.getControl().solveObject();

        mMovesController.clearMoves(act);

        }

      });

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void setupScrambleButton(final RubikActivity act)

    {

    int icon = RubikActivity.getDrawable(R.drawable.ui_small_cube_scramble_new,R.drawable.ui_medium_cube_scramble_new, R.drawable.ui_big_cube_scramble_new, R.drawable.ui_huge_cube_scramble_new);

    LinearLayout.LayoutParams params = new LinearLayout.LayoutParams(LinearLayout.LayoutParams.MATCH_PARENT,LinearLayout.LayoutParams.MATCH_PARENT,1.0f);

    mScrambleButton = new TransparentImageButton(act, icon, TransparentImageButton.GRAVITY_START, params);

    mScrambleButton.setOnClickListener( new View.OnClickListener()

      {

      @Override

      public void onClick(View v)

        {

        RubikScreenPlay play = (RubikScreenPlay) ScreenList.PLAY.getScreenClass();

        int numScrambles = play.getObject().getNumScramble();

        mShouldReactToEndOfScrambling = false;

        act.getControl().scrambleObject(numScrambles);

        }

      });

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void savePreferences(SharedPreferences.Editor editor)

    {

    editor.putString("statePlay_objName", mObject.name() );

    if( mObjectPopup!=null )

      {

      mObjectPopup.dismiss();

      mObjectPopup = null;

      }

    if( mMenuPopup!=null )

      {

      mMenuPopup.dismiss();

      mMenuPopup = null;

      }

    if( mPlayPopup!=null )

      {

      mPlayPopup.dismiss();

      mPlayPopup = null;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void restorePreferences(SharedPreferences preferences)

    {

    String objName= preferences.getString("statePlay_objName", DEF_OBJECT.name() );

    int ordinal = ObjectType.getOrdinal(objName);

    mObject = ordinal>=0 && ordinal<NUM_OBJECTS ? ObjectType.values()[ordinal] : DEF_OBJECT;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public boolean setObject(RubikActivity act, ObjectType obj)

    {

    if( mObject!=obj )

      {

      mObject = obj;

      if( mPlayLayout!=null ) adjustLevels(act);

      return true;

      }

    return false;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// work around lame bugs in Android's version <= 10 pop-up and split-screen modes

  private void displayPopup(RubikActivity act, View view, PopupWindow window, int w, int h, int xoff, int yoff)

    {

    View topLayout = act.findViewById(R.id.relativeLayout);

    boolean isFullScreen;

    if( topLayout!=null )

      {

      topLayout.getLocationOnScreen(mLocation);

      isFullScreen = (mLocation[1]==0);

      }

    else

      {

      isFullScreen = true;

      }

    try

      {

      // if on Android 11 or we are fullscreen

      if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R || isFullScreen )

        {

        window.showAsDropDown(view, xoff, yoff, Gravity.CENTER);

        window.update(view, w, h);

        }

      else  // Android 10 or below in pop-up mode or split-screen mode

        {

        view.getLocationOnScreen(mLocation);

        int width  = view.getWidth();

        int height = view.getHeight();

        int x = mLocation[0]+(width-w)/2;

        int y = mLocation[1]+height+yoff;

        window.showAsDropDown(view);

        window.update(x,y,w,h);

        }

      }

    catch( IllegalArgumentException iae )

      {

      // ignore, this means window is 'not attached to window manager' -

      // which most probably is because we are already exiting the app.

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void adjustSolvedIcons()

    {

    int dbLevel = getDBLevel(mObject);

    int numLevel = Math.min(dbLevel, LEVELS_SHOWN);

    RubikScores scores = RubikScores.getInstance();

    for(int i=0; i<numLevel; i++)

      {

      int level = i<numLevel-1 ? i+1 : dbLevel;

      Button button = (Button)mPlayLayout.getChildAt(i);

      int icon = scores.isSolved(mObject.ordinal(), level-1) ? R.drawable.ui_solved : R.drawable.ui_notsolved;

      button.setCompoundDrawablesWithIntrinsicBounds(icon,0,0,0);

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void adjustLevels(final RubikActivity act)

    {

    int dbLevel = getDBLevel(mObject);

    int numScrambles = mObject.getNumScramble();

    int numLevel = Math.min(dbLevel, LEVELS_SHOWN);

    String[] levels = new String[numLevel];

    for(int i=0; i<numLevel-1; i++)

      {

      levels[i] = act.getString(R.string.lv_placeholder,i+1);

      }

    if( numLevel>0 )

      {

      levels[numLevel-1] = act.getString(R.string.level_full);

      }

    if( mLevelValue>dbLevel || mLevelValue<1 ||

       (mLevelValue<dbLevel || mLevelValue>LEVELS_SHOWN ) )

      {

      mLevelValue=1;

      }

    float width  = act.getScreenWidthInPixels();

    int margin   = (int)(width*RubikActivity.MARGIN);

    int padding  = (int)(width*RubikActivity.PADDING);

    int butWidth = mPlayLayoutWidth - 2*padding;

    int butHeight= (int)mMenuItemSize;

    int lastButH = (int)(mMenuItemSize*LAST_BUTTON) ;

    LinearLayout.LayoutParams pM = new LinearLayout.LayoutParams( butWidth, butHeight );

    pM.setMargins(margin, 0, margin, margin);

    LinearLayout.LayoutParams pT = new LinearLayout.LayoutParams( butWidth, butHeight );

    pT.setMargins(margin, margin, margin, margin);

    LinearLayout.LayoutParams pB = new LinearLayout.LayoutParams( butWidth, lastButH  );

    pB.setMargins(margin, margin, margin, 2*margin);

    mPlayLayout.removeAllViews();

    RubikScores scores = RubikScores.getInstance();

    for(int i=0; i<numLevel; i++)

      {

      final int level     = i<numLevel-1 ? i+1 : dbLevel;

      final int scrambles = i<numLevel-1 ? i+1 : numScrambles;

      Button button = new Button(act);

      button.setLayoutParams(i==0 ? pT : (i==numLevel-1 ? pB : pM));

      button.setText(levels[i]);

      button.setTextSize(TypedValue.COMPLEX_UNIT_PX, mMenuTextSize);

      int icon = scores.isSolved(mObject.ordinal(), level-1) ? R.drawable.ui_solved : R.drawable.ui_notsolved;

      button.setCompoundDrawablesWithIntrinsicBounds(icon,0,0,0);

      button.setOnClickListener( new View.OnClickListener()

        {

        @Override

        public void onClick(View v)

          {

          ObjectControl control = act.getControl();

          if(control.isUINotBlocked())

            {

            if( mPlayPopup!=null ) mPlayPopup.dismiss();

            mLevelValue = level;

            mShouldReactToEndOfScrambling = true;

            control.scrambleObject(scrambles);

            }

          }

        });

      mPlayLayout.addView(button);

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// historically older versions of the app had lower 'maxScrambles' in case of several objects and

// those got remembered in the server-side DB already, so we need to keep using them. This function

// provides a map between 'maxScramble' of an object and its 'dbLevel'. All new objects will have

// those two values the same.

  public static int getDBLevel(ObjectType object)

    {

    switch(object)

      {

      case CUBE_3: return 16;

      case CUBE_4: return 20;

      case CUBE_5: return 24;

      case PYRA_4: return 15;

      case PYRA_5: return 20;

      case MEGA_5: return 35;

      case DIAM_2: return 10;

      case DIAM_3: return 18;

      case REDI_3: return 14;

      case HELI_3: return 18;

      case SKEW_3: return 17;

      case REX_3 : return 16;

      case MIRR_3: return 16;

      default    : return object.getNumScramble();

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public int getLevel()

    {

    return mLevelValue;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public boolean shouldReactToEndOfScrambling()

    {

    return mShouldReactToEndOfScrambling;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public ObjectType getObject()

    {

    return mObject;

    }

  }