StelMainScriptAPI.hpp   StelMainScriptAPI.hpp 
skipping to change at line 70 skipping to change at line 70
//! set the date in ISO format, e.g. "2008-03-24T13:21:01" //! set the date in ISO format, e.g. "2008-03-24T13:21:01"
//! @param dt the date string to use. Formats: //! @param dt the date string to use. Formats:
//! - ISO, e.g. "2008-03-24T13:21:01" //! - ISO, e.g. "2008-03-24T13:21:01"
//! - "now" (set sim time to real time) //! - "now" (set sim time to real time)
//! - relative, e.g. "+ 4 days", "-2 weeks". can use these //! - relative, e.g. "+ 4 days", "-2 weeks". can use these
//! units: seconds, minutes, hours, days, weeks, months, years. //! units: seconds, minutes, hours, days, weeks, months, years.
//! You may also append " sidereal" to use sidereal days and so on . //! You may also append " sidereal" to use sidereal days and so on .
//! You can also use "now" at the start. For example: //! You can also use "now" at the start. For example:
//! "now + 3 hours sidereal" //! "now + 3 hours sidereal"
//! Note: you must use the plural all the time, even when the numb //! @note you must use the plural all the time, even when the number
er //! of the unit is 1. i.e. use "+ 1 days" not "+1 day".
//! of the unit is 1. i.e. use "+ 1 days" not "+1 day". //! @note when sidereal time is used, the length of time for
//! Note: when sidereal time is used, the length of time for
//! 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. //! the ISO date type is used. Defaults to "utc".
//! @param enableDeltaT true or false - enable Delta-T correction or //! @param enableDeltaT is \a true or \a false - enable Delta-T corr
not ection or not.
void setDate(const QString& dt, const QString& spec="utc", const boo //! Defaults to "true".
l& enableDeltaT=false); //! @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");
//! before running \b core.setDate(); for disabling DeltaT correctio
n.
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
//! in HMS format, e.g. "0h1m68.2s" //! in HMS format, e.g. "0h1m68.2s"
//! @return the DeltaT for current simulation time. //! @return the DeltaT for current simulation time.
QString getDeltaT() const; QString getDeltaT() const;
//! get the DeltaT equation name for the simulation date and time as
a string
//! @return name of the DeltaT equation
QString getDeltaTAlgorithm() const;
//! set equation of the DeltaT for the simulation date and time
//! @param algorithmName is name of equation, e.g. "WithoutCorrectio
n" or "EspenakMeeus"
//! @note list of possible names of equation for DeltaT: WithoutCorr
ection, Schoch, Clemence, IAU,
//! AstronomicalEphemeris, TuckermanGoldstine, MullerStephenson, Ste
phenson1978, SchmadelZech1979,
//! MorrisonStephenson1982, StephensonMorrison1984, StephensonHoulde
n, Espenak, Borkowski,
//! SchmadelZech1988, ChaprontTouze, StephensonMorrison1995, Stephen
son1997, ChaprontMeeus,
//! JPLHorizons, MeeusSimons, MontenbruckPfleger, ReingoldDershowitz
, MorrisonStephenson2004,
//! EspenakMeeus, Reijs, Banjevic, IslamSadiqQureshi, Custom.
void setDeltaTAlgorithm(QString algorithmName);
//! Set time speed in JDay/sec //! Set time speed in JDay/sec
//! @param ts the new rate of passage of time as a multiple of real time. //! @param ts the new rate of passage of time as a multiple of real time.
//! For example if ts is 1, time will pass at the normal rate. If t s == 10 //! For example if ts is 1, time will pass at the normal rate. If t s == 10
//! then simulation time will pass at 10 times the normal rate. //! then simulation time will pass at 10 times the normal rate.
//! If ts is negative, simulation time will go backwards. //! If ts is negative, simulation time will go backwards.
void setTimeRate(double ts); void setTimeRate(double ts);
//! Get simulation time rate. //! Get simulation time rate.
//! @return time speed as a multiple of real time. //! @return time speed as a multiple of real time.
double getTimeRate() const; double getTimeRate() const;
skipping to change at line 127 skipping to change at line 145
//! 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 : declenation 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 : declenation angle in (J2000 frame) decimal degrees //! - decJ2000 : declination angle in (J2000 frame) decimal degrees
//! @deprecated Use getObjectInfo() //! @deprecated Use getObjectInfo()
QVariantMap getObjectPosition(const QString& name); QVariantMap getObjectPosition(const QString& name);
//! 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 : declenation 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 : declenation 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 decimal degrees
//! - localized-name : localized name //! - localized-name : localized name
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
//! @return a map of object data. Keys:
//! - altitude : apparent altitude angle in decimal degrees
//! - azimuth : apparent azimuth angle in decimal degrees
//! - altitude-geometric : geometric altitude angle in decimal degre
es
//! - azimuth-geometric : geometric azimuth angle in decimal degrees
//! - ra : right ascension angle (current date frame) in decimal deg
rees
//! - dec : declination angle in (current date frame) decimal degree
s
//! - raJ2000 : right ascension angle (J2000 frame) in decimal degre
es
//! - decJ2000 : declination angle in (J2000 frame) decimal degrees
//! - glongJ2000 : galactic longitude (J2000 frame) in decimal degre
es
//! - glatJ2000 : galactic latitude in (J2000 frame) decimal degrees
//! - vmag : visual magnitude
//! - vmage : visual magnitude (extincted)
//! - size : angular size in decimal degrees
//! - name : english name
//! - localized-name : localized name
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");
//! Get the current viewing direction altitude angle at center of vi ew. //! Get the current viewing direction altitude angle at center of vi ew.
skipping to change at line 397 skipping to change at line 434
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 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 ra The right ascension of the center of the image in J200 0 frame degrees //! @param ra The right ascension of the center of the image in J200 0 frame degrees
//! @param dec The declenation of the center of the image in J2000 f rame degrees //! @param dec The declination of the center of the image in J2000 f rame degrees
//! @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 loadSkyImage(const QString& id, const QString& filename, void loadSkyImage(const QString& id, const QString& filename,
double ra, double dec, double angS ize, double rotation, double ra, double dec, double angS ize, double rotation,
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
 End of changes. 9 change blocks. 
14 lines changed or deleted 66 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/