WPF 中嵌入Unity

luly靓

最近，有做过一个wpf 工程中嵌入Unity 的Demo。
引用其他博主的一段话：

把Unity3D嵌入winform或者wpf程序，过去大部分使用UnityWebPlayer插件来实现，这个插件其实就是网页上播放unity页游的插件。
但是使用UnityWebPlayer嵌入桌面开发有各种问题，我认为最大的问题是效率问题（加载缓慢），毕竟是网页的加载方式，而且可以确认未来也不会得到任何优化。
由于WebGL的高速发展，unity公司认识到了webplayer十分鸡肋，毕竟WebGL不需要任何插件可以直接显示3d内容了，所以Unity3D在5.4.x版本以后明确表示不再支持webplayer了，所以桌面上UnityWebPlayer插件能不用也就别用了吧。

大该意思 就是 UnityWebPlayer Unity3D在5.4.x版本以后被弃用了。所以我们使用其他方式来嵌入。


首先根据Unity官方文档，选择嵌入方式。


文档中 介绍，可以使用两种 不同方式启动在 window 程序中启动Unity
在这里 我使用的是最简单的方式：将Unity作为外部进程启动，并为其指定一个窗口，使用-parentHWND命令行参数对Unity程序进行初始化和呈现。
通信

我是使用socket进行通讯，Unity程序做客户端，使用wpf程序做服务器端。（参考文章中有更加规范的做法）
版本：

Unity 版本： Unity 2018.4.1f1
Vs 版本：vs2017
WPF端相关操作

1、新建 WPF 工程
2、新建 Winform 自定义控件
3、在用户自定控件上 新建一个 Panel 来承接 Unity.exe 画面
     打开工具箱   视图→工具箱  (注:需要在设计界面 才会有控件展示)
     如下图：


Panel 拖入到 空白区域即可。然后设置Panel 自适应 如下图。
新建一个label 来显示 将错误日志可视化。
4、编写用户控件相关代码
首先 打开 用户控件代码
代码如下：

1.   public partial class UserControl1 : UserControl
2.     {
3.         [DllImport("User32.dll")]
4.         static extern bool MoveWindow(IntPtr handle, int x, int y, int width, int height, bool redraw);
6.         internal delegate int WindowEnumProc(IntPtr hwnd, IntPtr lparam);
7.         [DllImport("user32.dll")]
8.         internal static extern bool EnumChildWindows(IntPtr hwnd, WindowEnumProc func, IntPtr lParam);
10.         [DllImport("user32.dll")]
11.         static extern int SendMessage(IntPtr hWnd, int msg, IntPtr wParam, IntPtr lParam);
13.         private Process process;
14.         private IntPtr unityHWND = IntPtr.Zero;
16.         private const int WM_ACTIVATE = 0x0006;
17.         private readonly IntPtr WA_ACTIVE = new IntPtr(1);
18.         private readonly IntPtr WA_INACTIVE = new IntPtr(0);
20.         public UserControl1()
21.         {
22.             InitializeComponent();
23.             this.Load += UnityControl_Load;
24.             panel1.Resize += panel1_Resize;
25.         }
27.         private void UnityControl_Load(object sender, EventArgs e)
28.         {
29.             try
30.             {
31.                 process = new Process();
32.                 //注意此路径 为Unity程序导出路径
33.                 process.StartInfo.FileName = Application.StartupPath + @"\UnityApp\WPFAndU3D.exe";
34.                 process.StartInfo.Arguments = "-parentHWND " + panel1.Handle.ToInt32() + " " + Environment.CommandLine;
35.                 process.StartInfo.UseShellExecute = true;
36.                 process.StartInfo.CreateNoWindow = true;
38.                 process.Start();
40.                 process.WaitForInputIdle();
41.                 // Doesn't work for some reason ?!
42.                 //unityHWND = process.MainWindowHandle;
43.                 EnumChildWindows(panel1.Handle, WindowEnum, IntPtr.Zero);
45.                 label1.Text = "Unity HWND: 0x" + unityHWND.ToString("X8");
46.             }
47.             catch (Exception ex)
48.             {
49.                 // label1 为 上面新建的label
50.                 label1.Text = ex.Message;
51.                 //MessageBox.Show(ex.Message);
52.             }
53.         }
55.         internal void ActivateUnityWindow()
56.         {
57.             SendMessage(unityHWND, WM_ACTIVATE, WA_ACTIVE, IntPtr.Zero);
58.         }
60.         internal void DeactivateUnityWindow()
61.         {
62.             SendMessage(unityHWND, WM_ACTIVATE, WA_INACTIVE, IntPtr.Zero);
63.         }
65.         private int WindowEnum(IntPtr hwnd, IntPtr lparam)
66.         {
67.             unityHWND = hwnd;
68.             ActivateUnityWindow();
69.             return 0;
70.         }
72.         private void panel1_Resize(object sender, EventArgs e)
73.         {
74.             MoveWindow(unityHWND, 0, 0, panel1.Width, panel1.Height, true);
75.             ActivateUnityWindow();
76.         }
78.         // Close Unity application
79.         internal void Form1_FormClosed()
80.         {
81.             try
82.             {
83.                 process.CloseMainWindow();
85.                 Thread.Sleep(1000);
86.                 while (process.HasExited == false)
87.                     process.Kill();
88.             }
89.             catch (Exception)
90.             {
92.             }
93.         }
95.         internal void Form1_Activated()
96.         {
97.             ActivateUnityWindow();
98.         }
100.         internal void Form1_Deactivate()
101.         {
102.             DeactivateUnityWindow();
103.         }
105.         private void panel1_Paint(object sender, PaintEventArgs e)
106.         {
108.         }
109.     }

