getvisual

R2026b

Get visual for actor, behavior, or analysis

Since R2026b

collapse all in page

    Syntax

    vis = getvisual(entity)
    vis = getvisual(v,entity)

    Description

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

    vis = getvisual(entity) returns the visual object, from the current viewer, associated with the specified actor, behavior, or analysis object. Visual objects are useful for customizing the appearance of an object in a viewer.

    vis = getvisual(v,entity) returns the visual object from the specified viewer.

    Input Arguments

    collapse all

    Scenario entity, specified as an Actor, FixedTrajectoryBehavior, LOSAnalysis, or RayTraceAnalysis object.

    Viewer, specified as a GlobeViewer object. When you do not specify a viewer, the function uses the current viewer.

    Output Arguments

    collapse all

    Visual, returned as an ActorVisual, WaypointTrajectoryVisual, LOSVisual, or RayTraceVisual object. The type of visual depends on the input entity:

    • For an Actor object, the visual is an ActorVisual object that renders the 3D asset or, if the asset is empty, a point.

    • For a FixedTrajectoryBehavior object, the visual is a WaypointTrajectoryVisual object that contains a line through the trajectory path with circular points at each waypoint position.

    • For an LOSAnalysis object, the visual is an LOSVisual object.

    • For a RayTraceAnalysis object, the visual is a RayTraceVisual object.

    Tips

    • The getvisual function is useful when you are working with multiple viewers. When you have only one viewer, you can get a visual object by querying the Visual property of the actor, behavior, or analysis object.

    Version History

    Introduced in R2026b

    See Also

    Objects

    Functions

    Topics