gather

Return values of selected property from all objects in selected branch

Since R2022b

collapse all in page

    Syntax

    res = gather(actor,PropertyName)
    res = gather(actor,PropertyName,IncludeChildren)

    Description

    res = gather(actor,PropertyName) returns a cell array with objects found in the actor class specified by actor and current property values for PropertyName.

    res = gather(actor,PropertyName,IncludeChildren) specifies whether the children of actor should be searched too.

    Input Arguments

    collapse all

    Actor object, specified as a sim3d.Actor object.

    Example: actor = sim3d.Actor()

    Name of property returned from actor, specified as one of the Properties of the sim3d.Actor object.

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

    • true – Include all children.

    • false – Do not include children.

    Output Arguments

    collapse all

    Table of results, returned as a cell array. The first column contains references to found actors. The second column contains the current value of the property specified by PropertyName.

    Version History

    Introduced in R2022b

    See Also

    | |