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.object;

import android.content.SharedPreferences;

import org.distorted.library.effect.MatrixEffectMove;

import org.distorted.library.effect.MatrixEffectQuaternion;

import org.distorted.library.effect.MatrixEffectRotate;

import org.distorted.library.main.DistortedEffects;

import org.distorted.library.main.DistortedNode;

import org.distorted.library.mesh.MeshBase;

import org.distorted.library.message.EffectListener;

import org.distorted.library.type.Dynamic1D;

import org.distorted.library.type.Static1D;

import org.distorted.library.type.Static3D;

import org.distorted.library.type.Static4D;

import org.distorted.magic.RubikSurfaceView;

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

class Cubit

  {

  private static final Static3D matrCenter = new Static3D(0,0,0);

  private final Static3D mOrigPosition;

  private RubikObject mParent;

  private MeshBase mMesh;

  private Static3D mRotationAxis;

  private MatrixEffectRotate mRotateEffect;

  private Static3D mCurrentPosition;

  private int mNumAxis;

  Dynamic1D mRotationAngle;

  DistortedNode mNode;

  DistortedEffects mEffect;

  Static4D mQuatScramble;

  int[] mRotationRow;

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

// Because of quatMultiplication, errors can accumulate - so to avoid this, we

// correct the value of the 'scramble' quat to what it should be - one of the legal quats from the

// list LEGAL_QUATS.

//

// We also have to remember that the group of unit quaternions is a double-cover of rotations

// in 3D ( q represents the same rotation as -q ) - so invert if needed.

  private void normalizeScrambleQuat(Static4D quat)

    {

    float x = quat.get0();

    float y = quat.get1();

    float z = quat.get2();

    float w = quat.get3();

    float diff;

    for(float legal: mParent.LEGAL_QUATS)

      {

      diff = x-legal;

      if( diff*diff<0.01f ) x = legal;

      diff = y-legal;

      if( diff*diff<0.01f ) y = legal;

      diff = z-legal;

      if( diff*diff<0.01f ) z = legal;

      diff = w-legal;

      if( diff*diff<0.01f ) w = legal;

      }

    if( w<0 )

      {

      w = -w;

      z = -z;

      y = -y;

      x = -x;

      }

    else if( w==0 )

      {

      if( z<0 )

        {

        z = -z;

        y = -y;

        x = -x;

        }

      else if( z==0 )

        {

        if( y<0 )

          {

          y = -y;

          x = -x;

          }

        else if( y==0 )

          {

          if( x<0 )

            {

            x = -x;

            }

          }

        }

      }

    quat.set(x,y,z,w);

    }

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

  private int computeNearestAngle(float angle)

    {

    final int NEAREST = 90;

    int tmp = (int)((angle+NEAREST/2)/NEAREST);

    if( angle< -(NEAREST*0.5) ) tmp-=1;

    return NEAREST*tmp;

    }

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

  private void modifyCurrentPosition(Static3D currentPosition, Static4D quat)

    {

    float diff = 0.5f*(mParent.mSize-1);

    float cubitCenterX = currentPosition.get0() - diff;

    float cubitCenterY = currentPosition.get1() - diff;

    float cubitCenterZ = currentPosition.get2() - diff;

    Static4D cubitCenter =  new Static4D(cubitCenterX, cubitCenterY, cubitCenterZ, 0);

    Static4D rotatedCenter = RubikSurfaceView.rotateVectorByQuat( cubitCenter, quat);

    float rotatedX = rotatedCenter.get0() + diff;

    float rotatedY = rotatedCenter.get1() + diff;

    float rotatedZ = rotatedCenter.get2() + diff;

    int roundedX = (int)(rotatedX+0.1f);

    int roundedY = (int)(rotatedY+0.1f);

    int roundedZ = (int)(rotatedZ+0.1f);

    currentPosition.set(roundedX, roundedY, roundedZ);

    computeRotationRow();

    }

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

// cast current position on axis; use mStart and mStep to compute the rotation row for each axis.

  private void computeRotationRow()

    {

    float tmp;

    Static3D axis;

    float x = mCurrentPosition.get0();

    float y = mCurrentPosition.get1();

    float z = mCurrentPosition.get2();

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

      {

      axis = mParent.ROTATION_AXIS[i];

      tmp = x*axis.get0() + y*axis.get1() + z*axis.get2();

      mRotationRow[i] = (int)( (tmp-mParent.mStart)/mParent.mStep + 0.5f );

      }

    }

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

  Cubit(RubikObject parent, MeshBase mesh, Static3D position)

    {

    float x = position.get0();

    float y = position.get1();

    float z = position.get2();

    float nc = parent.mSize*0.5f;

    Static3D vector = new Static3D(x-nc+0.5f, y-nc+0.5f, z-nc+0.5f);

    mParent          = parent;

    mMesh            = mesh;

    mOrigPosition    = new Static3D(x,y,z);

    mQuatScramble    = new Static4D(0,0,0,1);

    mRotationAngle   = new Dynamic1D();

    mRotationAxis    = new Static3D(1,0,0);

    mCurrentPosition = position;

    mRotateEffect    = new MatrixEffectRotate(mRotationAngle, mRotationAxis, matrCenter);

    mNumAxis     = mParent.ROTATION_AXIS.length;

    mRotationRow = new int[mNumAxis];

    computeRotationRow();

    mEffect = new DistortedEffects();

    mEffect.apply(mParent.mSinkEffect);

    mEffect.apply( new MatrixEffectMove(vector) );

    mEffect.apply( new MatrixEffectQuaternion(mQuatScramble, matrCenter));

    mEffect.apply(mRotateEffect);

    mEffect.apply(mParent.mQuatAEffect);

    mEffect.apply(mParent.mQuatCEffect);

    mEffect.apply(mParent.mScaleEffect);

    mNode = new DistortedNode(mParent.mTexture,mEffect,mMesh);

    }

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

  void savePreferences(SharedPreferences.Editor editor)

    {

    String number = mOrigPosition.get0()+"_"+mOrigPosition.get1()+"_"+mOrigPosition.get2();

    editor.putFloat("qx_"+number, mQuatScramble.get0());

    editor.putFloat("qy_"+number, mQuatScramble.get1());

    editor.putFloat("qz_"+number, mQuatScramble.get2());

    editor.putFloat("qw_"+number, mQuatScramble.get3());

    }

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

  void restorePreferences(SharedPreferences preferences)

    {

    String number = mOrigPosition.get0()+"_"+mOrigPosition.get1()+"_"+mOrigPosition.get2();

    float qx = preferences.getFloat("qx_"+number, 0.0f);

    float qy = preferences.getFloat("qy_"+number, 0.0f);

    float qz = preferences.getFloat("qz_"+number, 0.0f);

    float qw = preferences.getFloat("qw_"+number, 1.0f);

    mQuatScramble.set(qx,qy,qz,qw);

    modifyCurrentPosition( mCurrentPosition, mQuatScramble);

    }

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

  long finishRotationNow(EffectListener listener)

    {

    int pointNum = mRotationAngle.getNumPoints();

    if( pointNum>=1 )

      {

      float startingAngle = mRotationAngle.getPoint(pointNum-1).get0();

      int nearestAngleInDegrees = computeNearestAngle(startingAngle);

      mParent.mRotationAngleStatic.set0(startingAngle);

      mParent.mRotationAngleFinal.set0(nearestAngleInDegrees);

      mParent.mRotationAngleMiddle.set0( nearestAngleInDegrees + (nearestAngleInDegrees-startingAngle)*0.2f );

      return setUpCallback(listener);

      }

    return 0;

    }

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

  Static4D returnRotationQuat(int axis)

    {

    int pointNum = mRotationAngle.getNumPoints();

    if( pointNum>=1 )

      {

      float axisX = mParent.ROTATION_AXIS[axis].get0();

      float axisY = mParent.ROTATION_AXIS[axis].get1();

      float axisZ = mParent.ROTATION_AXIS[axis].get2();

      float startingAngle = mRotationAngle.getPoint(pointNum-1).get0();

      int nearestAngleInDegrees = computeNearestAngle(startingAngle);

      double nearestAngleInRadians = nearestAngleInDegrees*Math.PI/180;

      float sinA =-(float)Math.sin(nearestAngleInRadians*0.5);

      float cosA = (float)Math.cos(nearestAngleInRadians*0.5);

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

      }

    return null;

    }

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

  void removeRotationNow(Static4D quat)

    {

    mRotationAngle.removeAll();

    mQuatScramble.set(RubikSurfaceView.quatMultiply(quat,mQuatScramble));

    normalizeScrambleQuat( mQuatScramble );

    modifyCurrentPosition( mCurrentPosition,quat);

    }

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

// all DistortedTextures, DistortedNodes, DistortedFramebuffers, DistortedScreens and all types of

// Meshes HAVE TO be markedForDeletion when they are no longer needed- otherwise we have a major

// memory leak.

  void releaseResources()

    {

    mMesh.markForDeletion();

    mNode.markForDeletion();

    }

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

  void solve()

    {

    mQuatScramble.set(0,0,0,1);

    mCurrentPosition.set(mOrigPosition);

    computeRotationRow();

    }

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

  void beginNewRotation(int axis)

    {

    mRotationAxis.set( mParent.ROTATION_AXIS[axis] );

    mRotationAngle.add(mParent.mRotationAngleStatic);

    }

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

  void addNewRotation(int axis, long durationMillis, int angle)

    {

    mRotationAxis.set( mParent.ROTATION_AXIS[axis] );

    mRotationAngle.setDuration(durationMillis);

    mRotationAngle.resetToBeginning();

    mRotationAngle.add(new Static1D(0));

    mRotationAngle.add(new Static1D(angle));

    }

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

  long setUpCallback(EffectListener listener)

    {

    mRotateEffect.notifyWhenFinished(listener);

    return mRotateEffect.getID();

    }

}