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

import android.content.SharedPreferences;

import android.graphics.Bitmap;

import android.graphics.Canvas;

import android.graphics.Paint;

import org.distorted.library.effect.Effect;

import org.distorted.library.effect.MatrixEffectQuaternion;

import org.distorted.library.effect.MatrixEffectScale;

import org.distorted.library.effect.VertexEffectSink;

import org.distorted.library.main.DistortedEffects;

import org.distorted.library.main.DistortedNode;

import org.distorted.library.main.DistortedTexture;

import org.distorted.library.mesh.MeshBase;

import org.distorted.library.mesh.MeshRectangles;

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 static org.distorted.magic.RubikRenderer.NODE_FBO_SIZE;

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

public abstract class RubikObject extends DistortedNode

  {

  static final int TEXTURE_HEIGHT = 128;

  final float[] LEGAL_QUATS;

  final Static3D[] ROTATION_AXIS;

  static float OBJECT_SCREEN_RATIO;

  private static final int POST_ROTATION_MILLISEC = 500;

  private final int NUM_CUBITS;

  private int mRotRow;

  private int mRotAxis;

  private Static3D[] mOrigPos;

  private Static3D mScale, mNodeScale;

  private Static4D mQuatAccumulated;

  private Cubit[] mCubits;

  private int mSize;

  float mStart, mStep;

  Static1D mRotationAngleStatic, mRotationAngleMiddle, mRotationAngleFinal;

  DistortedTexture mTexture;

  VertexEffectSink mSinkEffect;

  MatrixEffectScale mScaleEffect;

  MatrixEffectQuaternion mQuatCEffect;

  MatrixEffectQuaternion mQuatAEffect;

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

  RubikObject(int size, Static4D quatCur, Static4D quatAcc, DistortedTexture nodeTexture, MeshRectangles nodeMesh, DistortedEffects nodeEffects)

    {

    super(nodeTexture,nodeEffects,nodeMesh);

    resizeFBO(NODE_FBO_SIZE, NODE_FBO_SIZE);

    mOrigPos = getCubitPositions(size);

    LEGAL_QUATS = getLegalQuats();

    NUM_CUBITS  = mOrigPos.length;

    ROTATION_AXIS = getRotationAxis();

    OBJECT_SCREEN_RATIO = getScreenRatio();

    mSize = size;

    computeStartAndStep(mOrigPos);

    mRotationAngleStatic = new Static1D(0);

    mRotationAngleMiddle = new Static1D(0);

    mRotationAngleFinal  = new Static1D(0);

    mScale    = new Static3D(1,1,1);

    mNodeScale= new Static3D(1,1,1);

    mQuatAccumulated = quatAcc;

    Static3D center = new Static3D(0,0,0);

    mSinkEffect  = getSink(mSize);

    mScaleEffect = new MatrixEffectScale(mScale);

    mQuatCEffect = new MatrixEffectQuaternion(quatCur, center);

    mQuatAEffect = new MatrixEffectQuaternion(quatAcc, center);

    MatrixEffectScale nodeScaleEffect = new MatrixEffectScale(mNodeScale);

    nodeEffects.apply(nodeScaleEffect);

    mCubits = new Cubit[NUM_CUBITS];

    mTexture = new DistortedTexture();

    int vertices = (int)(24.0f/mSize + 2.0f);

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

      {

      MeshBase cubitMesh = createCubitMesh(i,vertices);

      mCubits[i] = new Cubit(this,cubitMesh,mOrigPos[i]);

      textureCubitMesh(cubitMesh,i);

      attach(mCubits[i].mNode);

      }

    setProjection(30, 0.1f);

    }

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

  private void textureCubitMesh(MeshBase mesh, int cubit)

    {

    boolean belongs;

    final int numFaces = getNumFaces();

    final Static4D[] maps = new Static4D[numFaces];

    final float ratio = 1.0f/(numFaces+1);

    if( 2*ROTATION_AXIS.length == numFaces )  // i.e. there are faces on both ends of the axis (cube)

      {

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

        {

        belongs = isOnFace(cubit, i/2, i%2==0 ? mSize-1:0 );

        maps[i] = new Static4D( (belongs?i:6)*ratio, 0.0f, ratio, 1.0f);

        }

      }

    else if( ROTATION_AXIS.length == numFaces )  // just a single face on the right end of an axis (pyraminx)

      {

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

        {

        belongs = isOnFace(cubit, i, 0 );

        maps[i] = new Static4D( (belongs?i:6)*ratio, 0.0f, ratio, 1.0f);

        }

      }

    mesh.setTextureMap(maps);

    }

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

// Cast centers of all Cubits on the first rotation Axis and compute the leftmost and rightmost

// one. From there compute the 'start' (i.e. the leftmost) and 'step' (i.e. distance between two

// consecutive).

// it is assumed that other rotation axis have the same 'start' and 'step' - this is the case with

// the Cube and the Pyraminx.

// Start and Step are then needed to compute which rotation row (with respect to a given axis) a

// given Cubit belongs to.

  private void computeStartAndStep(Static3D[] pos)

    {

    float min = Float.MAX_VALUE;

    float max = Float.MIN_VALUE;

    float axisX = ROTATION_AXIS[0].get0();

    float axisY = ROTATION_AXIS[0].get1();

    float axisZ = ROTATION_AXIS[0].get2();

    float tmp;

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

      {

      tmp = pos[i].get0()*axisX + pos[i].get1()*axisY + pos[i].get2()*axisZ;

      if( tmp<min ) min=tmp;

      if( tmp>max ) max=tmp;

      }

    mStart = min;

    mStep  = (max-min+1.0f)/mSize;

    }

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

  private boolean belongsToRotation( int cubit, int axis, int row)

    {

    return ((int)(mCubits[cubit].mRotationRow[axis]+0.5f))==row;

    }

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

// we cannot use belongsToRotation for deciding if to texture a face. Counterexample: the 'rotated'

// tetrahedrons of Pyraminx nearby the edge: they belong to rotation but their face which is rotated

// away from the face of the Pyraminx shouldn't be textured.

  private boolean isOnFace( int cubit, int axis, int row)

    {

    final float MAX_ERROR = 0.0001f;

    float diff = mCubits[cubit].mRotationRow[axis] - row;

    return diff*diff < MAX_ERROR;

    }

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

  private void resetRotationAngle(Dynamic1D rotationAngle)

    {

    rotationAngle.setDuration(POST_ROTATION_MILLISEC);

    rotationAngle.resetToBeginning();

    rotationAngle.removeAll();

    rotationAngle.add(mRotationAngleStatic);

    rotationAngle.add(mRotationAngleMiddle);

    rotationAngle.add(mRotationAngleFinal);

    }

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

// Clamp all rotated positions to one of those original ones to avoid accumulating errors.

  void clampPos(Static3D pos)

    {

    float currError, minError = Float.MAX_VALUE;

    int minErrorIndex= -1;

    float x = pos.get0();

    float y = pos.get1();

    float z = pos.get2();

    float xo,yo,zo;

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

      {

      xo = mOrigPos[i].get0();

      yo = mOrigPos[i].get1();

      zo = mOrigPos[i].get2();

      currError = (xo-x)*(xo-x) + (yo-y)*(yo-y) + (zo-z)*(zo-z);

      if( currError<minError )

        {

        minError = currError;

        minErrorIndex = i;

        }

      }

    pos.set( mOrigPos[minErrorIndex] );

    }

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

// the getFaceColors + final black in a horizontal strip.

  public void createTexture()

    {

    Bitmap bitmap;

    final int numColors = getNumFaces();

    Paint paint = new Paint();

    bitmap = Bitmap.createBitmap( (numColors+1)*TEXTURE_HEIGHT, TEXTURE_HEIGHT, Bitmap.Config.ARGB_8888);

    Canvas canvas = new Canvas(bitmap);

    paint.setAntiAlias(true);

    paint.setTextAlign(Paint.Align.CENTER);

    paint.setStyle(Paint.Style.FILL);

    paint.setColor(0xff000000);

    canvas.drawRect(0, 0, (numColors+1)*TEXTURE_HEIGHT, TEXTURE_HEIGHT, paint);

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

      {

      createFaceTexture(canvas,paint,i);

      }

    mTexture.setTexture(bitmap);

    }

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

  public int getSize()

    {

    return mSize;

    }

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

  public void continueRotation(float angleInDegrees)

    {

    mRotationAngleStatic.set0(angleInDegrees);

    }

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

  public Static4D getRotationQuat()

      {

      return mQuatAccumulated;

      }

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

  public void recomputeScaleFactor(int scrWidth, int scrHeight)

    {

    float factor = Math.min(scrWidth,scrHeight);

    float scaleFactor = OBJECT_SCREEN_RATIO*NODE_FBO_SIZE/mSize;

    mNodeScale.set(factor,factor,factor);

    mScale.set(scaleFactor,scaleFactor,scaleFactor);

    }

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

  public void savePreferences(SharedPreferences.Editor editor)

    {

    for(int i=0; i<NUM_CUBITS; i++) mCubits[i].savePreferences(editor);

    }

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

  public void restorePreferences(SharedPreferences preferences)

    {

    for(int i=0; i<NUM_CUBITS; i++) mCubits[i].restorePreferences(preferences);

    }

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

  public long finishRotationNow(EffectListener listener)

    {

    boolean first = true;

    long effectID=0;

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

      {

      if( belongsToRotation(i,mRotAxis,mRotRow) )

        {

        if( first )

          {

          first=false;

          effectID = mCubits[i].finishRotationNow(listener);

          }

        resetRotationAngle(mCubits[i].mRotationAngle);

        }

      }

    return effectID;

    }

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

  public void releaseResources()

    {

    mTexture.markForDeletion();

    for(int i=0; i<NUM_CUBITS; i++) mCubits[i].releaseResources();

    }

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

  public void apply(Effect effect, int position)

    {

    for(int i=0; i<NUM_CUBITS; i++) mCubits[i].mEffect.apply(effect, position);

    }

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

  public void remove(long effectID)

    {

    for(int i=0; i<NUM_CUBITS; i++) mCubits[i].mEffect.abortById(effectID);

    }

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

  public void solve()

    {

    for(int i=0; i<NUM_CUBITS; i++) mCubits[i].solve();

    }

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

  public boolean isSolved()

    {

    Static4D q = mCubits[0].mQuatScramble;

    float x = q.get0();

    float y = q.get1();

    float z = q.get2();

    float w = q.get3();

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

      {

      q = mCubits[i].mQuatScramble;

      if( q.get0()!=x || q.get1()!=y || q.get2()!=z || q.get3()!=w ) return false;

      }

    return true;

    }

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

  public void beginNewRotation(int axis, int row )

    {

    if( axis<0 || axis>=ROTATION_AXIS.length )

      {

      android.util.Log.e("object", "invalid rotation axis: "+axis);

      return;

      }

    if( row<0 || row>=mSize )

      {

      android.util.Log.e("object", "invalid rotation row: "+row);

      return;

      }

    //android.util.Log.e("object", "beginning new rotation: axis: "+axis+" row: "+row);

    mRotAxis = axis;

    mRotRow  = row;

    mRotationAngleStatic.set0(0.0f);

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

      if( belongsToRotation(i,mRotAxis,mRotRow) )

        {

        mCubits[i].beginNewRotation(axis);

        }

     }

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

  public long addNewRotation( int axis, int row, int angle, long durationMillis, EffectListener listener )

     {

     long effectID=0;

     boolean first = true;

     mRotAxis = axis;

     mRotRow  = row;

     mRotationAngleStatic.set0(0.0f);

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

       if( belongsToRotation(i,mRotAxis,mRotRow) )

         {

         mCubits[i].addNewRotation(axis,durationMillis,angle);

         if( first )

           {

           first = false;

           effectID = mCubits[i].setUpCallback(listener);

           }

         }

     return effectID;

     }

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

  public void removeRotationNow()

     {

     boolean first = true;

     Static4D quat = null;

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

       if( belongsToRotation(i,mRotAxis,mRotRow) )

         {

         if( first )

           {

           first = false;

           quat = mCubits[i].returnRotationQuat(mRotAxis);

           }

         mCubits[i].removeRotationNow(quat);

         }

     mRotationAngleStatic.set0(0);

     }

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

  abstract float getScreenRatio();

  abstract VertexEffectSink getSink(int size);

  abstract Static3D[] getCubitPositions(int size);

  abstract float[] getLegalQuats();

  abstract int getNumFaces();

  abstract void createFaceTexture(Canvas canvas, Paint paint, int face);

  abstract MeshBase createCubitMesh(int cubit, int vertices);

  public abstract Static3D[] getRotationAxis();

  public abstract int getBasicAngle();

  public abstract int returnRowFromOffset(float offset);

  }