开发说明文档 - piplay.pimaxvr.compiplay.pimaxvr.com/小派 Unity SDK开发说明文档 v_1.1.1...

小派科技（上海）有限责任公司小派 VR 为玩家而生

第 1 页共 16 页

小派 VR SDK_Unity

开发说明文档

版本：v_1.1.1

小派科技（上海）责任有限公司


第 2 页共 16 页

1.前言

1.1编写目的

撰写“PimaxVRSDK_Unity”开发说明文档是为了帮助开发者能够快速地开发

基于 PimaxSDK 的应用。

本文档主要面向对象为：技术人员、开发者。

1.2 编写背景

“PimaxVRSDK_Unit”是小派科技（上海）有限责任公司为了配合广大的 Unity 3D 软件

开发者开发，适用于 Pimax 4K、Pimax pro 虚拟现实头盔而推出的 SDK（Software Development

Kit）软件开发工具包。开发包主要支持头部跟踪、畸变校正、双目视差等功能，为开发者

提供便利支持。本说明文档中的 SDK 通过 unity package 包的格式发布，接入 SDK 前，

需要配置好 Unity 开发环境，再导入开发包，在 Assets\PVRUnity\Sample 文件夹下我们提

供了 demo 场景供开发者参考。

1.3 支持设备

厂商设备

小派 Pimax 4K

小派 Pimax Pro

1.4 开发环境

推荐硬件配置配置版本信息

操作系统

Windows 7 SP1 64 位

Windows 8 64 位

Windows 8.1 64 位

Windows 10 64 位

内存 8G 及以上

显卡NVIDIA GeForce GTX 970 及以上

AMD Radeon R9 290 及以上

显卡驱动NVIDIA 显卡： Driver 361.91 及以上

AMD 显卡： Driver 16.3.2 及以上

Unity3D 5.4 及以上

配套软件说明

1.“PVR_Unity_SDK”需要配合 PiPlay 小派玩家模式运行。

2.安装 PVR_Unity_SDK_Steup 安装包后可以调用 PVR-Unity.unitypackage 文件


第 3 页共 16 页

2.环境搭建

2.1 PiPlay 的安装

登录小派官网 http://www.pimaxvr.com/.下载 piplay_Steup 安装包，根据提示进行安

装，然后启动 Piplay 程序。

2.2 连接小派头盔设备

使用 piplay 连接好 Pimax 头盔设备，顶部指示灯显示蓝色灯且头盔显示小派科技 Logo

即为连接成功

http://www.pimaxvr.com/


第 4 页共 16 页

3. Unity 的使用

3.1 下载 Unity 开发引擎

百度搜索 Unity，登陆 Unity 官方网站下载 Unity 引擎。

3.2 创建 Unity 项目

1. 双击打开桌面的 Unity，创建一个新的项目，点击右上角的 NEW 进行项目的创建

2. 点击后出现一个选项窗口，第一行 Project name 是项目名，第二行 Location 是存储项

目的路径，输入完成项目名以及路径后，点击 Create Project 创建一个 Unity 项目


第 5 页共 16 页

3. 创建完成后，会进入一个 Unity 操作窗口，这就是我们的 Unity 项目


第 6 页共 16 页

4. 导入 SDK

4.1 安装 SDK

1. 获得小派 VR Unity 开发插件 pvr_unity_sdk_setup.exe。

2. 双击下载 exe 进行安装，(语言选择)确定-->下一步-->下一步-->安装-->确定，即

会打开成功安装 SDK 的目录。

3. Unity_SDK 的目录为安装 PiPlay 的所存放的路径\Pimax\Sdk\Unity_plugin

4.2 导入 SDK

1. 找到 Unity_plugin 文件夹,导入 PVR-Unity.unitypackage 资源包到场景中。有两种

方法将 PVR-Unity.unitypackage 资源包导入到场景当中：

方法 1：将 PVR-Unity.unitypackage 资源包拖拽到如图所示的 Assets 文件夹上，如下图：