复制代码

5、找到 MainWindow.xaml 设置主界面 格式，将自定义控件 内置到主界面中

1. <Window x:Class="WpfApp.MainWindow"
2.         xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
3.         xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
4.         xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
5.         xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
6.         xmlns:local="clr-namespace:WpfApp"
7.         mc:Ignorable="d"
8.         
9.         WindowState="Maximized" WindowStyle="None"
10.         
11.         Title="MainWindow" Height="1080" Width="1920">
13.     <Grid>
14.         <Grid.RowDefinitions>
15.             <RowDefinition Height="50px"/>
16.             <RowDefinition Height="80px"/>
17.             <RowDefinition Height="*"/>
18.         </Grid.RowDefinitions>
20.         <!--注释绘制这个标题栏-->
21.         <Grid Name="toolBar" Height="50px" Width="Auto" Background="Black" MouseDown="Window_MouseDown" Margin="0" Grid.Row="0">
23.             <!--标题文本-->
24.             <StackPanel HorizontalAlignment="Left" VerticalAlignment="Center">
25.                 <TextBlock Text="WPFTOU3D" FontSize="30" Foreground="White" ></TextBlock>
26.             </StackPanel>
29.             <!--右侧按钮-->
30.             <StackPanel Name="buttons" Grid.ColumnSpan="1" Orientation="Horizontal" HorizontalAlignment="Right" VerticalAlignment="Center">
31.                 <!--最小化-->
32.                 <Button  Name="btn_min" Width="50px" Height="50px" Padding="2" Margin="5" Background="Transparent" Click="btn_min_Click">
34.                     <TextBlock FontFamily="Segoe MDL2 Assets" FontSize="30"  Text="" Foreground="White" />
35.                 </Button>
36.                 <!--normal/最大化-->
37.                 <Button Name="btn_normal" Width="50px" Height="50px" Padding="2" Margin="5" Background="Transparent" Click="btn_normal_Click">
38.                     <Grid>
39.                         <TextBlock Name="toNormalSize" FontSize="30"  FontFamily="Segoe MDL2 Assets" Text="" Foreground="White" />
40.                         <TextBlock Name="toMaxSize" Visibility="Hidden" FontSize="30" FontWeight="Bold" FontFamily="Segoe MDL2 Assets" Text="" Foreground="White" />
41.                     </Grid>
42.                 </Button>
44.                 <!--关闭程序-->
45.                 <Button Name="btn_close" Width="50px" Height="50px" Padding="2" Margin="5" Background="Transparent" Click="btn_close_Click">
46.                     <TextBlock FontFamily="Segoe MDL2 Assets" Text="" FontSize="30" FontWeight="Bold" Foreground="White" />
47.                 </Button>
48.             </StackPanel>
51.         </Grid>
53.         <!--主要内容页-->
55.         <Grid Grid.Row="2" Background="white" Margin="16,16,16,30">
56.             <Grid.ColumnDefinitions>
57.                 <ColumnDefinition Width="500"/>
58.                 <ColumnDefinition Width="233*"/>
59.                 <ColumnDefinition Width="118*"/>
60.             </Grid.ColumnDefinitions>
63.             <ListView>
64.                 <ListViewItem Width="500">
65.                     <Grid Height="100" Width="500" HorizontalAlignment="Center">
66.                         <StackPanel HorizontalAlignment="Left">
67.                             <Button Name="btn1" Click="btn1_Click">
68.                                 <!--图片问题，可找随意图片代替，同名即可放到对应文件夹下-->
69.                                 <Image Width="100" Height="100" Source="Assets/img/LeftArrow.png"></Image>
70.                             </Button>
71.                         </StackPanel>
72.                         <TextBlock HorizontalAlignment="Center" VerticalAlignment="Center" FontSize="30">X方向移动</TextBlock>
73.                         <StackPanel HorizontalAlignment="Right">
74.                             <Button Name="btn2" Click="btn2_Click">
75.                                 <Image  Width="100" Height="100" Source="Assets/img/RightArrow.png" RenderTransformOrigin="3.842,0.494"></Image>
76.                             </Button>
77.                         </StackPanel>
79.                     </Grid>
82.                 </ListViewItem>
87.                 <ListViewItem Width="500">
88.                     <Grid Height="100" Width="500" HorizontalAlignment="Center">
89.                         <StackPanel HorizontalAlignment="Left">
90.                             <Button Name="btn3" Click="btn3_Click">
91.                                 <Image Width="100" Height="100" Source="Assets/img/LeftArrow.png"></Image>
92.                             </Button>
93.                         </StackPanel>
94.                         <TextBlock HorizontalAlignment="Center" VerticalAlignment="Center" FontSize="30">Y方向移动</TextBlock>
95.                         <StackPanel HorizontalAlignment="Right">
96.                             <Button Name="btn4" Click="btn4_Click">
97.                                 <Image  Width="100" Height="100" Source="Assets/img/RightArrow.png" RenderTransformOrigin="3.842,0.494"></Image>
98.                             </Button>
99.                         </StackPanel>
101.                     </Grid>
104.                 </ListViewItem>
107.                 <ListViewItem Width="500">
108.                     <Grid Height="100" Width="500" HorizontalAlignment="Center">
109.                         <StackPanel HorizontalAlignment="Left">
110.                             <Button Name="btn5" Click="btn5_Click">
111.                                 <Image Width="100" Height="100" Source="Assets/img/LeftArrow.png"></Image>
112.                             </Button>
113.                         </StackPanel>
114.                         <TextBlock HorizontalAlignment="Center" VerticalAlignment="Center" FontSize="30">Z方向移动</TextBlock>
115.                         <StackPanel HorizontalAlignment="Right">
116.                             <Button Name="btn6" Click="btn6_Click">
117.                                 <Image  Width="100" Height="100" Source="Assets/img/RightArrow.png" RenderTransformOrigin="3.842,0.494"></Image>
118.                             </Button>
119.                         </StackPanel>
121.                     </Grid>
124.                 </ListViewItem>
126.             </ListView>
129.             <!--建立一个winform的容器-->
130.             <Grid Background="Azure"  Grid.Column="1" Name="Container" >
132.                 <WindowsFormsHost>
133.                     <local:UserControl1 x:Name="unityhost">
135.                     </local:UserControl1>
136.                 </WindowsFormsHost>
139.             </Grid>
142.         </Grid>
145.     </Grid>
146. </Window>

