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

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

解説

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

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

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

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

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

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

実装

プロジェクトの作成

プロジェックとを作成します。

「Welcome」画面の「Start a new Android Studio project」をクリックします。


Application name、に「ModelViewerTutorial」と入力します。
Company domain、に会社のドメイン名を指定します。
Project location、にプロジェクトを保存するフォルダパスを指定します。
「Next」ボタンを押します。


Minimum SDKを選択します。今回は、「API19: Android 4.4 (KitKat)」にしました。
「Next」ボタンを押します。


「Empty Activity」を選択し、「Next」ボタンを押します。


（変更なし）
「Finish」を押します。

Target SDKのバージョンの変更

Androidのバージョンの違いによる振る舞いの違いを抑制したいので、Targe SDKのバージョンを、Minimum SDKで指定したバージョンに揃えます。

「Project」ペインの「Gradle Scripts > build.gradle (Module.app)」を開きます。


「targetSdkVersion」行を探し、
「targetSdkVersion 19」に変更します。
apply plugin: 'com.android.application' android { compileSdkVersion 25 buildToolsVersion "26.0.0" defaultConfig { applicationId "com.hiramine.modelviewertutorial" minSdkVersion 19 targetSdkVersion 19 versionCode 1 versionName "1.0" testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" } （・・・省略・・・）

ファイルを上書き保存します。
メニュー「Build > Rebuild Project」で、リビルドし、エラー、警告がないことを確認します。

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

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

「Project」ペインの「app > java > ドメイン.modelviewertutorial」を右クリックします。


右クリックメニュー「New > Java Class」を選択します。


Nameに、「OpenGLBaseRenderer」、
Interfaceに、「android.opengl.GLSurfaceView.Renderer」、
を入力し、「OK」ボタンを押します。

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

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

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

public class OpenGLBaseRenderer implements GLSurfaceView.Renderer { // メンバー変数 private GL10 m_gl; // OpenGLオブジェクト // アクセサ public GL10 getGL() { return m_gl; } // サーフェースが作成された時、再作成された時 // （レンダリングスレッドの起動時および、アンドロイドデバイスのスリープからの復帰時） @Override 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 ); // シェーディングモード } }

「Cannot resolve symbol」エラーは、「Alt + Enter」で、必要なクラスをimportします。

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

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

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

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

public class OpenGLBaseRenderer implements GLSurfaceView.Renderer { // メンバー変数 （・・・省略・・・） private int m_iWidth; // サーフェースサイズ private int m_iHeight; // サーフェースサイズ private boolean m_bViewingFrustumValid; // 視野角錐台設定の有効性 private boolean m_bViewingTransformValid; // 視点座標変換設定の有効性 // アクセサ （・・・省略・・・） 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; } // サーフェースが作成された時、再作成された時 // （レンダリングスレッドの起動時および、アンドロイドデバイスのスリープからの復帰時） @Override public void onSurfaceCreated( GL10 gl, EGLConfig config ) { （・・・省略・・・） } // サーフェースが変更された時 // （サーフェースが作成された後および、サーフェースのサイズが変更された時） @Override public void onSurfaceChanged( GL10 gl, int width, int height ) { m_iWidth = width; m_iHeight = height; // ビューポート設定 setupViewport(); // 視野角錐台設定の無効化（描画処理時に再設定され、有効化される） setViewingFrustumValid( false ); // 視点座標変換設定の無効化（描画処理時に再設定され、有効化される） setViewingTransformValid( false ); } // ビューポート設定 private void setupViewport() { m_gl.glViewport( 0, 0, m_iWidth, m_iHeight ); } }

「Cannot resolve symbol」エラーは、「Alt + Enter」で、必要なクラスをimportします。

フレーム描画処理の実装

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

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

public class OpenGLBaseRenderer implements GLSurfaceView.Renderer { // static関数 // byteバッファーの作成 public static 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 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 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; } // 定数 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 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 ); } // アクセサ （・・・省略・・・） // サーフェースが作成された時、再作成された時 // （レンダリングスレッドの起動時および、アンドロイドデバイスのスリープからの復帰時） @Override public void onSurfaceCreated( GL10 gl, EGLConfig config ) { （・・・省略・・・） } // サーフェースが変更された時 // （サーフェースが作成された後および、サーフェースのサイズが変更された時） @Override public void onSurfaceChanged( GL10 gl, int width, int height ) { （・・・省略・・・） } // ビューポート設定 private void setupViewport() { （・・・省略・・・） } // フレームの描画 @Override public void onDrawFrame( GL10 gl ) { gl.glClear( GL10.GL_COLOR_BUFFER_BIT | GL10.GL_DEPTH_BUFFER_BIT ); if( !isViewingFrustumValid() ) { setupViewingFrustum(); } if( !isViewingTransformValid() ) { setupViewingTransform(); } preRenderScene(); gl.glPushMatrix(); renderStockScene(); gl.glPopMatrix(); gl.glPushMatrix(); renderScene(); gl.glPopMatrix(); postRenderScene(); } // 視野角錐台設定 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 ); } }

「Cannot resolve symbol」エラーは、「Alt + Enter」で、必要なクラスをimportします。

レイアウトの変更

メインアクティビティのレイアウトを変更します。

「Project」ペインの「app > res > layout > activity_main.xml」を開きます。


ルートレイアウトを「LinearLayout」に変更します。
OpenGL用のViewとして、GLSurfaceViewを設置します。

activity_main.xmlの内容を以下のようにします。

<?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:app="http://schemas.android.com/apk/res-auto" android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical"> <android.opengl.GLSurfaceView android:id="@+id/glview" android:layout_width="match_parent" android:layout_height="match_parent"/> </LinearLayout>

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

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

1. ビューからGLSurfaceVeiwオブジェクトを取得します。
2. GLSurfaceView.Rendererインターフェースを実装した「OpenGLBaseRenderer」クラスのオブジェクトを生成します。
3. 2.で生成した「OpenGLBaseRenderer」オブジェクトを、1.で取得したGLSurfaceViewオブジェクトに、setRenderer関数でセットします。

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

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

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

メインアクティビティに、「初回表示時、および、ポーズからの復帰時」に呼ばれる関数である onResume関数と、「別のアクティビティ（か別のアプリ）に移行したことで、バックグラウンドに追いやられた時」に呼ばれる関数である onPause関数を追加します。

public class MainActivity extends AppCompatActivity { // メンバー変数 private GLSurfaceView m_glsurfaceview; @Override protected void onCreate( Bundle savedInstanceState ) { super.onCreate( savedInstanceState ); setContentView( R.layout.activity_main ); // GLSurfaceViewの取得 m_glsurfaceview = (GLSurfaceView)findViewById( R.id.glview ); // Rendererの作成と、GLSurfaceViewへのセット m_glsurfaceview.setRenderer( new OpenGLBaseRenderer() ); // 絶え間ないレンダリングではなく都度のレンダリング（setRenderer()よりも後に呼び出す必要あり） m_glsurfaceview.setRenderMode( GLSurfaceView.RENDERMODE_WHEN_DIRTY ); } // 初回表示時、および、ポーズからの復帰時 @Override protected void onResume() { super.onResume(); m_glsurfaceview.onResume(); } // 別のアクティビティ（か別のアプリ）に移行したことで、バックグラウンドに追いやられた時 @Override protected void onPause() { m_glsurfaceview.onPause(); super.onPause(); } }

「Cannot resolve symbol」エラーは、「Alt + Enter」で、必要なクラスをimportします。
リビルドし、エラー、警告がないことを確認します。

実行

Android端末にて、動作確認。

軸が表示されます。

ダウンロード

サンプルプロジェクト
（github.com上のダウンロードページ）

関連ページ

次項目：02．トラックOpenGLレンダラクラスを作る