Skip to content

Commit d38ac22

Browse files
tamaskistamaskis
committed
Updated examples, file structure, options parameter, and added toolbox installation option
1 parent 2329ae7 commit d38ac22

4 files changed

Lines changed: 175 additions & 6 deletions

File tree

‎INSTALL/3D Earth and Celestial Bodies (planet3D).mltbx‎

86.9 MB
Binary file not shown.

‎INSTALL/3D Earth and Celestial Bodies (planet3D).prj‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
<deployment-project plugin="plugin.toolbox" plugin-version="1.0">
2+
<configuration file="/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/INSTALL/3D Earth and Celestial Bodies (planet3D).prj" location="/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/INSTALL" name="3D Earth and Celestial Bodies (planet3D)" target="target.toolbox" target-name="Package Toolbox">
3+
<param.appname>3D Earth and Celestial Bodies (planet3D)</param.appname>
4+
<param.authnamewatermark>Tamas Kis</param.authnamewatermark>
5+
<param.email>tamas.a.kis@outlook.com</param.email>
6+
<param.company />
7+
<param.summary>Creates high-resolution renderings of the Earth and the major celestial bodies in our solar system for astrodynamics applications.</param.summary>
8+
<param.description>Function Documentation:
9+
https://www.mathworks.com/matlabcentral/fileexchange/86483-3d-earth-and-celestial-bodies-planet3d
10+
https://github.com/tamaskis/planet3D-MATLAB
11+
12+
Technical Documentation:
13+
https://tamaskis.github.io/documentation/Visualizing_Celestial_Bodies_in_3D.pdf</param.description>
14+
<param.screenshot>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/local/MATLAB Central File Exchange Picture.jpg</param.screenshot>
15+
<param.version>5.0.0</param.version>
16+
<param.output>${PROJECT_ROOT}/3D Earth and Celestial Bodies (planet3D).mltbx</param.output>
17+
<param.products.name />
18+
<param.products.id />
19+
<param.products.version />
20+
<param.platforms />
21+
<param.guid>3215e027-02c3-4673-9adc-dcbbaa3cee5e</param.guid>
22+
<param.exclude.filters />
23+
<param.exclude.pcodedmfiles>true</param.exclude.pcodedmfiles>
24+
<param.examples />
25+
<param.demosxml />
26+
<param.apps />
27+
<param.registered.apps />
28+
<param.docs />
29+
<param.getting.started.guide />
30+
<param.matlabpath.excludes />
31+
<param.javaclasspath.excludes />
32+
<param.exported.on.package>false</param.exported.on.package>
33+
<param.required.addons />
34+
<param.matlab.project.id />
35+
<param.matlab.project.name />
36+
<param.release.start />
37+
<param.release.end />
38+
<param.release.current.only>false</param.release.current.only>
39+
<param.compatiblity.windows>true</param.compatiblity.windows>
40+
<param.compatiblity.macos>true</param.compatiblity.macos>
41+
<param.compatiblity.linux>true</param.compatiblity.linux>
42+
<param.compatiblity.matlabonline>true</param.compatiblity.matlabonline>
43+
<param.installation.map />
44+
<param.additional.sw.names />
45+
<param.additional.sw.licenses />
46+
<param.additional.sw.win.url />
47+
<param.additional.sw.mac.url />
48+
<param.additional.sw.linux.url />
49+
<unset>
50+
<param.authnamewatermark />
51+
<param.email />
52+
<param.company />
53+
<param.output />
54+
<param.products.name />
55+
<param.products.id />
56+
<param.products.version />
57+
<param.platforms />
58+
<param.exclude.filters />
59+
<param.exclude.pcodedmfiles />
60+
<param.examples />
61+
<param.demosxml />
62+
<param.apps />
63+
<param.registered.apps />
64+
<param.docs />
65+
<param.getting.started.guide />
66+
<param.matlabpath.excludes />
67+
<param.javaclasspath.excludes />
68+
<param.exported.on.package />
69+
<param.required.addons />
70+
<param.matlab.project.id />
71+
<param.matlab.project.name />
72+
<param.release.start />
73+
<param.release.end />
74+
<param.release.current.only />
75+
<param.compatiblity.windows />
76+
<param.compatiblity.macos />
77+
<param.compatiblity.linux />
78+
<param.compatiblity.matlabonline />
79+
<param.installation.map />
80+
<param.additional.sw.names />
81+
<param.additional.sw.licenses />
82+
<param.additional.sw.win.url />
83+
<param.additional.sw.mac.url />
84+
<param.additional.sw.linux.url />
85+
</unset>
86+
<fileset.rootdir>
87+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D</file>
88+
</fileset.rootdir>
89+
<fileset.rootfiles>
90+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/background.m</file>
91+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/clouds.png</file>
92+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/coastlines_data.mat</file>
93+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/earth.png</file>
94+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/earthnight.png</file>
95+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/jupiter.png</file>
96+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/mars.png</file>
97+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/mercury.png</file>
98+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/milkyway.png</file>
99+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/moon.png</file>
100+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/neptune.png</file>
101+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/planet3D.m</file>
102+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/pluto.png</file>
103+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/saturn.png</file>
104+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/saturnrings.png</file>
105+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/stars.png</file>
106+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/sun.png</file>
107+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/uranus.png</file>
108+
<file>/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/planet3D/venus.png</file>
109+
</fileset.rootfiles>
110+
<fileset.depfun.included />
111+
<fileset.depfun.excluded />
112+
<fileset.package />
113+
<build-deliverables>
114+
<file location="${PROJECT_ROOT}" name="3D Earth and Celestial Bodies (planet3D).mltbx" optional="false">/Users/tamaskis/Documents/Code/MATLAB/functions/planet3D-MATLAB/INSTALL/3D Earth and Celestial Bodies (planet3D).mltbx</file>
115+
</build-deliverables>
116+
<workflow />
117+
<matlab>
118+
<root>/Applications/MATLAB_R2021b.app</root>
119+
<toolboxes />
120+
</matlab>
121+
<platform>
122+
<unix>true</unix>
123+
<mac>true</mac>
124+
<windows>false</windows>
125+
<win2k>false</win2k>
126+
<winxp>false</winxp>
127+
<vista>false</vista>
128+
<linux>false</linux>
129+
<solaris>false</solaris>
130+
<osver>12.0.1</osver>
131+
<os32>false</os32>
132+
<os64>true</os64>
133+
<arch>maci64</arch>
134+
<matlab>true</matlab>
135+
</platform>
136+
</configuration>
137+
</deployment-project>

