StelMainScriptAPI.hpp   StelMainScriptAPI.hpp 
skipping to change at line 83 skipping to change at line 83
//! each unit is dependent on the current planet. By contrast //! each unit is dependent on the current planet. By contrast
//! when sidereal timeis not specified (i.e. solar time is used) //! when sidereal timeis not specified (i.e. solar time is used)
//! the value is conventional - i.e. 1 day means 1 Earth Solar day. //! the value is conventional - i.e. 1 day means 1 Earth Solar day.
//! @param spec "local" or "utc" - only has an effect when //! @param spec "local" or "utc" - only has an effect when
//! the ISO date type is used. Defaults to "utc". //! the ISO date type is used. Defaults to "utc".
//! @param enableDeltaT is \a true or \a false - enable Delta-T corr ection or not. //! @param enableDeltaT is \a true or \a false - enable Delta-T corr ection or not.
//! Defaults to "true". //! Defaults to "true".
//! @note for fully compatibles behavior of this function with the v ersion 0.11.4 //! @note for fully compatibles behavior of this function with the v ersion 0.11.4
//! or earlier, you should call \b core.setDeltaTAlgorithm("WithoutC orrection"); //! or earlier, you should call \b core.setDeltaTAlgorithm("WithoutC orrection");
//! before running \b core.setDate(); for disabling DeltaT correctio n. //! before running \b core.setDate(); for disabling DeltaT correctio n.
//! @note starting with version 0.13.2 all relative dates are set wi thout DeltaT correction.
void setDate(const QString& dt, const QString& spec="utc", const boo l& enableDeltaT=true); void setDate(const QString& dt, const QString& spec="utc", const boo l& enableDeltaT=true);
//! get the simulation date and time as a string in ISO format, //! get the simulation date and time as a string in ISO format,
//! e.g. "2008-03-24T13:21:01" //! e.g. "2008-03-24T13:21:01"
//! @param spec if "utc", the returned string's timezone is UTC, //! @param spec if "utc", the returned string's timezone is UTC,
//! else it is local time. //! else it is local time.
//! @return the current simulation time. //! @return the current simulation time.
QString getDate(const QString& spec="utc"); QString getDate(const QString& spec="utc");
//! get the DeltaT for the simulation date and time as a string //! get the DeltaT for the simulation date and time as a string
skipping to change at line 167 skipping to change at line 168
//! - 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 in (current date frame) 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 in (J2000 frame) decimal degrees
//! - glongJ2000 : galactic longitude (J2000 frame) in decimal degre es //! - glongJ2000 : galactic longitude (J2000 frame) in decimal degre es
//! - glatJ2000 : galactic latitude in (J2000 frame) decimal degrees //! - glatJ2000 : galactic latitude in (J2000 frame) decimal degrees
//! - vmag : visual magnitude //! - vmag : visual magnitude
//! - vmage : visual magnitude (extincted) //! - vmage : visual magnitude (extincted)
//! - size : angular size in decimal degrees //! - size: angular size in radians
//! - size-dd : angular size in decimal degrees
//! - size-deg : angular size in decimal degrees (formatted string)
//! - size-dms : angular size in DMS format
//! - localized-name : localized name //! - localized-name : localized name
//! - distance : distance to object in AU (for Solar system objects
only!)
//! - phase : phase of object (for Solar system objects only!)
//! - illumination : phase of object in percentages (for Solar syste
m objects only!)
//! - phase-angle : phase angle of object in radians (for Solar syst
em objects only!)
//! - phase-angle-dms : phase angle of object in DMS (for Solar syst
em objects only!)
//! - phase-angle-deg : phase angle of object in decimal degrees (fo
r Solar system objects only!)
//! - elongation : elongation of object in radians (for Solar system
objects only!)
//! - elongation-dms : elongation of object in DMS (for Solar system
objects only!)
//! - elongation-deg : elongation of object in decimal degrees (for
Solar system objects only!)
QVariantMap getObjectInfo(const QString& name); QVariantMap getObjectInfo(const QString& name);
//! Fetch a map with data about an latest selected object's position , magnitude and so on //! Fetch a map with data about an latest selected object's position , magnitude and so on
//! @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 in (current date frame) 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 in (J2000 frame) decimal degrees
//! - glongJ2000 : galactic longitude (J2000 frame) in decimal degre es //! - glongJ2000 : galactic longitude (J2000 frame) in decimal degre es
//! - glatJ2000 : galactic latitude in (J2000 frame) decimal degrees //! - glatJ2000 : galactic latitude in (J2000 frame) decimal degrees
//! - vmag : visual magnitude //! - vmag : visual magnitude
//! - vmage : visual magnitude (extincted) //! - vmage : visual magnitude (extincted)
//! - size : angular size in decimal degrees //! - size: angular size in radians
//! - size-dd : angular size in decimal degrees
//! - size-deg : angular size in decimal degrees (formatted string)
//! - size-dms : angular size in DMS format
//! - name : english name //! - name : english name
//! - localized-name : localized name //! - localized-name : localized name
//! - distance : distance to object in AU (for Solar system objects
only!)
//! - phase : phase of object (for Solar system objects only!)
//! - illumination : phase of object in percentages (for Solar syste
m objects only!)
//! - phase-angle : phase angle of object in radians (for Solar syst
em objects only!)
//! - phase-angle-dms : phase angle of object in DMS (for Solar syst
em objects only!)
//! - phase-angle-deg : phase angle of object in decimal degrees (fo
r Solar system objects only!)
//! - elongation : elongation of object in radians (for Solar system
objects only!)
//! - elongation-dms : elongation of object in DMS (for Solar system
objects only!)
//! - elongation-deg : elongation of object in decimal degrees (for
Solar system objects only!)
QVariantMap getSelectedObjectInfo(); QVariantMap getSelectedObjectInfo();
//! Clear the display options, setting a "standard" view. //! Clear the display options, setting a "standard" view.
//! Preset states: //! Preset states:
//! - natural : azimuthal mount, atmosphere, landscape, //! - natural : azimuthal mount, atmosphere, landscape,
//! no lines, labels or markers //! no lines, labels or markers
//! - starchart : equatorial mount, constellation lines, //! - starchart : equatorial mount, constellation lines,
//! no landscape, atmoshere etc. labels & markers on. //! no landscape, atmoshere etc. labels & markers on.
//! @param state the name of a preset state. //! @param state the name of a preset state.
void clear(const QString& state="natural"); void clear(const QString& state="natural");
skipping to change at line 651 skipping to change at line 676
void setMilkyWayVisible(bool b); void setMilkyWayVisible(bool b);
//! Set Milky Way intensity. //! Set Milky Way intensity.
//! @param i value of intensity for the Milky Way //! @param i value of intensity for the Milky Way
void setMilkyWayIntensity(double i); void setMilkyWayIntensity(double i);
//! Get Milky Way intensity. //! Get Milky Way intensity.
//! @return value of Milky Way intensity, e.g. "1.2" //! @return value of Milky Way intensity, e.g. "1.2"
double getMilkyWayIntensity(); double getMilkyWayIntensity();
//! Show or hide the Zodiacal Light.
//! @param b if true, show the Zodiacal Light, if false, hide the Zo
diacal Light.
void setZodiacalLightVisible(bool b);
//! Set Zodiacal Light intensity.
//! @param i value of intensity for the Zodiacal Light
void setZodiacalLightIntensity(double i);
//! Get Zodiacal Light intensity.
//! @return value of Zodiacal Light intensity, e.g. "1.2"
double getZodiacalLightIntensity();
//! 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.
// Details: https://bugs.launchpad.net/stellarium/+bug/1402200
//! Pauses the script for \e t milliseconds
//! @param t the number of milliseconds to wait
//! @note This method is pure JavaScript implementation.
void wait(double t) { Q_UNUSED(t) }
//! Waits until a specified simulation date/time. This function
//! will take into account the rate (and direction) in which simulat
ion
//! time is passing. e.g. if a future date is specified and the
//! time is moving backwards, the function will return immediately.
//! If the time rate is 0, the function will not wait. This is to
//! prevent infinite wait time.
//! @param dt the date string to use
//! @param spec "local" or "utc"
//! @note This method is pure JavaScript implementation.
void waitFor(const QString& dt, const QString& spec="utc") { Q_UNUSE
D(dt); Q_UNUSED(spec) }
signals: signals:
void requestLoadSkyImage(const QString& id, const QString& filename, void requestLoadSkyImage(const QString& id, const QString& filename,
double c1, double c 2, double c1, double c 2,
double c3, double c 4, double c3, double c 4,
double c5, double c 6, double c5, double c 6,
double c7, double c 8, double c7, double c 8,
double minRes, doub le maxBright, bool visible); double minRes, doub le maxBright, bool visible);
void requestLoadSkyImageAltAz(const QString& id, const QString& file name, void requestLoadSkyImageAltAz(const QString& id, const QString& file name,
double c1, double c 2, double c1, double c 2,
double c3, double c 4, double c3, double c 4,
 End of changes. 7 change blocks. 
2 lines changed or deleted 77 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/