Skip to content

Latest commit

 

History

History
94 lines (62 loc) · 4.16 KB

SceneCache.md

File metadata and controls

94 lines (62 loc) · 4.16 KB
Raw

Scene Cache

Scene Cache is a feature to playback all frames of an .sc file that was exported using MeshSyncDCCPlugins installed in a DCC Tool.
This functionality is very similar to AlembicForUnity, but it has the following differences:

  1. Scene Cache is designed to playback frames accurately with high performance.
  2. Scene Cache supports material export/import
  3. Unlike Alembic, .sc files are only playable in Unity.
  4. As a side effect from prioritizing performance, newer versions of MeshSync may not be able to play .sc file created with earlier versions, although this kind of change will be kept to a minimum.
    Please refer to SceneCache Version and Backward Compatibility for more details.

How to use

From the menu, select Game Object > MeshSync > Create Cache Player, and then select a previously exported .sc file, which can be either inside or outside the Unity project.
This will automatically create a GameObject with SceneCachePlayer component, which will be played automatically in PlayMode.

Menu

Normally, the playback is controlled using an Animator with an AnimationClip, but we can also control the playback of Scene Cache in Timeline.

Scene Cache Importer

When an .sc file is inside the Unity project, clicking on the .sc file will open its import settings in the inspector. These import settings are similar to the import properties in the inspector, and can be overridden in the inspector as well.

Scene Cache Player

This component handles the playback of an .sc file.

Properties

Properties Description
Cache File Path The path to the .sc file.
Copying the cache file to StreamingAssets is recommended, and can be done by simply clicking the Copy button.
Info Shows the basic information of the .sc file.
Playback Mode Refer to playback mode for more details.
Time The playback time.
Frame The selected frame of the .sc file.
Disabled if the Playback Mode is set to Interpolation.

Playing .sc files located in folders outside the active Unity project is supported, but keep in mind that only the computer which stores those .sc files can play them.

Please refer to common properties for details on the other properties.

Playback Mode

Playback Mode Description
Snap to Previous Frame Selects the last frame which has been passed by the playback time.
Snap to Nearest Frame (Default) Selects the frame which is nearest to the playback time.
Interpolation Smoothens animations by interpolating meshes and transforms between nearest neighboring frames.
Note that meshes are only interpolated if the topologies match (the vertex indexes remain unchanged).

Tips

  • Material List property can be used to carry over existing materials when the cache file is updated.

SceneCache Version and Backward Compatibility

MeshSync assigns a particular SceneCache Version when creating a SceneCache (.sc) file, and a MeshSync package with the same SceneCache Version is guaranteed to be able to load and play that .sc file.

On the other hand, MeshSync will not be able to play a .sc file if its SceneCache Version is different from the one supported by that particular MeshSync version.

Compatible MeshSync Version SceneCache Version
0.14.x-preview ~ 124
0.3.x-preview - 0.13.x-preview 123