iOS项目集成UnityFramework

背景:最近公司要做关于幼儿编程的项目,在iOS项目中需要使用视频交互的功能,最后选择的方案是使用Unity实现,主要涉及到iOS原生项目和Unity界面来回切换,iOS和Unity的相互通信。

1、iOS原生项目和Unity界面来回切换

1.1 从iOS原生项目通过点击按钮进入Unity

- (void)enterUnityButtonClick {
  [self initUnity];
}

- (void)initUnity
{
    if([self unityIsInitialized]) {
        showAlert(@"Unity already initialized", @"Unload Unity first");
        return;
    }
    if([self didQuit]) {
        showAlert(@"Unity cannot be initialized after quit", @"Use unload instead");
        return;
    }
    
    [self setUfw: UnityFrameworkLoad()];
    [[self ufw] setDataBundleId: "com.unity3d.framework"];
    [[self ufw] registerFrameworkListener: self];
    [[self ufw] runEmbeddedWithArgc: gArgc argv: gArgv appLaunchOpts: appLaunchOpts];
    // set quit handler to change default behavior of exit app
    [[self ufw] appController].quitHandler = ^(){ NSLog(@"AppController.quitHandler called"); };
  }

UnityFramework* UnityFrameworkLoad()
{
    NSString* bundlePath = nil;
    bundlePath = [[NSBundle mainBundle] bundlePath];
    bundlePath = [bundlePath stringByAppendingString: @"/Frameworks/UnityFramework.framework"];
    
    NSBundle* bundle = [NSBundle bundleWithPath: bundlePath];
    if ([bundle isLoaded] == false) [bundle load];
    
    UnityFramework* ufw = [bundle.principalClass getInstance];
    if (![ufw appController])
    {
        // unity is not initialized
        [ufw setExecuteHeader: &_mh_execute_header];
    }
    return ufw;
}
//其中 [self ufw] 是所在类的一个熟悉
@property (nonatomic, strong) UnityFramework *ufw;
[[self ufw] runEmbeddedWithArgc: gArgc argv: gArgv appLaunchOpts: appLaunchOpts];
//gArgc 、 gArgv 这两个参数是程序入口main函数中的参数,可以使用NSUserDefaults保存起来
//appLaunchOpts 是- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 函数中的launchOptions参数

1.2 从Unity界面回到iOS界面

上面的函数正确调用后,从iOS界面跳转到Unity应该是没问题了,那怎么从Unity退出回到iOS原生界面呢?

我们首先从Unity项目中导出Unity-iPhone项目中的接口文件UnityFramework看一下,接口文件如下图
UnityFramework.png

很容易我们调用- (void)pause:(bool)pause函数.

然后再调用- (void)unloadApplication或者- (void)quitApplication:(int)exitCode

结果LuaClient:Destroy(),连同iOS的程序也Crash了,那一定是调用的方法不对,或者顺序不对?那到底问题出在哪了呢?

最终找到了一个iOS集成Unity项目的工程 https://github.com/Unity-Technologies/uaal-example ,最终才理清楚调用顺序。

正确的退出顺序:

1.2.1、遵守协议注册监听

1、首先是所在的控制器要遵守协议 <UnityFrameworkListener>,监听Unity状态的变化

2、 注册监听 [[self ufw] registerFrameworkListener: self];

1.2.2、点击退出按钮
- (void)quitUnityButtonClick {
    if ([self unityIsInitialized]) {
        [UnityFrameworkLoad() unloadApplication];
    }
}

#pragma mark -UnityFrameworkListener
- (void)unityDidUnload:(NSNotification*)notification
{
    NSLog(@"unityDidUnload called");
    
    [[self ufw] unregisterFrameworkListener: self];
    [self setUfw: nil];
    [self.window makeKeyAndVisible];
}

2、创建一个能与iOS交互的Unity项目

2.1、引用接口文件遇到的链接错误

由于Unity-iPhone项目是另一个部门提供的,提供的接口文件在iOS项目中能编译,但是链接时报错,如下图

