カテゴリー: 技術

技術的な情報について

【Swift, iOS】UIActivityViewControllerを使用してファイルをiCloud Driveなどのアプリ外に保存する

前回はアプリ外のファイルを読み込む場合の話だったが、今回は、アプリ外にファイルを保存する場合の話

Androidだと普通にできる（簡単とは言っていない）ため、iOSでも割と需要はあると思うのだが、それっぽいキーワードで検索しても出てこなかったためメモ

アプリ外へのファイル保存はいわゆる「共有」で使われるUIActivityViewControllerを使用する（Androidで言うと暗黙的Intent的なやつ）

以下は例としてDocumentディレクトリに保存したファイルをアプリ外に保存する処理のソースコード

func fileSave(fileName: String) {
    let dir = FileManager.default.urls( for: .documentDirectory, in: .userDomainMask ).first!
    let filePath = dir.appendingPathComponent(fileName, isDirectory: false);
    let controller = UIActivityViewController.init(activityItems: [filePath], applicationActivities: nil)
    controller.excludedActivityTypes = [
        .addToReadingList,
        .airDrop,
        .assignToContact,
        .copyToPasteboard,
        .mail,
        .markupAsPDF,
        .message,
        .openInIBooks,
        .postToFacebook,
        .postToFlickr,
        .postToTencentWeibo,
        .postToTwitter,
        .postToVimeo,
        .postToWeibo,
        .print,
        .saveToCameraRoll
    ]
    self.present(controller, animated: true, completion: nil)
}

excludedActivityTypesは除外したい共有先で、今回はファイル保存以外を出来るだけ消したいのでとりあえず定義してあるものを全部を指定しているが、SNSへの共有などを許可したいのであれば要変更

これに正しいファイル名を渡して呼ぶと以下の画像のように表示される

IMG_0004

この中からファイルに保存を選択するとiCloud Driveなどの保存先を選んでファイルを保存することができる

ただし、基本的には共有用のものであり、ユーザー側で他のものを選択されてしまうと保存ができないので、アプリ側である程度ナビゲートするようにした方が良いかもしれない

【Swift, iOS】UIDocumentBrowserViewControllerでiCloud Driveのファイルを読み込む際にNSCocoaErrorDomain Code=257のエラーが出る問題の対処法

iOSアプリを開発していてアプリ外にあるファイルを読み込みたいと思った時にUIDocumentBrowserViewControllerというクラスを見つけた

早速実装してUIDocumentBrowserViewControllerDelegateのdidPickDocumentsAtでiCloud Driveにある選択したファイルのURLをDataにしたところ、シミュレーターでは問題なく動いてホクホク顔をしていたら、実機だとエラーが出て撃沈

まあ結論から言うと、そういう用途の時はUIDocumentPickerViewControllerの方を使うべきで、そちらで探したらすぐ修正方法は見つかったのだが、UIDocumentBrowserViewControllerの方で探すとどこにもなくて無駄に時間を費やしてしまったのでメモ

まずはJSONファイルを読み込む場合を例として以下のように実装する

import UIKit

class DataLoadViewController: UIViewController, UIDocumentBrowserViewControllerDelegate {
    
    override func viewDidLoad() {
        super.viewDidLoad()

        let controller = UIDocumentBrowserViewController.init(forOpeningFilesWithContentTypes: ["public.json"])
        controller.delegate = self;
        controller.allowsDocumentCreation = false;
        controller.allowsPickingMultipleItems = false;
        self.present(controller, animated: true, completion: nil)
    }
    
    func documentBrowser(_ controller: UIDocumentBrowserViewController, didPickDocumentsAt documentURLs: [URL]) {
        controller.dismiss(animated: true, completion: nil)
        if documentURLs.first == nil {
            return
        }
        let data = try! Data(contentsOf: documentURLs.first!);
        let jsonStr = String(data: data, encoding: .utf8)
        print(jsonStr)
        //jsonStrを使ってあーだーこーだする
    }
}

このViewControllerを呼び出すとファイル操作のできる画面が表示され、そのうちiCloud DriveのJSONファイルを選択するとシミュレーターでは画面が閉じて問題なくJSONのテキストのログが表示されるが、端末だと以下の様なエラーが発生してクラッシュする

・Thread 1: Fatal error: 'try!' expression unexpectedly raised an error: Error Domain=NSCocoaErrorDomain Code=257 "The file “ファイル名.json” couldn’t be opened because you don’t have permission to view it." UserInfo={NSFilePath=/private/var/mobile/Library/Mobile Documents/com~apple~CloudDocs/ファイル名.json, NSUnderlyingError=0x283e1f1b0 {Error Domain=NSPOSIXErrorDomain Code=1 "Operation not permitted"}}

エラー内容を見るにファイルを開く権限がないと言われているようだが、UIDocumentBrowserViewController permissionで検索するとそれらしい情報はいくつかあるもののどれも解決には至らなかった

半分諦めかけていたところ、MacのパーミッションのStack OverflowでNSURLにリソースへのアクセス要求をするメソッドがあるとのことなので、試しに真似して実装してみたら解決した

以下がその実装

func documentBrowser(_ controller: UIDocumentBrowserViewController, didPickDocumentsAt documentURLs: [URL]) {
    controller.dismiss(animated: true, completion: nil)
    if documentURLs.first == nil || !documentURLs.first!.startAccessingSecurityScopedResource() {
        return
    }
    let data = try! Data(contentsOf: documentURLs.first!);
    let jsonStr = String(data: data, encoding: .utf8)
    //jsonStrを使ってあーだーこーだする
    documentURLs.first!.stopAccessingSecurityScopedResource()
}

