Magic Cube

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

// Copyright 2019 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.magic;

import android.app.ActivityManager;

import android.content.Context;

import android.content.pm.ConfigurationInfo;

import android.opengl.GLSurfaceView;

import android.util.AttributeSet;

import android.view.MotionEvent;

import org.distorted.library.type.Static2D;

import org.distorted.library.type.Static3D;

import org.distorted.library.type.Static4D;

import org.distorted.object.RubikObject;

import org.distorted.object.RubikObjectMovement;

import org.distorted.uistate.RubikState;

import org.distorted.uistate.RubikStateSolving;

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

public class RubikSurfaceView extends GLSurfaceView

{

    // Moving the finger from the middle of the vertical screen to the right edge will rotate a

    // given face by SWIPING_SENSITIVITY/2 degrees.

    private final static int SWIPING_SENSITIVITY  = 240;

    // Moving the finger by 1/15 the distance of min(scrWidth,scrHeight) will start a Rotation.

    private final static int ROTATION_SENSITIVITY =  15;

    // Every 1/12 the distance of min(scrWidth,scrHeight) the direction of cube rotation will reset.

    private final static int DIRECTION_SENSITIVITY=  12;

    // Where did we get this sqrt(3)/2 ? From the (default, i.e. 60 degrees - see InternalOutputSurface!)

    // FOV of the projection matrix of the Node onto the Screen.

    // Take a look how the CAMERA_POINT is used in onTouchEvent - (x,y) there are expressed in sort of

    // 'half-NDC' coordinates i.e. they range from +0.5 to -0.5; thus CAMERA_POINT also needs to be

    // in 'half-NDC'. Since in this coordinate system the height of the screen is equal to 1, then the

    // Z-distance from the center of the object to the camera is equal to (scrHeight/2)/tan(FOV/2) =

    // 0.5/tan(30) = sqrt(3)/2.

    // Why is the Z-distance between the camera and the object equal to (scrHeight/2)/tan(FOV/2)?

    // Because of the way the View part of the ModelView matrix is constructed in EffectQueueMatrix.send().

    private final Static4D CAMERA_POINT = new Static4D(0, 0, (float)Math.sqrt(3)*0.5f, 0);

    private RubikRenderer mRenderer;

    private RubikObjectMovement mMovement;

    private boolean mDragging, mBeginningRotation, mContinuingRotation;

    private int mScreenWidth, mScreenHeight, mScreenMin;

    private float mX, mY;

    private float mStartRotX, mStartRotY;

    private float mAxisX, mAxisY;

    private float mRotationFactor;

    private static Static4D mQuatCurrent    = new Static4D(0,0,0,1);

    private static Static4D mQuatAccumulated= new Static4D(-0.25189602f,0.3546389f,0.009657208f,0.90038127f);

    private static Static4D mTempCurrent    = new Static4D(0,0,0,1);

    private static Static4D mTempAccumulated= new Static4D(0,0,0,1);

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

    void setScreenSize(int width, int height)

      {

      mScreenWidth = width;

      mScreenHeight= height;

      mScreenMin = Math.min(width, height);

      }

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

    RubikRenderer getRenderer()

      {

      return mRenderer;

      }

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

    void setQuatAccumulated()

      {

      mQuatAccumulated.set(mTempAccumulated);

      }

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

    void setQuatCurrent()

      {

      mQuatCurrent.set(mTempCurrent);

      }

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

    Static4D getQuatAccumulated()

      {

      return mQuatAccumulated;

      }

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

    Static4D getQuatCurrent()

      {

      return mQuatCurrent;

      }

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

    void setMovement(RubikObjectMovement movement)

      {

      mMovement = movement;

      }

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

    private Static4D quatFromDrag(float dragX, float dragY)

