RayPathVisual

R2026b

Ray path visual

Since R2026b

Description

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

A RayPathVisual object controls the appearance of a plotted ray path in a scenario viewer.

Creation

Create a RayPathVisual object by using the plot function.

Properties

Color — Color of ray path

RGB triplet | hexadecimal color code | color name

Color of the ray path, specified as an RGB triplet, a hexadecimal color code, or a color name.

When you plot a ray path by using the plot function, the function applies color to the ray paths by using the values of the ColorMetric, Colormap, and ColorLimits name-value arguments.

LineWidth — Line width, in pixels

5 (default) | positive scalar

Line width, in pixels, specified as a positive scalar. This value specifies the width of the line that makes up the ray path.

EndpointSize — Radius of endpoint markers, in pixels

7 (default) | positive scalar

Radius of the endpoint markers, in pixels, specified as a positive scalar.

Alpha — Ray path transparency

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

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

ShowLine — Option to show ray path line

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

Option to show the ray path line, 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 ray path line.

• "off" — Do not show the ray path line.

ShowEndpoints — Option to show endpoint markers

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

Option to show the endpoint markers, 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.

• "off" — Do not show the endpoint markers.

• "on" — Show the endpoint markers.

The color of the source endpoint is white with a black outline. The color of each destination endpoint corresponds to the highest value for the specified color metric.

ShowInteractionPoints — Option to show markers at interaction locations

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

Option to show circular point markers at the interaction locations, 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.

• "off" — Do not show markers at the interaction locations.

• "on" — Show markers at the interaction locations.

The color of each interaction point matches the color of the corresponding ray path.

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