Main Content

takeSnapshot

Take snapshot of selected properties

Since R2022b

collapse all in page

    Syntax

    takeSnapshot(actor)
    takeSnapshot(actor,Name)
    takeSnapshot(actor,Name,Properties)
    takeSnapshot(actor)
    takeSnapshot(actor,Name)
    takeSnapshot(actor,Name,Properties)
    takeSnapshot(actor,Name,Properties,IncludeChildren)

    Description

    takeSnapshot(actor) takes a snapshot of the actor specified by actor.

    takeSnapshot(actor,Name) takes a snapshot of the actor called Name.

    takeSnapshot(actor,Name,Properties) takes a snapshot of the actor called Name by storing the values of the properties specified by Properties.

    takeSnapshot(actor) takes a snapshot of actor.

    takeSnapshot(actor,Name) takes a snapshot of actor called Name.

    takeSnapshot(actor,Name,Properties) takes a snapshot of the actor called Name by storing the values of the properties contained in Properties.

    takeSnapshot(actor,Name,Properties,IncludeChildren) takes a snapshot of actor by storing the values of Properties mentioned.

    Input Arguments

    collapse all

    Actor class whose property is returned, specified as a sim3d.Actor object.

    Name of snapshot, specified as a string or character array. This name can be used later to retrieve the snapshot. If no name is specified, a default name is generated.

    Names of properties whose values are returned from actor, specified a cell array of Properties of the sim3d.Actor object properties.

    Properties should be a cell array of strings with the list of all properties to be included in the snapshot.

    Whether to include children of in search, specified as either true (1) or false (0).

    • true – Include all children.

    • false – Do not include children.

    Version History

    Introduced in R2022b

    See Also

    | | | |