ActorVisual

R2026b

Actor visual

Since R2026b

Description

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

An ActorVisual object controls the appearance of an Actor object displayed in a scenario viewer. Use actor visual properties to customize the appearance of an actor.

Creation

When you add an actor to a scenario with open viewers, the scenario automatically creates an ActorVisual object and stores the object in the Visual property of the corresponding Actor object.

You can access an ActorVisual object by using the getvisual function or by querying the Visual property of the Actor object.

Properties

MarkerEdgeColor — Marker outline color

"auto" (default) | RGB triplet | hexadecimal color code | color name | "none"

Marker outline color, specified as "auto", an RGB triplet, a hexadecimal color code, a color name, or "none". The value "auto" uses a darker version of the color specified by the MarkerFaceColor property.

For actors with 3D assets, the marker becomes visible when the camera is zoomed sufficiently far away from the actor.

MarkerFaceColor — Marker fill color

[0.96 0.46 0.16] (default) | RGB triplet | hexadecimal color code | color name | "none"

Marker fill color, specified as an RGB triplet, a hexadecimal color code, a color name, or "none".

For actors with 3D assets, the marker becomes visible when the camera is zoomed sufficiently far away from the actor.

MarkerSize — Marker radius, in pixels

9 (default) | positive scalar

Marker radius, in pixels, specified as a positive scalar.

For actors with 3D assets, the marker becomes visible when the camera is zoomed sufficiently far away from the actor.

Alpha — Actor transparency

1 (default) | scalar in range [0, 1]

Actor transparency, specified as a scalar in the range [0, 1]. A value of 1 is opaque and a value of 0 is completely transparent.

OrientationVectors — Visual for orientation vectors

OrientationVectorsVisual object

Visual for the orientation vectors, represented as an OrientationVectorsVisual object. By default, when you add an actor to a scenario with open viewers, the scenario creates an OrientationVectorsVisual object and stores it in this property.

Adjust the properties of the OrientationVectorsVisual object by using dot notation. For example, show the orientation vectors for the visual vis by using vis.OrientationVectors.Visible = "on".

Adding or removing the object using this property is not supported.

Visible — State of visibility

"on" (default) | on/off logical value

State of visibility, specified as "on" or "off", or as numeric or logical 1 (true) or 0 (false). A value of "on" is equivalent to true, and "off" is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• "on" — Show the visual object in the viewer.

• "off" — Do not show the visual object in the viewer.

Version History

Introduced in R2026b