Skip to content

Commit 01e0b01

Browse files
authored
docs: UseImageMarker (#55)
* Add UseImageMarker manual * Add a TimelineClip picture showing UseImageMarker * Update StreamingImageSequencePlayableAsset inspector image * Minor change to the inspector GUI of StreamingImageSequencePlayableAsset * Add Timeline version recommendation in the top readme.
1 parent e8a0f17 commit 01e0b01

File tree

6 files changed

+29
-6
lines changed

6 files changed

+29
-6
lines changed

Documentation~/en/StreamingImageSequencePlayableAsset.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,25 @@ For other ways for importing images, see [ImportingImages](ImportingImages.md)
4343

4444
# Curve
4545

46-
We can also change the timing of the playback by adjusting the curve of the asset.
47-
To do this, open the curve section, and right click on the curve to start adding keys.
46+
The timing of the playback is determined by the curve of the asset, which can be adjusted by
47+
opening the curve section, right clicking on the curve to add keys, and moving them accordingly.
4848

4949
![StreamingImageSequenceCurve](../images/StreamingImageSequenceCurve.png)
5050

51+
# UseImageMarker
52+
53+
Each frame has UseImageMarker, which can be used to skip the image assigned to that particular frame, and show the last used image instead.
54+
55+
![UseImageMarker](../images/UseImageMarker.png)
56+
57+
Keyboard shortcuts:
58+
59+
1. u: toggle use/skip. This shortcut can be changed in the StreamingImageSequence category in the Shortcuts window.
60+
1. left/right arrow: move to the prev/next UseImageMarker.
61+
62+
> If the UseImageMarkers are not shown correctly, click on the PlayableDirector GameObject in the hierarchy window to refresh the timeline window.
63+
64+
5165
# Inspector
5266
![StreamingImageSequencePlayableAsset](../images/StreamingImageSequencePlayableAsset.png)
5367

@@ -56,10 +70,14 @@ To do this, open the curve section, and right click on the curve to start adding
5670
* **Folder**
5771
The folder where the image files are located
5872
* **Images**
59-
The images inside the folder.
60-
We can reorder the images by dragging the image file name up/down.
73+
The images inside the folder.
74+
Can be reordered by dragging the image file name up/down.
6175
* **Reset Curve**.
6276
Reset the curve timing in the PlayableAsset to be linear.
77+
* **Show UseImageMarkers**.
78+
Show/hide UseImageMarker of each frame.
79+
* **Reset UseImageMarkers**.
80+
Reset UseImageMarkers of all frames.
6381

6482

6583

-10 KB
Loading
37.6 KB
Loading

Documentation~/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
Streaming Image Sequence is a package for playing sequential image sequences in Unity Timeline
44
easily without making Unity 2D Sprites.
55

6+
**Timeline 1.4.x or above is recommended.**
7+
68
# Supported Platforms
79

810
1. Windows

Editor/StreamingImageSequencePlayableAssetInspector.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,9 @@ public override void OnInspectorGUI() {
8181

8282
}
8383

84-
m_asset.SetUseImageMarkerVisibility(GUILayout.Toggle(m_asset.GetUseImageMarkerVisibility(), "Show Use Image Markers"));
85-
if (GUILayout.Button("Reset Use Image Markers")) {
84+
GUILayout.Space(15);
85+
m_asset.SetUseImageMarkerVisibility(GUILayout.Toggle(m_asset.GetUseImageMarkerVisibility(), "Show UseImageMarkers"));
86+
if (GUILayout.Button("Reset UseImageMarkers")) {
8687
m_asset.ResetPlayableFrames();
8788
}
8889

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
Streaming Image Sequence is a package for playing sequential image sequences in Unity Timeline
44
easily without making Unity 2D Sprites.
55

6+
**Timeline 1.4.x or above is recommended.**
7+
68
# Other Languages
79
- [日本語](README_JP.md)
810

0 commit comments

Comments
 (0)