Skip to content

Commit f9340e0

Browse files
authored
docs: documentation for 0.0.2-preview.2 (#44)
* Rename Demo.gif to StreamingImageSequenceDemo.gif * Update StreamingImageSequencePlayableAsset.png * Rename DragAndDropStreamingAssets.png to DragAndDropFolder.png * Add images * Updating docs * Update main readme * Update the description in package. Also increase the version to 0.0.2-preview.2
1 parent 62ee4ee commit f9340e0

16 files changed

+146
-94
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# FaderPlayableAsset
2+
3+
A playable asset for fading Image component in Unity Timeline.
4+
5+
# Tutorial
6+
7+
From an empty scene, do the following:
8+
9+
1. Create an empty *GameObject* and add a *Director* component to it
10+
1. Copy the sequential images in a folder inside the Unity project, preferably under *StreamingAssets*
11+
> Copying to a folder under *StreamingAssets* will save us from the process to import those images in Unity, which may take a long time if there are a lot of images
12+
1. Open the Timeline window, if not opened yet
13+
1. Add a FaderTrack in the Timeline Window
14+
15+
<img src="../images/AddFaderTrack.png" width=180>
16+
17+
1. Right click on the timeline window and click *Add Fader Playable Asset*
18+
19+
<img src="../images/AddFaderPlayableAsset.png" width=480>
20+
21+
1. Create an Image object by clicking the menu: GameObject -> UI -> Image
22+
23+
1. Drag and drop the Image object to the object property of the FaderTrack
24+
25+
26+
27+
The Image object will be faded in/out as we play the Timeline or drag the time slider of the Timeline window.
28+
29+
30+
31+
# Inspector
32+
33+
<img src="../images/FaderPlayableAsset.png" align=right width=320>
34+
35+
* **Color**
36+
The color to be applied to the Image component attached to the track.
37+
* **Fade Type**
38+
- FadeIn : from invisible (alpha=0) to visible (alpha=1)
39+
- FadeOut: from visible (alpha=1) to invisible (alpha=0)
40+
41+
42+
43+
44+

Documentation~/en/ImportingImages.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,33 @@
22

33
There are a couple of ways to import images into StreamingImageSequencePlayableAsset
44

5-
1. [Folder Drag and Drop to the track](#Folder Drag and Drop to the track)
6-
1. [Importing a file exported from Adobe After Effects using our StreamingImageSequence script for Adobe After Effects](Using StreamingImageSequence plugin for Adobe After Effects)
5+
1. [Folder Drag and Drop to the track](#folder-drag-and-drop-to-the-track)
6+
1. [Setting the folder via inspector](#setting-the-folder-via-inspector)
7+
1. [Using StreamingImageSequence script for Adobe After Effects](#using-streamingImageSequence-script-for-adobe-after-effects)
78

8-
# Folder Drag and Drop to the track
9+
## Folder Drag and Drop to the track
910

10-
This is done by doing drag and drop of the sequential images folder under *StreamingAssets* to the StreamingImageSequenceTrack.
11+
This is done by doing drag and drop of the sequential images folder to the StreamingImageSequenceTrack.
1112

12-
<img src="../images/DragAndDropStreamingAssets.png" width=960>
13+
<img src="../images/DragAndDropFolder.png" width=960>
1314

15+
## Setting the Folder via Inspector
1416

15-
# Using StreamingImageSequence script for Adobe After Effects
17+
We can simply click the **Select** button, or we can also drag and drop a folder directly into the inspector.
18+
<img src="../images/DragAndDropInspector.png" width=640>
19+
20+
If the chosen folder is not under *StreamingAssets*, then the following import window will appear to confirm if we'd like to copy the images into *StreamingAssets*.
21+
We can choose to skip copying by unchecking the checkbox to do so.
22+
23+
<img src="../images/ImporterWindow.png" width=480>
24+
25+
> Copying to *StreamingAssets* is recommended because it saves us from the import process, which may take a long time if there are a lot of images.
26+
27+
## Using StreamingImageSequence script for Adobe After Effects
1628

1729
1. In Adobe After Effects, Run [StreamingImageSequence script for Adobe After Effects](https://github.com/unity3d-jp/StreamingImageSequence/tree/dev/AE~/Plugins) to export the images into a folder.
1830
2. In Unity, click the menu: Assets -> StreamingImageSequence -> Import AE Timeline, and select the *jstimeline* file in the exported folder.
1931

2032
> This import will also create/setup the required Director and Image objects in the Assets/{jstimeline_name} folder.
2133
Importing a *jstimeline* which has the same file name as a previously imported *jstimeline* will overwrite the existing assets in the folder,
2234
so it is recommended to move these assets into another folder.
23-
24-
25-
26-
27-
28-
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# StreamingImageSequencePlayableAsset
2+
3+
A playable asset for playing sequential image sequences in Unity Timeline.
4+
5+
# Supported Image Formats
6+
7+
8+
| | Windows | Mac |
9+
| ----------- | ------------------ | ------------------ |
10+
| png | :white_check_mark: | :white_check_mark: |
11+
| tga | :white_check_mark: | |
12+
13+
14+
# Tutorial
15+
16+
From an empty scene, do the following:
17+
18+
1. Create an empty *GameObject* and add a *Director* component to it
19+
1. Copy the sequential images in a folder inside the Unity project, preferably under *StreamingAssets*
20+
> Copying to a folder under *StreamingAssets* will save us from the process to import those images in Unity, which may take a long time if there are a lot of images
21+
1. Open the Timeline window, if not opened yet
22+
1. Add a StreamingImageSequenceTrack in the Timeline Window
23+
24+
<img src="../images/AddStreamingImageSequenceTrack.png" width=180>
25+
26+
1. Drag and Drop the sequential images folder to the StreamingImageSequenceTrack added previously
27+
28+
<img src="../images/DragAndDropFolder.png" width=960>
29+
30+
1. Create an Image object by clicking the menu: GameObject -> UI -> Image
31+
32+
1. Drag and drop the Image object to the object property of the StreamingImageSequenceTrack, and click *Create StreamingImageSequenceNativeRenderer on Image*
33+
34+
<img src="../images/CreateStreamingImageSequenceNativeRenderer.png" width=960>
35+
36+
37+
The image sequences in the folder will then be shown inside the Image object,
38+
and the Image object will be played/enabled/disabled as we play the Timeline or drag the time slider of the Timeline window.
39+
40+
41+
For other ways for importing images, see [ImportingImages](ImportingImages.md)
42+
43+
44+
# Curve
45+
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.
48+
49+
50+
<img src="../images/StreamingImageSequenceCurve.png" width=640>
51+
52+
53+
# Inspector
54+
55+
<img src="../images/StreamingImageSequencePlayableAsset.png" align=right width=400>
56+
57+
* **Resolution** (Read Only)
58+
Shows the width and height of the first image in the folder
59+
* **Folder**
60+
The folder where the image files are located
61+
* **Images**
62+
The images inside the folder.
63+
We can reorder the images by dragging the image file name up/down.
64+
* **Reset Curve**.
65+
Reset the curve timing in the PlayableAsset to be linear.
66+
67+
68+
74 KB
Loading
49.3 KB
Loading
File renamed without changes.
126 KB
Loading
4.53 MB
Loading
8.31 KB
Loading
32.5 KB
Loading

0 commit comments

Comments
 (0)