import com.sun.opengl.util.j2d.TextRenderer;\r
\r
/**\r
- * OpenGL向けの描画関数を提供します。\r
+ * このクラスには、アプリケーションの為のOpenGL用のヘルパー関数を定義します。\r
+ * NyARToolKitを使ったアプリケーションを実装するのに役立ちます。\r
+ * ほとんどの関数はstatic宣言です。このクラスのインスタンスを作る必要はありません。\r
+ * \r
+ *\r
*/\r
public class NyARGLDrawUtil\r
{\r
private static TextRenderer _tr=new TextRenderer(new Font("SansSerif", Font.PLAIN, 10));\r
/**\r
- * 立方体を描画します。\r
+ * この関数は、指定サイズの立方体を現在のビューポートへ描画します。\r
+ * ARToolKitのサンプルで使われているカラーキューブを描画します。\r
* @param i_gl\r
- * OpenGLインスタンス\r
+ * OpenGLã\81®ã\82¤ã\83³ã\82¹ã\82¿ã\83³ã\82¹\r
* @param i_size_per_mm\r
- * 立方体の辺の長さを[mm単位]\r
+ * 立方体の辺の長さ。[mm単位]\r
+ * ARシステムをmmオーダーで構築していない場合は、別単位になります。\r
*/\r
public static void drawColorCube(GL i_gl,float i_size_per_mm)\r
{\r
i_gl.glCallList(polyList); // Draw the cube.\r
}\r
/**\r
- * フォントカラーをセットします。\r
+ * この関数は、{@link NyARGLDrawUtil}の描画する文字列の、フォントカラーを設定します。\r
+ * フォントカラーはOpenGL固有のものではなく、{@link NyARGLDrawUtil}固有のものです。\r
* @param i_c\r
+ * 設定する色。\r
*/\r
public static void setFontColor(Color i_c)\r
{\r
NyARGLDrawUtil._tr.setColor(i_c);\r
}\r
/**\r
- * フォントスタイルをセットします。\r
+ * この関数は、{@link NyARGLDrawUtil}の描画する文字列の、フォントスタイルを設定します。\r
+ * フォントスタイルはOpenGL固有のものではなく、{@link NyARGLDrawUtil}固有のものです。\r
* @param i_font_name\r
+ * フォントの名前を指定します。デフォルト値は、"SansSerif"です。\r
* @param i_font_style\r
+ * フォントスタイルを指定します。デフォルト値は、{@link Font#PLAIN}です。\r
* @param i_size\r
+ * フォントサイズを指定します。デフォルト値は、10です。\r
*/\r
public static void setFontStyle(String i_font_name,int i_font_style,int i_size)\r
{\r
NyARGLDrawUtil._tr=new TextRenderer(new Font(i_font_name,i_font_style, i_size));\r
}\r
/**\r
- * 現在のフォントで、文字列を描画します。\r
+ * この関数は、文字列を描画します。\r
+ * この関数は、ちらつきが発生したり、あまり品質が良くありません。品質を求められる環境では、別途実装をして下さい。\r
* @param i_str\r
+ * 描画する文字列。\r
* @param i_scale\r
+ * 文字列のスケール値。\r
*/\r
public static void drawText(String i_str,float i_scale)\r
{\r
return;\r
}\r
/**\r
- * INyARRasterの内容を現在のビューポートへ描画します。\r
+ * この関数は、{@link INyARRaster}の内容を、現在のビューポートへ描画します。\r
+ * カメラ画像の背景を描画するのに使用できます。\r
* @param i_gl\r
+ * OpenGLのインスタンス\r
* @param i_raster\r
+ * 描画するラスタオブジェクト。何れかのバッファ形式である必要があります。\r
+ * <ol>\r
+ * <li>{@link NyARBufferType#BYTE1D_B8G8R8_24}\r
+ * <li>{@link NyARBufferType#BYTE1D_R8G8B8_24}\r
+ * <li>{@link NyARBufferType#BYTE1D_B8G8R8X8_32}\r
+ * </ol>\r
* @param i_zoom\r
* @throws NyARException\r
*/\r
}\r
}\r
/**\r
- * スクリーン座標系をOpenGLにロードします。この関数は、PROJECTIONとMODELVIEWスタックをそれぞれ1づつpushします。\r
- * スクリーン座標系を使用し終わったら、endScreenCoordinateSystemを呼び出してください。\r
+ * この関数は、スクリーン座標系をOpenGLにロードします。\r
+ * スクリーンに二次元系の情報をそのまま書きこむときに使います。\r
+ * この関数は、PROJECTIONとMODELVIEWスタックをそれぞれ1づつpushします。\r
+ * スクリーン座標系を使用し終わったら、{@link endScreenCoordinateSystem}を必ず呼び出してください。\r
* @param i_gl\r
+ * OpenGLのインスタンス\r
* @param i_width\r
+ * スクリーンの幅\r
* @param i_height\r
+ * スクリーンの高さ\r
* @param i_revers_y_direction\r
- * Y軸ã\81®å\8f\8d転ã\83\95ã\83©ã\82°ã\81§ã\81\99ã\80\82trueã\81ªã\82\89ã\81°top->bottomã\80\81falseã\81ªã\82\89ã\81°bottom->topæ\96¹å\90\91ã\81«ã\81ªã\82\8aã\81¾ã\81\99ã\80\82\r
+ * Y軸の反転フラグ。trueならばtop->bottom、falseならばbottom->top方向になります。\r
*/\r
public static void beginScreenCoordinateSystem(GL i_gl,int i_width,int i_height,boolean i_revers_y_direction)\r
{\r
return;\r
}\r
/**\r
- * ロードしたスクリーン座標系を元に戻します。{@link #beginScreenCoordinateSystem}の後に呼び出してください。\r
+ * この関数は、ロードしたスクリーン座標系を元に戻します。\r
+ * {@link #beginScreenCoordinateSystem}の後に呼び出してください。\r
* @param i_gl\r
+ * OpenGLのインスタンス\r
*/\r
public static void endScreenCoordinateSystem(GL i_gl)\r
{\r
OSDN Git Service
