Flutter 与 Unity 通信

概要

Demo 说明

Demo 通过 flutter-unity-view-widget 库,达到 Flutter 内嵌 Unity 目的
主要功能:

  • flutter-unity-view-widget 为 Unity 提供依赖库导出插件,将 Unity 项目构建成 Android、IOS 依赖库
  • flutter-unity-view-widget 为 Flutter 提供组件库,将 Unity 视图以组件的形式渲染,并提供 Flutter、Unity 双向通信接口
Demo 预览

开发环境
Demo 使用了两个操作系统,所以会产生一些操作不便之处
win10:Unity 开发环境
macOS:APP 开发环境
macOS 环境操作,标记为 macOS。未标记的,都是 win10 环境操作


Flutter API 文档

UnityWidget 组件属性
  • fullscreen
    布尔值,是否全屏显示 UnityWidget 组件
UnityWidget 组件生命周期
  • onUnityMessage(data)
    触发时机:Unity 通过 SendMessageToFlutter 发布消息
  • onUnitySceneLoaded(String name, int buildIndex, bool isLoaded, bool isValid)
    触发时机:Unity 场景加载完成
  • onUnityUnloaded()
    触发时机:Unity 场景被销毁
UnityWidgetController API
  • pause()
    暂停 Unity 循环
  • resume()
    继续 Unity 循环
  • unload()
    销毁 Unity 场景
  • quit()
    退出 Unity 应用
  • postMessage(String gameObject, methodName, message)
    调用 Unity 类方法

Unity API 文档

  • SendMessageToFlutter(string)
    发布消息,Flutter 通过 onUnityMessage 订阅消息

初始化 Unity 项目

新建项目

Unity 版本要求:2019.4.3+

替换案例场景
新建方块 Cube、空物体 CanvasController

安装 Unity 插件

克隆 git 仓库
git clone https://github.com/juicycleff/flutter-unity-view-widget.git
插件粘贴至 Unity 项目
mkdir ./demoFlutterUnity/ThirdpartyPackage
cp ./flutter-unity-view-widget/scripts/FlutterUnityIntegration-v4.1.0.unitypackage ./demo_flutter_unity/unity/demoFlutterUnity/ThirdpartyPackage/FlutterUnityIntegration-v4.1.0.unitypackage

Unity 项目编写

编写脚本
  • UMMInject.cs
using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class UMMInject : MonoBehaviour
{
    void Start()
    {
        gameObject.AddComponent<UnityMessageManager>();
    }
}
  • CubeInteraction.cs
using System;
using UnityEngine;
using UnityEngine.EventSystems;

public class CubeInteraction: MonoBehaviour, IEventSystemHandler
{
    [SerializeField]
    Vector3 RotateAmount;

    void Start()
    {
        RotateAmount = new Vector3(1, 1, 1);
    }

    void Update()
    {
        gameObject.transform.Rotate(RotateAmount * Time.deltaTime * 10);

        for (int i = 0; i < Input.touchCount; ++i)
        {
            if (Input.GetTouch(i).phase.Equals(TouchPhase.Began))
            {
                var hit = new RaycastHit();

                Ray ray = Camera.main.ScreenPointToRay(Input.GetTouch(i).position);

                if (Physics.Raycast(ray, out hit))
                {
                    UnityMessageManager.Instance.SendMessageToFlutter("方块被触碰");
                }
            }
        }
    }

    // (Flutter 调用)设置旋转速度
    public void SetRotationSpeed(String message)
    {
        float value = float.Parse(message);
        RotateAmount = new Vector3(value, value, value);
    }
}
绑定脚本

UnityMessageManager.cs 是插件内置脚本


初始化 Flutter 项目

macOS 新建项目
flutter create demo_flutter_unity

Flutter 项目生成后,复制副本到 win10,作为 Unity 项目容器,用于生成 Flutter 依赖库

移动 Unity 项目 至 Flutter 项目
mkdir ./demo_flutter_unity/unity
cp -r ./demoFlutterUnity ./demo_flutter_unity/unity

Unity Player Settings

Android
IOS


导出 Android、IOS 依赖库

修改源码
// DoBuildAndroid()

