path

Visualize platform path in satellite scenario

Since R2024a

Syntax

path(pltf)

path(___,Name,Value)

Description

path(pltf) adds path visualization for each platform in the vector pltf based on their current positions.

path(___,Name,Value) adds platform visualization for each platform in the vector pltf specified by optional name-value arguments.

Input Arguments

pltf — Platform in the scenario

Platform object

Platform in the scenario, specified as a Platform (Satellite Communications Toolbox) object belonging to the satellite scenario specified by scenario.

You can modify the Platform object by changing its property values.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: Name = 'MySatellite' sets the satellite name to 'MySatellite'.

viewer — Satellite Scenario Viewer

satelliteScenarioViewer object

Satellite Scenario Viewer, specified as a scalar satelliteScenarioViewer object.¹

LineColor — Color of path visualization line

[0.494 0.184 0.556] (default) | RGB triplet | hexadecimal color code | color name | short name

Color of path visualization line, specified as an RGB triplet, hexadecimal color code, a color name, or a short name.

For a custom color, specify an RGB triplet or a hexadecimal color code.

• An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1], for example, [0.4 0.6 0.7].

• A hexadecimal color code is a string scalar or character vector that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from 0 to F. The values are not case sensitive. Therefore, the color codes "#FF8800", "#ff8800", "#F80", and "#f80" are equivalent.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and the hexadecimal color codes.

Color Name	Short Name	RGB Triplet	Hexadecimal Color Code	Appearance
"red"	"r"	[1 0 0]	"#FF0000"
"green"	"g"	[0 1 0]	"#00FF00"
"blue"	"b"	[0 0 1]	"#0000FF"
"cyan"	"c"	[0 1 1]	"#00FFFF"
"magenta"	"m"	[1 0 1]	"#FF00FF"
"yellow"	"y"	[1 1 0]	"#FFFF00"
"black"	"k"	[0 0 0]	"#000000"
"white"	"w"	[1 1 1]	"#FFFFFF"

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB^® uses in many types of plots.

RGB Triplet	Hexadecimal Color Code	Appearance
[0 0.4470 0.7410]	"#0072BD"
[0.8500 0.3250 0.0980]	"#D95319"
[0.9290 0.6940 0.1250]	"#EDB120"
[0.4940 0.1840 0.5560]	"#7E2F8E"
[0.4660 0.6740 0.1880]	"#77AC30"
[0.3010 0.7450 0.9330]	"#4DBEEE"
[0.6350 0.0780 0.1840]	"#A2142F"

Example: 'blue'

Example: [0 0 1]

Example: '#0000FF'

LineWidth — Width of path visualizations

1 (default) | scalar in the range (0 10]

Width of path visualizations in pixels, specified as 'LineWidth' and a scalar in the range (0 10].

The line width cannot be thinner than the width of a pixel. If you set the line width to a value that is less than the width of a pixel on your system, the line displays as one pixel wide.

VisibilityMode — Visibility mode of path graphic

'inherit' (default) | 'manual'

Visibility mode of path graphic in the satellite scenario viewer, specified as one of these values:

• 'inherit' — Visibility of the path graphic matches that of the parent platform.

• 'manual' — Visibility of the path graphic is not inherited and is independent of that of the parent platform.

Note

Path graphic is always invisible in 2-D viewers.

Version History

Introduced in R2024a