TwistyPuzzleLib

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

// Copyright 2020 Leszek Koltunski                                                               //

//                                                                                               //

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

//                                                                                               //

// Magic Cube is proprietary software licensed under an EULA which you should have received      //

// along with the code. If not, check https://distorted.org/magic/License-Magic-Cube.html        //

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

package org.distorted.objectlib.main;

import java.io.DataInputStream;

import java.io.IOException;

import java.io.InputStream;

import java.util.Random;

import android.graphics.Bitmap;

import android.graphics.Canvas;

import android.graphics.Paint;

import org.distorted.library.effect.Effect;

import org.distorted.library.effect.MatrixEffectMove;

import org.distorted.library.effect.MatrixEffectQuaternion;

import org.distorted.library.effect.MatrixEffectScale;

import org.distorted.library.effect.VertexEffectQuaternion;

import org.distorted.library.effect.VertexEffectSink;

import org.distorted.library.main.DistortedEffects;

import org.distorted.library.main.DistortedLibrary;

import org.distorted.library.main.DistortedNode;

import org.distorted.library.main.DistortedTexture;

import org.distorted.library.helpers.QuatHelper;

import org.distorted.library.mesh.MeshBase;

import org.distorted.library.mesh.MeshFile;

import org.distorted.library.mesh.MeshJoined;

import org.distorted.library.message.EffectListener;

import org.distorted.library.type.Static1D;

import org.distorted.library.type.Static3D;

import org.distorted.library.type.Static4D;

import org.distorted.objectlib.helpers.FactoryCubit;

import org.distorted.objectlib.helpers.FactorySticker;

import org.distorted.objectlib.helpers.ObjectFaceShape;

import org.distorted.objectlib.helpers.ObjectLibInterface;

import org.distorted.objectlib.helpers.ObjectShape;

import org.distorted.objectlib.metadata.Metadata;

import org.distorted.objectlib.signature.ObjectSignature;

import org.distorted.objectlib.helpers.ObjectSticker;

import org.distorted.objectlib.helpers.ObjectStickerOverride;

import org.distorted.objectlib.helpers.ObjectVertexEffects;

import org.distorted.objectlib.helpers.OperatingSystemInterface;

import org.distorted.objectlib.helpers.QuatGroupGenerator;

import org.distorted.objectlib.scrambling.ObjectScrambler;

import org.distorted.objectlib.json.JsonReader;

import org.distorted.objectlib.scrambling.ScrambleEdgeGenerator;

import org.distorted.objectlib.tablebases.ImplementedTablebasesList;

import org.distorted.objectlib.tablebases.TablebasesAbstract;

import org.distorted.objectlib.touchcontrol.*;

import static org.distorted.objectlib.touchcontrol.TouchControl.*;

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