startAccessingSecurityScopedResourceでリソースへのアクセス要求し、stopAccessingSecurityScopedResourceでリソースのアクセス要求を取り消している

ちなみに、UIDocumentPickerViewController permissionで検索すると速攻で以下が引っかかったので泣きそうになった

https://stackoverflow.com/questions/46440972/uidocumentpickerviewcontroller-with-uidocumentpickermodeopen-mode-not-giving-per

上記のUIDocumentBrowserViewControllerで行っている処理をUIDocumentPickerViewControllerでやると以下のようになる

import UIKit

class DataLoadViewController: UIViewController, UIDocumentPickerDelegate {
    
    override func viewDidLoad() {
        super.viewDidLoad()

        let controller = UIDocumentPickerViewController.init(documentTypes: ["public.json"], in: .open)
        controller.delegate = self;
        controller.allowsMultipleSelection = false;
        self.present(controller, animated: true, completion: nil)
    }
    
    func documentPicker(_ controller: UIDocumentPickerViewController, didPickDocumentsAt urls: [URL]) {
        if urls.first == nil || !urls.first!.startAccessingSecurityScopedResource() {
            return
        }
        let data = try! Data(contentsOf: urls.first!);
        let jsonStr = String(data: data, encoding: .utf8)
        //jsonStrを使ってあーだーこーだする
        urls.first!.stopAccessingSecurityScopedResource()
    }
}

こちらであればviewControllerをdismissで閉じる必要もないため、UIDocumentPickerViewControllerで実装するべきだろう

Cocos2d-xでGame Center(GameKit)、Google Play Games Servicesを使ってランキング機能を実装する

今回はCocos2d-xでゲーム内のランキング機能を実装したので、メモがてらここに貼っつけていきます
LobiなんかもCocos2d-xに対応していたりするので良いと思いますが、今回のアプリはカジュアルゲームだったので、ユーザー登録が必要ないGame CenterとPlay Games Servicesにしました
また、ここでは実装のみ紹介するので、コンソール側の登録などは以下などを参考にしてください

Game Center機能を実装する – Qiita
Google Play Game Servicesをとりあえず使ってみる（登録編） – Qiita

ちなみにログイン完了時のコールバック処理や認証失敗時のエラーダイアログ表示などは行っていないので、それが気になる方は各自で実装をお願いします

各OS共通

RankingController.h

#ifndef RankingController_h
#define RankingController_h


class RankingController {
public:
    
    static RankingController* getInstance();
    static void destroyInstance();
    
    virtual bool isLogin();
    virtual void start();
    virtual void showRanking();
    virtual void updateScore(int score);
    
protected:
    static RankingController* _singletonInstancePointer;
};

#endif /* RankingController_h */

全OS共通のヘッダです
シングルトンパターンを使っているのでどこからでも呼べるようにしています
各メソッドがvirtualなのはiOSでオーバーライドを行うからです

RankingController.cpp

#include "RankingController.h"
#include "cocos2d.h"

RankingController* RankingController::_singletonInstancePointer = nullptr;

#if CC_TARGET_PLATFORM != CC_PLATFORM_IOS
RankingController* RankingController::getInstance()
{
    if (_singletonInstancePointer == nullptr)
    {
        _singletonInstancePointer = new (std::nothrow) RankingController();
    }
    return _singletonInstancePointer;
}
#endif //CC_TARGET_PLATFORM != CC_PLATFORM_IOS

void RankingController::destroyInstance()
{
    delete _singletonInstancePointer;
    _singletonInstancePointer = nullptr;
}

#if CC_TARGET_PLATFORM != CC_PLATFORM_ANDROID

bool RankingController::isLogin() {
    return false;
}

void RankingController::start() {
    
}
void RankingController::showRanking() {
    
}
void RankingController::updateScore(int score) {
    
}
#endif //CC_TARGET_PLATFORM != CC_PLATFORM_ANDROID

全OS共通の実装です
getInstanceはiOSのみRankingControllerを継承したインスタンスを生成するためここでは実装しません
また、Android以外のOSでもビルドが通るように何もしないメソッドを用意しています（iOSはオーバーライドで実装）
AndroidのisLogin等の実装はRankingController_Android.cppで行います

iOS

RankingController_iOS.h

#ifndef RankingController_iOS_h
#define RankingController_iOS_h

#import <UIKit/UIKit.h>
#import <GameKit/GameKit.h>
#include "RankingController.h"

@interface GameCenterController : NSObject<GKGameCenterControllerDelegate> {
    
}

- (void)gameCenterViewControllerDidFinish:(GKGameCenterViewController *)gameCenterViewController;
- (BOOL)isLogin;
- (void)start;
- (void)showRanking;
- (void)updateScore:(NSInteger)score;

@end

class RankingController_iOS : public RankingController {
public:
    RankingController_iOS();
    virtual ~RankingController_iOS() = default;
    
    virtual bool isLogin() override;
    virtual void start() override;
    virtual void showRanking() override;
    virtual void updateScore(int score) override;
    
    GameCenterController* _gameCenterController;
};

#endif /* RankingController_iOS_h */

