Distorted Android

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

// Copyright 2016 Leszek Koltunski                                                               //

//                                                                                               //

// This file is part of Distorted.                                                               //

//                                                                                               //

// Distorted 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.                                                           //

//                                                                                               //

// Distorted 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 Distorted.  If not, see <http://www.gnu.org/licenses/>.                            //

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

package org.distorted.library.mesh;

import android.opengl.GLES30;

import android.opengl.Matrix;

import org.distorted.library.effect.MatrixEffect;

import org.distorted.library.main.InternalBuffer;

import org.distorted.library.program.DistortedProgram;

import org.distorted.library.type.Static4D;

import java.util.ArrayList;

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

/**

 * Abstract class which represents a Mesh, ie an array of vertices (rendered as a TRIANGLE_STRIP).

 * <p>

 * If you want to render to a particular shape, extend from here, construct a float array

 * containing per-vertex attributes, and call back setAttribs().

 */

public abstract class MeshBase

   {

   // sizes of attributes of an individual vertex.

   private static final int POS_DATA_SIZE= 3; // vertex coordinates: x,y,z

   private static final int NOR_DATA_SIZE= 3; // normal vector: x,y,z

   private static final int INF_DATA_SIZE= 3; // 'inflate' vector: x,y,z

   private static final int TEX_DATA_SIZE= 2; // texture coordinates: s,t

   static final int POS_ATTRIB   = 0;

   static final int NOR_ATTRIB   = POS_DATA_SIZE;

   static final int INF_ATTRIB   = POS_DATA_SIZE + NOR_DATA_SIZE;

   static final int TEX_ATTRIB   = POS_DATA_SIZE + NOR_DATA_SIZE + INF_DATA_SIZE;

   static final int VERT_ATTRIBS = POS_DATA_SIZE + NOR_DATA_SIZE + INF_DATA_SIZE + TEX_DATA_SIZE;  // number of attributes of a 'normal' vertex

   static final int TRAN_ATTRIBS = POS_DATA_SIZE + POS_DATA_SIZE;                                  // number of attributes of a transform feedback vertex

   private static final int BYTES_PER_FLOAT = 4;

   private static final int OFFSET_POS = POS_ATTRIB*BYTES_PER_FLOAT;

   private static final int OFFSET_NOR = NOR_ATTRIB*BYTES_PER_FLOAT;

   private static final int OFFSET_INF = INF_ATTRIB*BYTES_PER_FLOAT;

   private static final int OFFSET_TEX = TEX_ATTRIB*BYTES_PER_FLOAT;

   private static final int TRAN_SIZE  = TRAN_ATTRIBS*BYTES_PER_FLOAT;

   private static final int VERT_SIZE  = VERT_ATTRIBS*BYTES_PER_FLOAT;

   private boolean mShowNormals;      // when rendering this mesh, draw normal vectors?

   private InternalBuffer mVBO, mTFO; // main vertex buffer and transform feedback buffer

   private int mNumVertices;

   private float[] mVertAttribs;      // packed: PosX,PosY,PosZ, NorX,NorY,NorZ, InfX,InfY,InfZ, TexS,TexT

   private float mInflate;

   private float mBoundingX, mBoundingY, mBoundingZ;

   private float mStretchX, mStretchY, mStretchZ;

   private static class Component

     {

     private int mEndIndex;

     private Static4D mTextureMap;

     Component(int end)

       {

       mEndIndex  = end;

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

       }

     Component(Component original)

       {

       mEndIndex = original.mEndIndex;

       float x = original.mTextureMap.get0();

       float y = original.mTextureMap.get1();

       float z = original.mTextureMap.get2();

       float w = original.mTextureMap.get3();

       mTextureMap = new Static4D(x,y,z,w);

       }

     void setMap(Static4D map)

       {

       mTextureMap.set(map.get0(),map.get1(),map.get2(),map.get3());

       }

     }

   private ArrayList<Component> mComponent;

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

   MeshBase(float bx, float by, float bz)

     {

     mBoundingX = bx/2;

     mBoundingY = by/2;

     mBoundingZ = bz/2;

     mStretchX = 1.0f;

     mStretchY = 1.0f;

     mStretchZ = 1.0f;

     mShowNormals = false;

     mInflate     = 0.0f;

     mComponent   = new ArrayList<>();

     mVBO = new InternalBuffer(GLES30.GL_ARRAY_BUFFER             , GLES30.GL_STATIC_READ);

     mTFO = new InternalBuffer(GLES30.GL_TRANSFORM_FEEDBACK_BUFFER, GLES30.GL_STATIC_READ);

     }

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

// copy constructor

   MeshBase(MeshBase original)

     {

     mBoundingX = original.mBoundingX;

     mBoundingY = original.mBoundingY;

     mBoundingZ = original.mBoundingZ;

     mStretchX = original.mStretchX;

     mStretchY = original.mStretchY;

     mStretchZ = original.mStretchZ;

     mShowNormals = original.mShowNormals;

     mInflate     = original.mInflate;

     int size = original.mComponent.size();

     mComponent = new ArrayList<>();

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

       {

       Component comp = new Component(original.mComponent.get(i));

       mComponent.add(comp);

       }

     mVBO = new InternalBuffer(GLES30.GL_ARRAY_BUFFER             , GLES30.GL_STATIC_READ);

     mTFO = new InternalBuffer(GLES30.GL_TRANSFORM_FEEDBACK_BUFFER, GLES30.GL_STATIC_READ);

     System.arraycopy(original.mVertAttribs,0,mVertAttribs,0,original.mNumVertices*VERT_ATTRIBS);

     setAttribs(mVertAttribs);

     }

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

   int numComponents()

     {

     return mComponent.size();

     }

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

   void setBounding(float bx, float by, float bz)

     {

     mBoundingX = bx/2;

     mBoundingY = by/2;

     mBoundingZ = bz/2;

     }

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

// when a derived class is done computing its mesh, it has to call this method.

   void setAttribs(float[] vertexAttribs)

     {

     mNumVertices = vertexAttribs.length/VERT_ATTRIBS;

     mVertAttribs = vertexAttribs;

     mComponent.add(new Component(mNumVertices));

     mVBO.invalidate();

     mTFO.invalidate();

     }

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

// called from MeshJoined

   void join(MeshBase[] meshes)

     {

     MeshBase mesh;

     Component comp;

     int numComponents, numVertices, numMeshes = meshes.length;

     int origVertices = mNumVertices;

     // compute new numVertices; take care of Components

     if( origVertices>0 )

       {

       numComponents = mComponent.size();

       mNumVertices+= ( mNumVertices%2==1 ? 2:1 );

       mComponent.get(numComponents-1).mEndIndex = mNumVertices;

       }

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

       {

       mesh = meshes[i];

       numComponents = mesh.mComponent.size();

       for(int j=0; j<numComponents; j++)

         {

         comp = new Component(mesh.mComponent.get(j));

         comp.mEndIndex += mNumVertices;

         mComponent.add(comp);

         }

       numVertices = mesh.mNumVertices;

       if( mNumVertices==0 )

         {

         if( numMeshes>1 )

            mNumVertices += (numVertices%2==1 ? numVertices+2 : numVertices+1);

         else

            mNumVertices +=  numVertices;

         }

       else if( i==numMeshes-1 ) mNumVertices += (numVertices+1);

       else                      mNumVertices += (numVertices%2==1 ? numVertices+3 : numVertices+2);

       }

     // allocate new attrib array

     float[] newAttribs = new float[VERT_ATTRIBS*mNumVertices];

     numVertices = origVertices;

     if( origVertices>0 )

       {

       System.arraycopy(mVertAttribs,                             0, newAttribs,                         0, VERT_ATTRIBS*numVertices);

       System.arraycopy(mVertAttribs, VERT_ATTRIBS*(origVertices-1), newAttribs, VERT_ATTRIBS*origVertices, VERT_ATTRIBS    );

       origVertices++;

       if( numVertices%2==1 )

         {

         System.arraycopy(mVertAttribs, VERT_ATTRIBS*(origVertices-1), newAttribs, VERT_ATTRIBS*origVertices, VERT_ATTRIBS);

         origVertices++;

         }

       }

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

       {

       mesh = meshes[i];

       numVertices = mesh.mNumVertices;

       if( origVertices>0 )

         {

         System.arraycopy(mesh.mVertAttribs, 0, newAttribs, VERT_ATTRIBS*origVertices, VERT_ATTRIBS    );

         origVertices++;

         }

       System.arraycopy(mesh.mVertAttribs, 0, newAttribs, VERT_ATTRIBS*origVertices, VERT_ATTRIBS*numVertices);

       origVertices+=numVertices;

       if( i<numMeshes-1 )

         {

         System.arraycopy(mesh.mVertAttribs, VERT_ATTRIBS*(numVertices-1), newAttribs, VERT_ATTRIBS*origVertices, VERT_ATTRIBS);

         origVertices++;

         if( numVertices%2==1 )

           {

           System.arraycopy(mesh.mVertAttribs, VERT_ATTRIBS*(numVertices-1), newAttribs, VERT_ATTRIBS*origVertices, VERT_ATTRIBS);

           origVertices++;

           }

         }

       }

     if( origVertices!=mNumVertices )

       {

       android.util.Log.e("mesh", "join: origVertices: "+origVertices+" numVertices: "+mNumVertices);

       }

     mVertAttribs = newAttribs;

     mVBO.invalidate();

     }

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

/**

 * Not part of public API, do not document (public only because has to be used from the main package)

 *

 * @y.exclude

 */

   public int getTFO()

     {

     return mTFO.getIndex();

     }

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

/**

 * Not part of public API, do not document (public only because has to be used from the main package)

 *

 * @y.exclude

 */

   public int getNumVertices()

     {

     return mNumVertices;

     }

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

/**

 * Not part of public API, do not document (public only because has to be used from the main package)

 *

 * @y.exclude

 */

   public void bindVertexAttribs(DistortedProgram program)

     {

     int index = mVBO.createImmediately(mNumVertices*VERT_SIZE, mVertAttribs);

     GLES30.glBindBuffer(GLES30.GL_ARRAY_BUFFER, index );

     GLES30.glVertexAttribPointer(program.mAttribute[0], POS_DATA_SIZE, GLES30.GL_FLOAT, false, VERT_SIZE, OFFSET_POS);

     GLES30.glVertexAttribPointer(program.mAttribute[1], NOR_DATA_SIZE, GLES30.GL_FLOAT, false, VERT_SIZE, OFFSET_NOR);

     GLES30.glVertexAttribPointer(program.mAttribute[2], INF_DATA_SIZE, GLES30.GL_FLOAT, false, VERT_SIZE, OFFSET_INF);

     GLES30.glVertexAttribPointer(program.mAttribute[3], TEX_DATA_SIZE, GLES30.GL_FLOAT, false, VERT_SIZE, OFFSET_TEX);

     GLES30.glBindBuffer(GLES30.GL_ARRAY_BUFFER, 0);

     }

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

/**

 * Not part of public API, do not document (public only because has to be used from the main package)

 *

 * @y.exclude

 */

   public void bindTransformAttribs(DistortedProgram program)

     {

     int index = mTFO.createImmediately(mNumVertices*TRAN_SIZE, null);

     GLES30.glBindBuffer(GLES30.GL_ARRAY_BUFFER, index );

     GLES30.glVertexAttribPointer(program.mAttribute[0], POS_DATA_SIZE, GLES30.GL_FLOAT, false, 0, 0);

     GLES30.glBindBuffer(GLES30.GL_ARRAY_BUFFER, 0);

     }

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

/**

 * Not part of public API, do not document (public only because has to be used from the main package)

 *

 * @y.exclude

 */

   public void setInflate(float inflate)

     {

     mInflate = inflate;

     }

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

/**

 * Not part of public API, do not document (public only because has to be used from the main package)

 *

 * @y.exclude

 */

   public float getInflate()

     {

     return mInflate;

     }

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

// PUBLIC API

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

/**

 * When rendering this Mesh, do we want to render the Normal vectors as well?

 * <p>

 * Will work only on OpenGL ES >= 3.0 devices.

 *

 * @param show Controls if we render the Normal vectors or not.

 */

   public void setShowNormals(boolean show)

     {

     mShowNormals = show;

     }

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

/**

 * When rendering this mesh, should we also draw the normal vectors?

 *

 * @return <i>true</i> if we do render normal vectors

 */

   public boolean getShowNormals()

     {

     return mShowNormals;

     }

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

/**

 * Release all internal resources.

 */

   public void markForDeletion()

     {

     mVertAttribs = null;

     mVBO.markForDeletion();

     mTFO.markForDeletion();

     }

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

/**

 * Apply all Effects to the vertex mesh. Overwrite the mesh in place.

 * <p>

 * This is a static, permanent modification of the vertices contained in this Mesh. If the effects

 * contain any Dynamics, they will be evaluated at 0.

 *

 * Please note that calling this once with the complete list of Effects will be much faster than

 * calling it repeatedly with one Effect at a time, as we have to reallocate the array of vertices

 * each time.

 *

 * @param effects List of Matrix Effects to apply to the Mesh.

 */

   public void apply(MatrixEffect[] effects)

     {

     float[][] matrix = new float[effects.length][16];

     float[] tmp;

     float[] array = new float[7];

     float x,y,z;

     int numEffects = 0;

     for(MatrixEffect eff: effects)

       {

       if( eff!=null )

         {

         Matrix.setIdentityM(matrix[numEffects],0);

         eff.compute(array,0,0,0);

         eff.apply(matrix[numEffects], array, 0);

         numEffects++;

         }

       }

     for(int index=0; index<mNumVertices*VERT_ATTRIBS; index+=VERT_ATTRIBS )

       {

       for(int mat=0; mat<numEffects; mat++)

         {

         tmp = matrix[mat];

         x = mVertAttribs[index+POS_ATTRIB  ];

         y = mVertAttribs[index+POS_ATTRIB+1];

         z = mVertAttribs[index+POS_ATTRIB+2];

         mVertAttribs[index+POS_ATTRIB  ] = tmp[0]*x + tmp[4]*y + tmp[ 8]*z + tmp[12];

         mVertAttribs[index+POS_ATTRIB+1] = tmp[1]*x + tmp[5]*y + tmp[ 9]*z + tmp[13];

         mVertAttribs[index+POS_ATTRIB+2] = tmp[2]*x + tmp[6]*y + tmp[10]*z + tmp[14];

         x = mVertAttribs[index+NOR_ATTRIB  ];

         y = mVertAttribs[index+NOR_ATTRIB+1];

         z = mVertAttribs[index+NOR_ATTRIB+2];

         mVertAttribs[index+NOR_ATTRIB  ] = tmp[0]*x + tmp[4]*y + tmp[ 8]*z;

         mVertAttribs[index+NOR_ATTRIB+1] = tmp[1]*x + tmp[5]*y + tmp[ 9]*z;

         mVertAttribs[index+NOR_ATTRIB+2] = tmp[2]*x + tmp[6]*y + tmp[10]*z;

         x = mVertAttribs[index+INF_ATTRIB  ];

         y = mVertAttribs[index+INF_ATTRIB+1];

         z = mVertAttribs[index+INF_ATTRIB+2];

         mVertAttribs[index+INF_ATTRIB  ] = tmp[0]*x + tmp[4]*y + tmp[ 8]*z;

         mVertAttribs[index+INF_ATTRIB+1] = tmp[1]*x + tmp[5]*y + tmp[ 9]*z;

         mVertAttribs[index+INF_ATTRIB+2] = tmp[2]*x + tmp[6]*y + tmp[10]*z;

         }

       }

     mVBO.invalidate();

     }

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

/**

 * Sets texture maps for (some of) the components of this mesh.

 * <p>

 * Format: ( x of lower-left corner, y of lower-left corner, width, height ).

 * For example maps[0] = new Static4D( 0.0, 0.5, 0.5, 0.5 ) sets the 0th component texture map to the

 * upper-left quadrant of the texture.

 * <p>

 * Probably the most common user case would be sending as many maps as there are components in this

 * Mesh. One can also send less, or more (the extraneous ones will be ignored) and set some of them

 * to null (those will be ignored as well). So if there are 5 components, and we want to set the map

 * of the 2nd and 4rd one, call this with

 * maps = new Static4D[4]

 * maps[0] = null

 * maps[1] = the map for the 2nd component

 * maps[2] = null

 * maps[3] = the map for the 4th component

 *

 * A map's width and height have to be non-zero (but can be negative!)

 *

 * @param maps List of texture maps to apply to the texture's components.

 */

   public void setTextureMap(Static4D[] maps)

     {

     int num_comp = mComponent.size();

     int num_maps = maps.length;

     int min = Math.min(num_comp, num_maps);

     int vertex = 0;

     Static4D newMap, oldMap;

     Component comp;

     float newW, newH, ratW, ratH, movX, movY;

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

       {

       newMap = maps[i];

       comp = mComponent.get(i);

       if( newMap!=null )

         {

         newW = newMap.get2();

         newH = newMap.get3();

         if( newW!=0.0f && newH!=0.0f )

           {

           oldMap = comp.mTextureMap;

           ratW = newW/oldMap.get2();

           ratH = newH/oldMap.get3();

           movX = newMap.get0() - ratW*oldMap.get0();

           movY = newMap.get1() - ratH*oldMap.get1();

           for( int index=vertex*VERT_ATTRIBS+TEX_ATTRIB ; vertex<=comp.mEndIndex; vertex++, index+=VERT_ATTRIBS)

             {

             mVertAttribs[index  ] = ratW*mVertAttribs[index  ] + movX;

             mVertAttribs[index+1] = ratH*mVertAttribs[index+1] + movY;

             }

           comp.setMap(newMap);

           }

         }

       vertex= comp.mEndIndex+1;

       }

     mVBO.invalidate();

     }

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

/**

 * Return the texture map of one of the components.

 *

 * @param component The component number whose texture map we want to retrieve.

 */

   public Static4D getTextureMap(int component)

     {

     return (component>=0 && component<mComponent.size()) ? mComponent.get(component).mTextureMap : null;

     }

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

/**

 * Each mesh has its 'bounding box' - return half of its X-length.

 * <p>

 * In case of all 'simple' Meshes, the bounding box is always 1x1x1 (Sphere, Cubes) or 1x1x0

 * (Rectangles, Triangles, Quad - i.e. all 'flat' Meshes). But this can be something else in case of

 * MeshComponent.

 */

   public float getBoundingX()

    {

    return mBoundingX*mStretchX;

    }

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

/**

 * Each mesh has its 'bounding box' - return half of its Y-length.

 */

   public float getBoundingY()

    {

    return mBoundingY*mStretchY;

    }

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

/**

 * Each mesh has its 'bounding box' - return half of its Z-length.

 */

   public float getBoundingZ()

    {

    return mBoundingZ*mStretchZ;

    }

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

/**

 * Sometimes we want to display a Mesh on a rectangular screen. Then we need to stretch it by

 * different factors in x and y (or z) directions. If we also wanted do display some vertex effects

 * done on this mesh, let's say a bulge done by a Distort effect, and wanted the bulge to be round,

 * (i.e the same in x and y directions) then doing so without this method would be impossible.

 *

 * This sets 'stretch' factors in each 3 dimensions. All vertices of this Mesh will be premultiplied

 * by those factors in the very first line of the Vertex Shader, before any Effects are done on it.

 * Using this we can thus pre-stretch the mesh to aspect ratio equal to the surface we eventually

 * want to display the Mesh on, and this way we can achieve a round Distort bulge!

 *

 * This could also be used to pre-stretch a Rectangles Mesh to a size equal (in pixels) to the bitmap

 * this mesh is textured with - and this lets us work with all Effects in natural, pixel units.

 *

 * @param sx stretch factor in x.

 * @param sy stretch factor in y.

 * @param sz stretch factor in z.

 */

   public void setStretch(float sx, float sy, float sz)

     {

     mStretchX = sx;

     mStretchY = sy;

     mStretchZ = sz;

     }

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

/**

 * Returns the x-factor set by setStretch().

 */

   public float getStretchX()

     {

     return mStretchX;

     }

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

/**

 * Returns the y-factor set by setStretch().

 */

   public float getStretchY()

     {

     return mStretchY;

     }

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

/**

 * Returns the z-factor set by setStretch().

 */

   public float getStretchZ()

     {

     return mStretchZ;

     }

   }