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.opengl.GLSurfaceView;

import org.distorted.effect.BaseEffect;

import org.distorted.library.effect.VertexEffectSink;

import org.distorted.library.main.DistortedEffects;

import org.distorted.library.main.DistortedLibrary;

import org.distorted.library.main.DistortedScreen;

import org.distorted.library.main.DistortedTexture;

import org.distorted.library.mesh.MeshFlat;

import org.distorted.library.message.EffectListener;

import javax.microedition.khronos.egl.EGLConfig;

import javax.microedition.khronos.opengles.GL10;

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

public class RubikRenderer implements GLSurfaceView.Renderer, EffectListener

{

    private static final float CUBE_SCREEN_RATIO = 0.5f;

    private static final float CAMERA_DISTANCE   = 0.6f;  // 0.6 of the length of max(scrHeight,scrWidth)

    public  static final int TEXTURE_SIZE = 600;

    private RubikSurfaceView mView;

    private DistortedScreen mScreen;

    private float mCubeSizeInScreenSpace;

    private int mNextCubeSize, mScrambleCubeNum;

    private long mRotationFinishedID;

    private long[] mEffectID;

    private boolean mFinishRotation, mRemoveRotation, mSetQuatCurrent, mSetQuatAccumulated;

    private boolean mSizeChangeCube, mSolveCube, mScrambleCube;

    private boolean mCanRotate, mCanDrag, mCanUI;

    private boolean mIsSolved;

    private RubikCube mOldCube, mNewCube;

    private int mScreenWidth, mScreenHeight;

    private MeshFlat mMesh;

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

    RubikRenderer(RubikSurfaceView v)

      {

      mView = v;

      mScreen = new DistortedScreen();

      mOldCube = null;

      mNewCube = null;

      mScreenWidth = mScreenHeight = 0;

      mScrambleCubeNum = 0;

      mFinishRotation     = false;

      mRemoveRotation     = false;

      mSetQuatCurrent     = false;

      mSetQuatAccumulated = false;

      mSizeChangeCube     = true;

      mSolveCube          = false;

      mScrambleCube       = false;

      mCanRotate   = true;

      mCanDrag     = true;

      mCanUI       = true;

      mEffectID = new long[BaseEffect.Type.LENGTH];

      mMesh= new MeshFlat(20,20);

      mNextCubeSize = RubikActivity.getSize();

      }

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

   private float computeFOV(float cameraDistance, int screenHeight)

     {

     double halfFOVInRadians = Math.atan( screenHeight/(2*cameraDistance) );

     return (float)(2*halfFOVInRadians*(180/Math.PI));

     }

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

   private void recomputeScaleFactor(int screenWidth, int screenHeight)

     {

     mCubeSizeInScreenSpace = CUBE_SCREEN_RATIO*(screenWidth>screenHeight ? screenHeight:screenWidth);

     if( mNewCube!=null )

       {

       mNewCube.recomputeScaleFactor(screenWidth, screenHeight, mCubeSizeInScreenSpace);

       }

     }

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

   private void createCubeNow(int newSize)

     {

     if( mOldCube!=null ) mOldCube.releaseResources();

     mOldCube = mNewCube;

     DistortedTexture texture = new DistortedTexture(TEXTURE_SIZE,TEXTURE_SIZE);

     DistortedEffects effects = new DistortedEffects();

     mNewCube = new RubikCube(newSize, mView.getQuatCurrent(), mView.getQuatAccumulated(), texture, mMesh, effects);

     mNewCube.createTexture();

     if( mScreenWidth!=0 )

       {

       recomputeScaleFactor(mScreenWidth,mScreenHeight);

       }

     mIsSolved = true;

     }

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

// do all 'adjustable' effects (SizeChange, Solve, Scramble)

   private void doEffectNow(BaseEffect.Type type)

     {

     int index = type.ordinal();

     mEffectID[index] = type.startEffect(this);

     if( mEffectID[index] < 0 )

       {

       mCanUI     = true;

       mCanRotate = true;

       mCanDrag   = true;

       }

     }

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

// no this will not race with onDrawFrame

   void finishRotation()

     {

     mFinishRotation = true;

     }

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

   boolean createCube(int newSize)

     {

     if( mCanDrag && mCanRotate && (mNewCube==null || newSize != mNewCube.getSize()) )

       {

       mSizeChangeCube = true;

       mNextCubeSize = newSize;

       return true;

       }

     return false;

     }

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