UnityForiOSInteface.png
LinkerError.png

查阅了大量资料也没搞清楚原因,最后在 Unity的官方文档 中看到iOS去调用Unity有两种方式

1、UnitySendMessage

2、delegates

由于我们的项目要在Unity启动前就把数据准备好,用于加载不同的内容,UnitySendMessage这种方式只适用于Unity已经启动好了,iOS向Unity通信,所以就要使用delegates的方式进行通信

为了调试项目,只能自己创建一个Unity项目区验证delegates这种方式是否行得通了,之前没有Unity项目基础就在腾讯课堂看到一个讲解的还不错的适合Unity入门的项目

2.2、创建一个Unity项目

https://ke.qq.com/course/3101943?taid=10573792874026231

3、iOS和Unity的相互调用:

UnityToiOS.png
iOS与Unity相互通信的文件放在Plugins/iOS/ 目录下
//UnityForiOSInterface.h 文件

#import <Foundation/Foundation.h>

typedef void (*ResultHandler) (const char * _Nonnull object);

//Unity退出时触发该通知
#define kQuitUnityNotification  @"kQuitUnityNotification"
//使用NSUserDefaults通过kCourseInfoKey保存课件信息
#define kCourseInfoKey          @"kCourseInfoKey"

NS_ASSUME_NONNULL_BEGIN

@interface UnityForiOSInterface : NSObject

#ifdef __cplusplus
extern "C" {
#endif
    
    void unitySendToiOSMessage(const char *msg); //打开Unity后,Unity回调课程的状态给iOS
    void getiOSParams(ResultHandler resultHandler); //Unity调用iOS,iOS通过函数指针参数赋值的方式向Unity赋值
    
#ifdef __cplusplus
}
#endif
@end

NS_ASSUME_NONNULL_END

//UnityForiOSInterface.m 文件
#import "UnityForiOSInterface.h"

@implementation UnityForiOSInterface

void unitySendToiOSMessage(const char *msg) {
    NSLog(@"msg:%@",[NSString stringWithUTF8String:msg]);
    [[NSNotificationCenter defaultCenter] postNotificationName:kQuitUnityNotification object:[NSString stringWithUTF8String:msg]];
}

void getiOSParams(ResultHandler resultHandler) {
    NSString *paramsStr = [[NSUserDefaults standardUserDefaults] objectForKey:kCourseInfoKey];
    resultHandler (paramsStr.UTF8String);
}
@end
这里写一个简单的Unity项目 用于和iOS做交互,也可以参考腾讯课堂的Unity项目讲解 ,简单来说就是在场景上挂在一个脚本,通过点击场景的按钮由Unity向iOS发送消息
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using AOT;
using UnityEngine;
using UnityEngine.UI;

public class UnityCallObjc : MonoBehaviour
{
    public InputField input;  
    public Text text;

    [DllImport("__Internal")]
    static extern void UnitySendToiOSMessage(string msg);

    [DllImport("__Internal")]
    static extern void getiOSParams(IntPtr resultHandler);

    public void OnButtonClick()
    {
        //IOSLog(input.text);
        ResultHandler handler = new ResultHandler(resultHandler);
        IntPtr fp = Marshal.GetFunctionPointerForDelegate(handler);
        getiOSParams(fp);
    }

    //非托管方法
    [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
    public delegate void ResultHandler(string resultString);

    [MonoPInvokeCallback(typeof(ResultHandler))]
    static void resultHandler(string resultStr)
    {
        Debug.LogFormat("result string = {0}", resultStr);
    }
}
Unity的主要语言是C#,因此可以利用C#的特性来访问C语言所定义的接口,然后再通过C接口再调用ObjC的代码,UnityCallObjc脚本为什么这么写,Unity3D与iOS的交互,讲得非常清楚了,具体可以看一下.

参考资料:

https://github.com/Unity-Technologies/uaal-example.git

https://ke.qq.com/course/3101943?taid=10573792874026231

https://docs.unity3d.com/Manual/PluginsForIOS.html

https://www.jianshu.com/p/1ab65bee6692

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容