Path

R2026b

Path graphic object corresponding to platform, satellite, or Moon in scenario

Since R2024a

expand all in page

    Description

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

    Creation

    Create Path objects using the path function of the Satellite, Platform, or CentralBodyOptions object.

    For the CentralBodyOptions object, the CentralBody property must equal "Moon". Otherwise, this property is hidden and ignored.

    Properties

    expand all

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

    Duration of the future path to be visualized, specified as a nonnegative scalar, in seconds.

    Default Value

    The default value is for platforms and satellites whose OrbitPropagator is set to 'ephemeris':

    • The duration from the satelliteScenario StartTime to StopTime when OrbitPropagator is set to "ephemeris".

    • For satellites in a parabolic or hyperbolic orbit and whose OrbitPropagator is set to "two-body-keplerian" or "numerical", the default LeadTime is the duration from the satellite scenario StartTime to the time when the satellite reaches 145 times the equatorial radius of the central body.

    • One orbital period in all other cases.

    For platforms, the default value is the duration from the satelliteScenario StartTime to StopTime.

    Duration of the path history to be visualized, specified as a nonnegative scalar, in seconds.

    Default Value

    The default value is for platforms and satellites whose OrbitPropagator is set to 'ephemeris':

    • The duration from the satelliteScenario StartTime to StopTime when OrbitPropagator is set to "ephemeris".

    • For satellites in a parabolic or hyperbolic orbit and whose OrbitPropagator is set to "two-body-keplerian" or "numerical", the default TrailTime is the duration from the satellite scenario StartTime to the time when the satellite reaches 145 times the equatorial radius of the central body.

    • One orbital period in all other cases.

    For platforms, the default value is the duration from the satelliteScenario StartTime to StopTime.

    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 NameShort NameRGB TripletHexadecimal Color CodeAppearance
    "red" "r" [1 0 0] "#FF0000"

    Sample of the color red

    "green" "g" [0 1 0] "#00FF00"

    Sample of the color green

    "blue" "b" [0 0 1] "#0000FF"

    Sample of the color blue

    "cyan" "c" [0 1 1] "#00FFFF"

    Sample of the color cyan

    "magenta" "m" [1 0 1] "#FF00FF"

    Sample of the color magenta

    "yellow" "y" [1 1 0] "#FFFF00"

    Sample of the color yellow

    "black" "k" [0 0 0] "#000000"

    Sample of the color black

    "white" "w" [1 1 1] "#FFFFFF"

    Sample of the color white

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

    RGB TripletHexadecimal Color CodeAppearance
    [0 0.4470 0.7410] "#0072BD"

    Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

    [0.8500 0.3250 0.0980] "#D95319"

    Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

    [0.9290 0.6940 0.1250] "#EDB120"

    Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

    [0.4940 0.1840 0.5560] "#7E2F8E"

    Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

    [0.4660 0.6740 0.1880] "#77AC30"

    Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

    [0.3010 0.7450 0.9330] "#4DBEEE"

    Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

    [0.6350 0.0780 0.1840] "#A2142F"

    Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

    Example: 'blue'

    Example: [0 0 1]

    Example: '#0000FF'

    Width of path visualizations in pixels, specified as 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.

    Visibility mode of the path graphic in the Satellite Scenario Viewer, specified as one of these values:

    • 'inherit' — Inherit visibility from parent platform graphic. The visibility of the path graphic matches that of the parent platform.

    • 'manual' — Do not inherit visibility from parent. Visibility of the path graphic is independent of that of the parent platform.

    The default value is 'inherit'. For platforms and satellites whose CentralBody equals "Earth", or "Moon", path is drawn on the central body. In any case, groundtracks are not drawn on the Moon.

    Note

    Path graphic is always invisible in 2-D viewers.

    Object Functions

    showShow object in satellite scenario viewer
    hideHide satellite scenario entity from viewer

    Version History

    Introduced in R2024a

    See Also

    Objects

    Functions

    Topics

    1 Alignment of boundaries and region labels are a presentation of the feature provided by the data vendors and do not imply endorsement by MathWorks®.