方法 2：找到图中的Assets文件目录，鼠标移至Assets上点击右键选择 Import Package

中的 Custom Package，在出现的选择框中找到存放 PVR-Unity.unitypackage 资源包的文件

夹后，点击文件夹中的 PVR-Unity.unitypackage 后，点击右下角的“打开”按钮.


第 7 页共 16 页

2. 完成上述两种操作中的一种，会出现如图所示的弹窗，点击右下角的 Import 按钮导

入 SDk

3. 出现下面的资源文件目录就证明我们导入成功了~


第 8 页共 16 页


第 9 页共 16 页

5. SDK 的使用

1. 找到 Asset 目录中的 PVRUnity 文件夹，将其中的 Prefab 文件夹中的 PVRCameraRig

和 PVRSSession 这两个预制体拖到 Sence 视图中，并删除原场景的 MainCamera，如图：

2. 在确保 PiPlay 中头盔是连接成功的前提下，单击图中红色圆圈的左侧三角按钮运行

项目，即可开始我们的 vr 开发之旅~


第 10 页共 16 页


第 11 页共 16 页

6. Unity 打包

如何将 VRDisplayDemo 打包成 .exe 文件？

第 1 步：点击左上角的 File 栏中的 Save Sence，将场景进行保存

第 2 步：点击最上角 File -> Build Setting,会出现一个选项框，

第 3 步：点击 addOpenSences，添加你打包的场景 VRDisplayDemo，并且将发布的平台

platform选为选项栏中的第一个（红框中的PC端选项），并将Architecture选为x86_64（点


第 12 页共 16 页

击 x86 横条按钮会出现下拉菜单，选中其中的 X86_64）即可

第 4 步：上述两步选项操作完全后，点击右下角的 Build 按钮（如下图），会出现存储.exe

的路径的选择窗口，选择你要存放的路径后点击保存即可。这样，就成功的完成了一个 Unity

版本的 VR 项目。


第 13 页共 16 页

7.重置正方向

调用接口：

PVR.Unity.PVRSession.instance.recenterTrackingOrigin();可以在按键响应中调用该接口即可实现正方向的重置，如下图


第 14 页共 16 页

8. 各个接口脚本含义

8.1 PVRSession.cs

实现与 PVR runtime 的连接，每个场景需要且只需要添加一个，可以用 PVRSession.prefab

来添加

8.2 PVRPoseTracking.cs

实现 GameObject 的姿态（方向和位置）与头部，手柄等的绑定，当勾选掉 PVRCamereRig

子物体 PVRCamera 中的该脚本是可以关闭 vr 头饰上的陀螺仪，如图：


第 15 页共 16 页

8.3 PVREyeOffset.cs

按照双眼的位置设置其位置

8.4 PVRSurface.cs

实现将 camera 的画面输出到头盔，依赖 Camera 组件，PVREyeOffset 组件。

8.5 PVRInputEvent.cs

实现手柄按键事件的发送，使用 RecenterTest.cs 脚本中的格式可以接收事件，完成按键的

响应，进行按键控制。


第 16 页共 16 页

9. 示例场景介绍

9.1 SimpleVRDemo:

示例单个 PVRCameraRig 的 VR 示例

9.2 MultiCameraDemo:

示例使用多个 PVRCameraRig 来实现更加复杂的需求，包括每个 PVRCameraRig 是否可以随头

部控制都可以定制。

9.3 ObjectTrackedDemo:

示例场景中某个对象有头部或者手柄动作控制。

9.4 RecenterOnInputDemo:

示例手柄按钮的事件处理和重置正方向。

9.5 CustomMirrorWindowDemo:

示例通过普通 camera 来显示与头盔中不同的 window 画面。

开发说明文档 - piplay.pimaxvr.compiplay.pimaxvr.com/小派 Unity SDK开发说明文档 v_1.1.1...

Documents

Transcript of 开发说明文档 - piplay.pimaxvr.compiplay.pimaxvr.com/小派 Unity SDK开发说明文档 v_1.1.1...