Distorted Android

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

// Copyright 2021 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.library.main;

import org.distorted.library.type.Static4D;

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

public class QuatHelper

  {

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

// 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);

    }

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

// return quat1*(rx,ry,rz,rw)

  public static Static4D quatMultiply( Static4D quat1, float rx, float ry, float rz, float rw )

    {

    float qx = quat1.get0();

    float qy = quat1.get1();

    float qz = quat1.get2();

    float qw = quat1.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);

    }

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

// return (qx,qy,qz,qw)*quat2

  public static Static4D quatMultiply( float qx, float qy, float qz, float qw, Static4D quat2 )

    {

    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);

    }

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

// return (qx,qy,qz,qw)*(rx,ry,rz,rw)

  public static Static4D quatMultiply( float qx, float qy, float qz, float qw, float rx, float ry, float rz, float rw )

    {

    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);

    }

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

// ret = (qx,qy,qz,qw)*(rx,ry,rz,rw)

  public static void quatMultiply( float[] ret, float[] q, float[] r )

    {

    ret[0] = r[3]*q[0] - r[2]*q[1] + r[1]*q[2] + r[0]*q[3];

    ret[1] = r[3]*q[1] + r[2]*q[0] + r[1]*q[3] - r[0]*q[2];

    ret[2] = r[3]*q[2] + r[2]*q[3] - r[1]*q[0] + r[0]*q[1];

    ret[3] = r[3]*q[3] - r[2]*q[2] - r[1]*q[1] - r[0]*q[0];

    }

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

// ret = (qx,qy,qz,qw)*(rx,ry,rz,rw)

  public static void quatMultiply( float[] ret, float qx, float qy, float qz, float qw, float rx, float ry, float rz, float rw )

    {

    ret[0] = rw*qx - rz*qy + ry*qz + rx*qw;

    ret[1] = rw*qy + rz*qx + ry*qw - rx*qz;

    ret[2] = rw*qz + rz*qw - ry*qx + rx*qy;

    ret[3] = rw*qw - rz*qz - ry*qy - rx*qx;

    }

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

// 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 tmp = quatMultiply(qx,qy,qz,qw,vector);

    return quatMultiply(tmp,-qx,-qy,-qz,qw);

    }

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

// rotate (x1,x2,x3,x4) by quat  ( i.e. return quat*vector*(quat^-1) )

  public static Static4D rotateVectorByQuat(float x, float y, float z, float w, Static4D quat)

    {

    float qx = quat.get0();

    float qy = quat.get1();

    float qz = quat.get2();

    float qw = quat.get3();

    Static4D tmp = quatMultiply(qx,qy,qz,qw,x,y,z,w);

    return quatMultiply(tmp,-qx,-qy,-qz,qw);

    }

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

// rotate (x1,x2,x3,x4) by quat  ( i.e. return quat*vector*(quat^-1) )

  public static void rotateVectorByQuat(float[] output, float x, float y, float z, float w, Static4D quat)

    {

    float[] tmp = new float[4];

    float qx = quat.get0();

    float qy = quat.get1();

    float qz = quat.get2();

    float qw = quat.get3();

    quatMultiply(tmp,qx,qy,qz,qw,x,y,z,w);

    quatMultiply(output,tmp[0],tmp[1],tmp[2],tmp[3],-qx,-qy,-qz,qw);

    }

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

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

  public static void rotateVectorByQuat(float[] output, float[] vec, float[] quat)

    {

    float[] tmp = new float[4];

    quatMultiply(tmp,quat,vec);

    quat[0] = -quat[0];

    quat[1] = -quat[1];

    quat[2] = -quat[2];

    quatMultiply(output,tmp,quat);

    quat[0] = -quat[0];

    quat[1] = -quat[1];

    quat[2] = -quat[2];

    }

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

// 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 tmp = quatMultiply(-qx,-qy,-qz,qw,vector);

    return quatMultiply(tmp,quat);

    }

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

  public static 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);

    }

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

  public static double computeCos(double oldX, double oldY, double newX, double newY, double len1, double len2)

    {

    double ret= (oldX*newX+oldY*newY) / (len1*len2);

    if( ret<-1.0 ) return -1.0;

    if( ret> 1.0 ) return  1.0;

    return ret;

    }

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

// sin of (signed!) angle between vectors 'old' and 'new', counterclockwise!

  public static double computeSin(double oldX, double oldY, double newX, double newY, double len1, double len2)

    {

    double ret= (newX*oldY-oldX*newY) / (len1*len2);

    if( ret<-1.0 ) return -1.0;

    if( ret> 1.0 ) return  1.0;

    return ret;

    }

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

// return quat Q that turns 3D vector A=(ax,ay,az) to another 3D vector B=(bx,by,bz)

// take care of double-cover by ensuring that always Q.get3() >=0

  public static Static4D retRotationQuat(float ax, float ay, float az, float bx, float by, float bz)

    {

    float nx = ay*bz - az*by;

    float ny = az*bx - ax*bz;

    float nz = ax*by - ay*bx;

    float sin = (float)Math.sqrt(nx*nx + ny*ny + nz*nz);

    float cos = ax*bx + ay*by + az*bz;

    if( sin!=0 )

      {

      nx /= sin;

      ny /= sin;

      nz /= sin;

      }

    // Why sin<=0 and cos>=0 ?

    // 0<angle<180 -> 0<halfAngle<90 -> both sin and cos are positive.

    // But1: quats work counterclockwise -> negate cos.

    // But2: double-cover, we prefer to have the cos positive (so that unit=(0,0,0,1))

    // so negate again both cos and sin.

    float sinHalf =-(float)Math.sqrt((1-cos)/2);

    float cosHalf = (float)Math.sqrt((1+cos)/2);

    return new Static4D(nx*sinHalf,ny*sinHalf,nz*sinHalf,cosHalf);

    }

  }