iOS用のヘッダです
RankingControllerの継承クラスと、Objective-CのGameCenterControllerクラスを宣言しています
GameKitを使用するので、Build PhasesのLink Binary With LibrariesからGameKit.frameworkを追加してください
GameCenterControllerクラスを用意する理由はGKGameCenterControllerDelegateを使用するためです

RankingController_iOS.mm

#include "cocos2d.h"
#if CC_TARGET_PLATFORM == CC_PLATFORM_IOS
#include "RankingController_iOS.h"
#import "AppController.h"

@implementation GameCenterController

static NSString* const LEADER_BOARD_ID = @"XXXXXXXXXXXXXXXXXXXXXX";

- (BOOL)isLogin
{
    GKLocalPlayer* player = [GKLocalPlayer localPlayer];
    return player.isAuthenticated;
}

- (void)start
{
    GKLocalPlayer* player = [GKLocalPlayer localPlayer];
    player.authenticateHandler = ^(UIViewController* ui, NSError* error )
    {
        if( nil != ui )
        {
            AppController* appController = [UIApplication sharedApplication].delegate;
            [appController.viewController presentViewController:ui animated:YES completion:nil];
        }
    };
}

- (void)updateScore:(NSInteger)score
{
    if (![self isLogin]) {
        return;
    }
    
    GKScore* gkScore = [[GKScore alloc] initWithLeaderboardIdentifier:LEADER_BOARD_ID];
    gkScore.value = score;
    [GKScore reportScores:@[gkScore] withCompletionHandler:^(NSError *error) {
        if (error) {
            
        }
    }];
}

- (void)showRanking
{
    if (![self isLogin]) {
        return;
    }
    GKGameCenterViewController *gcView = [GKGameCenterViewController new];
    gcView.gameCenterDelegate = self;
    gcView.viewState = GKGameCenterViewControllerStateLeaderboards;
    gcView.leaderboardTimeScope = GKLeaderboardTimeScopeAllTime;
    gcView.leaderboardIdentifier = LEADER_BOARD_ID;
    AppController* appController = [UIApplication sharedApplication].delegate;
    [appController.viewController  presentViewController:gcView animated:YES completion:nil];
}

- (void)gameCenterViewControllerDidFinish:(GKGameCenterViewController *)gameCenterViewController
{
    [gameCenterViewController dismissViewControllerAnimated:YES completion:nil];
}

@end


RankingController* RankingController::getInstance()
{
    if (_singletonInstancePointer == nullptr)
    {
        _singletonInstancePointer = new (std::nothrow) RankingController_iOS();
    }
    return _singletonInstancePointer;
}

RankingController_iOS::RankingController_iOS() {
    _gameCenterController = [[GameCenterController alloc] init];
}

bool RankingController_iOS::isLogin() {
    return [_gameCenterController isLogin];
}

void RankingController_iOS::start() {
    [_gameCenterController start];
};
void RankingController_iOS::showRanking() {
    [_gameCenterController showRanking];
};
void RankingController_iOS::updateScore(int score) {
    [_gameCenterController updateScore:score];
};

#endif //CC_TARGET_PLATFORM == CC_PLATFORM_IOS

iOS用のObjective-C++の実装部分です
GameCenterControllerでは実際にGameKitを使ってログインやスコアの更新、ランキングの表示を行っています
LEADER_BOARD_IDにはiTunes Connectで設定したリーダーボードのIDを入れてください
スコア送信失敗時や未ログイン時のランキング表示失敗などのエラー表示は特に何もしていないので、必要な場合は何かしらの処理を入れてください
また、ランキングの集計期間を１日や１週間にしたい場合は、GKGameCenterViewControllerのleaderboardTimeScopeをGKLeaderboardTimeScopeTodayやGKLeaderboardTimeScopeWeekに変更してください
RankingController_iOSではGameCenterControllerの生成と呼び出しを行っています
ここでRankingControllerのgetInstanceの実装を行うことで、iOSでのみgetInstance時にRankingController_iOSを生成するようにしています

Android

RankingController_Android.cpp

#include "RankingController.h"
#include "cocos2d.h"
#if CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID
#include <jni.h>
#include "platform/android/jni/JniHelper.h"

#define  CLASS_NAME "org/cocos2dx/cpp/PlayGamesController"

USING_NS_CC;

jobject getObject() {
    JniMethodInfo t;
    bool isHave = JniHelper::getStaticMethodInfo(t,
                                                 CLASS_NAME,
                                                 "getObject",
                                                 "()Ljava/lang/Object;");
    jobject instance;
    if (isHave)
    {
        instance = t.env->CallStaticObjectMethod(t.classID, t.methodID);
    }
    return instance;
}

bool RankingController::isLogin() {
    JniMethodInfo t;
    jobject instance = getObject();
    
    bool isHave = JniHelper::getMethodInfo(t, CLASS_NAME, "isLogin", "()Z");
    
    if (!isHave) {
        return false;
    }
    
    jboolean jIsLogin = t.env->CallBooleanMethod(instance, t.methodID);
    t.env->DeleteLocalRef(t.classID);
    
    return (bool)jIsLogin;
}

void RankingController::start() {
    JniMethodInfo t;
    jobject instance = getObject();
    
    bool isHave = JniHelper::getMethodInfo(t, CLASS_NAME, "start", "()V");
    
    if (!isHave) {
        return;
    }
    
    t.env->CallVoidMethod(instance, t.methodID);
    t.env->DeleteLocalRef(t.classID);
}

