StelMainScriptAPI.hpp   StelMainScriptAPI.hpp 
skipping to change at line 166 skipping to change at line 166
//! Fetch a map with data about an object's position, magnitude and so on //! Fetch a map with data about an object's position, magnitude and so on
//! @param name is the English name of the object for which data wil l be //! @param name is the English name of the object for which data wil l be
//! returned. //! returned.
//! @return a map of object data. Keys: //! @return a map of object data. Keys:
//! - altitude : apparent altitude angle in decimal degrees //! - altitude : apparent altitude angle in decimal degrees
//! - azimuth : apparent azimuth angle in decimal degrees //! - azimuth : apparent azimuth angle in decimal degrees
//! - altitude-geometric : geometric altitude angle in decimal degre es //! - altitude-geometric : geometric altitude angle in decimal degre es
//! - azimuth-geometric : geometric azimuth angle in decimal degrees //! - azimuth-geometric : geometric azimuth angle in decimal degrees
//! - ra : right ascension angle (current date frame) in decimal deg rees //! - ra : right ascension angle (current date frame) in decimal deg rees
//! - dec : declination angle in (current date frame) decimal degree s //! - dec : declination angle (current date frame) in decimal degree s
//! - raJ2000 : right ascension angle (J2000 frame) in decimal degre es //! - raJ2000 : right ascension angle (J2000 frame) in decimal degre es
//! - decJ2000 : declination angle in (J2000 frame) decimal degrees //! - decJ2000 : declination angle (J2000 frame) in decimal degrees
//! - glong : galactic longitude in decimal degrees //! - glong : galactic longitude in decimal degrees
//! - glat : galactic latitude in decimal degrees //! - glat : galactic latitude in decimal degrees
//! - elong : ecliptic longitude in decimal degrees (on Earth only!) //! - elong : ecliptic longitude in decimal degrees (on Earth only!)
//! - elat : ecliptic latitude in decimal degrees (on Earth only!) //! - elat : ecliptic latitude in decimal degrees (on Earth only!)
//! - elongJ2000 : ecliptic longitude (J2000 frame) in decimal degre es (on Earth only!) //! - elongJ2000 : ecliptic longitude (J2000 frame) in decimal degre es (on Earth only!)
//! - elatJ2000 : ecliptic latitude (J2000 frame) in decimal degrees (on Earth only!) //! - elatJ2000 : ecliptic latitude (J2000 frame) in decimal degrees (on Earth only!)
//! - vmag : visual magnitude //! - vmag : visual magnitude
//! - vmage : visual magnitude (extincted) //! - vmage : visual magnitude (extincted)
//! - size: angular size in radians //! - size: angular size in radians
//! - size-dd : angular size in decimal degrees //! - size-dd : angular size in decimal degrees
skipping to change at line 267 skipping to change at line 267
double getViewDecAngle(); double getViewDecAngle();
//! Get the current viewing direction Right Ascension in J2000 frame at center of view. //! Get the current viewing direction Right Ascension in J2000 frame at center of view.
//! @return the Right Ascension angle in J2000 frame in decimal degr ees. //! @return the Right Ascension angle in J2000 frame in decimal degr ees.
double getViewRaJ2000Angle(); double getViewRaJ2000Angle();
//! Get the current viewing direction Declination angle in J2000 fra me at center of view. //! Get the current viewing direction Declination angle in J2000 fra me at center of view.
//! @return the Declination angle in J2000 frame in decimal degrees. //! @return the Declination angle in J2000 frame in decimal degrees.
double getViewDecJ2000Angle(); double getViewDecJ2000Angle();
//! move the current viewing direction to some specified altitude an //! move the current viewing direction to some specified altitude an
d azimuth d azimuth.
//! The move will run in AltAz coordinates. This will look different
from moveToRaDec() when timelapse is fast.
//! angles may be specified in a format recognised by StelUtils::get DecAngle() //! angles may be specified in a format recognised by StelUtils::get DecAngle()
//! @param alt the altitude angle //! @param alt the altitude angle
//! @param azi the azimuth angle //! @param azi the azimuth angle
//! @param duration the duration of the movement in seconds //! @param duration the duration of the movement in seconds
void moveToAltAzi(const QString& alt, const QString& azi, float dura tion=1.); void moveToAltAzi(const QString& alt, const QString& azi, float dura tion=1.);
//! move the current viewing direction to some specified right ascen //! move the current viewing direction to some specified right ascen
sion and declination sion and declination.
//! The move will run in equatorial coordinates. This will look diff
erent from moveToAltAzi() when timelapse is fast.
//! angles may be specified in a format recognised by StelUtils::get DecAngle() //! angles may be specified in a format recognised by StelUtils::get DecAngle()
//! @param ra the right ascension angle //! @param ra the right ascension angle
//! @param dec the declination angle //! @param dec the declination angle
//! @param duration the duration of the movement in seconds //! @param duration the duration of the movement in seconds
void moveToRaDec(const QString& ra, const QString& dec, float durati on=1.); void moveToRaDec(const QString& ra, const QString& dec, float durati on=1.);
//! move the current viewing direction to some specified right ascen sion and declination in the J2000 frame //! move the current viewing direction to some specified right ascen sion and declination in the J2000 frame
//! angles may be specified in a format recognised by StelUtils::get DecAngle() //! angles may be specified in a format recognised by StelUtils::get DecAngle()
//! @param ra the right ascension angle //! @param ra the right ascension angle
//! @param dec the declination angle //! @param dec the declination angle
skipping to change at line 409 skipping to change at line 411
bool getDiskViewport(); bool getDiskViewport();
//! Set the disk viewport //! Set the disk viewport
//! @param b if true, sets the disk viewport on, else sets it off //! @param b if true, sets the disk viewport on, else sets it off
void setDiskViewport(bool b); void setDiskViewport(bool b);
//! Set the viewport distortion effect //! Set the viewport distortion effect
//! @param b if true, sets the spherical mirror distortion effect fo r viewport on, else sets it off //! @param b if true, sets the spherical mirror distortion effect fo r viewport on, else sets it off
void setSphericMirror(bool b); void setSphericMirror(bool b);
//! Set viewport offset
//! This can be used e.g. in wide cylindrical panorama screens to pu
sh the horizon down and see more of the sky.
//! @param x -0.5...0.5 horizontal offset. This is not available in
the GUI, and it is recommended to keep it at 0.
//! @param y -0.5...0.5 vertical offset. This is available in the GU
I.
//! @deprecated Use StelMovementMgr::moveViewport instead
void setViewportOffset(const float x, const float y);
//! Set a lateral width distortion. Use this e.g. in startup.ssc.
//! Implemented for 0.15 for a setup with 5 beamers with edge blendi
ng. The 9600x1200 get squeezed somewhat which looks a bit odd. Use this str
etch to compensate.
//! Experimental! To avoid overuse, there is currently no config.ini
setting available.
//! @note Currently only the projected content is affected. ScreenIm
age, ScreenLabel is not stretched.
void setViewportStretch(const float stretch);
//! Get a list of Sky Culture IDs //! Get a list of Sky Culture IDs
//! @return a list of valid sky culture IDs //! @return a list of valid sky culture IDs
QStringList getAllSkyCultureIDs(); QStringList getAllSkyCultureIDs();
//! Find out the current sky culture //! Find out the current sky culture
//! @return the ID of the current sky culture (i.e. the name of the directory in //! @return the ID of the current sky culture (i.e. the name of the directory in
//! which the curret sky cultures files are found, e.g. "western") //! which the curret sky cultures files are found, e.g. "western")
QString getSkyCulture(); QString getSkyCulture();
//! Set the current sky culture //! Set the current sky culture
skipping to change at line 445 skipping to change at line 460
//! @param b if true, turn on gravity labels, else turn them off //! @param b if true, turn on gravity labels, else turn them off
void setFlagGravityLabels(bool b); void setFlagGravityLabels(bool b);
//! Load an image which will have sky coordinates. //! Load an image which will have sky coordinates.
//! @param id a string ID to be used when referring to this //! @param id a string ID to be used when referring to this
//! image (e.g. when changing the displayed status or deleting //! image (e.g. when changing the displayed status or deleting
//! it. //! it.
//! @param filename the file name of the image. If a relative //! @param filename the file name of the image. If a relative
//! path is specified, "scripts/" will be prefixed before the //! path is specified, "scripts/" will be prefixed before the
//! image is searched for using StelFileMgr. //! image is searched for using StelFileMgr.
//! @param ra0 The right ascension of the first corner of the image //! @param ra0 The right ascension of the first corner of the image
in degrees in degrees (J2000.0)
//! @param dec0 The declination of the first corner of the image in //! @param dec0 The declination of the first corner of the image in
degrees degrees (J2000.0)
//! @param ra1 The right ascension of the second corner of the image //! @param ra1 The right ascension of the second corner of the image
in degrees in degrees (J2000.0)
//! @param dec1 The declination of the second corner of the image in //! @param dec1 The declination of the second corner of the image in
degrees degrees (J2000.0)
//! @param ra2 The right ascension of the third corner of the image //! @param ra2 The right ascension of the third corner of the image
in degrees in degrees (J2000.0)
//! @param dec2 The declination of the third corner of the image in //! @param dec2 The declination of the third corner of the image in
degrees degrees (J2000.0)
//! @param ra3 The right ascension of the fourth corner of the image //! @param ra3 The right ascension of the fourth corner of the image
in degrees in degrees (J2000.0)
//! @param dec3 The declination of the fourth corner of the image in //! @param dec3 The declination of the fourth corner of the image in
degrees degrees (J2000.0)
//! @param minRes The minimum resolution setting for the image //! @param minRes The minimum resolution setting for the image
//! @param maxBright The maximum brightness setting for the image //! @param maxBright The maximum brightness setting for the image
//! @param visible The initial visibility of the image //! @param visible The initial visibility of the image
void loadSkyImage(const QString& id, const QString& filename, void loadSkyImage(const QString& id, const QString& filename,
double ra0, double dec0, double ra0, double dec0,
double ra1, double dec1, double ra1, double dec1,
double ra2, double dec2, double ra2, double dec2,
double ra3, double dec3, double ra3, double dec3,
double minRes=2.5, double maxBrigh t=14, bool visible=true); double minRes=2.5, double maxBrigh t=14, bool visible=true);
skipping to change at line 499 skipping to change at line 514
double minRes=2.5, double maxBrigh t=14, bool visible=true); double minRes=2.5, double maxBrigh t=14, bool visible=true);
//! Convenience function which allows loading of a sky image based o n a //! Convenience function which allows loading of a sky image based o n a
//! central coordinate, angular size and rotation. Parameters are t he same //! central coordinate, angular size and rotation. Parameters are t he same
//! as the version of this function which takes double values for th e //! as the version of this function which takes double values for th e
//! ra and dec, except here text expressions of angles may be used. //! ra and dec, except here text expressions of angles may be used.
void loadSkyImage(const QString& id, const QString& filename, void loadSkyImage(const QString& id, const QString& filename,
const QString& ra, const QString& dec, double angSize, double rotation, const QString& ra, const QString& dec, double angSize, double rotation,
double minRes=2.5, double maxBrigh t=14, bool visible=true); double minRes=2.5, double maxBrigh t=14, bool visible=true);
//! Load an image which will have sky coordinates. //! Load an image which will have a sky location given in alt-azimut hal coordinates.
//! @param id a string ID to be used when referring to this //! @param id a string ID to be used when referring to this
//! image (e.g. when changing the displayed status or deleting //! image (e.g. when changing the displayed status or deleting
//! it. //! it.
//! @param filename the file name of the image. If a relative //! @param filename the file name of the image. If a relative
//! path is specified, "scripts/" will be prefixed before the //! path is specified, "scripts/" will be prefixed before the
//! image is searched for using StelFileMgr. //! image is searched for using StelFileMgr.
//! @param alt0 The altitude angle of the first corner of the image in degrees //! @param alt0 The altitude angle of the first corner of the image in degrees
//! @param azi0 The azimuth angle of the first corner of the image i n degrees //! @param azi0 The azimuth angle of the first corner of the image i n degrees
//! @param alt1 The altitude angle of the second corner of the image in degrees //! @param alt1 The altitude angle of the second corner of the image in degrees
//! @param azi1 The azimuth angle of the second corner of the image in degrees //! @param azi1 The azimuth angle of the second corner of the image in degrees
//! @param alt2 The altitude angle of the third corner of the image in degrees //! @param alt2 The altitude angle of the third corner of the image in degrees
//! @param azi2 The azimuth angle of the third corner of the image i n degrees //! @param azi2 The azimuth angle of the third corner of the image i n degrees
//! @param alt3 The altitude angle of the fourth corner of the image in degrees //! @param alt3 The altitude angle of the fourth corner of the image in degrees
//! @param azi3 The azimuth angle of the fourth corner of the image in degrees //! @param azi3 The azimuth angle of the fourth corner of the image in degrees
//! @param minRes The minimum resolution setting for the image //! @param minRes The minimum resolution setting for the image
//! @param maxBright The maximum brightness setting for the image //! @param maxBright The maximum brightness setting for the image
//! @param visible The initial visibility of the image //! @param visible The initial visibility of the image
void loadSkyImageAltAz(const QString& id, const QString& filename, void loadSkyImageAltAz(const QString& id, const QString& filename,
double alt0, double azi0, double azi0, double alt0,
double alt1, double azi1, double azi1, double alt1,
double alt2, double azi2, double azi2, double alt2,
double alt3, double azi3, double azi3, double alt3,
double minRes=2.5, double maxBrigh t=14, bool visible=true); double minRes=2.5, double maxBrigh t=14, bool visible=true);
//! Convenience function which allows loading of a sky image based o n a //! Convenience function which allows loading of a sky image based o n a
//! central coordinate, angular size and rotation. //! central alt-azimuthal coordinate, angular size and rotation.
//! @param id a string ID to be used when referring to this //! @param id a string ID to be used when referring to this
//! image (e.g. when changing the displayed status or deleting it. //! image (e.g. when changing the displayed status or deleting it.
//! @param filename the file name of the image. If a relative //! @param filename the file name of the image. If a relative
//! path is specified, "scripts/" will be prefixed before the //! path is specified, "scripts/" will be prefixed before the
//! image is searched for using StelFileMgr. //! image is searched for using StelFileMgr.
//! @param alt The altitude angle of the center of the image in degr ees //! @param alt The altitude angle of the center of the image in degr ees
//! @param azi The azimuth angle of the center of the image in degre es //! @param azi The azimuth angle of the center of the image in degre es
//! @param angSize The angular size of the image in arc minutes //! @param angSize The angular size of the image in arc minutes
//! @param rotation The clockwise rotation angle of the image in deg rees //! @param rotation The clockwise rotation angle of the image in deg rees
//! @param minRes The minimum resolution setting for the image //! @param minRes The minimum resolution setting for the image
//! @param maxBright The maximum brightness setting for the image //! @param maxBright The maximum brightness setting for the image
//! @param visible The initial visibility of the image //! @param visible The initial visibility of the image
void loadSkyImageAltAz(const QString& id, const QString& filename, void loadSkyImageAltAz(const QString& id, const QString& filename,
double alt, double azi, double ang Size, double rotation, double alt, double azi, double ang Size, double rotation,
double minRes=2.5, double maxBrigh t=14, bool visible=true); double minRes=2.5, double maxBrigh t=14, bool visible=true);
//! Remove a SkyImage. //! Remove a SkyImage.
//! @param id the ID of the image to remove. //! @param id the ID of the image to remove.
void removeSkyImage(const QString& id); void removeSkyImage(const QString& id);
//! Get screen coordinates from some specified altitude and azimuth
//! angles may be specified in a format recognised by StelUtils::get
DecAngle()
//! @param alt the altitude angle [degrees]
//! @param azi the azimuth angle [degrees]
//! @return a map of object data. Keys:
//! - x : x coordinate on the screen
//! - y : y coordinate on the screen
QVariantMap getScreenXYFromAltAzi(const QString& alt, const QString&
azi);
//! Load a sound from a file. //! Load a sound from a file.
//! @param filename the name of the file to load. //! @param filename the name of the file to load.
//! @param id the identifier which will be used to refer to the soun d //! @param id the identifier which will be used to refer to the soun d
//! when calling playSound, pauseSound, stopSound and dropSound. //! when calling playSound, pauseSound, stopSound and dropSound.
void loadSound(const QString& filename, const QString& id); void loadSound(const QString& filename, const QString& id);
//! Play a sound which has previously been loaded with loadSound //! Play a sound which has previously been loaded with loadSound
//! @param id the identifier used when loadSound was called //! @param id the identifier used when loadSound was called
void playSound(const QString& id); void playSound(const QString& id);
skipping to change at line 572 skipping to change at line 596
//! sound to the start so that subsequent playSound calls will //! sound to the start so that subsequent playSound calls will
//! start from the beginning. //! start from the beginning.
//! @param id the identifier used when loadSound was called //! @param id the identifier used when loadSound was called
void stopSound(const QString& id); void stopSound(const QString& id);
//! Drop a sound from memory. You should do this before the end //! Drop a sound from memory. You should do this before the end
//! of your script. //! of your script.
//! @param id the identifier used when loadSound was called //! @param id the identifier used when loadSound was called
void dropSound(const QString& id); void dropSound(const QString& id);
//! Get position in a playing sound.
//! @param id the identifier used when loadSound was called
//! @return position [ms] during play or pause, 0 when stopped, -1 i
n case of error.
qint64 getSoundPosition(const QString& id);
//! Get duration of a sound object (if possible).
//! @param id the identifier used when loadSound was called
//! @return duration[ms] if known, 0 if unknown (e.g. during load/be
fore playing), -1 in case of error.
qint64 getSoundDuration(const QString& id);
//! Load a video from a file. //! Load a video from a file.
//! @param filename the name of the file to load. //! @param filename the name of the file to load, relative to the sc ripts directory.
//! @param id the identifier which will be used to refer to the vide o //! @param id the identifier which will be used to refer to the vide o
//! when calling playVideo, pauseVideo, stopVideo and dropVideo. //! when calling playVideo(), pauseVideo(), stopVideo(), dropVideo()
//! @param x the x-coordinate for the video widget. etc.
//! @param y the y-coordinate for the video widget. //! @param x the x-coordinate (pixels from left) for the video fram
//! @param show the visibility state for the video. e.
//! @param alpha the initial alpha value of the video. //! @param y the y-coordinate (pixels from top) for the video frame
void loadVideo(const QString& filename, const QString& id, float x, .
float y, bool show, float alpha); //! @param show the visibility state for the video. (Optional since
V0.15)
//! You should load a video with show=true (or leave default), to st
art it immediately in native size.
//! Else set show=false, and then call resizeVideo(), playVideo() or
use playVideoPopout().
//! @param alpha the initial alpha value of the video, defaults to 1
.
//! @bug With Qt5/V0.15+, alpha does not work properly (no semitrans
parency), only alpha=0 makes it invisible.
//! @bug With Qt5/V0.15+, show=false causes an assert failure (crash
) on Windows. The responsible assert is not fired on release builds.
void loadVideo(const QString& filename, const QString& id, float x,
float y, bool show=true, float alpha=1.0f);
//! Play a video which has previously been loaded with loadVideo //! Play a video which has previously been loaded with loadVideo
//! @param id the identifier used when loadVideo was called //! @param id the identifier used when loadVideo was called
void playVideo(const QString& id); void playVideo(const QString& id, bool keepVisibleAtEnd=false);
//! Pause a video which is playing. Subsequent playVideo calls will //! Play a video which has previously been loaded with loadVideo wit
//! resume playing from the position in the file when it was paused. h a complex effect.
//! The video appears out of fromX/fromY,
//! grows within popupDuration to size finalSizeX/finalSizeY, and
//! shrinks back towards fromX/fromY at the end during popdownDurati
on.
//! @param id the identifier used when loadVideo was called //! @param id the identifier used when loadVideo was called
//! @param fromX X position of starting point, counted from left of
window. May be absolute (if >1) or relative (0<X<1)
//! @param fromY Y position of starting point, counted from top of w
indow. May be absolute (if >1) or relative (0<Y<1)
//! @param atCenterX X position of center of final video frame, coun
ted from left of window. May be absolute (if >1) or relative (0<X<1)
//! @param atCenterY Y position of center of final video frame, coun
ted from top of window. May be absolute (if >1) or relative (0<Y<1)
//! @param finalSizeX X size of final video frame. May be absolute (
if >1) or relative to window size (0<X<1). If -1, scale proportional from f
inalSizeY.
//! @param finalSizeY Y size of final video frame. May be absolute (
if >1) or relative to window size (0<Y<1). If -1, scale proportional from f
inalSizeX.
//! @param popupDuration duration of growing start transition (secon
ds)
//! @param frozenInTransition true if video should be paused during
growing/shrinking transition.
void playVideoPopout(const QString& id, float fromX, float fromY, fl
oat atCenterX, float atCenterY, float finalSizeX, float finalSizeY, float p
opupDuration, bool frozenInTransition);
//! Pause a video which is playing. Subsequent playVideo() calls wi
ll
//! resume playing from the position in the file when it was paused.
//! @param id the identifier used when loadVideo() was called
void pauseVideo(const QString& id); void pauseVideo(const QString& id);
//! Stop a video from playing. This resets the position in the //! Stop a video from playing. This resets the position in the
//! video to the start so that subsequent playVideo calls will //! video to the start so that subsequent playVideo() calls will
//! start from the beginning. //! start from the beginning.
//! @param id the identifier used when loadVideo was called //! @param id the identifier used when loadVideo() was called
void stopVideo(const QString& id); void stopVideo(const QString& id);
//! Drop a video from memory. You should do this before the end //! Drop a video from memory. You should do this before the end
//! of your script. //! of your script.
//! @param id the identifier used when loadVideo was called //! @param id the identifier used when loadVideo() was called
void dropVideo(const QString& id); void dropVideo(const QString& id);
//! Seeks a video to the requested time. //! Seeks a video to the requested time and either start playing or
//! @param id the identifier used when loadVideo was called freeze there.
//! @param id the identifier used when loadVideo() was called
//! @param ms the time in milliseconds from the start of the media. //! @param ms the time in milliseconds from the start of the media.
void seekVideo(const QString& id, qint64 ms); //! @param pause true if you want to pause at the requested position
, keep it false to play from here.
void seekVideo(const QString& id, qint64 ms, bool pause=false);
//! Sets the position of the video widget. //! Sets the position of the video widget.
//! @param id the identifier used when loadVideo was called //! @param id the identifier used when loadVideo() was called
//! @param x the new x-coordinate for the video. //! @param x the new x-coordinate for the video. (if <1, relative to
//! @param y the new y-coordinate for the video. main view size)
void setVideoXY(const QString& id, float x, float y); //! @param y the new y-coordinate for the video. (if <1, relative to
main view size)
//! @param relative true if you want to move in relative coordinates
, not set absolutely
void setVideoXY(const QString& id, float x, float y, bool relative=f
alse);
//! Set the alpha value of a video when visible. //! Set the alpha value of a video when visible.
//! @param id the identifier used when loadVideo was called //! @param id the identifier used when loadVideo() was called
//! @param alpha the new alpha value to set. //! @param alpha the new alpha value to set.
void setVideoAlpha(const QString& id, float alpha); //! @bug With Qt5/V0.13+, @param alpha does not work properly, only
@param alpha=0 makes it invisible.
void setVideoAlpha(const QString& id, float alpha);
//! Resize the video widget to the specified width, height. //! Resize the video widget to the specified width, height.
//! @param id the identifier used when loadVideo was called //! @param id the identifier used when loadVideo() was called
//! @param w the new width for the widget. //! @param w the new width for the widget. (if <1, relative to main
//! @param h the new height for the widget. view size)
//! @param h the new height for the widget. (if <1, relative to main
view size)
void resizeVideo(const QString& id, float w, float h); void resizeVideo(const QString& id, float w, float h);
//! Set the visibility state of a video. //! Set the visibility state of a video.
//! @param id the identifier used when loadVideo was called //! @param id the identifier used when loadVideo() was called
//! @param show the new visible state of the video. //! @param show the new visible state of the video.
void showVideo(const QString& id, bool show); //! @note You must call this if you called loadVideo() with its @par
am show=false, else video will be played hidden.
void showVideo(const QString& id, bool show=true);
//! Get the duration of a loaded video, or -1
//! @param id the identifier used when loadVideo() was called
qint64 getVideoDuration(const QString& id);
//! Get the current position of a loaded video, or -1
//! @param id the identifier used when loadVideo() was called
qint64 getVideoPosition(const QString& id);
//! Get the screen width in pixels. //! Get the screen width in pixels.
//! @return The screen width in pixels //! @return The screen width (actually, width of Stellarium main vie w) in pixels
int getScreenWidth(); int getScreenWidth();
//! Get the screen height in pixels. //! Get the screen height (actually, height of Stellarium main view) in pixels.
//! @return The screen height in pixels //! @return The screen height in pixels
int getScreenHeight(); int getScreenHeight();
//! Get the script execution rate as a multiple of normal execution speed //! Get the script execution rate as a multiple of normal execution speed
//! @return the current script execution rate. //! @return the current script execution rate.
double getScriptRate(); double getScriptRate();
//! Set the script execution rate as a multiple of normal execution speed //! Set the script execution rate as a multiple of normal execution speed
//! @param r the multiple of the normal script execution speed, i.e. //! @param r the multiple of the normal script execution speed, i.e.
//! if 5 is passed the script will execute 5 times faster than it wo uld //! if 5 is passed the script will execute 5 times faster than it wo uld
//! if the script rate was 1. //! if the script rate was 1.
void setScriptRate(double r); void setScriptRate(double r);
//! Pause the currently running script. Note that you may need to us e //! Pause the currently running script. Note that you may need to us e
//! the key '6' or the GUI to resume script execution. //! a key sequence like 'Ctrl-D,R' or the GUI to resume script execu tion.
void pauseScript(); void pauseScript();
//! Set the amount of selected object information to display //! Set the amount of selected object information to display
//! @param level can be "AllInfo", "ShortInfo", "None" //! @param level can be "AllInfo", "ShortInfo", "None"
void setSelectedObjectInfo(const QString& level); void setSelectedObjectInfo(const QString& level);
//! Stop the script //! Stop the script
void exit(); void exit();
//! Close Stellarium //! Close Stellarium
skipping to change at line 670 skipping to change at line 735
//! @param s the message to be displayed on the console. //! @param s the message to be displayed on the console.
void debug(const QString& s); void debug(const QString& s);
//! print an output message from script //! print an output message from script
//! @param s the message to be displayed on the output file. //! @param s the message to be displayed on the output file.
void output(const QString& s); void output(const QString& s);
//! Reset (clear) output file //! Reset (clear) output file
void resetOutput(void); void resetOutput(void);
//! Save output file to new file (in same directory as output.txt).
//! This is required to allow reading with other program on Windows
while output.txt is still open.
void saveOutputAs(const QString &filename);
//! Get the current application language. //! Get the current application language.
//! @return two letter language code, e.g. "en", or "de" and so on. //! @return two letter language code, e.g. "en", or "de" and so on.
QString getAppLanguage(); QString getAppLanguage();
//! Set the current application language. //! Set the current application language.
//! @param langCode two letter language code, e.g. "en", or "de". //! @param langCode two letter language code, e.g. "en", or "de".
void setAppLanguage(QString langCode); void setAppLanguage(QString langCode);
//! Get the current sky language. //! Get the current sky language.
//! @return two letter language code, e.g. "en", or "de" and so on. //! @return two letter language code, e.g. "en", or "de" and so on.
skipping to change at line 713 skipping to change at line 782
void setZodiacalLightVisible(bool b); void setZodiacalLightVisible(bool b);
//! Set Zodiacal Light intensity. //! Set Zodiacal Light intensity.
//! @param i value of intensity for the Zodiacal Light //! @param i value of intensity for the Zodiacal Light
void setZodiacalLightIntensity(double i); void setZodiacalLightIntensity(double i);
//! Get Zodiacal Light intensity. //! Get Zodiacal Light intensity.
//! @return value of Zodiacal Light intensity, e.g. "1.2" //! @return value of Zodiacal Light intensity, e.g. "1.2"
double getZodiacalLightIntensity(); double getZodiacalLightIntensity();
//! Returns the currently set Bortle scale index, which is used to s
imulate light pollution.
//! Wrapper for StelSkyDrawer::getBortleScaleIndex
//! @see https://en.wikipedia.org/wiki/Bortle_scale
//! @return the Bortle scale index in range [1,9]
int getBortleScaleIndex() const;
//! Changes the Bortle scale index, which is used to simulate light
pollution.
//! Wrapper for StelSkyDrawer::setBortleScaleIndex
//! Valid values are in the range [1,9]
//! @see https://en.wikipedia.org/wiki/Bortle_scale
//! @param index the new Bortle scale index, must be in range [1,9]
void setBortleScaleIndex(int index);
//! For use in setDate and waitFor //! For use in setDate and waitFor
//! For parameter descriptions see setDate(). //! For parameter descriptions see setDate().
//! @returns Julian day. //! @returns Julian day.
double jdFromDateString(const QString& dt, const QString& spec); double jdFromDateString(const QString& dt, const QString& spec);
// Methods wait() and waitFor() was added for documentation. // Methods wait() and waitFor() was added for documentation.
// Details: https://bugs.launchpad.net/stellarium/+bug/1402200 // Details: https://bugs.launchpad.net/stellarium/+bug/1402200
//! Pauses the script for \e t seconds //! Pauses the script for \e t seconds
//! @param t the number of seconds to wait //! @param t the number of seconds to wait
skipping to change at line 759 skipping to change at line 841
double minRes, doub le maxBright, bool visible); double minRes, doub le maxBright, bool visible);
void requestRemoveSkyImage(const QString& id); void requestRemoveSkyImage(const QString& id);
void requestLoadSound(const QString& filename, const QString& id); void requestLoadSound(const QString& filename, const QString& id);
void requestPlaySound(const QString& id); void requestPlaySound(const QString& id);
void requestPauseSound(const QString& id); void requestPauseSound(const QString& id);
void requestStopSound(const QString& id); void requestStopSound(const QString& id);
void requestDropSound(const QString& id); void requestDropSound(const QString& id);
void requestLoadVideo(const QString& filename, const QString& id, fl oat x, float y, bool show, float alpha); void requestLoadVideo(const QString& filename, const QString& id, fl oat x, float y, bool show, float alpha);
void requestPlayVideo(const QString& id); void requestPlayVideo(const QString& id, const bool keepVisibleAtEnd
);
void requestPlayVideoPopout(const QString& id, float fromX, float fr
omY, float atCenterX, float atCenterY, float finalSizeX, float finalSizeY,
float popupDuration, bool frozenInTransition);
void requestPauseVideo(const QString& id); void requestPauseVideo(const QString& id);
void requestStopVideo(const QString& id); void requestStopVideo(const QString& id);
void requestDropVideo(const QString& id); void requestDropVideo(const QString& id);
void requestSeekVideo(const QString& id, qint64 ms); void requestSeekVideo(const QString& id, qint64 ms, bool pause=false
void requestSetVideoXY(const QString& id, float x, float y); );
void requestSetVideoXY(const QString& id, float x, float y, bool rel
ative=false);
void requestSetVideoAlpha(const QString& id, float alpha); void requestSetVideoAlpha(const QString& id, float alpha);
void requestResizeVideo(const QString& id, float w, float h); void requestResizeVideo(const QString& id, float w, float h);
void requestShowVideo(const QString& id, bool show); void requestShowVideo(const QString& id, bool show);
void requestSetNightMode(bool b); void requestSetNightMode(bool b);
void requestSetProjectionMode(QString id); void requestSetProjectionMode(QString id);
void requestSetSkyCulture(QString id); void requestSetSkyCulture(QString id);
void requestSetDiskViewport(bool b); void requestSetDiskViewport(bool b);
void requestExit(); void requestExit();
void requestSetHomePosition(); void requestSetHomePosition();
 End of changes. 34 change blocks. 
62 lines changed or deleted 200 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/