复制代码

设置后如下图：

注意 ： 添加用户自定义空间时 ， xmal可能 会报错，说Wpf 程序 不支持 WindowsFormsHost

按如下操作可解决报错
在Visual Studio中，通过右键单击项目中的“引用”节点并选择“添加引用”来完成此操作：
在弹出的对话框中，选择“程序集”，然后勾选我们需要添加的两个程序集：


6、编写 MainWindow.xaml 的交互逻辑

1.     /// <summary>
2.     /// MainWindow.xaml 的交互逻辑
3.     /// </summary>
4.     public partial class MainWindow : Window
5.     {
7.         TcpServer WpfServer;
8.         int size_state = 0;
9.         public MainWindow()
10.         {
11.             InitializeComponent();
14.             this.Closed += MainWindow_Closed;
15.             this.Activated += MainWindow_Activated;
16.             this.Deactivated += MainWindow_Deactivated;
20.             WpfServer = new TcpServer();
21.             WpfServer.StartServer();
24.         }
26.         private void btn_close_Click(object sender, RoutedEventArgs e)
27.         {
28.             this.Close();
30.         }
32.         void MainWindow_Closed(object sender, EventArgs e)
33.         {
34.             unityhost.Form1_FormClosed();
37.             WpfServer.QuitServer();
39.         }
41.         void MainWindow_Deactivated(object sender, EventArgs e)
42.         {
44.             unityhost.Form1_Deactivate();
45.         }
47.         void MainWindow_Activated(object sender, EventArgs e)
48.         {
49.             unityhost.Form1_Activated();
50.         }
52.         private void btn_normal_Click(object sender, RoutedEventArgs e)
53.         {
54.             if (size_state == 0)
55.             {
56.                 this.WindowState = WindowState.Normal;
57.                 this.Width = 1280;
58.                 this.Height = 800;
59.                 toNormalSize.Visibility = Visibility.Hidden;
60.                 toMaxSize.Visibility = Visibility.Visible;
62.                 size_state = 1;
63.             }
64.             else
65.             {
66.                 this.WindowState = WindowState.Maximized;
67.                 toNormalSize.Visibility = Visibility.Visible;
68.                 toMaxSize.Visibility = Visibility.Hidden;
69.                 size_state = 0;
70.             }
72.         }
74.         private void btn_min_Click(object sender, RoutedEventArgs e)
75.         {
76.             this.WindowState = WindowState.Minimized;
77.         }
79.         private void Window_MouseDown(object sender, MouseButtonEventArgs e)
80.         {
81.             try
82.             {
83.                 this.DragMove();
84.             }
85.             catch (Exception)
86.             {
89.             }
91.         }
93.         private void btn1_Click(object sender, RoutedEventArgs e)
94.         {
95.             WpfServer.SendMessage("1");
96.         }
98.         private void btn2_Click(object sender, RoutedEventArgs e)
99.         {
100.             WpfServer.SendMessage("2");
101.         }
103.         private void btn3_Click(object sender, RoutedEventArgs e)
104.         {
105.             WpfServer.SendMessage("3");
106.         }
108.         private void btn4_Click(object sender, RoutedEventArgs e)
109.         {
110.             WpfServer.SendMessage("4");
111.         }
113.         private void btn5_Click(object sender, RoutedEventArgs e)
114.         {
115.             WpfServer.SendMessage("5");
116.         }
118.         private void btn6_Click(object sender, RoutedEventArgs e)
119.         {
120.             WpfServer.SendMessage("6");
121.         }
122.     }
123. }