void RankingController::showRanking() {
    JniMethodInfo t;
    jobject instance = getObject();
    
    bool isHave = JniHelper::getMethodInfo(t, CLASS_NAME, "showRanking", "()V");
    
    if (!isHave) {
        return;
    }
    
    t.env->CallVoidMethod(instance, t.methodID);
    t.env->DeleteLocalRef(t.classID);
}

void RankingController::updateScore(int score) {
    JniMethodInfo t;
    jobject instance = getObject();
    
    bool isHave = JniHelper::getMethodInfo(t, CLASS_NAME, "updateScore", "(I)V");
    
    if (!isHave) {
        return;
    }
    jint jScore = (jint)score;
    
    t.env->CallVoidMethod(instance, t.methodID, jScore);
    t.env->DeleteLocalRef(t.classID);
}

#endif //CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID

RankingControllerのAndroidでの実装部分です
基本的にはPlayGamesController.javaのメソッドをJNI経由で呼んでいるだけです
PlayGamesControllerはシングルトンなので、staticのメソッドを呼ぶのではなく、PlayGamesControllerのインスタンスを取得してからそのインスタンスのメソッドを呼んでいます

PlayGamesController.java

package org.cocos2dx.cpp;

import android.app.Activity;
import android.content.Context;
import android.content.Intent;
import android.content.IntentSender;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;

import com.google.android.gms.common.ConnectionResult;
import com.google.android.gms.common.api.GoogleApiClient;
import com.google.android.gms.games.Games;
import com.google.android.gms.games.GamesActivityResultCodes;

import org.cocos2dx.lib.Cocos2dxActivity;

public class PlayGamesController implements GoogleApiClient.ConnectionCallbacks, GoogleApiClient.OnConnectionFailedListener {

    private GoogleApiClient mGoogleApiClient;

    private static final int RESOLUTION_REQUEST_CODE = 1000;
    private static final int LEADER_BOARD_REQUEST_CODE = 1001;

    private static PlayGamesController instance = new PlayGamesController();

    public static PlayGamesController getInstance() {
        return instance;
    }

    public static Object getObject() {
        return instance;
    }

    private PlayGamesController() {
        Context con = Cocos2dxActivity.getContext();
        mGoogleApiClient = new GoogleApiClient.Builder(con)
                .addConnectionCallbacks(this)
                .addOnConnectionFailedListener(this)
                .addApi(Games.API).addScope(Games.SCOPE_GAMES)
                .build();
    }

    public boolean isLogin() {
        return mGoogleApiClient.isConnected();
    }

    public void start() {
        if (isLogin() || mGoogleApiClient.isConnecting()) {
            return;
        }
        mGoogleApiClient.connect();
    }

    public void showRanking() {
        if (!isLogin()) {
            return;
        }
        Cocos2dxActivity activity = (Cocos2dxActivity)Cocos2dxActivity.getContext();
        activity.startActivityForResult(Games.Leaderboards.getLeaderboardIntent(mGoogleApiClient,
                        activity.getString(R.string.leaderboard_)), LEADER_BOARD_REQUEST_CODE);
    }

    public void updateScore(int score) {
        if (!isLogin()) {
            return;
        }
        Context con = Cocos2dxActivity.getContext();
        Games.Leaderboards.submitScore(mGoogleApiClient, con.getString(R.string.leaderboard_), score);
    };

    public void onActivityResult(int requestCode, int resultCode, Intent data) {
        if (requestCode == RESOLUTION_REQUEST_CODE) {
            if (resultCode != Activity.RESULT_OK) {
                return;
            }
            if (!mGoogleApiClient.isConnected()) {
                mGoogleApiClient.connect();
            }
        } else if (requestCode == LEADER_BOARD_REQUEST_CODE && resultCode == GamesActivityResultCodes.RESULT_RECONNECT_REQUIRED) {
            mGoogleApiClient.disconnect();
        }
    }

    @Override
    public void onConnected(@Nullable Bundle bundle) {
    }

    @Override
    public void onConnectionSuspended(int i) {
        //自動で再接続するらしいのでここいらないかも
        mGoogleApiClient.connect();
    }

    @Override
    public void onConnectionFailed(@NonNull ConnectionResult connectionResult) {
        if (connectionResult.getErrorCode() == ConnectionResult.SIGN_IN_REQUIRED
                && connectionResult.hasResolution()) {
            try {
                Cocos2dxActivity activity = (Cocos2dxActivity)Cocos2dxActivity.getContext();
                connectionResult.startResolutionForResult(activity, RESOLUTION_REQUEST_CODE);
            } catch (IntentSender.SendIntentException e) {
                mGoogleApiClient.connect();
            }
        }
    }
}

AndroidのJava側の実装です
この実装を行う前に、PlayGamesServicesAPIを使うためにapp/build.gradleに以下を追加してください

dependencies {
    compile 'com.google.android.gms:play-services-games:9.4.0'
}

後ろのバージョンはその時のGooglePlayAPIのバージョンに合わせてください
また、GooglePlayDeveloperConsoleで実績を5つ以上、リーダーボードを1つ以上設定した上でリソースを取得し、res/valuesに保存してください
その上で、AndroidManifest.xmlに以下を追加してください

<meta-data android:name="com.google.android.gms.games.APP_ID"
                   android:value="@string/app_id" />

