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.util.Log;

import org.distorted.library.effect.VertexEffect;

import org.distorted.library.effectqueue.EffectQueue;

import org.distorted.library.main.InternalBuffer;

import org.distorted.library.program.DistortedProgram;

import org.distorted.library.type.Static4D;

import java.nio.ByteBuffer;

import java.nio.ByteOrder;

import java.nio.FloatBuffer;

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

   {

   private static final int MAX_COMPONENTS= 100;

   private static final int DEFAULT_ASSOCIATION = 0xffffffff;

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

   private static final int COM_DATA_SIZE= 1; // component number, a single float

   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   = 0;

   static final int COM_ATTRIB   = TEX_DATA_SIZE;

   static final int VERT1_ATTRIBS= POS_DATA_SIZE + NOR_DATA_SIZE + INF_DATA_SIZE;  // number of attributes of a vertex (the part changed by preapply)

   static final int VERT2_ATTRIBS= TEX_DATA_SIZE + COM_DATA_SIZE;                  // number of attributes of a vertex (the 'preapply invariant' part)

   static final int TRAN_ATTRIBS = POS_DATA_SIZE + NOR_DATA_SIZE + INF_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 OFFSET_COM = COM_ATTRIB*BYTES_PER_FLOAT;

   private static final int TRAN_SIZE  = TRAN_ATTRIBS*BYTES_PER_FLOAT;

   private static final int VERT1_SIZE = VERT1_ATTRIBS*BYTES_PER_FLOAT;

   private static final int VERT2_SIZE = VERT2_ATTRIBS*BYTES_PER_FLOAT;

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

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

   private int mNumVertices;

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

   private float[] mVertAttribs2;             // packed: TexS,TexT, Component

   private float mInflate;

   private int[] mAssociation;

   DeferredJobs.JobNode[] mJobNode;

   private static int[] mComponentAssociationH = new int[EffectQueue.MAIN_VARIANTS];

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

     {

     mShowNormals= false;

     mInflate    = 0.0f;

     mComponent  = new ArrayList<>();

     mAssociation= new int[MAX_COMPONENTS];

     mJobNode = new DeferredJobs.JobNode[1];

     for(int i=0; i<MAX_COMPONENTS; i++) mAssociation[i] = DEFAULT_ASSOCIATION;

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

     mVBO2= 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, boolean deep)

     {

     mShowNormals     = original.mShowNormals;

     mInflate         = original.mInflate;

     mNumVertices     = original.mNumVertices;

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

       }

     mAssociation= new int[MAX_COMPONENTS];

     System.arraycopy(original.mAssociation, 0, mAssociation, 0, MAX_COMPONENTS);

     if( deep )

       {

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

       mVertAttribs1= new float[mNumVertices*VERT1_ATTRIBS];

       mJobNode = new DeferredJobs.JobNode[1];

       if( original.mJobNode[0]!=null )

         {

         mJobNode[0] = DeferredJobs.copy(this,original);

         }

       else

         {

         deepCopyAttribs1(original);

         }

       }

     else

       {

       mJobNode      = original.mJobNode;

       mVBO1         = original.mVBO1;

       mVertAttribs1 = original.mVertAttribs1;

       }

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

     mVertAttribs2= new float[mNumVertices*VERT2_ATTRIBS];

     System.arraycopy(original.mVertAttribs2,0,mVertAttribs2,0,mNumVertices*VERT2_ATTRIBS);

     mVBO2.invalidate();

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

     mTFO.invalidate();

     }

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

   public static int getMaxComponents()

     {

     return MAX_COMPONENTS;

     }

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

   public static void getUniforms(int mProgramH, int variant)

     {

     mComponentAssociationH[variant] = GLES30.glGetUniformLocation( mProgramH, "vComponAssoc");

     }

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

   void deepCopyAttribs1(MeshBase original)

     {

     System.arraycopy(original.mVertAttribs1,0,mVertAttribs1,0,mNumVertices*VERT1_ATTRIBS);

     mVBO1.invalidate();

     }

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

   int numComponents()

     {

     return mComponent.size();

     }

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

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

   void setAttribs(float[] vert1Attribs, float[] vert2Attribs)

     {

     mNumVertices = vert1Attribs.length/VERT1_ATTRIBS;

     mVertAttribs1= vert1Attribs;

     mVertAttribs2= vert2Attribs;

     mComponent.add(new Component(mNumVertices-1));

     mVBO1.invalidate();

     mVBO2.invalidate();

     }

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