复制代码

wpf 端  通信类 （这个通信类，参考别人写，比较简单）

1. using System.Net.Sockets;
2. using System.Net;
3. using System.Threading;
4. using System.Diagnostics;
5. using System.Text;
6. using System;
10.     class TcpServer
11.     {
12.         //私有成员
13.         private static byte[] result = new byte[1024];
14.         private int myProt = 500;   //端口  
15.         static Socket serverSocket;
16.         static Socket clientSocket;
18.         Thread myThread;
19.         static Thread receiveThread;
21.         //属性
23.         public int port { get; set; }
24.         //方法
27.         
28.         internal void StartServer()
29.         {
30.             //服务器IP地址  
31.             IPAddress ip = IPAddress.Parse("127.0.0.1");
32.             serverSocket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
33.             serverSocket.Bind(new IPEndPoint(ip, myProt));  //绑定IP地址：端口  
34.             serverSocket.Listen(10);    //设定最多10个排队连接请求  
36.             Debug.WriteLine("启动监听{0}成功", serverSocket.LocalEndPoint.ToString());
37.       
38.             //通过Clientsoket发送数据  
39.             myThread = new Thread(ListenClientConnect);
40.             myThread.Start();
41.             
42.         }
45.         internal void QuitServer()
46.         {
48.             serverSocket.Close();
49.             clientSocket.Close();
50.             myThread.Abort();
51.             receiveThread.Abort();
54.         }
57.         internal void SendMessage(string msg)
58.         {
59.                 clientSocket.Send(Encoding.ASCII.GetBytes(msg));
60.         }
64.         /// <summary>  
65.         /// 监听客户端连接  
66.         /// </summary>  
67.         private static void ListenClientConnect()
68.         {
69.             while (true)
70.             {
71.                 try
72.                 {
73.                     clientSocket = serverSocket.Accept();
74.                     clientSocket.Send(Encoding.ASCII.GetBytes("Server Say Hello"));
75.                     receiveThread = new Thread(ReceiveMessage);
76.                     receiveThread.Start(clientSocket);
77.                 }
78.                 catch (Exception)
79.                 {
81.                 }
83.             }
84.         }
86.         /// <summary>  
87.         /// 接收消息  
88.         /// </summary>  
89.         /// <param name="clientSocket"></param>  
90.         private static void ReceiveMessage(object clientSocket)
91.         {
92.             Socket myClientSocket = (Socket)clientSocket;
93.             while (true)
94.             {
95.                 try
96.                 {
97.                     //通过clientSocket接收数据  
98.                     int receiveNumber = myClientSocket.Receive(result);
99.                     Debug.WriteLine("接收客户端{0}消息{1}", myClientSocket.RemoteEndPoint.ToString(), Encoding.ASCII.GetString(result, 0, receiveNumber));
100.                 }
101.                 catch (Exception ex)
102.                 {
103.                     try
104.                     {
105.                         Debug.WriteLine(ex.Message);
106.                         myClientSocket.Shutdown(SocketShutdown.Both);
107.                         myClientSocket.Close();
108.                         break;
109.                     }
110.                     catch (Exception)
111.                     {
112.                     }
114.                 }
115.             }
116.         }
117.     }