この状態で上記PlayGamesControllerを実装して、R.string.leaderboard_の部分を設定したリーダーボードの名前に書き換えてください
ちなみにこのクラスはActivityではないのでonActivityResultが呼ばれないため、AppActivityに以下を追加してください

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        PlayGamesController.getInstance().onActivityResult(requestCode, resultCode, data);
    }

これらを実装した上で、C++部分で以下のような実装を追加してください

    RankingController::getInstance()->start();
    button1->addClickEventListener([](cocos2d::Ref* ref) {
        RankingController::getInstance()->updateScore(100);
    });
    button2->addClickEventListener([](cocos2d::Ref* ref) {
        RankingController::getInstance()->showRanking();
    });

このようにすれば、iOSであればGameCenter、AndroidであればGooglePlayGamesServicesを使ってランキングの更新、ランキングの表示が行えると思います

Cocos2d-xでgetWritablePath以外のファイルパスを取得する

前回シェア機能を実装した時に、Androidにおいてシェアする画像の保存先がgetWritablePathだと他のアプリから画像が参照できず、画像のシェアができないといった問題がありました
また、iOSにおいてはデフォルトのgetWritablePathの保存先がDocumentsになっているため、ダウンロードしたファイルをgetWritablePathに保存しているとアプリ申請でリジェクトを食らうといったことがよくあります
なので、保存先のパスを取得する処理を簡単に実装したのでメモがてらここに貼ります

FilePath.h

#ifndef FilePath_h
#define FilePath_h

#include "cocos2d.h"

class FilePath {
public:
    static std::string getDocumentPath(bool isPublic = false);
    static std::string getCachePath(bool isPublic = false);
    
#if CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID
    static std::string getExternalFilesPath();
    static std::string getExternalCachePath();
    
#endif
    
};

#endif /* FilePath_h */

各OS共通のヘッダです
AndroidにおいてはgetDocumentPathは正確にはgetFilesPathあたりの名前が正しいのですが、共通化するためiOSに合わせてます

FilePath_Apple.mm

#include "FilePath.h"
#import <UIKit/UIKit.h>

std::string getPath(NSSearchPathDirectory directory) {
    NSArray *paths = NSSearchPathForDirectoriesInDomains(directory, NSUserDomainMask, YES);
    NSString *documentsDirectory = [paths objectAtIndex:0];
    std::string strRet = [documentsDirectory UTF8String];
    strRet.append("/");
    return strRet;
}

std::string FilePath::getDocumentPath(bool isPublic) {
    return getPath(NSDocumentDirectory);
}

std::string FilePath::getCachePath(bool isPublic) {
    return getPath(NSCachesDirectory);
}

iOS、Mac用の実装です
getWritablePathの実装をコピペしてNSCachesDirectoryを選べるようにしただけです
isPublic引数はAndroidのためのものなので無視しています

FilePath_Android.cpp

#include "FilePath.h"
#include <jni.h>
#include "platform/android/jni/JniHelper.h"
#include "cocos2d.h"

#define  CLASS_NAME "org/cocos2dx/cpp/FilePath"

USING_NS_CC;

std::string getPath(const char* methodName) {
    JniMethodInfo t;
    std::string str;
    if (JniHelper::getStaticMethodInfo(t, CLASS_NAME, methodName, "()Ljava/lang/String;")) {
        jstring jpath  = (jstring)t.env->CallStaticObjectMethod(t.classID, t.methodID);
        
        const char* npath = t.env->GetStringUTFChars(jpath, NULL);
        str = npath;
        str += "/";
        
        t.env->ReleaseStringUTFChars(jpath, npath);
        t.env->DeleteLocalRef(t.classID);
    }
    return str;
}

std::string FilePath::getDocumentPath(bool isPublic) {
    if (isPublic) {
        return getExternalFilesPath();
    }
    return getPath("getFilesPath");
}

std::string FilePath::getCachePath(bool isPublic) {
    if (isPublic) {
        return getExternalCachePath();
    }
    return getPath("getCachePath");
}

std::string FilePath::getExternalFilesPath() {
    return getPath("getExternalFilesPath");
}

std::string FilePath::getExternalCachePath() {
    return getPath("getExternalCachePath");
}

Android用の実装です
isPublicがtrueならExternalの方のファイルパスを返すようにしています

FilePath.java

package org.cocos2dx.cpp;

import android.content.Context;

import org.cocos2dx.lib.Cocos2dxActivity;

import java.io.File;

public class FilePath {

    public static String getFilesPath() {
        Context con = Cocos2dxActivity.getContext();
        return con.getFilesDir().getAbsolutePath();
    }

    public static String getCachePath() {
        Context con = Cocos2dxActivity.getContext();
        return con.getCacheDir().getAbsolutePath();
    }

    public static String getExternalFilesPath() {
        Context con = Cocos2dxActivity.getContext();
        File file = con.getExternalFilesDir(null);
        if (file != null) {
            return file.getAbsolutePath();
        }
        return "";
    }

    public static String getExternalCachePath() {
        Context con = Cocos2dxActivity.getContext();
        File file = con.getExternalCacheDir();
        if (file != null) {
            return file.getAbsolutePath();
        }
        return "";
    }
}

AndroidのJavaの実装です
Externalのディレクトリがnullだと空白を返しているので注意
ここら辺適当な実装なので気になる方は各自で修正してください
また、Externalのディレクトリに書き込み・読み込みをする場合、以下の権限が必要になるのでAndroidManifest.xmlに以下を追加してください

    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