      {

      float axisX = dragY;  // inverted X and Y - rotation axis is perpendicular to (dragX,dragY)

      float axisY = dragX;  // Why not (-dragY, dragX) ? because Y axis is also inverted!

      float axisZ = 0;

      float axisL = (float)Math.sqrt(axisX*axisX + axisY*axisY + axisZ*axisZ);

      if( axisL>0 )

        {

        axisX /= axisL;

        axisY /= axisL;

        axisZ /= axisL;

        float ratio = axisL;

        ratio = ratio - (int)ratio;     // the cos() is only valid in (0,Pi)

        float cosA = (float)Math.cos(Math.PI*ratio);

        float sinA = (float)Math.sqrt(1-cosA*cosA);

        return new Static4D(axisX*sinA, axisY*sinA, axisZ*sinA, cosA);

        }

      return new Static4D(0f, 0f, 0f, 1f);

      }

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

    private void setUpDragOrRotate(float x, float y)

      {

      Static4D touchPoint1 = new Static4D(x, y, 0, 0);

      Static4D rotatedTouchPoint1= rotateVectorByInvertedQuat(touchPoint1, mQuatAccumulated);

      Static4D rotatedCamera= rotateVectorByInvertedQuat(CAMERA_POINT, mQuatAccumulated);

      if( mMovement!=null && mMovement.faceTouched(rotatedTouchPoint1,rotatedCamera) )

        {

        mDragging           = false;

        mBeginningRotation  = mRenderer.canRotate();

        mContinuingRotation = false;

        }

      else

        {

        mDragging           = mRenderer.canDrag();

        mBeginningRotation  = false;

        mContinuingRotation = false;

        }

      }

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

// cast the 3D axis we are currently rotating along to the 2D in-screen-surface axis

    private void computeCurrentAxis(Static3D axis)

      {

      Static4D axis4D = new Static4D(axis.get0(), axis.get1(), axis.get2(), 0);

      Static4D result = rotateVectorByQuat(axis4D, mQuatAccumulated);

      mAxisX =result.get0();

      mAxisY =result.get1();

      float len = (float)Math.sqrt(mAxisX*mAxisX + mAxisY*mAxisY);

      mAxisX /= len;

      mAxisY /= len;

      // android.util.Log.e("axis", "axis 2D: "+mAxisX+" , "+mAxisY);

      }

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

    private float continueRotation(float dx, float dy)

      {

      float alpha = dx*mAxisX + dy*mAxisY;

      float x = dx - alpha*mAxisX;

      float y = dy - alpha*mAxisY;

      float len = (float)Math.sqrt(x*x + y*y);

      // we have the length of 1D vector 'angle', now the direction:

      float tmp = mAxisY==0 ? -mAxisX*y : mAxisY*x;

      return (tmp>0 ? 1:-1)*len*mRotationFactor;

      }

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

// return quat1*quat2

    public static Static4D quatMultiply( Static4D quat1, Static4D quat2 )

      {

      float qx = quat1.get0();

      float qy = quat1.get1();

      float qz = quat1.get2();

      float qw = quat1.get3();

      float rx = quat2.get0();

      float ry = quat2.get1();

      float rz = quat2.get2();

      float rw = quat2.get3();

      float tx = rw*qx - rz*qy + ry*qz + rx*qw;

      float ty = rw*qy + rz*qx + ry*qw - rx*qz;

      float tz = rw*qz + rz*qw - ry*qx + rx*qy;

      float tw = rw*qw - rz*qz - ry*qy - rx*qx;

      return new Static4D(tx,ty,tz,tw);

      }

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

// rotate 'vector' by quat  ( i.e. return quat*vector*(quat^-1) )

    public static Static4D rotateVectorByQuat(Static4D vector, Static4D quat)

      {

      float qx = quat.get0();

      float qy = quat.get1();

      float qz = quat.get2();

      float qw = quat.get3();

      Static4D quatInverted= new Static4D(-qx,-qy,-qz,qw);

      Static4D tmp = quatMultiply(quat,vector);

      return quatMultiply(tmp,quatInverted);

      }

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

// rotate 'vector' by quat^(-1)  ( i.e. return (quat^-1)*vector*quat )

    public static Static4D rotateVectorByInvertedQuat(Static4D vector, Static4D quat)

      {

      float qx = quat.get0();

      float qy = quat.get1();

      float qz = quat.get2();

      float qw = quat.get3();

      Static4D quatInverted= new Static4D(-qx,-qy,-qz,qw);

      Static4D tmp = quatMultiply(quatInverted,vector);

      return quatMultiply(tmp,quat);

      }

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

// PUBLIC API

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

