01．ベースOpenGLレンダラクラスを作る

（開発環境として「Eclipse」を使用した、古い情報です。
　開発環境として「Android Studio」を使用した、新しい情報は、
　「ホーム > プログラミング > モデルビューアを作る ( Android + OpenGL ES 1.0/1.1 ) ( Android Studio 2.3.3 版 )」）

OpenGLの初期化処理と終了処理を行い、OpenGLを用いた描画処理の骨格を担う、ベースOpenGLレンダラクラスを作成します。

使用開発環境は、Eclipse 3.7.2 ベースの Pleiades です。

解説

Androidで、OpenGLを使用して描画をするためにすべきことは、以下です。

GLSurfaceView.Rendererインターフェースを実装したクラスのオブジェクトを生成する。
GLSurfaceViewクラス（もしくは、その派生クラス）のオブジェクトを生成する。
1.で作成したGLSurfaceView.Rendererオブジェクトを、2.で作成したGLSurfaceViewオブジェクトに、setRenderer関数でセットする。
2.で作成したGLSurfaceViewオブジェクトを、メインアクティビティの、onCreate関数内で、setContentView関数でセットする。
GLSurfaceView.Rendererインターフェースを実装したクラスの、サーフェースが作成された時およびサーフェースが再作成された時に呼び出される onSurfaceCreated関数で、クリアカラーの設定や、クリア深度設定、およびOpenGLの有効、無効の設定をする。
GLSurfaceView.Rendererインターフェースを実装したクラスの、サーフェースが変更された時に呼び出される onSurfaceChanged関数で、ビューポートの設定、視野角錐台の設定、視点座標変換の設定をする。
GLSurfaceView.Rendererインターフェースを実装したクラスの、フレームを描画する時に呼び出されるonDrawFrame関数で、モデル描画の処理をする。

Androidで、OpenGLを使用して描画をするときに、した方がよいことは、以下です。

メインアクティビティクラスの、他のアクティビティが起動したことでバックグラウンドに追いやられた時に呼び出される onPause関数で、GLSurfaceViewオブジェクトのonPause関数呼び出しを行う。
メインアクティビティクラスの、ポーズから復帰する時に呼び出される onResume関数で、GLSurfaceViewオブジェクトのonResume関数呼び出しを行う。

Androidで、OpenGLを使用して描画をするときに、しなくても良いが、今回やっていることは、以下です。

GLSurfaceViewの描画モードは、既定では、RENDERMODE_CONTINUOUSLYという、絶え間なく描画するというモードになっていますが、RENDERMODE_WHEN_DIRTYという、描画要求があったときだけ描画するというモードに変更しています。描画要求は、requestRenderという関数で行います。

実装

プロジェクトの作成

メニュー「ファイル > 新規 > プロジェクト」を選択します。

Android プロジェクトを選択し、「次へ」ボタンを押します。

Project Name に「ModelViewerEtude」と入力し、「次へ」ボタンを押します。

ビルドターゲットを一つチェックし（たとえば、「Android 2.1」をチェックし）、「次へ」ボタンを押します。

Package Name にパッケージ名（たとえば、「com.hiramine.modelvieweretude」）を入力し、「完了」ボタンを押します。

ベースOpenGLレンダラクラスの作成

OpenGLを用いた描画処理の骨格を担う、ベースOpenGLレンダラクラスを作成します。
GLSurfaceView.Rendererインターフェースを実装したクラスとして作成します。

パッケージエクスプローラで、作成したプロジェクトの下の「src」の下の作成したパッケージを右クリックし、右クリックメニューの「新規 > クラス」を選択します。

名前にクラス名「OpenGLBaseRenderer」、
インターフェースに、「android.opengl.GLSurfaceView.Renderer」、
を入力し、「完了」ボタンを押します。

サーフェースが作成された時、再作成された時の処理の実装