おまけのFilePath.cpp

#include "FilePath.h"
#if CC_TARGET_PLATFORM != CC_PLATFORM_IOS && CC_TARGET_PLATFORM != CC_PLATFORM_MAC && CC_TARGET_PLATFORM != CC_PLATFORM_ANDROID


std::string FilePath::getDocumentPath(bool isPublic) {
    return cocos2d::FileUtils::getInstance()->getWritablePath();
}

std::string FilePath::getCachePath(bool isPublic) {
    return cocos2d::FileUtils::getInstance()->getWritablePath();
}

#endif

iOS、Mac、Android以外の場合の実装です
ビルドを通すためだけのものなので面倒なのでgetWritablePath返しちゃってます

以下この実装を使ったサンプル

        cocos2d::utils::captureScreen([](bool success, std::string filePath) {
            if (success) {
                //前回の記事で実装したシェアのメソッド
                Share::lineSendImage(filePath);
            }
        }, FilePath::getCachePath(true) + "capture.png");

こんな感じでやれば画面のスクリーンショット画像をキャッシュディレクトリに保存してLINEでシェアなんかできたりすると思います

Cocos2d-xでTwitter、Facebook、LINEの簡易的なシェア機能を実装する

プロジェクトが変わるたびにいつも同じようなコードを書いている気がするので、シェアの機能を実装したついでにここにコードをメモしておきます
ちなみにSDKを使った本格的な実装は面倒だったのでopenURLやintentなどを使った簡易的なものになります
まずは基本のクラスから

Share.h

#ifndef Share_h
#define Share_h

#include <string>

class Share{
public:
    static void facebook(const std::string& message, const std::string& imagePath = "", const std::string& url = "");
    static void twitter(const std::string& message, const std::string& imagePath = "", const std::string& url = "");
    static void lineSendMessage(const std::string& message);
    static void lineSendImage(const std::string& imagePath);
    
private:
    
    static constexpr auto LINE_URL_SCHEME = "line://msg/%s/%s";
    static constexpr auto CONTENT_IMAGE = "image";
    static constexpr auto CONTENT_TEXT = "text";
};

#endif /* Share_h */

とりあえずシェアするものはメッセージと画像とURLにしています
LINEはそれぞれ画像かメッセージかのどちらか片方しか送れないので一つずつ関数を用意しています

Share.cpp

#include "Share.h"
#include "cocos2d.h"
#include <iomanip>

std::string url_encode(const std::string &value) {
    std::ostringstream escaped;
    escaped.fill('0');
    escaped << std::hex;
    
    for (auto i = value.begin(); i != value.end(); ++i) {
        unsigned char c = (*i);
        
        if (isalnum(c) || c == '-' || c == '_' || c == '.' || c == '~') {
            escaped << c;
            continue;
        }
        
        escaped << '%' << std::setw(2) << int(c);
    }
    
    return escaped.str();
}

void Share::lineSendMessage(const std::string& message) {
    std::string encodedMessage = url_encode(message);
    std::string urlString = cocos2d::StringUtils::format(LINE_URL_SCHEME, CONTENT_TEXT, encodedMessage.c_str());
    cocos2d::Application::getInstance()->openURL(urlString);
}


#if CC_TARGET_PLATFORM != CC_PLATFORM_IOS && CC_TARGET_PLATFORM != CC_PLATFORM_ANDROID

void Share::facebook(const std::string& message, const std::string& imagePath, const std::string& url) {
    CCLOG("This OS is not implemented yet");
}

void Share::twitter(const std::string& message, const std::string& imagePath, const std::string& url) {
    CCLOG("This OS is not implemented yet");
}

void Share::lineSendImage(const std::string& imagePath) {
    CCLOG("This OS is not implemented yet");
}
#endif

LINEのメッセージ送信のみiOSとAndroidで実装を共通化可能なためここで実装しています
LINEのメッセージはURLエンコーディングする必要があるのでエンコードしてからopenURLを叩いています
URLエンコードの実装はほぼStackOverflowからパクっています
iOSとAndroid以外では一応ビルドエラーが出ないようにしています（英語は適当）

ここから下はOSごとの実装になります

Share_iOS.mm

#include "Share.h"
#include "cocos2d.h"
#import "AppController.h"
#import <Social/Social.h>

void SLComposeViewShare(NSString* serviceType, const std::string& message, const std::string& imagePath, const std::string& url) {
    
    SLComposeViewController *composeViewController = [SLComposeViewController composeViewControllerForServiceType:serviceType];
    void (^completion) (SLComposeViewControllerResult result) = ^(SLComposeViewControllerResult result) {
        [composeViewController dismissViewControllerAnimated:YES completion:nil];
    };
    [composeViewController setCompletionHandler:completion];
    [composeViewController setInitialText:[NSString stringWithUTF8String:message.c_str()]];
    if (!imagePath.empty()) {
        UIImage* image = [UIImage imageWithContentsOfFile:[NSString stringWithUTF8String:imagePath.c_str()]];
        [composeViewController addImage:image];
    }
    if (!url.empty()) {
        [composeViewController addURL:[NSURL URLWithString:[NSString stringWithUTF8String:url.c_str()]]];
    }
    
    AppController* appController = [UIApplication sharedApplication].delegate;
    [appController.viewController presentViewController:composeViewController animated:YES completion:Nil];
}


