DKAlpha edited this page Dec 12, 2017 · 99 revisions

========================================================

SS5Player For Cocos2d-x v1.3.5

Copyright(C) Web Technology Corp. All rights reserved.

========================================================

概要

OPTPiX SpriteStudio 5 で制作したアニメーションデータを Cocos2d-x 上で再生するためのプログラムです。
更新内容はこちらのIssueを参照してください。

SS5Player For Cocos2d-xは開発を終了しました。

現在開発中のSS6Player For Cocos2d-xはこちらです。

対応バージョン

過去バージョンについては対応バージョン一覧を参照してください。

  • 対応するCocos2d-xのバージョン
    v3系プレイヤー:v3.15.1 での動作検証をしています。
    v2系プレイヤー:v2.2.6 での動作検証をしています。
    Visual Studio Communityで動作を確認しています。
    ※上記以外のバージョン、および非正式版(アルファ、ベータ、rc 等)については動作保証していません。
    また、今後も基本的に正式版のみへの対応となりますのでご注意下さい。

  • 対応するSpriteStudio 5 SDKのバージョン
    対応するssbpファイルのフォーマットバージョンは4です。
    OPTPiX SpriteStudio 5 SDK v1.7.0に含まれるSs5Converterで動作確認をしています。

  • 対応するSpriteStudio 5 のバージョン
    OPTPiX SpriteStudio 5.7.0のエフェクトの挙動と同等になります。
    プレイヤーをアップデートする場合はOPTPiX SpriteStudio 5.7.0でエフェクトファイルの調整、確認を行ってください。

(重要)SS5PlayerとSpriteStudioSDKの互換性について

SpriteStudioSDKに付属されているSs5converterで出力するssbpファイルにはフォーマットバージョンが存在します。
フォーマットバージョンの一覧はこちら
SS5Playerの対応しているフォーマットバージョンを確認し、対応したSs5converterを使用してください。
フォーマットバージョンが異なる場合ssbpファイル読み込み時にエラーとなります。
プロジェクトの都合などでssbpファイルのフォーマットを変更できない場合は動作している組み合わせを継続して使用する事を検討してください。

使用手順

  1. Ss5Converterを使ってアニメデータからsspbファイルを作製します。 Ss5ConverterはSpriteStudio5SDKに含まれています。
    こちらを参照してください

※コンバーターが更新されていると正しく再生されない可能性があります。最新のコンバーターを使用してください。
※SpriteStudio5本体からエクスポートするssbaファイルはSSPlayer用ファイルとなります。SS5Playerでは使用できませんのでご注意ください。

  1. プログラム側へ組み込みます。

Visual Studioの場合はこちらのFAQを参考にしてみてください。
Xcodeの場合はこちらのFAQを参考にしてみてください。
例として sample.sspj を変換して作られた sample.ssbp に含まれるアニメーションを再生する場合は以下の様になります。
v1.1.3以前をお使いの方はこちらの記事も参照してください。

#include "SS5Player.h"

//---- 
//プレイヤーが共有するエフェクトバッファを作成します。
//バッファは常駐されますのでゲーム起動時等に1度行ってください。
auto ss5man = ss::SS5Manager::getInstance();
ss5man->createEffectBuffer(1024);			//エフェクト用バッファの作成
//---- 

auto resman = ss::ResourceManager::getInstance();
resman->addData("sample.ssbp");

auto player = ss::Player::create();
player->setData("sample");		// ssbpファイル名(拡張子不要)
player->play("sample/anime1");	// アニメーション名を指定(ssae名/アニメーションの形で指定してください)
player->setPosition(200, 200);
this->addChild(player);

リファレンス

再生、制御方法についてはSS5Player.h のPlayer クラスのコメントをご覧ください。

サンプルプログラム

  • samples\cocos2d-xにcocos2d-x のサンプルプログラムが含まれています。

マルチ解像度対応について

  • 解像度によって読み込むテクスチャを変更する
    director->setContentScaleFactor()を使用してリソースのスケールを変更した場合UVが変わり壊れたように見えます。
    resman->addData()の第二引数にパスを指定する事によって、そのフォルダから画像を読み込む事ができます。
    画像ファイル名はアニメで使用している名前と同じ名前で用意してください。

  • UVをスケールに合わせて補正する
    Playerクラスのメンバ関数setContentScaleEneble()にtrueを設定すると、cocosに設定されたスケールからUVを補正して表示します。

制限される機能

  • X回転、Y回転について
    cocos2d-x Ver2.x対応のSS5PlayerはX回転、Y回転に対応していません。
    cocos2d-x Ver3.x対応のSS5PlayerでX回転、Y回転を行う場合は、アプリケーションの初期化で平行投影を設定しないと描画結果がSS5と異なります。
     
    auto director = Director::getInstance();
    //平行投影の設定
    director->setProjection(kCCDirectorProjection2D);
    

 
X回転、Y回転、Z回転の2つを組み合わせて回転する場合、パーツの原点を中央から変更していると描画結果がSS5と異なります。

SSPlayer(旧バージョン) から移行する方へ

こちらを参照してください。

ダウンロード

Players フォルダの Cocos2d-x フォルダの中にソースファイルとヘッダファイルがあります。
任意のプロジェクトに追加して使用してください。
各バージョンのダウンロードはこちら

お問い合わせ

まずこちらのリンクからIssuesページを開き過去に投稿されたFAQをご確認ください。

Issuesページの質問だけ表示する場合はこちら
Issuesページの不具合だけ表示する場合はこちら
Issuesページの要望だけ表示する場合はこちら
同じ内容の質問があった場合、何か追加情報がある場合はコメントに書いて下さい。

質問、不具合、要望を投稿する方法

  • 投稿前に必ずお読みください

    • (重要)投稿した内容について
      投稿した内容は全て一般に公開されますので個人情報や機密情報を記載しないようにご注意ください。
    • 質問をIssueへの書き込むにはGitHubのアカウントが必要です。
      アカウントをお持ちでない場合、こちらのGitHubチュートリアルを参考にアカウントを作成してください。
    • 別のプレイヤー、別のツールの質問はそれぞれのページへ投稿してください。
  • 投稿する
    Title欄に先頭にバージョン番号をvX.X.Xとつけて概要を記入し、Leave a comment に詳細を記入します。
    [Submit new issue] ボタンを押して完了です。後ほど担当者が確認しコメントいたします。

  • 再現データの添付が必要な場合

    • ウェブテクノロジの専用メールアドレス github-spritestudio@webtech.co.jp に添付して送付してください。
  • クリックするとメーラーが起動します。

  • ※送信する前に宛先が上記アドレスと相違ないかご確認ください。

  • ※重要なデータを含んでいる場合は、.zip を暗号化し、パスワードは別途お知らせください。

旧バージョンのドキュメントについて

SpriteStudioArchiveをご参照ください。

========================================================

株式会社ウェブテクノロジ
http://www.webtech.co.jp/
Copyright(C) Web Technology Corp.

========================================================

  • SpriteStudio, Web Technologyは、株式会社ウェブテクノロジの登録商標です。
  • その他の商品名は各社の登録商標または商標です。
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.