スケルトンデータのロード
Spineアニメーションをあなたのアプリケーションに取り込むための最初のステップは、Spineからエクスポートされたテクスチャアトラスとスケルトンデータをロードすることです。
テクスチャアトラス
Spineはスケルトンを効率的にレンダリングするためにテクスチャアトラスをパックします。他のツールもSpineのアトラスフォーマットでテクスチャアトラスをパックするために使用できます。"libgdx"アトラスフォーマットを使用するTexture Packer Proがその例です。Spineランタイムは以下を使用することでアトラスをロードします:
Atlas atlas = new Atlas("myAtlas.atlas", textureLoader);
アトラスの作成では、アトラスページ画像内のどこに領域が存在するかを示すアトラステキストファイルを解析します。また、各アトラスページの画像ファイルもロードします。
TextureLoader
画像のロードはゲームのツールキット毎に特有なため、TextureLoaderが画像の作成、廃棄を行います。ゲームツールキット用のランタイムにはそのゲームツールキット用のTextureLoaderが搭載されています。汎用ランタイムを使用する場合、自分でTextureLoaderを書く必要があり、これには2つのメソッドがあります:
void unload (Object rendererObject)
load
メソッドはパスを使用して画像をロードし、AtlasPageにrendererObject
フィールドを設定します。unload
メソッドは以前にロードされた画像を破棄します。例えば、ここでのTextureはゲームツールキットタイプです:
Texture texture = GameToolkit.loadTexture(path);
page.rendererObject = texture;
}
void unload (Object rendererObject) {
Texture texture = (Texture)rendererObject;
texture.dispose();
}
AtlasPageのrendererObject
はレンダリングコードで使用されます。
JSONとバイナリデータ
JSONまたはバイナリスケルトンデータのロードはSkeletonJsonまたはSkeletonBinaryを使用して実行します。JSONは人間が判読可能ですが、ファイルサイズが大きく解析に時間が掛かります。バイナリはサイズが小さく迅速ですが人間には判読できません。SkeletonJsonとSkeletonBinaryは両方ともSkeletonDataを返すreadSkeletonData
メソッドを持っています。
SkeletonJsonまたはSkeletonBinaryインスタンスの作成は、新しいアタッチメントインスタンスを返すメソッドを持つAttachmentLoaderを指定する必要があります。AttachmentLoaderは、ロード時にアタッチメントをカスタマイズする方法を提供します。例えば、後でレンダリングするためにアタッチメントのアトラス領域を設定することができます。これは頻繁に行われるため、Spineランタイムはこれを実行するAtlasAttachmentLoaderを搭載しています:
SkeletonJson json = new SkeletonJson(attachmentLoader);
SkeletonData skeletonData = json.readSkeletonData("mySkeleton.json");
AtlasAttachmentLoaderはアタッチメントのpath
文字列を使用してテクスチャアトラス内の領域を発見し、その後レンダリングコードで使用するために、その領域にアタッチメントのrendererObject
フィールドを設定します。
AttachmentLoader
上級者はAtlasAttachmentLoaderを使用する代わりに、各アタッチメントタイプにメソッドを持つ自身のAttachmentLoaderを指定することを望むかもしれません:
MeshAttachment newMeshAttachment (Skin skin, String name, String path)
BoundingBoxAttachment newBoundingBoxAttachment (Skin skin, String name, String path)
PathAttachment newPathAttachment (Skin skin, String name, String path)
最低限、適切なタイプ(またはサブクラス)の新しいアタッチメントを作成して返されます。その後、JSONまたはバイナリファイルからのデータによってさらに設定される必要があります。メソッドがNULLを返した場合、アタッチメントはデータに存在しないかのように無視されます。
これはオプションですが、領域およびメッシュアタッチメントの場合、rendererObjectフィールドには、レンダリングコードが必要とする任意のオブジェクトを設定できます。例えば、レンダリング以外の目的にスケルトンを使用し、画像をロードする必要がない場合。あるいは、数千個のアタッチメントがあり、スケルトンデータをロードする時に全ての画像をロードすることが不可能な場合があります。このようなケースでは、実際に使用するアタッチメントを特定するまで画像のロードを待つほうがよいでしょう。
また、レンダリングする前にrendererObject
およびアトラス領域に関するいくつかのプロパティを設定する必要があります。例えば、UV、空白を除去された領域サイズ、元の画像サイズ、テクスチャパッカーにより領域が90度回転されたかどうかなどです。これらのプロパティの設定例については、ご使用のランタイム用のAtlasAttachmentLoaderのソースを参照してください。
スケーリング
スケルトンデータがロードされる時、SkeletonJsonまたはSkeletonBinaryクラスはボーンの位置、画像サイズ、およびトランスレーションのスケールを決定します:
json.scale = 2;
SkeletonData skeletonData = json.readSkeletonData("mySkeleton.json");
これによりスケルトンが様々なサイズで描画されます。上の例では2倍の大きさで描画されます。スケーリングはSpineでデザインした時のスケルトンとは異なる様々なサイズの画像を使用したい場合に便利です。例えば、Spineで使用された画像の半分のサイズの画像を使用する場合は、0.5のスケールを使用することができます。ゲームによっては、異なるサイズのテクスチャアトラスが含まれており、プレイヤーの画面解像度に応じて使用するものを選択しているものもあります。
ローダーのスケールを使用すると、使用される単位が変わります。例えばボーンのローカルポジションが50 , 100の場合、スケールを2にするとこれらはロード時に100 , 200に変更されます。これはランタイムでピクセル単位のスケールを使用しない場合に便利です。例えば、Box2Dはメートルを使用しているため、0.01のスケールを使ってピクセルをメートルに変換することができます。
rootボーンのスケールを変更することで、単位に影響を与えずにスケーリングすることもできます:
SkeletonData skeletonData = json.readSkeletonData("mySkeleton.json");
BoneData root = skeletonData.findBone("root");
root.scaleX = 2;
root.scaleY = 2;
この場合、ボーンのローカル位置が50 , 100であれば、その位置に留まります。しかし、ボーンのワールドトランスフォームが計算されると、その位置はスケーリングされます。ただし、そのスケルトンにスケールの継承を無効にしたボーンがある場合、うまくいかない可能性がありますのでご注意ください。