   void scrambleCube(int num)

     {

     if( mCanUI )

       {

       mScrambleCube = true;

       mScrambleCubeNum = num;

       }

     }

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

   void solveCube()

     {

     if( mCanUI )

       {

       mSolveCube = true;

       }

     }

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

   float returnCubeSizeInScreenSpace()

     {

     return mCubeSizeInScreenSpace;

     }

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

   boolean canRotate()

     {

     return mCanRotate;

     }

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

   boolean canDrag()

     {

     return mCanDrag;

     }

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

   void setQuatCurrentOnNextRender()

     {

     mSetQuatCurrent = true;

     }

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

   void setQuatAccumulatedOnNextRender()

     {

     mSetQuatAccumulated = true;

     }

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

// PUBLIC API

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

// various things are done here delayed, 'after the next render' as not to be done mid-render and

// cause artifacts.

   @Override

   public void onDrawFrame(GL10 glUnused)

     {

     mScreen.render( System.currentTimeMillis() );

     if( mSetQuatCurrent )

       {

       mSetQuatCurrent = false;

       mView.setQuatCurrent();

       }

     if( mSetQuatAccumulated )

       {

       mSetQuatAccumulated = false;

       mView.setQuatAccumulated();

       }

     if( mFinishRotation )

       {

       mFinishRotation = false;

       mCanRotate      = false;

       mCanUI          = false;

       mRotationFinishedID = mNewCube.finishRotationNow(this);

       }

     if( mRemoveRotation )

       {

       mRemoveRotation=false;

       mNewCube.removeRotationNow();

       boolean solved = mNewCube.isSolved();

       if( solved && !mIsSolved )

         {

         mCanDrag        = false;

         mCanRotate      = false;

         mCanUI          = false;

         doEffectNow( BaseEffect.Type.WIN );

         }

       else

         {

         mCanRotate = true;

         mCanUI     = true;

         }

       mIsSolved = solved;

       }

     if( mSizeChangeCube )

       {

       mSizeChangeCube = false;

       mCanDrag        = false;

       mCanRotate      = false;

       mCanUI          = false;

       createCubeNow(mNextCubeSize);

       doEffectNow( BaseEffect.Type.SIZECHANGE );

       }

     if( mSolveCube )

       {

       mSolveCube      = false;

       mCanDrag        = false;

       mCanRotate      = false;

       mCanUI          = false;

       doEffectNow( BaseEffect.Type.SOLVE );

       }

     if( mScrambleCube )

       {

       mScrambleCube = false;

       mCanDrag      = false;

       mCanRotate    = false;

       mCanUI        = false;

       doEffectNow( BaseEffect.Type.SCRAMBLE );

       }

     }

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

   @Override

   public void onSurfaceChanged(GL10 glUnused, int width, int height)

      {

      if( mNewCube!=null ) mNewCube.createTexture();

      float cameraDistance = CAMERA_DISTANCE*(width>height ? width:height);

      float fovInDegrees   = computeFOV(cameraDistance,height);

      mScreen.setProjection( fovInDegrees, 0.1f);

      mView.setScreenSize(width,height);

      mView.setCameraDist(cameraDistance);

      mScreen.resize(width, height);

      recomputeScaleFactor(width,height);

      mScreenHeight = height;

      mScreenWidth  = width;

      }

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

   @Override

   public void onSurfaceCreated(GL10 glUnused, EGLConfig config)

      {

      VertexEffectSink.enable();

      BaseEffect.Type.enableEffects();

      try

        {

        DistortedLibrary.onCreate(mView.getContext());

        }

      catch(Exception ex)

        {

        android.util.Log.e("Rubik", ex.getMessage() );

        }

      }

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

   public void effectFinished(final long effectID)

     {

     if( effectID == mRotationFinishedID )

       {

       mRemoveRotation = true;

       }

     else

       {

       for(int i=0; i<BaseEffect.Type.LENGTH; i++)

         {

         if( effectID == mEffectID[i] )

           {

           mCanRotate   = true;

           mCanDrag     = true;

           mCanUI       = true;

           break;

           }

         }

       }

     }

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

   public RubikCube getCube()

     {

     return mNewCube;

     }

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

   public RubikCube getOldCube()

     {

     return mOldCube;

     }

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

   public DistortedScreen getScreen()

     {

     return mScreen;

     }

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

   public int getNumScrambles()

     {

     return mScrambleCubeNum;

     }

}