Springhead
An open source physics engine for virtual reality, haptics and motion generation.
　APIのしくみ

◇ Contents ◇

　　1　APIの形式
　　2　APIクラス
　　3　安全なキャスト
　　4　ステートとデスクリプタ

1　APIの形式

ここでは，Springhead2 SDKのAPIの形式について説明します． SDKは，下の図の上側のような，実装を持たないAPIクラスを介して使います．

APIInherit.png

2　APIクラス

APIクラスは，名前の最後にインタフェースを表すIfがつきます． まず，SDKクラスのインスタンスを返すグローバル関数を用いて， SDKクラスのインスタンスを作成・取得し， 次にSDKクラスから別のAPIクラスのインスタンスを作成・取得していきます．
次のコードは物理エンジンAPIを使ったプログラムの例です． 

int main(int argc, char* argv[]){
    PHSdkIf* sdk = CreatePHSdk();                   //  物理エンジンSDKの作成
    PHSceneIf* scene = sdk->CreateScene();          //  シーンの作成
    :

3　安全なキャスト

APIクラス同士のキャストには， Cast()関数が便利です． 

    ObjectIf* obj = CreatePHSdk();
    PHSdkIf* phsdk = obj->Cast();   //  phsdk型にキャストされる，
    GRSdkIf* grsdk = obj->Cast();   //  キャストできないので，grsdk=NULLになる．

アップキャスト，ダウンキャスト共に安全です． Cast()関数は，オブジェクトが本当にそのAPIクラスを実装している場合だけキャストを実行し， できない場合は NULL を返します．

4　ステートとデスクリプタ

APIクラスのインスタンスを作るときには，デスクリプタという構造体を使って 初期値を渡します．デスクリプタは，APIクラスの名前からIfをとってDescをつけた名前です． 

int main(int argc, char* argv[]){
    PHSdkIf* sdk = CreatePHSdk();                   //  物理エンジンSDKの作成
    PHSceneIf* scene = sdk->CreateScene();          //  シーンの作成
    PHSolidDesc desc;                               //  剛体のディスクリプタ
    desc.mass = 2.0;                                //  質量を2に設定
    desc.inertia *= 2.0;                            //  慣性テンソルの対角成分を2に設定
    PHSolidIf* solid1 = scene->CreateSolid(desc);   //  剛体１をdescに基づいて作成
    desc.center = Vec3f(1,0,0);                     //  剛体の重心を(1,0,0)に設定
    PHSolidIf* solid2 = scene->CreateSolid(desc);   //  剛体２をdescに基づいて作成
    :

ディスクリプタのなかには， Spr::PHSolidDesc のように，ステート (Spr::PHSolidState) を継承しているものがあります． ステートは，そのインスタンスの状態を表す変数でシミュレーションを進めると変化します． ステートだけを保存しておけば，そのオブジェクトを保存しておいた時点の状態に戻すことができます． 図のように，オブジェクトは，ステートとディスクリプタと継承していることが多いです．

APIDesc.png