You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/en/docs/tutorials/distribution/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ toc: true
16
16
## Build and ship
17
17
18
18
If you intent to distribute your Application built with the Unity Geometry Sequence Streamer, you need to consider where you store your geometry sequence.
19
-
In Unity, the best way is to create a [**Streamingassets**](https://docs.unity3d.com/Manual/StreamingAssets.html) folder inside of your root Asset path, and store all geometry sequences in there. This folder will be copied into your build, so that all files remain intact.
19
+
In Unity, you need to store all assets loaded at runtime in a [**Streamingassets**](https://docs.unity3d.com/Manual/StreamingAssets.html) folder ([exept for Android Builds](/docs/tutorials/distribution/#android)), located inside of the Asset path root, and store all geometry sequences in there. This folder will be copied into your build as-is.
20
20
21
21
1. Inside of the Unity project view, go to the "Assets" folder and create a **Streamingsassets** folder there:
22
22
@@ -32,9 +32,9 @@ In Unity, the best way is to create a [**Streamingassets**](https://docs.unity3d
32
32
33
33
## Android
34
34
35
-
On Android, the StreamingAssets path is a special case. Data stored into this path, will be compressed into the .apk and needs to be decompressed on load. For large files, like geometry sequences, this will make a noticable impact on playback performance, therefore the Streamingassets path is not supported. On Android, you have to use the applications [**Persistent Data Path**](https://docs.unity3d.com/ScriptReference/Application-persistentDataPath.html). The persistent data path is a special path, which stores data spefically for the appliaction. However Unity won't copy the files automatically on build, you have to **copy them manually**.
35
+
On Android, the StreamingAssets path is a special case. Data stored into this path, will be compressed into the .apk and needs to be decompressed on load. For large files, like geometry sequences, this will make a noticable impact on playback performance, therefore we don't support the Streamingassets path. On Android, you have to use the applications [**Persistent Data Path**](https://docs.unity3d.com/ScriptReference/Application-persistentDataPath.html). The persistent data path is a special path, reserved for application data on the device. Unlike the StreamingAssets path, Unity won't copy your files automatically to the persistent data path, instead, you have to **copy them manually**, or on distribution in the Play Store, let your application download them from a server.
36
36
37
-
> ⚠️The persistent data path will only be generated on the applications first run on the device. So you need to run the application once, then copy the files and then run the application again, or download the files onto the device before the Geometry Sequence Player runs.
37
+
> ⚠️The persistent data path will only be generated on the applications first run on the device. So you need to run the application once, then copy the files and then run the application again, or let the app download the files onto the device before the Geometry Sequence Player runs.
38
38
39
39
1. Inside of your Geometry Sequence Player, set the **Path Relation** to **Relative to Persisten Data Path** and enter the relative path in which you later want to store your sequence, in this example we choose *"Sequence/MySequence"*.
Copy file name to clipboardExpand all lines: docs/content/en/docs/tutorials/editor-playback/index.md
+23-13Lines changed: 23 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,18 +22,22 @@ After you've prepared and converted your sequence, you can now stream them from
22
22
23
23
## Playback
24
24
25
-
1. Open your Unity scene in which you want to implement the playback. We recommend that you create a new gameobject, onto which you can attach the streaming and playback scripts/components, but you can use any gameobject of your choice. 
25
+
1. Open your Unity scene in which you want to implement the playback. We recommend that you create a new gameobject, onto which you can attach the streaming and playback scripts/components, but you can use any gameobject of your choice.
26
+
26
27
27
-
2. In the inspector, click on **"Add Component"**, search for **"Geometry Sequence Player"** and add this component. 
28
+
2. In the inspector, click on **"Add Component"**, search for **"Geometry Sequence Player"** and add this component.
3. You should now see a Geometry Sequence Player and Geometry Sequence Stream component attached to your gameobject. Click on **"Open Sequence"** in the Player script, and then open the folder, in which your converted sequence is stored.
30
32
> ⚠️ When you're just trying out playback on your machine, or you don't intent to distribute your app to other PCs, it's fine to store the sequence anywhere on disk. However, if you plan to distribute your application, [please take a look here](/docs/tutorials/distribution)!
4. Set the **playback framerate** of your sequence. This should be the same framerate in which your animated sequence was exported. 
36
+
4. Set the **playback framerate** of your sequence. This should be the same framerate in which your animated sequence was exported.
37
+
35
38
36
-
5. Click Play. You should now see your sequence playing back inside of your scene. If you don't see anything, it might simply be because your camera is not looking at the sequence. Go to the scene window, select the "Streamed Mesh" Gameobject and press **"F"** to focus on it. 
39
+
5. Click Play. You should now see your sequence playing back inside of your scene. If you don't see anything, it might simply be because your camera is not looking at the sequence. Go to the scene window, select the "Streamed Mesh" Gameobject and press **"F"** to focus on it.
40
+
37
41
38
42
## Controls & Settings explained
39
43
@@ -74,19 +78,25 @@ Use the **|<** Button to go back to the start of the sequence, the **<<** and **
74
78
75
79
76
80
77
-
These settings, expect for the materials, should usually not need to be adjusted.
81
+
**Parent Transform**
82
+
You can attach the streamed mesh onto a parent gameobject, which you can use to place, scale, and rotate your streamed mesh.
78
83
79
-
**Buffer size**
84
+
**Pointcloud Material**
85
+
Set an alternative material that is used for displaying pointclouds. If left empty, the supplied default material will be used. Please note that pointclouds **cannot use standard Unity Materials/Shaders!** You need to use a special Pointcloud shader, like the one provided in the package.
86
+
87
+
**Mesh material**
88
+
Set an alternative material that is used for displaying pointclouds. If left empty, the supplied default material will be used.
89
+
90
+
**Buffer options:**
91
+
92
+
-**Buffer size**
80
93
This size sets how many frames the streaming service will load from disk and store in a buffer in advance of the playback. A larger buffer might provide a smoother playback, however it also uses more memory and skipping/restarting playback might take longer, as the buffer needs to be flushed.
81
94
82
-
**Use all threads**
95
+
-**Use all threads**
83
96
Should the Unity Job system which is responsible for streaming use all available threads? If you deactive this, you can set the thread count yourself, but note that it will also effect other scripts that might use the job system!
84
97
85
-
**Thread count**
98
+
-**Thread count**
86
99
Set how many threads the job system should use. Is only used the **Use all threads** is deactivated. Will also effect other scripts that might use the job system!
87
100
88
-
**Pointcloud Material**
89
-
Set an alternative material that is used for displaying pointclouds. If left empty, the supplied default material will be used. Please note that pointclouds **cannot use standard Unity Materials/Shaders!** You need to use a special Pointcloud shader, like the one provided in the package.
90
-
91
-
**Mesh material**
92
-
Set an alternative material that is used for displaying pointclouds. If left empty, the supplied default material will be used.
101
+
**Frame Info**
102
+
This foldout contains read-only frame information. Used only for debugging.
- `relativeTo`:Isthepathrelativetothe [datapath](https://docs.unity3d.com/ScriptReference/Application-dataPath.htmls), [streaming assets path](https://docs.unity3d.com/Manual/StreamingAssets.html), or is it an absolute path?
0 commit comments