// var options = BuildOptions.AcceptExternalModificationsToPlayer;
var options = BuildOptions.AllowDebugging;
EditorUserBuildSettings.exportAsGoogleAndroidProject = true;
// BuildIOS()

// var options = BuildOptions.AcceptExternalModificationsToPlayer;
var options = BuildOptions.AllowDebugging;
生成 unityLibrary 库

导出前,需要切换到对应的构建平台
Export Android:Android 依赖,导出到 android/unityLibrary
Export Android:IOS 依赖,导出到 ios/UnityLibrary

macOS 移动 Flutter 依赖库 至 macOS Flutter 项目

macOS Android 项目配置

android/settings.gradle
+ include ":unityLibrary"
+ project(":unityLibrary").projectDir = file("./unityLibrary")
android/build.gradle
allprojects {
    repositories {
        + flatDir {
        +     dirs "${project(':unityLibrary').projectDir}/libs"
        + }
    }
}
android/app/build.gradle
android {
    defaultConfig {
        minSdkVersion xxx    // xxx 需要 Unity Player Settings Android SDK 版本号一致
    }
}

dependencies {
    + implementation project(':unityLibrary')
}

macOS IOS 项目配置

注意:正常情况下,按照该配置,构建 IOS 应用时,还会出现一些小问题,需要按照报错信息,自行解决(如:文件访问权限、CocoaPods 相关等等)

导入原生工程
导入、配置 Unity-iPhone 工程
配置 UnityFramework
配置团队、签名
单独构建 UnityFramework

macOS Flutter 项目编写

pubspec.yaml
dependencies:
  + flutter_unity_widget: ^4.1.0
lib/main.dart
import 'package:flutter/material.dart';
import 'package:flutter_unity_widget/flutter_unity_widget.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  static final GlobalKey<ScaffoldState> _scaffoldKey =
      GlobalKey<ScaffoldState>();
  late UnityWidgetController _unityWidgetController;
  double _sliderValue = 0.0;

  @override
  void initState() {
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        key: _scaffoldKey,
        appBar: AppBar(
          title: const Text('Flutter 与 Unity 通信'),
        ),
        body: Card(
          margin: const EdgeInsets.all(8),
          clipBehavior: Clip.antiAlias,
          shape: RoundedRectangleBorder(
            borderRadius: BorderRadius.circular(20.0),
          ),
          child: Stack(
            children: <Widget>[
              UnityWidget(
                onUnityCreated: onUnityCreated,
                onUnityMessage: onUnityMessage,
                onUnitySceneLoaded: onUnitySceneLoaded,
                fullscreen: false,
              ),
              Positioned(
                bottom: 20,
                left: 20,
                right: 20,
                child: Card(
                  elevation: 10,
                  child: Column(
                    children: <Widget>[
                      Padding(
                        padding: const EdgeInsets.only(top: 20),
                        child: Text("旋转速度"),
                      ),
                      Slider(
                        onChanged: (value) {
                          setState(() {
                            _sliderValue = value;
                          });
                          setRotationSpeed(value.toString());
                        },
                        value: _sliderValue,
                        min: 0,
                        max: 20,
                      ),
                    ],
                  ),
                ),
              ),
            ],
          ),
        ),
      ),
    );
  }

  // Communcation from Flutter to Unity
  void setRotationSpeed(String speed) {
    _unityWidgetController.postMessage(
      'Cube',
      'SetRotationSpeed',
      speed,
    );
  }

  void onUnityMessage(message) {
    print('Unity 消息推送: ${message.toString()}');
  }

  void onUnityCreated(controller) {
    this._unityWidgetController = controller;
  }

  void onUnitySceneLoaded(SceneLoaded? sceneInfo) {
    print('场景名称: ${sceneInfo!.name}');
    print(
        '场景编号: ${sceneInfo!.buildIndex}');
  }
}
运行项目
flutter emulators
// apple_ios_simulator • iOS Simulator  • Apple  • ios
// Pixel_2_API_30      • Pixel 2 API 30 • Google • android

flutter emulators --launch apple_ios_simulator

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

推荐阅读更多精彩内容