‎README.md‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# `planet3D` [![View 3D Planets and Celestial Bodies (planet3D) on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/86483-3d-planets-and-celestial-bodies-planet3d)
2-
Creates high-resolution renderings of the Earth and the major celestial bodies in our solar system for space mechanics applications.
2+
Creates high-resolution renderings of the Earth and the major celestial bodies in our solar system for astrodynamics applications.
33

44

55
## Syntax
@@ -28,8 +28,14 @@ Creates high-resolution renderings of the Earth and the major celestial bodies i
2828
**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.
2929

3030

31+
32+
3133
<br/><br/>
3234
<br/><br/>
35+
36+
37+
38+
3339
# `background`
3440
Sets the plot background for drawing celestial bodies in 3D.
3541

@@ -46,9 +52,29 @@ Sets the plot background for drawing celestial bodies in 3D.
4652
`background(spec)` sets the plot background for drawing celestial bodies in 3D. `spec` refers to the specified background, and can be set to `'Black'`, `'Stars'`, or `'Milky Way'`.
4753

4854

55+
56+
4957
<br/><br/>
5058
<br/><br/>
59+
60+
61+
62+
5163
# Examples and Additional Documentation
5264

5365
- See "EXAMPLES.mlx" or the "Examples" tab on the File Exchange page for examples.
5466
- See [Visualizing Celestial Bodies in 3D.pdf](https://tamaskis.github.io/documentation/Visualizing_Celestial_Bodies_in_3D.pdf) (also included with download) for additional documentation.
67+
68+
69+
70+
71+
<br/><br/>
72+
<br/><br/>
73+
74+
75+
76+
77+
# Installation
78+
79+
- Open "3D Earth and Celestial Bodies (planet3D).mltbx" in the "INSTALL" folder to install as a toolbox. MATLAB will automatically perform the installation and add all the functions, images, and data to the MATLAB search path.
80+
- Alternatively, the "planet3D" folder can be copied to the directory of a script that you want to use the functions in. At the beginning of the script, include "`addpath('planet3D')`" to add all functions, images, and data to the MATLAB search path.

‎planet3D/planet3D.m‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
%
66
% planet3D(planet)
77
% planet3D(planet,opts)
8+
% planet_surface = planet3D(__)
89
%
910
% See also background, ground_track.
1011
%
@@ -36,11 +37,11 @@
3637
% ------
3738
% INPUT:
3839
% ------
39-
% planet - (char) 'Sun', 'Moon', 'Mercury', 'Venus', 'Earth',
40-
% 'Earth Cloudy', 'Earth Coastlines', 'Earth Night',
41-
% 'Earth Night Cloudy', 'Mars', 'Jupiter', 'Saturn', 'Uranus',
42-
% 'Neptune', or 'Pluto'
43-
% opts - (OPTIONAL) (struct) plot options
40+
% planet - (char) 'Sun', 'Moon', 'Mercury', 'Venus', 'Earth',
41+
% 'Earth Cloudy', 'Earth Coastlines', 'Earth Night',
42+
% 'Earth Night Cloudy', 'Mars', 'Jupiter', 'Saturn',
43+
% 'Uranus', 'Neptune', or 'Pluto'
44+
% opts - (OPTIONAL) (1×1 struct) plot options
4445
% • Clipping - (char) 'on' or 'off' (defaults to 'off')
4546
% --> if 'on', the surface will be "clipped" to fit
4647
% the axes when zooming in
@@ -59,6 +60,11 @@
5960
% • RotAngle - (1×1 double) rotation angle [deg]
6061
% • Units - (char) 'AU', 'ft', 'km', 'm', 'mi', or 'nmi'
6162
%
63+
% -------
64+
% OUTPUT:
65+
% -------
66+
% planet_surface - (1×1 Surface) surface object defining planet
67+
%
6268
% -----
6369
% NOTE:
6470
% -----

0 commit comments

Comments
 (0)