Main Content

restoreSnapshot

Restore actor to state of properties saved in specified snapshot

    Description

    restoreSnapshot(actor) restores properties of the actor specified by actor to the values stored in the snapshot. If IncludeChildren is set to true while taking the snapshot, all the properties of the children of the actor restore to their original state.

    restoreSnapshot(actor,SnapID) additionally specifies the name or time of the snapshot specified by SnapID.

    Input Arguments

    collapse all

    Actor class whose properties are restored, specified as a sim3d.Actor object.

    Name of snapshot being restored, specified as a character array. If SnapID is empty or incorrect or non existing snapshot ID is provided, it will result in an error and no snapshot will be restored.

    Version History

    Introduced in R2022b