Skip to content

Commit 6dc106b

Browse files
committed
Updated README
1 parent 5660b5e commit 6dc106b

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed
-1 Bytes
Binary file not shown.

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Creates high-resolution renderings of the Earth and the major celestial bodies i
55
## Syntax
66

77
`planet3D(planet)`\
8-
`planet3D(planet,opts)`
8+
`planet3D(planet,opts)`\
9+
`planet_surface = planet3D(__)`
910

1011
**NOTE:** Use the `background` function (see below) to set the plot background. When using `background` to set the plot background, the function call on `background` must occur *before* the function call on `planet3D`, otherwise the background will be plotted *over* the celestial body.
1112

@@ -25,6 +26,8 @@ Creates high-resolution renderings of the Earth and the major celestial bodies i
2526
- `RotAngle` → specifies the rotation angle about the 3rd axis of the celestial body (in degrees)
2627
- `Units` → specifies the units the celestial body should be drawn in. Units available are `'AU'`, `'ft'`, `'km'`, `'m'`, `'mi'`, and `'nmi'`.
2728

29+
`planet_surface = planet3D(__)` does the same as the previous two syntaxes, but also returns the `Surface` object defining the planet.
30+
2831
**NOTE:** All fields of `opts` do NOT have to be defined; when a field is left undefined, the rest of the plot settings are set to default values. Additionally, `Color`, `LineWidth`, and `LineStyle` are only relevant when plotting the Earth's coastlines.
2932

3033

0 commit comments

Comments
 (0)