centralBodyOptions

R2026b

Modify central body options used in satellite scenario

Since R2025a

collapse all in page

    Syntax

    options = centralBodyOptions(scenario)
    options = centralBodyOptions(___,Name=Value)

    Description

    options = centralBodyOptions(scenario) returns the Aero.satellitescenario.CentralBodyOptions object options stored in the CentralBodyOptions property of the satellite scenario scenario.

    options = centralBodyOptions(___,Name=Value) updates the Aero.satellitescenario.CentralBodyOptions object stored in the CentralBodyOptions property of the satellite scenario scenario using additional parameters specified by one or more name-value arguments and returns the object in options. When AutoSimulate of scenario is false, you can specify the optional name-value arguments only if SimulationStatus is set to NotStarted.

    Input Arguments

    collapse all

    Satellite scenario, specified as a scalar satelliteScenario object.

    Name-Value Arguments

    collapse all

    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: UseEarthOrientationParameters = 1 uses Earth orientation parameters.

    Since R2026b

    Central body, specified as "Earth" or "Moon".

    Data Types: string

    Option to use Earth orientation parameters for the transformation between the International Celestial Reference Frame (ICRF) and International Terrestrial Reference Frame (ITRF), specified as a logical scalar. This argument affects all ICRF to ITRF and ITRF to ICRF transformations throughout the scenario.

    This input is applicable only when CentralBody equals "Earth". Otherwise, it is ignored.

    Default Value

    The default value is the currently used value of the UseEarthOrientationParameters property of the Aero.satellitescenario.CentralBodyOptions object returned by the CentralBodyOptions property of the satellite scenario scenario.

    Data Types: logical

    Earth orientation data file, specified as a MAT file. To create the file, use the aeroReadIERSData function.

    This input is applicable only when CentralBody equals "Earth". Otherwise, it is ignored.

    Default Value

    The default value is the currently used value of the EarthOrientationParameterFile property of the Aero.satellitescenario.CentralBodyOptions object returned by the CentralBodyOptions property of the satellite scenario scenario.

    Data Types: string

    Since R2026b

    Color of the celestial body point marker, specified as an RGB triplet, a hexadecimal color code, a color name, or a short name.

    This input is applicable only when CentralBody equals "Moon". Otherwise, it is ignored.

    Default Value

    The default value is the currently used value of the MarkerColor property of the Aero.satellitescenario.CentralBodyOptions object returned by the CentralBodyOptions property of the satellite scenario scenario.

    Data Types: string | double

    Since R2026b

    Size of the celestial body marker in pixels, specified as a scalar in the range (0,30].

    This input is applicable only when CentralBody equals "Moon". Otherwise, it is ignored.

    Default Value

    The default value is the currently used value of the MarkerSize property of the Aero.satellitescenario.CentralBodyOptions object returned by the CentralBodyOptions property of the satellite scenario scenario.

    Data Types: double

    Since R2026b

    Label visibility state, specified as 1 (true) or 0 (false).

    This input is applicable only when CentralBody equals "Moon". Otherwise, it is ignored.

    Default Value

    The default value is the currently used value of the ShowLabel property of the Aero.satellitescenario.CentralBodyOptions object returned by the CentralBodyOptions property of the satellite scenario scenario.

    Data Types: double

    Since R2026b

    Font size of the label, specified as a scalar in the range [6,30].

    This input is applicable only when CentralBody equals "Moon". Otherwise, it is ignored.

    Default Value

    The default value is the currently used value of the LabelFontSize property of the Aero.satellitescenario.CentralBodyOptions object returned by the CentralBodyOptions property of the satellite scenario scenario.

    Data Types: double

    Since R2026b

    Color of the celestial body label, specified as an RGB triplet, a hexadecimal color code, a color name, or a short name.

    This input is applicable only when CentralBody equals "Moon". Otherwise, it is ignored.

    Default Value

    The default value is the currently used value of the LabelFontColor property of the Aero.satellitescenario.CentralBodyOptions object returned by the CentralBodyOptions property of the satellite scenario scenario.

    Data Types: string | double

    Since R2026b

    Satellite scenario viewer, specified as a scalar, vector, or array of satelliteScenarioViewer objects. If the AutoSimulate property of the scenario is false, or modifying an Aero.satellitescenario.CentralBodyOptions object disables the timeline and playback widgets if they were previously available after calling the play function.

    Output Arguments

    collapse all

    Currently used options for the central body, returned as a scalar Aero.satellitescenario.CentralBodyOptions object.

    Version History

    Introduced in R2025a

    See Also

    Objects

    Functions

    Topics