void Share::facebook(const std::string& message, const std::string& imagePath, const std::string& url) {
    SLComposeViewShare(SLServiceTypeFacebook, message, imagePath, url);
}
void Share::twitter(const std::string& message, const std::string& imagePath, const std::string& url) {
    SLComposeViewShare(SLServiceTypeTwitter, message, imagePath, url);
}

void Share::lineSendImage(const std::string& imagePath) {
    UIImage* image = [UIImage imageWithContentsOfFile:[NSString stringWithUTF8String:imagePath.c_str()]];
    
    UIPasteboard *pasteboard;
    
    if ([[UIDevice currentDevice].systemVersion floatValue] >= 7.0) {
        pasteboard = [UIPasteboard generalPasteboard];
    } else {
        pasteboard = [UIPasteboard pasteboardWithUniqueName];
    }
    [pasteboard setImage:image];
    
    std::string urlString = cocos2d::StringUtils::format(LINE_URL_SCHEME, CONTENT_IMAGE, [pasteboard.name UTF8String]);
    cocos2d::Application::getInstance()->openURL(urlString);
}

iOS側のObjective-C++の実装になります
TwitterとFacebookのシェアではSLComposeViewControllerを使っているため、必ずSocial.frameworkをBuild Phasesから追加してください
LINEの画像のシェアはline://のURLスキームでopenURLから行いますが、iOSの場合はペーストボード名をURLに含める必要があります

Share_Android.cpp

#include "Share.h"
#include <jni.h>
#include "platform/android/jni/JniHelper.h"
#include "cocos2d.h"

#define  CLASS_NAME "org/cocos2dx/cpp/Share"

USING_NS_CC;