// called from MeshJoined

   void join(MeshBase[] meshes)

     {

     MeshBase mesh;

     Component comp;

     int origComponents=0, numComponents, numVertices, numMeshes = meshes.length;

     int origVertices = mNumVertices;

     // compute new numVertices; take care of Components

     if( origVertices>0 )

       {

       origComponents = mComponent.size();

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

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

       }

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

       {

       mesh = meshes[i];

       numComponents = mesh.mComponent.size();

       numVertices = mesh.mNumVertices;

       int extraVerticesBefore = mNumVertices==0 ? 0:1;

       int extraVerticesAfter  = (i==numMeshes-1) ? 0 : (numVertices%2==1 ? 2:1);

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

         {

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

         comp.mEndIndex += (extraVerticesBefore+mNumVertices+extraVerticesAfter);

         mComponent.add(comp);

         if( origComponents<MAX_COMPONENTS )

           {

           mAssociation[origComponents] = mesh.mAssociation[j];

           origComponents++;

           }

         }

       mNumVertices += (extraVerticesBefore+numVertices+extraVerticesAfter);

       }

     // allocate new attrib array

     float[] newAttribs1 = new float[VERT1_ATTRIBS*mNumVertices];

     float[] newAttribs2 = new float[VERT2_ATTRIBS*mNumVertices];

     numVertices = origVertices;

     if( origVertices>0 )

       {

       System.arraycopy(mVertAttribs1,                              0, newAttribs1,                         0, VERT1_ATTRIBS*numVertices);

       System.arraycopy(mVertAttribs2,                              0, newAttribs2,                         0, VERT2_ATTRIBS*numVertices);

       System.arraycopy(mVertAttribs1, VERT1_ATTRIBS*(origVertices-1), newAttribs1, VERT1_ATTRIBS*origVertices, VERT1_ATTRIBS    );

       System.arraycopy(mVertAttribs2, VERT2_ATTRIBS*(origVertices-1), newAttribs2, VERT2_ATTRIBS*origVertices, VERT2_ATTRIBS    );

       origVertices++;

       if( numVertices%2==1 )

         {

         System.arraycopy(mVertAttribs1, VERT1_ATTRIBS*(origVertices-1), newAttribs1, VERT1_ATTRIBS*origVertices, VERT1_ATTRIBS);

         System.arraycopy(mVertAttribs2, VERT2_ATTRIBS*(origVertices-1), newAttribs2, VERT2_ATTRIBS*origVertices, VERT2_ATTRIBS);

         origVertices++;

         }

       }

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

       {

       mesh = meshes[i];

       numVertices = mesh.mNumVertices;

       if( origVertices>0 )

         {

         System.arraycopy(mesh.mVertAttribs1, 0, newAttribs1, VERT1_ATTRIBS*origVertices, VERT1_ATTRIBS    );

         System.arraycopy(mesh.mVertAttribs2, 0, newAttribs2, VERT2_ATTRIBS*origVertices, VERT2_ATTRIBS    );

         origVertices++;

         }

       System.arraycopy(mesh.mVertAttribs1, 0, newAttribs1, VERT1_ATTRIBS*origVertices, VERT1_ATTRIBS*numVertices);

       System.arraycopy(mesh.mVertAttribs2, 0, newAttribs2, VERT2_ATTRIBS*origVertices, VERT2_ATTRIBS*numVertices);

       origVertices+=numVertices;

       if( i<numMeshes-1 )

         {

         System.arraycopy(mesh.mVertAttribs1, VERT1_ATTRIBS*(numVertices-1), newAttribs1, VERT1_ATTRIBS*origVertices, VERT1_ATTRIBS);

         System.arraycopy(mesh.mVertAttribs2, VERT2_ATTRIBS*(numVertices-1), newAttribs2, VERT2_ATTRIBS*origVertices, VERT2_ATTRIBS);

         origVertices++;

         if( numVertices%2==1 )

           {

           System.arraycopy(mesh.mVertAttribs1, VERT1_ATTRIBS*(numVertices-1), newAttribs1, VERT1_ATTRIBS*origVertices, VERT1_ATTRIBS);

           System.arraycopy(mesh.mVertAttribs2, VERT2_ATTRIBS*(numVertices-1), newAttribs2, VERT2_ATTRIBS*origVertices, VERT2_ATTRIBS);

           origVertices++;

           }

         }

       }

     if( origVertices!=mNumVertices )

       {

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

       }

     int endIndex, index=0, numComp = mComponent.size();

     for(int component=0; component<numComp; component++)

       {

       endIndex = mComponent.get(component).mEndIndex;

       for( ; index<=endIndex; index++) newAttribs2[VERT2_ATTRIBS*index+COM_ATTRIB] = component;

       }

     mVertAttribs1 = newAttribs1;

     mVertAttribs2 = newAttribs2;

     mVBO1.invalidate();

     mVBO2.invalidate();

     }

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

