Skip to content

Commit 851cbc8

Browse files
Added Changelog for V1.0.2
1 parent 6e44a1e commit 851cbc8

File tree

3 files changed

+44
-14
lines changed

3 files changed

+44
-14
lines changed

docs/content/en/docs/about/changelog.md

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

16+
### Version 1.0.2
17+
18+
Added features:
19+
20+
- A parent transform for the streamed mesh can be set
21+
- Pointcloud meshes are now mirrorable
22+
- Added better documentation in some parts
23+
- Added Unity Test Project to the main repository
24+
25+
Fixed Issues:
26+
27+
[#6 "The transform of Streamed Meshes should be settable before going into play mode"](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Streaming/issues/6)
28+
29+
[#3 "Meshes/Pointclouds are mirrored on the X-Axis"](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Streaming/issues/3)
30+
31+
Releases:
32+
[Package release v1.0.2](https://github.com/BuildingVolumes/Geometry_Sequence_Streaming_Package/releases/tag/v1.0.2)
33+
1634
### Version 1.0.1 (Package only)
1735

1836
Fixed Issues:

docs/content/en/docs/tutorials/editor-playback/index.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,47 +47,59 @@ Detailed explanation of all the settings and controls inside of the player and s
4747

4848
![All player settings](editor_playback_player_component.png)
4949

50-
**Path relation**
50+
#### Path relation
51+
5152
Choose if your path to the sequence is relative to the [Data path](https://docs.unity3d.com/ScriptReference/Application-dataPath.html), [Streaming Assets path](https://docs.unity3d.com/Manual/StreamingAssets.html) or is an absolute path. This gets set automatically if you open a sequence with the **Open Sequence** button. If you enter the path yourself, you also need to set this field!
5253

53-
**Path to sequence**
54+
#### Path to sequence
55+
5456
Enter your relative or absolute path to the folder containing the sequence
5557

56-
**Open Sequence / Clear Sequence**
58+
#### Open Sequence / Clear Sequence
59+
5760
Use the file explorer to choose the folder where your converted sequence is located, or clear the path from the player.
5861

59-
**Target Playback FPS**
62+
#### Target Playback FPS
63+
6064
This is the framerate at which you want to playback your sequence. It's important that this is set to the same framerate that you used while animating/capturing your sequence, as it also effects playback speed. E.g. if you exported your sequence at 30 FPS, but set the playback framerate to 60 FPS, the sequence will play twice as fast.
6165

62-
**Play at Start**
66+
#### Play at Start
67+
6368
Should the playback of the sequence start directly when the scene is started/you entered play mode?
6469

65-
**Loop playback**
70+
#### Loop playback
71+
6672
If activated, repeats the animation indefinitly
6773

68-
**Actual FPS / Frame drop**
74+
#### Actual FPS / Frame drop
75+
6976
This is the actual framerate at which the sequence plays back. If you either see a framerate lower than your target playback FPS, or see lot's of "Frame Dropped!" warning messages, this means that your system doesn't have enough resources to playback the sequence at it's intendet speed. You can either reduce the geometric complexity of your sequence, reduce the texture size, or upgrade your system.
7077

71-
**Time slider**
78+
#### Time slider
79+
7280
Use this slider to skip to any time in the sequence, just like in a regular video player. On the right, you can see at which frame the playback is right now, and how many frames there are in total in the sequence. The slider is only available in the editor.
7381

74-
**Playback controls**
82+
#### Playback controls
83+
7584
Use the **|<** Button to go back to the start of the sequence, the **<<** and **>>** to scroll forwards/backwards for a few frames, and the **Play/Pause** button to pause/resume the playback. These buttons are only available in the editor.
7685

7786
### Stream component
7887

7988
![All player settings](editor_playback_stream_component.png)
8089

81-
**Parent Transform**
90+
#### Parent Transform
91+
8292
You can attach the streamed mesh onto a parent gameobject, which you can use to place, scale, and rotate your streamed mesh.
8393

84-
**Pointcloud Material**
94+
#### Pointcloud Material
95+
8596
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.
8697

87-
**Mesh material**
98+
#### Mesh material
99+
88100
Set an alternative material that is used for displaying pointclouds. If left empty, the supplied default material will be used.
89101

90-
**Buffer options:**
102+
#### Buffer options
91103

92104
- **Buffer size**
93105
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.

0 commit comments

Comments
 (0)