复制代码

Wpf 端我们搞定了，接下来我们来配置Unity端。
Unity 部分

1、新建一个工程，在场景中 新建一个Cube
在Cube上面 添加上如下脚本。

1. using UnityEngine;
2. using System.Collections;
3. using System.Net.Sockets;
4. using System;
6. public class Demo : MonoBehaviour
7. {
8.     public GameObject man;
12.     const int portNo = 500;
13.     private TcpClient _client;
14.     byte[] data;
16.     string Error_Message;
18.     void Start()
19.     {
20.         try
21.         {
22.             this._client = new TcpClient();
23.             this._client.Connect("127.0.0.1", portNo);
24.             data = new byte[this._client.ReceiveBufferSize];
25.             //SendMessage(txtNick.Text);
26.             SendMessage("Unity Demo Client is Ready!");
27.             this._client.GetStream().BeginRead(data, 0, System.Convert.ToInt32(this._client.ReceiveBufferSize), ReceiveMessage, null);
28.         }
29.         catch (Exception ex)
30.         {
33.         }
34.     }
37.     public void translateX(float x)
39.     {
41.         transform.Translate(new Vector3(x, 0, 0));
43.     }
45.     public void translateY(float y)
47.     {
49.         transform.Translate(new Vector3(0, y, 0));
51.     }
54.     public void translateZ(float z)
56.     {
58.         transform.Translate(new Vector3(0, 0, z));
60.     }
64.     void OnGUI()
65.     {
66.         GUI.Label(new Rect(50, 50, 150, 50), Error_Message);
67.     }
70.     public new void SendMessage(string message)
71.     {
72.         try
73.         {
74.             NetworkStream ns = this._client.GetStream();
75.             byte[] data = System.Text.Encoding.ASCII.GetBytes(message);
76.             ns.Write(data, 0, data.Length);
77.             ns.Flush();
78.         }
79.         catch (Exception ex)
80.         {
81.             Error_Message = ex.Message;
82.             //MessageBox.Show(ex.ToString());
83.         }
84.     }
85.     public void ReceiveMessage(IAsyncResult ar)
86.     {
87.         try
88.         {
89.             //清空errormessage
90.             Error_Message = "";
91.             int bytesRead;
92.             bytesRead = this._client.GetStream().EndRead(ar);
93.             if (bytesRead < 1)
94.             {
95.                 return;
96.             }
97.             else
98.             {
99.                 Debug.Log(System.Text.Encoding.ASCII.GetString(data, 0, bytesRead));
100.                 string message = System.Text.Encoding.ASCII.GetString(data, 0, bytesRead);
101.                 switch (message)
102.                 {
103.                     case "1":
104.                         translateX(1);
105.                         break;
107.                     case "2":
108.                         translateX(-1);
109.                         break;
110.                     case "3":
111.                         translateY(1);
112.                         break;
113.                     case "4":
114.                         translateY(-1);
115.                         break;
116.                     case "5":
117.                         translateZ(1);
118.                         break;
119.                     case "6":
120.                         translateZ(-1);
121.                         break;
122.                     default:
123.                         Error_Message = "unknown command";
124.                         break;
127.                 }
132.             }
133.             this._client.GetStream().BeginRead(data, 0, System.Convert.ToInt32(this._client.ReceiveBufferSize), ReceiveMessage, null);
134.         }
135.         catch (Exception ex)
136.         {
137.             Error_Message = ex.Message;
138.         }
139.     }
142.     void OnDestroy()
143.     {
145.         this._client.Close();
146.     }
151. }

复制代码

2、导出工程
工程设置 如下： 其中Display ResolutionDialog  需要关闭，否则启动Unity导出exe文件 会有选择分辨率提示，导致wpf端 不显示。
导入  上面 新建Wpf项目中文件夹的 bin/Debug/UnityApp 文件夹下。
exe 文件名称需要与  wpf 端用户控件中 代码 保持一致。
如下图


至此，Unity 端设置完毕。
返回，WPF项目，点击运行，可得到下图效果：


参考文章：


git仓库地址：