remove

R2026b

Remove actor or analysis from 3D scenario

Since R2026b

collapse all in page

    Syntax

    remove(entity)

    Description

    Add-On Required: This feature requires the 3D Scenarios add-on.

    remove(entity) removes the specified actor or analysis objects from the scenario and deletes the objects. The visuals that are associated with the actor and analysis objects are removed from all viewers.

    • When you remove an actor, the Actors property of the scenario no longer reports the actor object. If an analysis object references the actor, the actor is removed from the analysis. The analysis remains in the scenario, but might not be usable until you assign a new actor to the analysis.

    • When you remove an analysis, the analyses function no longer reports the analysis object.

    • When you remove an actor or analysis, the viewers remove all visuals that are associated with the actor or analysis.

    To remove an actor or analysis from a scenario, the SimulationStatus property of the associated Scenario object must be "notstarted".

    Input Arguments

    collapse all

    Actor or analysis to remove, specified as a vector of Actor, LOSAnalysis, or RayTraceAnalysis objects. The vector can include more than one type of object.

    Version History

    Introduced in R2026b

    See Also

    Objects