    public RubikSurfaceView(Context context, AttributeSet attrs)

      {

      super(context,attrs);

      if(!isInEditMode())

        {

        mRenderer = new RubikRenderer(this);

        final ActivityManager activityManager     = (ActivityManager) context.getSystemService(Context.ACTIVITY_SERVICE);

        final ConfigurationInfo configurationInfo = activityManager.getDeviceConfigurationInfo();

        setEGLContextClientVersion( (configurationInfo.reqGlEsVersion>>16) >= 3 ? 3:2 );

        setRenderer(mRenderer);

        }

      }

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

    @Override

    public boolean onTouchEvent(MotionEvent event)

      {

      int action = event.getAction();

      float x = (event.getX() - mScreenWidth*0.5f)/mScreenMin;

      float y = (mScreenHeight*0.5f -event.getY())/mScreenMin;

      switch(action)

         {

         case MotionEvent.ACTION_DOWN: mX = x;

                                       mY = y;

                                       setUpDragOrRotate(x,y);

                                       break;

         case MotionEvent.ACTION_MOVE: if( mBeginningRotation )

                                         {

                                         if( (mX-x)*(mX-x)+(mY-y)*(mY-y) > 1.0f/(ROTATION_SENSITIVITY*ROTATION_SENSITIVITY) )

                                           {

                                           mStartRotX = x;

                                           mStartRotY = y;

                                           Static4D touchPoint2 = new Static4D(x, y, 0, 0);

                                           Static4D rotatedTouchPoint2= rotateVectorByInvertedQuat(touchPoint2, mQuatAccumulated);

                                           Static2D res = mMovement.newRotation(rotatedTouchPoint2);

                                           RubikObject object = mRenderer.getObject();

                                           int axis = (int)res.get0();

                                           float offset = res.get1();

                                           computeCurrentAxis( object.getRotationAxis()[axis] );

                                           mRotationFactor = object.returnRotationFactor(offset);

                                           object.beginNewRotation( axis, object.returnRowFromOffset(offset) );

                                           if( RubikState.getCurrentState()==RubikState.SOLV )

                                             {

                                             RubikStateSolving solving = (RubikStateSolving)RubikState.SOLV.getStateClass();

                                             solving.startCounting( (RubikActivity)getContext() );

                                             }

                                           mBeginningRotation = false;

                                           mContinuingRotation= true;

                                           }

                                         }

                                       else if( mContinuingRotation )

                                         {

                                         float angle = continueRotation(x-mStartRotX,y-mStartRotY);

                                         mRenderer.getObject().continueRotation(SWIPING_SENSITIVITY*angle);

                                         }

                                       else if( mDragging )

                                         {

                                         mTempCurrent.set(quatFromDrag(mX-x,y-mY));

                                         mRenderer.setQuatCurrentOnNextRender();

                                         if( (mX-x)*(mX-x) + (mY-y)*(mY-y) > 1.0f/(DIRECTION_SENSITIVITY*DIRECTION_SENSITIVITY) )

                                           {

                                           mX = x;

                                           mY = y;

                                           mTempAccumulated.set(quatMultiply(mQuatCurrent, mQuatAccumulated));

                                           mTempCurrent.set(0f, 0f, 0f, 1f);

                                           mRenderer.setQuatCurrentOnNextRender();

                                           mRenderer.setQuatAccumulatedOnNextRender();

                                           }

                                         }

                                       else if( mRenderer.canRotate() || mRenderer.canDrag() )

                                         {

                                         setUpDragOrRotate(x,y);

                                         }

                                       break;

         case MotionEvent.ACTION_UP  : if( mDragging )

                                         {

                                         mTempAccumulated.set(quatMultiply(mQuatCurrent, mQuatAccumulated));

                                         mTempCurrent.set(0f, 0f, 0f, 1f);

                                         mRenderer.setQuatCurrentOnNextRender();

                                         mRenderer.setQuatAccumulatedOnNextRender();

                                         }

                                       if( mContinuingRotation )

                                         {

                                         mRenderer.finishRotation();

                                         }

                                       break;

         }

      return true;

      }

}