void Share::facebook(const std::string& message, const std::string& imagePath, const std::string& url) {
    if (imagePath.empty() && url.empty()) {
        //Facebookは画像かURLのどちらかのみシェア可能
        return;
    }
    JniMethodInfo t;
    if (JniHelper::getStaticMethodInfo(t, CLASS_NAME, "facebook", "(Ljava/lang/String;Ljava/lang/String;)V")) {
        jstring jUrl = t.env->NewStringUTF(url.c_str());
        jstring jFilePath = t.env->NewStringUTF(imagePath.c_str());
        
        t.env->CallStaticVoidMethod(t.classID, t.methodID, jFilePath, jUrl);
        
        t.env->DeleteLocalRef(jFilePath);
        t.env->DeleteLocalRef(jUrl);
        t.env->DeleteLocalRef(t.classID);
    }
    
}
void Share::twitter(const std::string& message, const std::string& imagePath, const std::string& url) {
    
    JniMethodInfo t;
    if (JniHelper::getStaticMethodInfo(t, CLASS_NAME, "twitter", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V")) {
        jstring jMessage = t.env->NewStringUTF(message.c_str());
        jstring jFilePath = t.env->NewStringUTF(imagePath.c_str());
        jstring jUrl = t.env->NewStringUTF(url.c_str());
        
        
        t.env->CallStaticVoidMethod(t.classID, t.methodID, jMessage, jFilePath, jUrl);
        
        t.env->DeleteLocalRef(jMessage);
        t.env->DeleteLocalRef(jFilePath);
        t.env->DeleteLocalRef(jUrl);
        t.env->DeleteLocalRef(t.classID);
    }
}

void Share::lineSendImage(const std::string& imagePath) {
    std::string urlString = cocos2d::StringUtils::format(LINE_URL_SCHEME, CONTENT_IMAGE, imagePath.c_str());
    cocos2d::Application::getInstance()->openURL(urlString);
}

Android側のJNI他の実装になります
このファイルはiOSのビルド対象に含めないでください
AndroidのTwitterとFacebookのシェアはIntentを使ってシェアしますが、Facebookはメッセージのシェアは行えないので、画像かURLがあった場合のみシェアを行います
AndroidのLINEはURLにファイルパスを含めるだけで画像のシェアを行えます
ただ、Androidの画像のシェアはgetWritablePathで取得するファイルパスが他のアプリから参照できないため、Cocos2d-xで保存した画像をシェアする場合はファイルパスを工夫する必要があります

Share.java

package org.cocos2dx.cpp;

import android.content.Context;
import android.content.Intent;
import android.net.Uri;
import android.webkit.MimeTypeMap;

import org.cocos2dx.lib.Cocos2dxActivity;

import java.io.File;

public class Share {

    public static void twitter(String message, String filePath, String url) {
        Context con = Cocos2dxActivity.getContext();

        Intent intent = new Intent(Intent.ACTION_SEND);

        File file = new File(filePath);
        if (file.exists()) {
            int index = file.getName().lastIndexOf('.');
            String ext = (index >= 0) ? file.getName().substring(index + 1).toLowerCase() : "";
            String mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(ext);
            intent.setType(mimeType);
            intent.putExtra(Intent.EXTRA_STREAM, Uri.fromFile(file));
        } else {
            intent.setType("text/plain");
        }

        if (url.isEmpty()) {
            intent.putExtra(Intent.EXTRA_TEXT, message);
        } else {
            intent.putExtra(Intent.EXTRA_TEXT, message + " " + url);
        }
        intent.setPackage("com.twitter.android");

        con.startActivity(intent);
    }


    public static void facebook(String filePath, String url) {
        Context con = Cocos2dxActivity.getContext();

        Intent intent = new Intent(Intent.ACTION_SEND);

        File file = new File(filePath);
        if (file.exists()) {
            int index = file.getName().lastIndexOf('.');
            String ext = (index >= 0) ? file.getName().substring(index + 1).toLowerCase() : "";
            String mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(ext);
            intent.setType(mimeType);
            intent.putExtra(Intent.EXTRA_STREAM, Uri.fromFile(file));
        } else {
            intent.setType("text/plain");
            intent.putExtra(Intent.EXTRA_TEXT, url);
        }

        intent.setPackage("com.facebook.katana");

        con.startActivity(intent);
    }
}

AndroidのJNIで呼ぶJavaの実装になります
TwitterはURLがある場合はメッセージの後ろに空白を入れてURLを入れています
Facebookは画像とURLが両方ある場合は画像を優先してシェアするようにしています

これで一応一通りシェアが可能になるかと思います
最初はgithubで公開しようかと思ったのですが、既に似たようなものがあったのでやめました
Androidの画像のファイル保存先の取得については次の記事でやろうと思います

Cocos2d-x(JS)でCocosStudioのcsdファイル内csdファイルのアニメーションを取得、再生する その２

前回からの続きで、今回は作成したCocosStudioのcsdファイル内csdのNodeのアニメーションをコード上で制御する方法を紹介します

まず、Nodeからアニメーション（ccs.ActionTimeline）を取得するために以下のようなメソッドを用意します

var utils = utils || {};

/**
 * @param {cc.Node} node
 * @returns {ccs.ActionTimeline|cc.Action|null}
 */
utils.getActionTimeLine = function (node) {
    return node.getActionByTag(node.getTag());
};

このメソッドを利用して、ccs.loadをしているところで以下のように実装します

var HelloWorldLayer = cc.Layer.extend({
    ctor:function () {
        this._super();

        /** @type {{node: cc.Node, action: cc.Action}} */
        var mainscene = ccs.load(res.MainScene_json);
        this.addChild(mainscene.node);

        /** @type {cc.Node} */
        var rotateIcon = mainscene.node.getChildByName("RotateIcon");
        /** @type {ccs.ActionTimeline} */
        var iconTimeLine = utils.getActionTimeLine(rotateIcon);
        iconTimeLine.play("rotate", true);

        return true;
    }
});

この状態でproject.jsonやresource.jsなどを修正してから起動すると、子要素のアニメーションがループ再生されるのが確認できると思います

なぜこれで子要素のアニメーションが取得できるかというと、ccs.loadをした際に読み込むcsd(json)データが、CocosStudio v2以降のものであれば、timelineParser-2.x.jsが呼ばれ、そこで以下のような処理をしているからになります

    parser.initProjectNode = function(json, resourcePath){
        var projectFile = json["FileData"];
        if(projectFile != null && projectFile["Path"]){
            var file = resourcePath + projectFile["Path"];
            if(cc.loader.getRes(file)){
                var obj = ccs.load(file, resourcePath);
                parser.generalAttributes(obj.node, json);
                if(obj.action && obj.node){
                    obj.action.tag = obj.node.tag;
                    var InnerActionSpeed = json["InnerActionSpeed"];
                    if(InnerActionSpeed !== undefined)
                        obj.action.setTimeSpeed(InnerActionSpeed);
                    obj.node.runAction(obj.action);
                    obj.action.gotoFrameAndPause(0);
                }
                return obj.node;
            } else
                cc.log("%s need to be preloaded", file);
        }
    };

読み込んだactionをnodeのタグと同じにした上でrunActionしているのがわかると思います
そのため、nodeからnodeのタグでgetActionByTagをするとccs.ActionTimelineが取得できるというわけです

これを応用して、以下のようなccs.loadのwrapperを用意すると非常に捗ります

/**
 * @param {string} file
 * @param {string} [path]
 * @returns {cc.Node}
 */
utils.loadCCSNode = function (file, path) {
    var ccsObj = ccs.load(file, path);
    var node = ccsObj.node;
    var action = ccsObj.action;

    if(action && node){
        action.tag = node.tag;
        node.runAction(action);
        action.gotoFrameAndPause(0);
    }
    return node;
};

こうすることにより、nodeとactionを分けずに扱えるため、actionが必要になった時だけutils.getActionTimeLineを呼ぶといった使い方ができるようになるため、オススメです

Cocos2d-x(JS)でCocosStudioのcsdファイル内csdファイルのアニメーションを取得、再生する その１

今回はCocos Studioにおいて、csdファイル内csdファイルのNodeのアニメーションを取得、再生する方法についてになります

まず、CocosStudioで以下のようにアニメーションを設定したcsdファイルを用意します

Icon

次に、アニメーションを設定したcsdファイルを別のcsdファイル表示時にドラッグ＆ドロップします

drag

すると、csdファイル内に別のcsdファイルを子要素のNodeとして持たせることができます
Begin to record frameにチェックを入れて、この子要素のNested Actionという項目を設定すると、親のアニメーションの特定のタイミングで子要素をアニメーションさせることができます

nested_action

しかし、これだと親のアニメーションの時間が子要素より短い場合、子要素のアニメーションが途中で止まってしまったり、クリックイベントのタイミングでアニメーションを再生させたい場合などの時に、複雑なタイムラインになっていまいます

そのため、この子要素のアニメーションの再生をコード上で制御する必要があるのですが・・・長くなったので続きは次の記事で