public abstract class TwistyObject

  {

  public static final int MODE_ICON = 0;

  public static final int MODE_NORM = 1;

  public static final int COLOR_YELLOW   = 0xffffff00;

  public static final int COLOR_WHITE    = 0xffffffff;

  public static final int COLOR_BLUE     = 0xff0000ff;

  public static final int COLOR_GREEN    = 0xff00bb00;

  public static final int COLOR_RED      = 0xff990000;

  public static final int COLOR_ORANGE   = 0xffff6200;

  public static final int COLOR_GREY     = 0xff727c7b;

  public static final int COLOR_VIOLET   = 0xff7700bb;

  public static final int COLOR_STROKE   = 0xff000000;

  public static final int COLOR_INTERNAL = 0xff000000;

  public static final int COLOR_RED_TET  = 0xffff1111;

  public static final int COLOR_BLUE_TET = 0xff4444ff;

  private static final int DEFAULT_TEXTURE_HEIGHT = 256;

  private static final int DEFAULT_TEXTURE_ROWS   = 8;

  public static final float SQ2 = (float)Math.sqrt(2);

  public static final float SQ3 = (float)Math.sqrt(3);

  public static final float SQ5 = (float)Math.sqrt(5);

  public static final float SQ6 = (float)Math.sqrt(6);

  private static final float MAX_SIZE_CHANGE = 1.35f;

  private static final float MIN_SIZE_CHANGE = 0.75f;

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

  protected float[][][][] mStickerCoords;

  protected Static4D[] mObjectQuats;

  private int[][] mStickerVariants;

  private float[] mStickerScales;

  private TwistyObjectCubit[] mCubits;

  private TwistyObjectSolved mSolved;

  private MeshBase[] mMeshes;

  private int mNumCubits, mNumQuats, mNumFaceColors, mNumTextures, mNumOverrides;

  private int mNumCubitFaces, mNumStickerTypes;

  private Static3D[] mAxis;

  private float[][] mCuts;

  private int[][] mMinimalCubiesInRow;

  private int[] mNumCuts;

  private float[][] mOrigPos;

  private Static4D[] mOrigQuat;

  private Static4D[] mMixupModeQuats;

  private boolean mIsInMixupMode;

  private Static4D mQuat;

  private int[] mNumLayers;

  private float mSize;

  private DistortedEffects mEffects;

  private Static3D mObjectScale;

  private int[] mQuatDebug;

  private DistortedTexture mTexture;

  private float mInitScreenRatio;

  private boolean mIsBandaged;

  private float mObjectScreenRatio;

  private int mNumTexRows, mNumTexCols, mTexHeight;

  private MeshBase mMesh;

  private ObjectScrambler mScrambler;

  private TouchControl mTouchControl;

  private DistortedNode mNode;

  private ObjectLibInterface mInterface;

  private Bitmap mBitmap;

  private ObjectSticker[] mStickers;

  private ObjectShape[] mShapes;

  private int mNumCubitVariants;

  private int[][] mCubitFaceColors;

  private int[][] mVariantFaceIsOuter;

  private int[][] mBasicAngles;

  private int mIconMode;

  private Metadata mMetadata;

  private float[][] mRowOffsets;

  private boolean[] mBelongs;

  private float[] mTmp;

  private int mNumPuzzleFaces;

  private ObjectStickerOverride[] mStickerOverrides;

  private boolean mError;

  private String mErrorString;

  private int mMaxNumLayers;

  private int mNumAxis;

  private boolean mThereAreDeciders;

  private TwistyLayerRotations mRotation;

  private int[] mColorTable;

  private int[] mOriginalColorTable;

  private float mTextureBorderMultiplier, mTextureCornerMultiplier;

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

  TwistyObject(int iconMode, Static4D quat, Static3D move, float scale, InitAssets asset)

    {

    try

      {

      InputStream jsonStream = asset!=null ? asset.getJsonStream(): null;

      JsonReader reader = new JsonReader();

      reader.parseJsonFile(jsonStream);

      setReader(reader);

      mNumLayers = reader.getNumLayers();

      mSize      = reader.getSize();

      mMetadata  = null;

      initialize(iconMode,quat,move,scale,asset,true);

      if( asset!=null ) asset.close();

      mError = false;

      mErrorString=null;

      }

    catch(Exception ex)

      {

      mError = true;

      mErrorString = ex.getMessage();

      }

    }

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

  public TwistyObject(int iconMode, float size, Static4D quat, Static3D move, float scale, Metadata meta, InitAssets asset)

    {

    mNumLayers = meta.getNumLayers();

    mSize      = size;

    mMetadata  = meta;

    initialize(iconMode,quat,move,scale,asset,false);

    if( asset!=null ) asset.close();

    mError = false;

    mErrorString = null;

    }

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

  private void debugQuat(Static4D quat, int cubitIndex, float axisX, float axisY, float axisZ, float angle, int place)

    {

    float[] tracking = mCubits[cubitIndex].getTrackingPoint();

    if( tracking!=null )

      {

      String problem = (getShortName()+" "+cubitIndex+" "+quat.get0()+" "+quat.get1()+" "+quat.get2()+" "+quat.get3());

      problem += (" "+angle+" "+place+" "+tracking[0]+" "+tracking[1]+" "+tracking[2]);

      problem += (" "+axisX+" "+axisY+" "+axisZ);

      mInterface.reportProblem(problem, true);

      }

    }

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

  private void initialize(int iconMode, Static4D quat, Static3D move, float scale, InitAssets asset, boolean fromJSON)

    {

    mIconMode = iconMode;

    mQuat = quat;

    mAxis = getRotationAxis();

    mInitScreenRatio = getScreenRatio();

    mBasicAngles = getBasicAngles();

    mObjectQuats = getQuats();

    mNumQuats = mObjectQuats.length;

    mOrigPos = getCubitPositions(mNumLayers);

    mNumPuzzleFaces = getNumPuzzleFaces();

    mRowOffsets = new float[mNumPuzzleFaces][3];

    mTmp = new float[4];

    mNumAxis = mAxis.length;

    mCuts = getCuts(mNumLayers);

    mNumCuts = new int[mNumAxis];

    mMaxNumLayers = -1;

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

      {

      if( mMaxNumLayers<mNumLayers[i] ) mMaxNumLayers = mNumLayers[i];

      mNumCuts[i] = (mCuts==null || mCuts[i]==null ? 0 : mCuts[i].length);

      }

    mOriginalColorTable = getColorTable();

    mNumFaceColors = mOriginalColorTable.length;

    mColorTable = new int[mNumFaceColors];

    recreateFaceColors();

    mTextureBorderMultiplier = 1.0f;

    mTextureCornerMultiplier = 1.0f;

    mMinimalCubiesInRow = getMinimalCubiesInRow();

    mNumCubits = mOrigPos.length;

    mBelongs = new boolean[mNumCubits];

    int scramblingType = getScrambleType();

    int[][] edges = getScrambleEdges();

    int[][] algorithms = getScrambleAlgorithms();

    OperatingSystemInterface os = asset==null ? null : asset.getOS();

    TablebasesAbstract tablebase = os!=null ? getTablebase(os) : null;

    mScrambler = new ObjectScrambler(scramblingType,mNumAxis,mNumLayers,algorithms,edges,tablebase);

    boolean bandaged=false;

    for( int c=0; c<mNumCubits; c++)

      {

      if( mOrigPos[c].length>3 )

        {

        bandaged=true;

        break;

        }

      }

    mIsBandaged = bandaged;

    mQuatDebug = new int[mNumCubits];

    mObjectScale = new Static3D(scale,scale,scale);

    setObjectRatioNow(scale,720);

    mEffects = new DistortedEffects();

    createQuaternionEffects();

    mRotation = new TwistyLayerRotations(this,mAxis,mNumLayers,getGhostAngle(),mEffects);

    MatrixEffectScale scaleEffect = new MatrixEffectScale(mObjectScale);

    MatrixEffectQuaternion quatEffect = new MatrixEffectQuaternion(mQuat, CENTER);

    MatrixEffectMove moveEffect = new MatrixEffectMove(move);

    InputStream meshStream = asset!=null ? asset.getMeshStream(): null;

    boolean fromDMESH = (meshStream!=null);

    getQuatsAndShapes(fromDMESH,fromJSON);

    createMeshAndCubits(meshStream,fromDMESH);

    setUpTextures(fromDMESH,fromJSON);

    int index = getSolvedFunctionIndex();

    mSolved = new TwistyObjectSolved(this,mOrigPos,index);

    mSolved.setupSolvedQuats(getSolvedQuats());

    mSolved.setPuzzleFaceColor(mColorTable);

    mEffects.apply(quatEffect);

    mEffects.apply(scaleEffect);

    mEffects.apply(moveEffect);

    mNode = new DistortedNode(mTexture,mEffects,mMesh);

    }

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

  public void recreateFaceColors()

    {

    for(int i=0; i<mNumFaceColors; i++) mColorTable[i] = mOriginalColorTable[i];

    }

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

// in degrees so that everything can be treated modulo 360

  public int getGhostAngle()

    {

    return 0;

    }

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

  private TablebasesAbstract getTablebase(OperatingSystemInterface os)

    {

    String shortName = getShortName();

    return ImplementedTablebasesList.createPacked(os,shortName);

    }

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

  private void createQuaternionEffects()

    {

    if( mNumQuats<=ObjectControl.MAX_QUATS )

      {

      mIsInMixupMode = false;

      for( int q=0; q<mNumQuats; q++)

        {

        VertexEffectQuaternion vq = new VertexEffectQuaternion(mObjectQuats[q],CENTER);

        vq.setMeshAssociation(0,q);

        mEffects.apply(vq);

        }

      }

    else if( mNumCubits<=ObjectControl.MAX_QUATS )

      {

      mIsInMixupMode = true;

      mMixupModeQuats = new Static4D[mNumCubits];

      for( int q=0; q<mNumCubits; q++)

        {

        mMixupModeQuats[q] = new Static4D(mObjectQuats[0]);

        VertexEffectQuaternion vq = new VertexEffectQuaternion(mMixupModeQuats[q],CENTER);

        vq.setMeshAssociation(0,q);

        mEffects.apply(vq);

        }

      }

    else

      {

      android.util.Log.e("D", "object has too many quaternions ("+mNumQuats+") or too many cubits ("+mNumCubits+")");

      }

    }

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

  private Static3D getPos(float[] origPos)

    {

    int len = origPos.length/3;

    float sumX = 0.0f;

    float sumY = 0.0f;

    float sumZ = 0.0f;

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

      {

      sumX += origPos[3*i  ];

      sumY += origPos[3*i+1];

      sumZ += origPos[3*i+2];

      }

    sumX /= len;

    sumY /= len;

    sumZ /= len;

    return new Static3D(sumX,sumY,sumZ);

    }

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

  private void createOuterFaces()

    {

    for(int v=0; v<mNumCubitVariants; v++)

      {

      int numFaces = mShapes[v].getNumFaces();

      mVariantFaceIsOuter[v] = new int[numFaces];

      }

    for( int cubit=0; cubit<mNumCubits; cubit++)

      {

      int variant = getCubitVariant(cubit,mNumLayers);

      int numFaces = mShapes[variant].getNumFaces();

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

        if( getCubitFaceColor(cubit,face)>=0 )

          {

          mVariantFaceIsOuter[variant][face] = 1;

          }

      }

    }

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

  private void getQuatsAndShapes(boolean fromDMESH, boolean fromJSON)

    {

    mNumCubitVariants = getNumCubitVariants(mNumLayers);

    if( !fromDMESH || !fromJSON )

      {

      FactoryCubit factory = FactoryCubit.getInstance();

      factory.clear();

      mShapes = new ObjectShape[mNumCubitVariants];

      for(int v=0; v<mNumCubitVariants; v++) mShapes[v] = getObjectShape(v);

      mNumCubitFaces = ObjectShape.computeNumComponents(mShapes);

      mVariantFaceIsOuter = new int[mNumCubitVariants][];

      mOrigQuat = new Static4D[mNumCubits];

      for(int i=0; i<mNumCubits; i++) mOrigQuat[i] = getCubitQuats(i,mNumLayers);

      if( !fromJSON )

        {

        mCubitFaceColors = ObjectShape.computeColors(mShapes,mOrigPos,mOrigQuat,this);

        createOuterFaces();

        }

      if( fromDMESH )

        {

        for(int i=0; i<mNumCubitVariants; i++) factory.createNewFaceTransform(mShapes[i], mVariantFaceIsOuter[i]);

        }

      }

    }

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

  private void createMeshAndCubits(InputStream stream, boolean fromDMESH)

    {

    mCubits = new TwistyObjectCubit[mNumCubits];

    if( fromDMESH )

      {

      DataInputStream dos = new DataInputStream(stream);

      mMesh = new MeshFile(dos);

      try

        {

        stream.close();

        }

      catch(IOException e)

        {

        android.util.Log.e("meshFile", "Error closing InputStream: "+e);

        }

      }

    else

      {

      MeshBase[] cubitMesh = new MeshBase[mNumCubits];

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

        {

        cubitMesh[i] = createCubitMesh(i,mNumLayers,mNumCubitFaces);

        Static3D pos = getPos(mOrigPos[i]);

        cubitMesh[i].apply(new MatrixEffectMove(pos),1,0);

        }

      mMesh = new MeshJoined(cubitMesh);

      float pillowCoeff = getPillowCoeff();

      if( pillowCoeff!=1.0f )

        {

        float radius = getCircumscribedRadius();

        Static1D coeff = new Static1D(pillowCoeff);

        Static4D region= new Static4D(0,0,0,radius);

        VertexEffectSink sink = new VertexEffectSink(coeff,CENTER,region);

        mMesh.apply(sink);

        }

      }

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

      {

      mCubits[i] = new TwistyObjectCubit(this,mOrigPos[i],mNumAxis,mMaxNumLayers,i);

      setCubitQuat(i,0);

      if( !mThereAreDeciders && mCubits[i].getType()==TwistyObjectCubit.TYPE_DECIDER )

        {

        mThereAreDeciders = true;

        }

      }

    }

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

  private MeshBase createCubitMesh(int cubit, int[] numLayers, int numComponents)

    {

    int variant = getCubitVariant(cubit,numLayers);

    if( mMeshes==null ) mMeshes = new MeshBase[mNumCubitVariants];

    if( mMeshes[variant]==null )

      {

      ObjectFaceShape faceShape = getObjectFaceShape(variant);

      ObjectVertexEffects effects = getVertexEffects(variant);

      FactoryCubit factory = FactoryCubit.getInstance();

      factory.createNewFaceTransform(mShapes[variant],mVariantFaceIsOuter[variant]);

      mMeshes[variant] = factory.createRoundedSolid(mShapes[variant],faceShape,effects,numComponents);

      }

    MeshBase mesh = mMeshes[variant].copy(true);

    MatrixEffectQuaternion quat = new MatrixEffectQuaternion( mOrigQuat[cubit], CENTER );

    mesh.apply(quat,0xffffffff,0);

    return mesh;

    }

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

  private void figureOutBitmapDimensions(int numTextures)

    {

    int maxSize = DistortedLibrary.getMaxTextureSize();

    mTexHeight  = DEFAULT_TEXTURE_HEIGHT;

    while(true)

      {

      mNumTexCols = DEFAULT_TEXTURE_ROWS;

      mNumTexRows = numTextures/mNumTexCols + 1;

      if( mNumTexRows*mTexHeight <= maxSize &&

          mNumTexCols*mTexHeight <= maxSize  ) break;

      mTexHeight/=2;

      }

    }

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

  private void setUpTextures(boolean fromDMESH, boolean fromJSON)

    {

    mTexture = new DistortedTexture();

    if( fromJSON )

      {

      mNumStickerTypes = getNumStickerTypes();

      mNumCubitFaces = getNumCubitFaces();

      }

    else

      {

      FactoryCubit factory = FactoryCubit.getInstance();

      mStickerCoords   = factory.getStickerCoords();

      mStickerVariants = factory.getStickerVariants();

      mStickerScales   = factory.getStickerScales();

      adjustStickerCoords();

      mNumStickerTypes = (mStickerCoords==null ? 0 : mStickerCoords.length);

      }

    mStickerOverrides = getStickerOverrides();

    mNumOverrides = mStickerOverrides==null ? 0 : mStickerOverrides.length;

    mNumTextures= mNumFaceColors*mNumStickerTypes + mNumOverrides;

    figureOutBitmapDimensions(mNumTextures);

    if( mNumTexCols*mNumTexRows < mNumTextures+1 ) mNumTexRows++;

    if( !fromDMESH || shouldResetTextureMaps() ) resetAllTextureMaps();

    else overrideCubitFaceColor();

    setTexture();

    }

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

  public Metadata getMetadata()

    {

    return mMetadata;

    }

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

  public boolean isInIconMode()

    {

    return mIconMode==MODE_ICON;

    }

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

  public int getVariantStickerShape(int variant, int face)

    {

    if( variant <mStickerVariants.length )

      {

      int[] var = mStickerVariants[variant];

      return face>=var.length ? -1 : var[face];

      }

    return -1;

    }

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

  public boolean shouldResetTextureMaps()

    {

    return false;

    }

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

  public int[][] getScrambleAlgorithms()

    {

    return ScrambleEdgeGenerator.getScramblingAlgorithms(mBasicAngles);

    }

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

  private boolean sticksOut(Static3D[] faceAxis, float[] dist, float x, float y, float z )

    {

    final float MAXERR = 0.05f;

    int numAxis = dist.length;

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

      {

      Static3D ax = faceAxis[i];

      float len = ax.get0()*x + ax.get1()*y + ax.get2()*z;

      if( len>mSize*dist[i]+MAXERR ) return true;

      }

    return false;

    }

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

  private boolean doesNotStickOut(int variant, float px, float py, float pz, float[] tmp, Static4D quat)

    {

    float[][] vertices = mShapes[variant].getVertices();

    Static3D[] axis = getFaceAxis();

    float[] dist3D = getDist3D(mNumLayers);

    for( float[] vertex : vertices)

      {

      float x = vertex[0];

      float y = vertex[1];

      float z = vertex[2];

      QuatHelper.rotateVectorByQuat(tmp, x, y, z, 1, quat);

      float mx = tmp[0] + px;

      float my = tmp[1] + py;

      float mz = tmp[2] + pz;

      if( sticksOut(axis, dist3D, mx,my,mz) ) return false;

      }

    return true;

    }

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

  private float computeAvg(float[] pos, int offset)

    {

    int len = pos.length/3;

    float ret=0.0f;

    for(int i=0; i<len; i++) ret += pos[3*i+offset];

    ret /= len;

    return ret;

    }

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

  protected void displayCubitQuats()

    {

    StringBuilder builder = new StringBuilder();

    float[] tmp = new float[4];

    float ERR = 0.01f;

    for(int cubit=0; cubit<mNumCubits; cubit++)

      {

      builder.append(cubit);

      builder.append(" : ");

      int refCubit,variant = getCubitVariant(cubit,mNumLayers);

      for(refCubit=0; refCubit<mNumCubits; refCubit++)

        {

        if( getCubitVariant(refCubit,mNumLayers)==variant ) break;

        }

      float[] curpos = mOrigPos[cubit];

      float[] refpos = mOrigPos[refCubit];

      float refX = computeAvg(refpos,0);

      float refY = computeAvg(refpos,1);

      float refZ = computeAvg(refpos,2);

      float curX = computeAvg(curpos,0);

      float curY = computeAvg(curpos,1);

      float curZ = computeAvg(curpos,2);

      for(int quat=0; quat<mNumQuats; quat++)

        {

        QuatHelper.rotateVectorByQuat(tmp,refX,refY,refZ,0,mObjectQuats[quat]);

        float dx = tmp[0]-curX;

        float dy = tmp[1]-curY;

        float dz = tmp[2]-curZ;

        if( dx>-ERR && dx<ERR && dy>-ERR && dy<ERR && dz>-ERR && dz<ERR )

          {

          if( doesNotStickOut(variant,curX,curY,curZ,tmp,mObjectQuats[quat]) )

            {

            builder.append(quat);

            builder.append(',');

            }

          else

            {

            android.util.Log.e("D", "cubit: "+cubit+" quat: "+quat+" : center correct, but shape sticks out");

            }

          }

        }

      builder.append('\n');

      }

    android.util.Log.e("D", "cubitQuats: \n"+builder );

    }

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

  public int getCubitRotationType(int cubit)

    {

    return TwistyObjectCubit.TYPE_NORMAL;

    }

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

  float[] getTrackingPoint(int cubitIndex, int cubitType)

    {

    if( cubitType!=TwistyObjectCubit.TYPE_NORMAL )

      {

      int variant = getCubitVariant(cubitIndex,mNumLayers);

      // object must have been created from JSON

      if( mVariantFaceIsOuter==null || mVariantFaceIsOuter[variant]==null )

        {

        mVariantFaceIsOuter = getVariantFaceIsOuter();

        }

      if( mShapes==null )

        {

        mShapes = new ObjectShape[mNumCubitVariants];

        }

      if( mShapes[variant]==null )

        {

        mShapes[variant] = getObjectShape(variant);

        }

      if( mOrigQuat==null )

        {

        mOrigQuat = new Static4D[mNumCubits];

        }

      if( mOrigQuat[cubitIndex]==null )

        {

        mOrigQuat[cubitIndex] = getCubitQuats(cubitIndex,mNumLayers);

        }

      int outer=-1, faces = mShapes[variant].getNumFaces();

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

        {

        if( mVariantFaceIsOuter[variant][i]==1 )

          {

          outer=i;

          break;

          }

        }

      if( outer>=0 )

        {

        float[] v = mShapes[variant].getFirstVertexInFace(outer);

        float[] ret = new float[3];

        float[] curpos = mOrigPos[cubitIndex];

        Static4D quat = mOrigQuat[cubitIndex];

        QuatHelper.rotateVectorByQuat(mTmp, v[0], v[1], v[2], 1, quat);

        ret[0] = mTmp[0]+computeAvg(curpos,0);

        ret[1] = mTmp[1]+computeAvg(curpos,1);

        ret[2] = mTmp[2]+computeAvg(curpos,2);

        return ret;

        }

      else

        {

        android.util.Log.e("D", "Error in getTrackingPoint: no outer face??");

        }

      }

    return null;

    }

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

  public int computeCurrentPuzzleFace(int type, float[] vertex)

    {

    if( type!=TwistyObjectCubit.TYPE_NORMAL )

      {

      Static3D[] axis = getFaceAxis();

      float[] dist3D = getDist3D(mNumLayers);

      final float MAXERR = 0.98f;

      int numAxis = axis.length;

      float x = vertex[0];

      float y = vertex[1];

      float z = vertex[2];

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

        {

        Static3D ax = axis[i];

        float len = ax.get0()*x + ax.get1()*y + ax.get2()*z;

        if( len>mSize*dist3D[i]*MAXERR ) return i;

        }

      return -2;

      }

    return -1;

    }

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

  public float[] getCubitRowOffset(int cubitIndex)