Skip to content

Commit c289ed0

Browse files
[Docs] Updated docs to V1.2.2
1 parent 7036c88 commit c289ed0

9 files changed

Lines changed: 36 additions & 3 deletions

File tree

docs/content/docs/about/changelog.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ weight: 420
1313
toc: true
1414
---
1515

16+
### Version 1.2.2
17+
18+
This version contains several new features, contributed by [Anwar Lu](https://github.com/MrGcGamer):
19+
20+
- **Converter Tool MacOS support:** The converter tool now supports MacOS as well (texture compression is not yet supported)
21+
- **Sequence Compression:** Sequences can now be compressed to around half their size!
22+
23+
Fixes:
24+
25+
- [Issue #9](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Player/issues/11)
26+
- Several small bug fixes and additions
27+
1628
### Version 1.2.1
1729

1830
This version contains a small improvement for the rendering bounds of Sequences. The bounds were not correctly calculated in previous version, leading to the sequence not being correctly culled from the camera view.

docs/content/docs/about/license-credits.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,14 @@ The Unity Asset Store version of the package is licensed under the [Unity Standa
2727

2828
## Credits
2929

30-
- This website was created with the **[Doks](https://getdoks.org/)** theme made by **[Thulite](https://thulite.io/)**
30+
- The compression feature and MacOS support for the converter were made by [Anwar Lu](https://www.linkedin.com/in/anwar-lu/) - Thanks!
3131

3232
- The sequences in the showreel, from the landing page and on Github, were created by:
3333

3434
- ["A Windy Day2 by Loic Norgeot](https://sketchfab.com/3d-models/a-windy-day-fb78f4cc938144e6902dd5cff354d525)
3535

3636
- ["Galactic Incident2 by Loic Norgeot](https://sketchfab.com/3d-models/galactic-incident-397b266af9604b9fbf0a4e5446cf864b)
37+
38+
- This website was created with the **[Doks](https://getdoks.org/)** theme made by **[Thulite](https://thulite.io/)**
39+
40+
- The converter tool is made possible by [PyMeshLab](https://github.com/cnr-isti-vclab/PyMeshLab), [DearPyGUI](https://github.com/hoffstadt/DearPyGui), [ASTCEncoder](https://github.com/ARM-software/astc-encoder) and [TexConv](https://github.com/microsoft/DirectXTex/wiki/texconv)

docs/content/docs/tutorials/materials/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ Go to the **Geometry Sequence Stream** component that can be found on the same G
3737

3838
If you have a mesh sequence with textures, you can also control to which texture slot the texture will be applied. By default, textures will always be applied to the Main/Albedo/Diffuse slot, which is defined in the shader as _\_MainTexture_. But you can also apply the texture to any other slot. Either you select one or more predefined slots in the **Apply to texture slots** variable, or you enter the name of the texture slot into the **Custom texture slots** list. This has to be the name of the texture slot as found in the **shader**, not the material! Shader texture slot variables are often prefixed with an _Underscore.
3939

40+
### Mesh normals
41+
42+
By default, mesh normals won't be saved in the sequence, as it increases the sequence size and is not necessary in most cases. Unity will generate
43+
new normals during playback. However, if you need precise normals (for example for hard-surface meshes), you can also keep the original normals, by activating the "Save Normals" option in the sequence converter before converting your sequence.
44+
4045
## Pointcloud sequences
4146

4247
Changing the appearance of the pointcloud works very differently compared to meshes, as pointclouds require special shaders for rendering correctly. If you don't assign a custom pointcloud material, there are some predefined settings you can use to easily and quickly the appearance. These settings can be found under the **Geometry Sequence Stream** component and include the **Point Size** as well as the **Point Emission Strength**.
@@ -74,3 +79,11 @@ If you don't set a custom material, a default pointcloud material will be loaded
7479
`Packages > Geometry Sequence Player > Runtime > Shader > Resources`
7580

7681
You'll see three different sets of shaders, _Legacy_, _Shadergraph_ and _Polyspatial_. Clone one of the shaders appropriate for your chosen render path. Then, create a material that uses your freshly cloned shader and apply it under **Custom Material**. For quick iteration, we recommend to disable the **Instantiate Shader** option. If you're a little bit familiar with Shaderlab/Shadergraph, you should be able to get an idea of how the shaders work, by taking a look at the commented code/graph.
82+
83+
### Pointcloud normals
84+
85+
![Pointcloud normals example](pointcloud_normals.jpg)
86+
87+
In comparison to meshes, pointcloud sequences usually don't contain any normals. If you want your pointcloud sequence to receive lighting and shadows inside Unity, you need to generate normals. The sequence converter comes with a build-in functionality to estimate pointcloud normals and save them in the sequence.
88+
89+
[More info](/Unity_Geometry_Sequence_Player/docs/tutorials/preparing-your-sequences/#using-the-converter/)
207 KB
Loading
1.09 KB
Loading
916 Bytes
Loading
1.1 KB
Loading

docs/content/docs/tutorials/prepare-data/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,13 @@ And for images:
8181
3. The converter provides some settings which can be used to modify the sequence:
8282
![Converter Select Input](Converter_Options.png)
8383

84+
- **Use compression:** Sequences are compressed to around half their size. Works for meshes and pointclouds
8485
- **Save normals:** When enabled, the normals of the mesh or pointcloud sequence are exported. Only recommended to enable if you have custom normals
8586
- **Pointcloud Settings:** Only affects pointclouds
8687
- **Decimate Pointcloud:** You can downsize your pointcloud sequence with this option. The value determines the percentage of points left after conversion. E.g. setting the value to 30% will decrease the points of the sequence by 70%.
8788
- **Merge Points by Distance:** Merges points that are close together. The higher the value, the more points will be merged. Useful if the data contains duplicated points
8889
- **Estimate Normals:** Pointclouds usually don't come with normals. When this option is enabled, the normals will be reasonably estimated.
90+
- **Invert Normals:** This settings is only visible when *Estimate Normals* is enabled. Use if the generated normals are not facing the correct direction.
8991
- **Texture Settings** Only affects mesh sequences with textures
9092
- **Generate textures for desktop devices (DDS):** This converts the textures into a format for desktop GPUs. Recommended to leave on, even when you only build for mobile devices, otherwise textures won't show up in the Unity editor.
9193
- **Generate textures for mobile devices (ASTC):** If you plan to distribute your application on mobile devices (Android, IPhone, Meta Quest, Apple Vision Pro) and use textured meshes, you need to also generate .astc textures. You only need to transfer the .astc textures to your device, but not the .dds textures.
@@ -177,6 +179,7 @@ The sequence.json file contains information about your sequence in the following
177179
//three frames
178180

179181
{
182+
"sequenceVersion": "1.2.2", //Should be the same as the package version
180183
"geometryType": 2, //0 = Pointcloud, 1 = Mesh, 2 = Textured Mesh
181184
"textureMode": 2, //0 = No Textures, 1 = One texture, 2 = Per Frame textures
182185
"DDS": true, //Does this sequence have .dds textures?
@@ -185,7 +188,8 @@ The sequence.json file contains information about your sequence in the following
185188
"hasNormals": false, //Are per-vertex normals used?
186189
"maxVertexCount": 26545, //The vertice count of the mesh/pointcloud with the highest vertice count in the whole sequence
187190
"maxIndiceCount": 55423, //The indice count of the mesh/pointcloud with the highest indice count in the whole sequence
188-
"maxBounds": [325.8575134277344, 295.0, 2103.5478515625, -18.240554809570312, -238.74757385253906, 0], //Bounds of the mesh in the format: MaxboundX, MaxboundY, MaxboundZ, MinboundX, MinboundY, MinboundZ
191+
"boundsCenter": {"x": -0.010323499999999985, "y": -0.043528500000000026, "z": 0.007380500000000012},
192+
"boundsSize": {"x": 1.472131, "y": 1.386613, "z": 1.468193}, //The meshes/pointclouds center and bounds in world coordinates
189193
"textureWidth": 512, //The width of the texture(s)
190194
"textureHeight": 512, //The hight of the texture(s)
191195
"textureSizeDDS": 2097152, //The size of a single .dds texture in bytes

0 commit comments

Comments
 (0)