/**

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

 *

 * @y.exclude

 */

   public void copyTransformToVertex()

     {

     ByteBuffer buffer = (ByteBuffer)GLES30.glMapBufferRange( GLES30.GL_TRANSFORM_FEEDBACK_BUFFER, 0,

                                                              TRAN_SIZE*mNumVertices, GLES30.GL_MAP_READ_BIT);

     if( buffer!=null )

       {

       FloatBuffer feedback = buffer.order(ByteOrder.nativeOrder()).asFloatBuffer();

       feedback.get(mVertAttribs1,0,VERT1_ATTRIBS*mNumVertices);

       mVBO1.update(mVertAttribs1);

       }

     else

       {

       int error = GLES30.glGetError();

       Log.e("mesh", "failed to map tf buffer, error="+error);

       }

     GLES30.glUnmapBuffer(GLES30.GL_TRANSFORM_FEEDBACK);

     }

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

/**

 * 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.createImmediately(mNumVertices*TRAN_SIZE, null);

     }

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

/**

 * 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 send(int variant)

     {

     GLES30.glUniform1iv( mComponentAssociationH[variant], MAX_COMPONENTS, mAssociation, 0);

     }

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

/**

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

     {

     if( mJobNode[0]!=null )

       {

       mJobNode[0].execute();  // this will set itself to null

       }

     int index1 = mVBO1.createImmediately(mNumVertices*VERT1_SIZE, mVertAttribs1);

     int index2 = mVBO2.createImmediately(mNumVertices*VERT2_SIZE, mVertAttribs2);

     GLES30.glBindBuffer(GLES30.GL_ARRAY_BUFFER, index1 );

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

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

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

     GLES30.glBindBuffer(GLES30.GL_ARRAY_BUFFER, index2 );

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

     GLES30.glVertexAttribPointer(program.mAttribute[4], COM_DATA_SIZE, GLES30.GL_FLOAT, false, VERT2_SIZE, OFFSET_COM);

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

     {

     mVertAttribs1 = null;

     mVertAttribs2 = null;

     mVBO1.markForDeletion();

     mVBO2.markForDeletion();

     mTFO.markForDeletion();

     }

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

/**

 * Apply a Vertex Effect to the vertex mesh.

 * <p>

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

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

 *

 * We would call this several times building up a list of Effects to do. This list of effects gets

 * lazily executed only when the Mesh is used for rendering for the first time.

 *

 * @param effect Vertex Effect to apply to the Mesh.

 */

   public void apply(VertexEffect effect)

     {

     mJobNode[0] = DeferredJobs.vertex(this,effect);

     }

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

/**

 * 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*VERT2_ATTRIBS+TEX_ATTRIB ; vertex<=comp.mEndIndex; vertex++, index+=VERT2_ATTRIBS)

             {

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

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

             }

           comp.setMap(newMap);

           }

         }

       vertex= comp.mEndIndex+1;

       }

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

     }

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

/**

 * Set Effect association.

 *

 * This creates an association between a Component of this Mesh and a Vertex Effect.

 * One can set the association of an Effect and of a Component, and the Effect will only be active on

 * vertices of Components such that

 *

 * (effect assoc) & (component assoc) != 0 || (effect component) == (mesh component)

 *

 * (see main_vertex_shader)

 *

 * The point: this way we can configure the system so that each Vertex Effect acts only on a certain

 * subset of a Mesh, thus potentially significantly reducing the number of render calls.

 */

  public void setEffectAssociation(int component, int association)

    {

    if( component>=0 && component<MAX_COMPONENTS )

      {

      mAssociation[component] = association;

      }

    }

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

/**

 * Copy the Mesh.

 *

 * @param deep If to be a deep or shallow copy of mVertAttribs1, i.e. the array holding vertices,

 *             normals and inflates (the rest, in particular the mVertAttribs2 containing texture

 *             coordinates and effect associations, is always deep copied)

 */

   public abstract MeshBase copy(boolean deep);

   }