GLSurfaceView.Rendererインターフェースを実装したクラスの、サーフェースが作成された時およびサーフェースが再作成された時に呼び出される onSurfaceCreated関数に、OpenGLオブジェクトに関するメンバ変数への設定、クリア処理の設定、クリア処理の設定、ポリゴン処理の設定、ライティング処理の設定、ブレンド処理の設定を追加します。

public class OpenGLBaseRenderer implements Renderer { （・・・省略・・・） // サーフェースが作成された時、再作成された時 // （レンダリングスレッドの起動時および、アンドロイドデバイスのスリープからの復帰時） public void onSurfaceCreated( GL10 gl, EGLConfig config ) { m_gl = gl; // クリア処理 gl.glClearColor( 0.0f, 0.0f, 0.0f, 1.0f ); // クリアカラー gl.glClearDepthf( 1.0f ); // クリア深度 // デプス処理 gl.glEnable( GL10.GL_DEPTH_TEST ); // デプステスト gl.glDepthFunc( GL10.GL_LEQUAL ); // デプスファンクの設定（同じか、手前にあるもので上描いていく） gl.glDepthMask( true ); // デプスバッファーへの書き込み許可 // ポリゴン処理 gl.glDisable( GL10.GL_CULL_FACE ); // 裏を向いている面のカリング gl.glEnable( GL10.GL_NORMALIZE ); // 法線処理 gl.glDisable( GL10.GL_POLYGON_OFFSET_FILL ); // ポリゴンオフセットフィル gl.glPolygonOffset( 1.0f, 1.0f ); // ポリゴンオフセット量 // ライティング処理 gl.glDisable( GL10.GL_LIGHTING ); // 光源 gl.glDisable( GL10.GL_COLOR_MATERIAL ); // カラー設定値をマテリアルとして使用 // ブレンド処理 gl.glDisable( GL10.GL_BLEND ); // 半透明およびアンチエイリアシング gl.glDisable( GL10.GL_POINT_SMOOTH ); // 点のスムース処理 gl.glDisable( GL10.GL_LINE_SMOOTH ); // 線のスムース処理 gl.glShadeModel( GL10.GL_SMOOTH ); // シェーディングモード } }

OpenGLオブジェクトに関するメンバ変数およびアクセサを追加します。

public class OpenGLBaseRenderer implements Renderer { private GL10 m_gl; // OpenGLオブジェクト public GL10 getGL() { return m_gl; } （・・・省略・・・） }

サーフェースが変更された時の処理の実装

GLSurfaceView.Rendererインターフェースを実装したクラスの、サーフェースが変更された時に呼び出される onSurfaceChanged関数に、サーフェースのサイズに関するメンバ変数への設定、ビューポートの設定、視野角錐台の無効化、視点座標変換の無効化、の処理を追加します。

public class OpenGLBaseRenderer implements Renderer { （・・・省略・・・） // サーフェースが変更された時 // （サーフェースが作成された後および、サーフェースのサイズが変更された時） public void onSurfaceChanged( GL10 gl, int width, int height ) { m_iWidth = width; m_iHeight = height; // ビューポート設定 setupViewport(); // 視野角錐台設定の無効化（描画処理時に再設定され、有効化される） setViewingFrustumValid( false ); // 視点座標変換設定の無効化（描画処理時に再設定され、有効化される） setViewingTransformValid( false ); } （・・・省略・・・） }

サーフェースのサイズに関するメンバ変数およびアクセサ関数、ビューポート設定関数を追加します。

public class OpenGLBaseRenderer implements Renderer { private GL10 m_gl; // OpenGLオブジェクト private int m_iWidth; // サーフェースサイズ private int m_iHeight; // サーフェースサイズ public int getWidth() { return m_iWidth; } public int getHeight() { return m_iHeight; } （・・・省略・・・） // ビューポート設定 private void setupViewport() { m_gl.glViewport( 0, 0, m_iWidth, m_iHeight ); } }

視野角錐台設定、視点座標変換設定は、OpenGLの変換行列を変更するとき以外は設定する必要はありません。必要なときのみ設定することで、描画処理の負担を軽減するようにします。設定を実施する必要があるかを判断するための設定の有効性メンバ変数、アクセサを追加します。

public class OpenGLBaseRenderer implements Renderer { private GL10 m_gl; // OpenGLオブジェクト private int m_iWidth; // サーフェースサイズ private int m_iHeight; // サーフェースサイズ private boolean m_bViewingFrustumValid; // 視野角錐台設定の有効性 private boolean m_bViewingTransformValid; // 視点座標変換設定の有効性 public GL10 getGL() { return m_gl; } public int getWidth() { return m_iWidth; } public int getHeight() { return m_iHeight; } public boolean isViewingFrustumValid() { return m_bViewingFrustumValid; } public boolean isViewingTransformValid() { return m_bViewingTransformValid; } public void setViewingFrustumValid( boolean arg ) { m_bViewingFrustumValid = arg; } public void setViewingTransformValid( boolean arg ) { m_bViewingTransformValid = arg; } （・・・省略・・・） }

フレーム描画処理の実装

GLSurfaceView.Rendererインターフェースを実装したクラスの、フレームを描画する時に呼び出されるonDrawFrame関数に、モデル描画の処理を追加します。
視野角錐台設定、視点座標変換は、設定の有効性メンバ変数に応じて実施するようにします。

public class OpenGLBaseRenderer implements Renderer { （・・・省略・・・） // フレームの描画 public void onDrawFrame( GL10 gl ) { gl.glClear( GL10.GL_COLOR_BUFFER_BIT | GL10.GL_DEPTH_BUFFER_BIT ); if( false == isViewingFrustumValid() ) { setupViewingFrustum(); } if( false == isViewingTransformValid() ) { setupViewingTransform(); } preRenderScene(); gl.glPushMatrix(); renderStockScene(); gl.glPopMatrix(); gl.glPushMatrix(); renderScene(); gl.glPopMatrix(); postRenderScene(); } （・・・省略・・・） }

視野角錐台設定、視点座標変換設定、シーン描画前の処理、シーン描画後の処理、ストックシーンの描画、シーン描画、軸の描画、byteバッファーの作成、shortバッファーの作成、floatバッファーの作成の関数を追加します。
また、byte型のバイト数、short型のバイト数、float型のバイト数の定数変数を追加します。
また、軸描画用の頂点バッファーメンバ変数、色バッファーメンバ変数を追加します。
また、コンストラクタを追加し、コンストラクタに、軸描画用の頂点バッファーメンバ変数、色バッファーメンバ変数の構築処理を追加します。

public class OpenGLBaseRenderer implements Renderer { private static final int SIZEOF_BYTE = Byte.SIZE / 8; // Byte.SIZEで、byte型のビット数が得られるので、8で割って、バイト数を得る private static final int SIZEOF_SHORT = Short.SIZE / 8; // Short.SIZEで、short型のビット数が得られるので、8で割って、バイト数を得る private static final int SIZEOF_FLOAT = Float.SIZE / 8; // Float.SIZEで、float型のビット数が得られるので、8で割って、バイト数を得る private GL10 m_gl; // OpenGLオブジェクト private int m_iWidth; // サーフェースサイズ private int m_iHeight; // サーフェースサイズ private boolean m_bViewingFrustumValid; // 視野角錐台設定の有効性 private boolean m_bViewingTransformValid; // 視点座標変換設定の有効性 private FloatBuffer m_fbVertex; // 軸の頂点 private ByteBuffer m_fbColor; // 軸の色（・・・省略・・・） // コンストラクタ public OpenGLBaseRenderer() { float[] af3Vertex = { 0.0f, 0.0f, 0.0f, 10.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 10.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 10.0f, }; byte[] abt3Color = { (byte)255, 0, 0, (byte)255, (byte)255, 0, 0, (byte)255, 0, (byte)255, 0, (byte)255, 0, (byte)255, 0, (byte)255, 0, 0, (byte)255, (byte)255, 0, 0, (byte)255, (byte)255, }; m_fbVertex = makeFloatBuffer( af3Vertex ); m_fbColor = makeByteBuffer( abt3Color ); } （・・・省略・・・） // 視野角錐台設定 protected void setupViewingFrustum() { m_gl.glMatrixMode( GL10.GL_PROJECTION ); m_gl.glLoadIdentity(); m_gl.glOrthof( -m_iWidth * 0.5f / 10.0f, m_iWidth * 0.5f / 10.0f, -m_iHeight * 0.5f / 10.0f, m_iHeight * 0.5f / 10.0f, 0.1f, 1000.0f ); m_gl.glMatrixMode( GL10.GL_MODELVIEW ); setViewingFrustumValid( true ); } // 視点座標変換設定 protected void setupViewingTransform() { m_gl.glMatrixMode( GL10.GL_MODELVIEW ); m_gl.glLoadIdentity(); GLU.gluLookAt( m_gl, 0.0f, 0.0f, 500, 0.0f, 0.0f, 0.0f, 0.0f, 1.0f, 0.0f ); setViewingTransformValid( true ); } // シーン描画前の処理 protected void preRenderScene() { } // シーン描画後の処理 protected void postRenderScene() { } // ストックシーンの描画 protected void renderStockScene() { renderAxis(); } // シーンの描画 protected void renderScene() { } // 軸の描画 private void renderAxis() { m_gl.glEnableClientState( GL10.GL_VERTEX_ARRAY ); m_gl.glEnableClientState( GL10.GL_COLOR_ARRAY ); m_gl.glVertexPointer( 3, GL10.GL_FLOAT, 0, m_fbVertex ); m_gl.glColorPointer( 4, // Must be 4. GL10.GL_UNSIGNED_BYTE, 0, m_fbColor ); m_gl.glLineWidth( 2.0f ); m_gl.glDrawArrays( GL10.GL_LINES, 0, 6 ); m_gl.glDisableClientState( GL10.GL_VERTEX_ARRAY ); m_gl.glDisableClientState( GL10.GL_COLOR_ARRAY ); } // byteバッファーの作成 public static final ByteBuffer makeByteBuffer( byte[] arr ) { ByteBuffer bb = ByteBuffer.allocateDirect( arr.length * SIZEOF_BYTE ); // byte:1byte bb.order( ByteOrder.nativeOrder() ); bb.put( arr ); bb.position( 0 ); return bb; } // shortバッファーの作成 public static final ShortBuffer makeShortBuffer( short[] arr ) { ByteBuffer bb = ByteBuffer.allocateDirect( arr.length * SIZEOF_SHORT ); // short:2byte bb.order( ByteOrder.nativeOrder() ); ShortBuffer sb = bb.asShortBuffer(); sb.put( arr ); sb.position( 0 ); return sb; } // floatバッファーの作成 public static final FloatBuffer makeFloatBuffer( float[] arr ) { ByteBuffer bb = ByteBuffer.allocateDirect( arr.length * SIZEOF_FLOAT ); bb.order( ByteOrder.nativeOrder() ); FloatBuffer fb = bb.asFloatBuffer(); fb.put( arr ); fb.position( 0 ); return fb; } }

メインアクティビティクラスの実装

メインアクティビティの、onCreate関数内で、以下を行います。

GLSurfaceView.Rendererインターフェースを実装したクラスのオブジェクトを生成します。
GLSurfaceViewクラスのオブジェクトを生成します。
1.で作成したGLSurfaceView.Rendererオブジェクトを、2.で作成したGLSurfaceViewオブジェクトに、setRenderer関数でセットします。
2.で作成したGLSurfaceViewオブジェクトを、メインアクティビティに、setContentView関数でセットします。

また、GLSurfaceViewクラスのオブジェクトメンバ変数を追加します。

また、GLSurfaceViewの描画モードは、既定では、RENDERMODE_CONTINUOUSLYという、絶え間なく描画するというモードになっていますが、RENDERMODE_WHEN_DIRTYという、描画要求があったときだけ描画するというモードに変更します。（描画要求は、requestRenderという関数で行います。）

また、その他、フルスクリーン設定、タイトルなし設定の処理を追加します。

public class ModelViewerEtudeActivity extends Activity { private GLSurfaceView m_glsurfaceview; @Override public void onCreate( Bundle savedInstanceState ) { super.onCreate( savedInstanceState ); // フルスクリーンの指定 getWindow().clearFlags( WindowManager.LayoutParams.FLAG_FORCE_NOT_FULLSCREEN ); getWindow().addFlags( WindowManager.LayoutParams.FLAG_FULLSCREEN ); // タイトルなし requestWindowFeature( Window.FEATURE_NO_TITLE ); // GLSurfaceViewの生成 m_glsurfaceview = new GLSurfaceView( this ); // Rendererの作成と、GLSurfaceViewへのセット m_glsurfaceview.setRenderer( new OpenGLBaseRenderer() ); // 絶え間ないレンダリングではなく都度のレンダリング（setRenderer()よりも後に呼び出す必要あり） m_glsurfaceview.setRenderMode( GLSurfaceView.RENDERMODE_WHEN_DIRTY ); // ActivityにViewのセット setContentView( m_glsurfaceview ); } }

他のアクティビティが起動した場合等には、OpenGLの処理を一時中断するようにします。

メインアクティビティクラスの、他のアクティビティが起動したことでバックグラウンドに追いやられた時に呼び出される onPause関数をオーバーライドし、GLSurfaceViewオブジェクトのonPause関数呼び出しを追加します。

メインアクティビティクラスの、ポーズから復帰する時に呼び出される onResume関数をオーバーライドし、GLSurfaceViewオブジェクトのonResume関数呼び出しを追加します。

public class ModelViewerEtudeActivity extends Activity { （・・・省略・・・） // 他のアクティビティが起動したことで、バックグラウンドに追いやられた時 @Override protected void onPause() { m_glsurfaceview.onPause(); super.onPause(); } // ポーズから復帰する時 @Override protected void onResume() { super.onResume(); m_glsurfaceview.onResume(); } }

import宣言は、eclipseの「エラーの即時修正」機能を使用して、追加します。

実行

Android Virtual Deviceの作成

動作確認用のAndroid Virtual Deviceを作成します。

OpenGL ES 1.0 の機能のみを利用したアプリケーションの動作確認用の Android Virtual Device の作成においては、特に気にすることはありません。
しかし、OpenGL ES 1.0 の機能に加えて、1.1 の機能を利用したアプリケーションの動作確認の Android Virtual Device においては、私の環境においては、Android Virtual Deviceを
・ターゲットとして、「Android 4.0.3 - API Level 15」
・ハードウェアとして、「GPU emulation」をyes
の設定で作成しなければ、「GPU内で関数が定義されていない」旨のエラーが発生し、動作確認ができませんでした。（エラーの具体的なメッセージとしては、「called unimplemented OpenGL ES API」。エラーが発生する具体的な関数としては、「glGetFloatv」。）

この章では、OpenGL ES 1.0の機能のみを利用していますが、続く章で、OpenGL ES 1.1の機能も利用するので、Android Virtual Device を
・ターゲットとして、「Android 4.0.3 - API Level 15」
・ハードウェアとして、「GPU emulation」をyes
の設定で作成します。

メニュー「ウィンドウ > AVD マネージャー」を選択します。

「新規」ボタンを押します。

名前：適当な名前を入力
ターゲット：「Android 4.0.3 - API Level 15」を選択
CPU/ABI：「ARM (armeabi-v7a)」を選択
SDカードサイズ：64[MiB]を入力
ハードウェア：「GPU emulation」の項目を追加し、値を「yes」に設定

「AVD の作成」ボタンを押します。

作成したAVDの項目を選択し、「開始」ボタンを押します。

「起動」ボタンを押します。

しばらくすると、AVDが起動し、しばらくすると、AVD内に、Android OSが起動します。
Android OSの起動が完了するのを待ちます。

スライドロックを解除します。