Stellarium

https://stellarium.org/doc/26.0/
Admin
Stellarium is a free and open-source planetarium software that displays a realistic 3D simulation of...
Tokens:1,728,342
Snippets:16,669
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### setup

Source: https://stellarium.org/doc/26.0/functions_func_s.html

Performs setup operations.

```APIDOC
## setup()

### Description
Performs setup operations.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
- **ColorButton** (type) - Description of the return type.

#### Response Example
N/A
```

--------------------------------

### Start Telescope

Source: https://stellarium.org/doc/26.0/group__telescopeControl.html

Starts a telescope at the specified slot.

```APIDOC
## startTelescopeAtSlot

### Description
Starts a telescope at the given slot, getting its description with getTelescopeAtSlot().

### Method
`bool startTelescopeAtSlot(int slot)`
```

--------------------------------

### HttpListenerSettings Configuration Example

Source: https://stellarium.org/doc/26.0/group__qtWebApp.html

Example configuration settings for HttpListener, including host, port, thread pool settings, SSL file paths, and request size limits. Settings can be provided in a configuration file.

```ini
;host=192.168.0.100
port=8080
minThreads=1
maxThreads=10
cleanupInterval=1000
readTimeout=60000
;sslKeyFile=ssl/my.key
;sslCertFile=ssl/my.cert
maxRequestSize=16000
maxMultiPartSize=1000000

```

--------------------------------

### start

Source: https://stellarium.org/doc/26.0/classSyncServer.html

Starts the SyncServer on the specified port. If the server is already running, it stops it first. Returns true if successful, false otherwise (e.g., if the port is in use).

```APIDOC
## start

### Description
Starts the SyncServer on the specified port. If the server is already running, stops it first. Returns true if successful (false usually means port was in use, use getErrorString).

### Method
SLOT

### Parameters
#### Path Parameters
- **port** (quint16) - Required - The port number to start the server on.

### Response
#### Success Response (true)
Indicates the server started successfully.

#### Error Response (false)
Indicates the server failed to start, likely due to the port being in use.
```

--------------------------------

### Line Wrapping Example

Source: https://stellarium.org/doc/26.0/codingStyle.html

When wrapping long function calls, use tabs to align with the start of the function call, then spaces for subsequent parameters.

```text
 [--tab-][--tab-][--tab-]someFunction(param, ...
 [--tab-][--tab-][--tab-][  spaces   ]moreparams, ...);
```

--------------------------------

### Basic Template Filling Example

Source: https://stellarium.org/doc/26.0/classTemplate.html

Demonstrates how to fill a simple template with variables and conditions. Note that loop variables are numbered starting from 0.

```cpp
Template t(QFile("test.tpl"),QTextCode::codecForName("UTF-8"));
t.setVariable("username", "Stefan");
t.setCondition("locked",false);
t.loop("user",2);
t.setVariable("user0.name,\"Markus\");
t.setVariable("user0.time,\"8:30\");
t.setVariable("user1.name,\"Roland\");
t.setVariable("user1.time,\"8:45\");
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classStelCore.html

Initializes and loads all main core components of Stellarium.

```APIDOC
## init

### Description
Initializes and loads all main core components.

### Method
void init()

```

--------------------------------

### Accessing ObjectService Find Operation

Source: https://stellarium.org/doc/26.0/remoteControlApi.html

Example of how to access the 'find' operation of the ObjectService to search for objects. This uses a standard HTTP GET request with a query string parameter.

```http
http://localhost:8090/api/objects/find?str=moon
```

--------------------------------

### Configure and Build Plugin on Unix-like Systems

Source: https://stellarium.org/doc/26.0/plugins.html

Use CMake to configure the build and then make to compile the plugin. 'make install' copies the plugin to the user's Stellarium modules directory.

```bash
cmake ../..
make
make install

```

--------------------------------

### Startup and Highlight Settings

Source: https://stellarium.org/doc/26.0/group__navigationalStars.html

Manage settings related to enabling navigational stars at startup and highlighting them when visible.

```APIDOC
## setEnableAtStartup

### Description
Sets whether navigational stars should be enabled at startup.

### Method
void

### Parameters
- **b** (bool) - Description: Flag to enable or disable at startup.

## getEnableAtStartup

### Description
Gets the flag indicating if navigational stars are enabled at startup.

### Method
bool

### Parameters
- **void** (void) - Description: No parameters.

## setHighlightWhenVisible

### Description
Sets whether navigational stars should be highlighted when they are visible.

### Method
void

### Parameters
- **b** (bool) - Description: Flag to enable or disable highlighting when visible.

## getHighlightWhenVisible

### Description
Gets the flag indicating if navigational stars are highlighted when visible.

### Method
bool

### Parameters
- **void** (void) - Description: No parameters.

```

--------------------------------

### init()

Source: https://stellarium.org/doc/26.0/group__telescopeControl.html

Initializes the Telescope Control module. If initialization is time-consuming, progress should be displayed.

```APIDOC
## init()

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Method Signature
`void TelescopeControl::init()`
```

--------------------------------

### Get Module Version

Source: https://stellarium.org/doc/26.0/classLandscapeMgr.html

Gets the version of the module.

```APIDOC
## getModuleVersion

### Description
Get the version of the module, default is stellarium main version.

### Method
virtual QString

### Parameters
None
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classSkyGui.html

Initializes the SkyGui with the provided StelGui object.

```APIDOC
## init()

### Description
Initializes the SkyGui with the provided StelGui object.

### Method
void

### Parameters
* **StelGui*** - A pointer to the StelGui object.
```

--------------------------------

### Get Parallactic Angle

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the parallactic angle of the telescope.

```APIDOC
## getParallacticAngle

### Description
Gets the parallactic angle of the telescope.

### Method
GET

### Endpoint
/getParallacticAngle

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **float** - The parallactic angle.
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classLandscapeMgr.html

Initializes the LandscapeManager, loading the default landscape and setting up display flags from configuration.

```APIDOC
## init()

### Description
Initialize the LandscapeManager class. Operations performed: Load the default landscape as specified in the application configuration, Set up landscape-related display flags from ini parser object. Implements StelModule.

### Method
void

### Endpoint
LandscapeMgr::init
```

--------------------------------

### init()

Source: https://stellarium.org/doc/26.0/group__remoteSync.html

Initializes the Remote Sync module.

```APIDOC
## ◆ init()

### Description
Initialize itself.

### Method
`void init()`
```

--------------------------------

### Get Supergalactic Position

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the observer-centered supergalactic coordinates.

```APIDOC
## getSupergalacticPos

### Description
Gets the observer-centered supergalactic coordinates.

### Method
GET

### Endpoint
/getSupergalacticPos

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **Vec3d** - The observer-centered supergalactic coordinates.
```

--------------------------------

### setupArt

Source: https://stellarium.org/doc/26.0/functions_func_s.html

Sets up artwork.

```APIDOC
## setupArt()

### Description
Sets up artwork.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
- **scm::ScmConstellationArtwork** (type) - Description of the return type.

#### Response Example
N/A
```

--------------------------------

### Get Galactic Position

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the observer-centered galactic coordinates.

```APIDOC
## getGalacticPos

### Description
Gets the observer-centered galactic coordinates.

### Method
GET

### Endpoint
/getGalacticPos

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **Vec3d** - The observer-centered galactic coordinates.
```

--------------------------------

### Get Author Name

Source: https://stellarium.org/doc/26.0/classLandscapeMgr.html

Gets the name of the module author.

```APIDOC
## getAuthorName

### Description
Get the name of the module author.

### Method
virtual QString

### Parameters
None
```

--------------------------------

### startServer

Source: https://stellarium.org/doc/26.0/group__remoteControl.html

Starts the HTTP server using the current configuration and begins processing requests via the RequestHandler.

```APIDOC
## startServer()

### Description
Starts the HTTP server using the current settings and begins handling requests. Uses the RequestHandler class for processing.

### See also
*   RequestHandler
```

--------------------------------

### Minimal Script Example

Source: https://stellarium.org/doc/26.0/scripting.html

This script prints 'Hello Universe' to the Script Console's output window. Ensure the Script Console is enabled.

```javascript
core.debug("Hello Universe");
```

--------------------------------

### StarMgr Get Name

Source: https://stellarium.org/doc/26.0/classStarMgr.html

Gets a user-displayable name for the star category.

```APIDOC
## getName

### Description
Gets a user-displayable name of the object category.

### Method
QString getName() const

### Parameters
None
```

--------------------------------

### Get Author Email

Source: https://stellarium.org/doc/26.0/classLandscapeMgr.html

Gets the email address of the module author.

```APIDOC
## getAuthorEmail

### Description
Get the email address of the module author.

### Method
virtual QString

### Parameters
None
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/group__exoplanets.html

Initializes the Exoplanets module. If initialization is time-consuming, progress should be displayed.

```APIDOC
## init

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Method
POST

### Endpoint
/exoplanets/init
```

--------------------------------

### Get Loading Scene

Source: https://stellarium.org/doc/26.0/group__scenery3D.html

Gets the SceneInfo object for the scene that is currently being loaded.

```APIDOC
## getLoadingScene

### Description
Gets the SceneInfo of the scene that is currently being loaded.

### Method
SceneInfo
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classS3DRenderer.html

Performs initialization that requires a valid OpenGL context.

```APIDOC
## void init ()

### Description
Performs initialization that requires a valid OpenGL context.
```

--------------------------------

### Get Current Scene

Source: https://stellarium.org/doc/26.0/group__scenery3D.html

Gets the SceneInfo object for the scene that is currently being displayed.

```APIDOC
## getCurrentScene

### Description
Gets the SceneInfo of the scene that is currently being displayed.

### Method
SceneInfo
```

--------------------------------

### StelGuiBase::init

Source: https://stellarium.org/doc/26.0/classStelGuiBase.html

Initializes the GUI with a top-level graphics widget.

```APIDOC
## StelGuiBase::init

### Description
Initializes the GUI with a top-level graphics widget.

### Method
virtual void

### Parameters
- **atopLevelGraphicsWidget** (QGraphicsWidget *) - Description of the parameter
```

--------------------------------

### Server

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Initializes the server with a specified port.

```APIDOC
## Server

### Description
Initializes the server with a specified port.

### Signature
`Server(int port)`
```

--------------------------------

### Get Alt/Az Position Apparent

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the observer-centered apparent altitude/azimuth position.

```APIDOC
## getAltAzPosApparent

### Description
Gets the observer-centered apparent altitude/azimuth position.

### Method
GET

### Endpoint
/getAltAzPosApparent

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **Vec3d** - The observer-centered apparent alt/az position.
```

--------------------------------

### Get Alt/Az Position Geometric

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the observer-centered geometric altitude/azimuth position.

```APIDOC
## getAltAzPosGeometric

### Description
Gets the observer-centered geometric altitude/azimuth position.

### Method
GET

### Endpoint
/getAltAzPosGeometric

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **Vec3d** - The observer-centered geometric alt/az position.
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classHighlightMgr.html

Initializes the HighlightMgr module, displaying progress if initialization is time-consuming.

```APIDOC
## init

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Method
void init()

### Implements
Implements StelModule.
```

--------------------------------

### HelloStelModule::init

Source: https://stellarium.org/doc/26.0/classHelloStelModule.html

Initializes the module. If initialization is time-consuming, progress should be displayed on the loading bar.

```APIDOC
## ◆ init()

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Method
void init()
```

--------------------------------

### StarMgr Get Stel Object Type

Source: https://stellarium.org/doc/26.0/classStarMgr.html

Gets the type of the Stel object.

```APIDOC
## getStelObjectType

### Description
Gets the type of the Stel object.

### Method
QString getStelObjectType() const

### Parameters
None
```

--------------------------------

### init()

Source: https://stellarium.org/doc/26.0/classSkyLine.html

Initializes the SkyLine system. Call once before creating the first line.

```APIDOC
static void init()
```

--------------------------------

### Get Date Parts

Source: https://stellarium.org/doc/26.0/classEgyptianCalendar.html

Gets the calendar date as a vector of integer parts.

```APIDOC
## getDate () const

### Description
Gets a vector of calendar date elements, sorted from largest to smallest.

### Method
`virtual QVector< int > getDate() const`
```

--------------------------------

### setupAxes

Source: https://stellarium.org/doc/26.0/functions_s.html

Sets up the celestial axes.

```APIDOC
## setupAxes()

### Description
Sets up the celestial axes.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### get()

Source: https://stellarium.org/doc/26.0/group__remoteControl.html

Handles HTTP GET requests. Implement this to define reactions to GET requests, which should generally only query data or program state without changing it. Errors should be reported using APIServiceResponse::writeRequestError.

```APIDOC
## get()

### Description
Handles HTTP GET requests. Implement this to define reactions to GET requests, which should generally only query data or program state without changing it. Errors should be reported using APIServiceResponse::writeRequestError.

### Method
`void get(const QByteArray &operation, const APIParameters &parameters, APIServiceResponse &response)`

### Parameters
#### Path Parameters
- **operation** (const QByteArray &) - The operation string of the request (i.e. the part of the request URL after the service name, without parameters).
- **parameters** (const APIParameters &) - The extracted service parameters (extracted from the URL).
- **response** (APIServiceResponse &) - The response object, write your response into this.

### Note
The thread this is called in depends on the supportThreadedOperation() return value.
```

--------------------------------

### Get Equinox Equatorial Position

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the observer-centered equatorial coordinate at the current equinox.

```APIDOC
## getEquinoxEquatorialPos

### Description
Gets the observer-centered equatorial coordinate at the current equinox. The frame's Z axis is at the planet's current rotation axis. For time 2000-01-01, this frame is almost the same as J2000, but ONLY if the observer is on Earth.

### Method
GET

### Endpoint
/getEquinoxEquatorialPos

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **Vec3d** - The observer-centered equatorial coordinate.
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classSolarSystem.html

Initializes the SolarSystem module, loading data and setting up initial states.

```APIDOC
## init()

### Description
Initialize the SolarSystem. Includes loading planetary body orbital and model data, performing initial planet position calculation, and setting display options from application settings.

### Implements
StelModule
```

--------------------------------

### Select Planet Example

Source: https://stellarium.org/doc/26.0/classStelMainScriptAPI.html

Demonstrates selecting a planet by its name.

```javascript
core.selectObjectByName("Mars", true);
```

--------------------------------

### Get Formatted Date String

Source: https://stellarium.org/doc/26.0/classEgyptianCalendar.html

Gets a complete formatted string representation of the date.

```APIDOC
## getFormattedDateString ()

### Description
Gets a formatted complete string for the date. The default implementation concatenates strings from `getDateStrings()` with spaces.

### Method
`QString getFormattedDateString() const`
```

```APIDOC
## getFormattedDateString (const QVector< int > &date, QString sep=" ")

### Description
Gets a formatted complete string for a given date vector, using a specified separator.

### Method
`static QString getFormattedDateString(const QVector< int > &date, QString sep=" ")`
```

--------------------------------

### Get Julian Day Number

Source: https://stellarium.org/doc/26.0/classEgyptianCalendar.html

Gets the Julian day number from the current calendar date.

```APIDOC
## getJD () const

### Description
Gets the Julian day number from a calendar date.

### Method
`virtual double getJD() const`
```

--------------------------------

### Configure and Build Plugin on Windows

Source: https://stellarium.org/doc/26.0/plugins.html

Use CMake with the 'MSYS Makefiles' generator for Windows, followed by make to compile the plugin. Installation on Windows requires manual copying of files.

```bash
cmake -G "MSYS Makefiles" ../..
make

```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classStarMgr.html

Initializes the Star Manager, loading star catalogue data, setting up color tables, loading textures and fonts, and configuring display flags.

```APIDOC
## init

### Description
Initialize the StarMgr. Loads the star catalogue data into memory, sets up the star color table, loads the star texture, loads the star font (for labels on named stars), loads the texture of the star selection indicator, and sets various display flags from the ini parser object.
```

--------------------------------

### Landscape Installation and Removal Error Signals

Source: https://stellarium.org/doc/26.0/classLandscapeMgr.html

Signals indicating errors during landscape installation or removal.

```APIDOC
### Landscape Installation and Removal Error Signals

- **errorUnableToOpen** (QString path)
| Emitted when installLandscapeFromArchive() can't read from, write to or create a file or a directory. More...
- **errorNotArchive** ()
| Emitted when the file passed to installLandscapeFromArchive() is not a ZIP archive or does not contain a valid landscape. More...
- **errorNotUnique** (QString nameOrID)
| Emitted when installLandscapeFromArchive() tries to install a landscape with the same name or identifier as an already installed one. More...
- **errorRemoveManually** (QString path)
| Emitted when removeLandscape() is unable to remove all the files of a landscape. More...
```

--------------------------------

### StelFileMgr::init()

Source: https://stellarium.org/doc/26.0/classStelFileMgr.html

Initializes the directories used by StelFileMgr. It sets up the search path including the installation directory and the per-user data directory.

```APIDOC
## StelFileMgr::init()

### Description
Initializes the directories. By default, StelFileMgr includes the Stellarium installation directory and the per-user data/settings directory in its search path.

### Method
`static void init()`
```

--------------------------------

### Get Formatted Date String (Static)

Source: https://stellarium.org/doc/26.0/classFrenchAstronomicalCalendar.html

Gets a formatted string representation of a date, with a specified separator.

```APIDOC
## getFormattedDateString (static)

### Description
Gets a formatted complete string for a date. This implementation converts and concatenates all integers with the specified separator.

### Method
static QString

### Parameters
- **date** (QVector<int>) - The date components.
- **sep** (QString) - The separator string. Defaults to a space.

### Endpoint
N/A (Static method)
```

--------------------------------

### Variables starting with 'k'

Source: https://stellarium.org/doc/26.0/functions_vars_k.html

This section lists variables that start with the letter 'k', along with their corresponding types.

```APIDOC
## Variables

### k

- **Ka** (StelOBJ::Material)
- **Kd** (StelOBJ::Material)
- **Ke** (StelOBJ::Material)
- **kineticScrollingList** (StelDialog)
- **Ks** (StelOBJ::Material)
```

--------------------------------

### ColorButton::setup

Source: https://stellarium.org/doc/26.0/classColorButton.html

Prepares the ColorButton to manage a StelProperty and its corresponding configuration entry, specifically for color values.

```APIDOC
## ColorButton::setup

### Description
Prepares this button so that it can work properly with the StelProperty and config entry it represents.

### Method
void

### Signature
void setup(const QString &propertyName, const QString &iniName, const QString &moduleName = "")

### Parameters
#### Path Parameters
- **propertyName** (const QString &) - Required - A StelProperty name which must represent a color (coded as Vec3f).
- **iniName** (const QString &) - Required - The associated entry for config.ini, in the form group/name. Usually "color/some_feature_name_color".
- **moduleName** (const QString &) - Optional - If the iniName is for a module (plugin)-specific ini file, add the module name here. The module needs an implementation of getSettings().

### Warning
If the action with `propertyName` is invalid/unregistered, or cannot be converted to the required datatype, the application will crash.
```

--------------------------------

### errorNotUnique

Source: https://stellarium.org/doc/26.0/classLandscapeMgr.html

Signal emitted when installLandscapeFromArchive() tries to install a landscape with the same name or identifier as an already installed one.

```APIDOC
## errorNotUnique

### Description
Signal emitted when installLandscapeFromArchive() tries to install a landscape with the same name or identifier as an already installed one. (A way of moving the need for translatable error messages to the GUI.)

### Parameters
- **_nameOrID_** (QString) - The name or the identifier of the landscape.
```

--------------------------------

### init()

Source: https://stellarium.org/doc/26.0/group__navigationalStars.html

Initializes the Navigational Stars module. If initialization takes significant time, progress should be displayed on the loading bar.

```APIDOC
## init()

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Returns
* **void**
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classArchaeoLines.html

Initializes the module. If initialization is time-consuming, progress should be displayed on the loading bar.

```APIDOC
## ◆ init()

### Description
Initialize itself.
If the initialization takes significant time, the progress should be displayed on the loading bar.

### Implements
StelModule
```

--------------------------------

### StelPropertyService GET Operation

Source: https://stellarium.org/doc/26.0/group__remoteControl.html

Implements the HTTP GET method for StelPropertyService. This allows retrieving information related to StelProperties.

```APIDOC
## GET /api/stelproperty/

### Description
Implements the HTTP GET method for StelPropertyService.

### Method
GET

### Endpoint
/api/stelproperty/

### Parameters
#### Path Parameters
- **operation** (QByteArray) - Required - The specific operation to perform.
- **parameters** (APIParameters) - Required - Parameters for the operation.

#### Request Body
None

### Response
#### Success Response (200)
- **response** (APIServiceResponse) - Contains the result of the GET operation.
```

--------------------------------

### init()

Source: https://stellarium.org/doc/26.0/classNebulaTextures.html

Initializes the NebulaTextures module. If initialization is time-consuming, progress should be displayed.

```APIDOC
## init()

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Method
`void NebulaTextures::init()`

### Remarks
Implements StelModule.
```

--------------------------------

### StelActionService GET Operation

Source: https://stellarium.org/doc/26.0/group__remoteControl.html

Implements the HTTP GET method for StelActionService. This allows retrieving information related to StelActions.

```APIDOC
## GET /api/stelaction/

### Description
Implements the HTTP GET method for StelActionService.

### Method
GET

### Endpoint
/api/stelaction/

### Parameters
#### Path Parameters
- **operation** (QByteArray) - Required - The specific operation to perform.
- **parameters** (APIParameters) - Required - Parameters for the operation.

#### Request Body
None

### Response
#### Success Response (200)
- **response** (APIServiceResponse) - Contains the result of the GET operation.
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classStelSkyTranslator.html

Initializes the translation system with a specified file.

```APIDOC
## init

### Description
Initialize Translation.

### Method
static void
init (const QString &fileName)

### Parameters
* **fileName** (const QString &) - The name of the translation file to initialize.
```

--------------------------------

### Get Alt/Az Position Auto

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the observer-centered altitude/azimuth position with automatic refraction correction if the atmosphere is active.

```APIDOC
## getAltAzPosAuto

### Description
Gets the observer-centered altitude/azimuth position with automatic refraction correction if the atmosphere is active.

### Method
GET

### Endpoint
/getAltAzPosAuto

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **Vec3d** - The observer-centered alt/az position with automatic refraction correction.
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classSkyCultureMaker.html

Initializes the module. If initialization is time-consuming, progress should be displayed.

```APIDOC
## init()

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Method
void SkyCultureMaker::init
```

--------------------------------

### Landscape Installation and Management

Source: https://stellarium.org/doc/26.0/classLandscapeMgr.html

Functions for installing landscapes from archives, removing existing landscapes, and retrieving landscape metadata.

```APIDOC
## installLandscapeFromArchive

### Description
Installs a landscape from a ZIP archive.

### Method
QString

### Endpoint
installLandscapeFromArchive (QString pathToSourceArchive, const bool display=false, const bool forAllUsers=false)

## removeLandscape

### Description
Removes a landscape from the user data directory.

### Method
bool

### Endpoint
removeLandscape (const QString landscapeID)

## loadLandscapeName

### Description
Reads a landscape's name from its configuration file.

### Method
QString

### Endpoint
loadLandscapeName (const QString landscapeID)

## loadLandscapeSize

### Description
Calculates and returns a landscape's disc size in bytes.

### Method
quint64

### Endpoint
loadLandscapeSize (const QString landscapeID) const
```

--------------------------------

### Get Sidereal Position Apparent

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the observer-centered apparent sidereal position (hour angle + declination) at the current equinox.

```APIDOC
## getSiderealPosApparent

### Description
Gets the observer-centered apparent sidereal position (hour angle + declination) at the current equinox.

### Method
GET

### Endpoint
/getSiderealPosApparent

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **Vec3d** - The observer-centered apparent sidereal position.
```

--------------------------------

### setup

Source: https://stellarium.org/doc/26.0/classAstroCalcAlmanacWidget.html

Sets up the AstroCalcAlmanacWidget. This method is responsible for initializing the widget's components and layout.

```APIDOC
## void setup()

### Description
Sets up the AstroCalcAlmanacWidget. This method is responsible for initializing the widget's components and layout.

### Method
void
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/group__observability.html

Initializes the Observability module. If the initialization process is time-consuming, it should display progress on the loading bar.

```APIDOC
## init()

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Returns
- **void**
```

--------------------------------

### Get Sidereal Position Geometric

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the observer-centered geometric sidereal position (hour angle + declination) at the current equinox.

```APIDOC
## getSiderealPosGeometric

### Description
Gets the observer-centered geometric sidereal position (hour angle + declination) at the current equinox.

### Method
GET

### Endpoint
/getSiderealPosGeometric

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **Vec3d** - The observer-centered geometric sidereal position.
```

--------------------------------

### Scenery3d::init

Source: https://stellarium.org/doc/26.0/group__scenery3D.html

Initializes the Scenery3D module. If initialization is time-consuming, progress should be displayed on the loading bar.

```APIDOC
## Scenery3d::init()

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Remarks
Implements StelModule.
```

--------------------------------

### Example Usage of moveToJ2000

Source: https://stellarium.org/doc/26.0/classStelMovementMgr.html

Example demonstrating how to convert a vector to J2000 frame and use it with moveToJ2000. Assumes StelMovementMgr is accessible.

```cpp
StelMovementMgr* mvmgr = GETSTELMODULE(StelMovementMgr);
mvmgr->moveToJ2000(pos, mvmgr->mountFrameToJ2000(Vec3d(0., 0., 1.)), mvmgr->getAutoMoveDuration());
```

--------------------------------

### Example Usage of moveToAltAzi

Source: https://stellarium.org/doc/26.0/classStelMovementMgr.html

Example demonstrating how to find a valid aimUp vector and use it with moveToAltAzi. Assumes StelMovementMgr is accessible.

```cpp
StelMovementMgr* mvmgr = GETSTELMODULE(StelMovementMgr);
mvmgr->moveToAltAzi(pos, Vec3d(0., 0., 1.), mvmgr->getAutoMoveDuration());
```

--------------------------------

### startServer

Source: https://stellarium.org/doc/26.0/group__remoteSync.html

Starts the plugin in server mode, listening on the port specified by the serverPort property. This action has no effect if the plugin is not in the IDLE state.

```APIDOC
## startServer

### Description
Starts the plugin in server mode, on the port specified by the serverPort property. If currently in a state other than IDLE, this call has no effect.
```

--------------------------------

### Get Equinox Equatorial Position Apparent

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the apparent observer-centered equatorial coordinate at the current equinox, including refraction correction.

```APIDOC
## getEquinoxEquatorialPosApparent

### Description
Gets the apparent observer-centered equatorial coordinate at the current equinox, always adding refraction correction to the position.

### Method
GET

### Endpoint
/getEquinoxEquatorialPosApparent

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **Vec3d** - The apparent observer-centered equatorial coordinate.
```

--------------------------------

### setPluginLoadAtStartup

Source: https://stellarium.org/doc/26.0/classStelModuleMgr.html

Defines whether a plugin should be loaded at startup. This allows control over which plugins are initialized when Stellarium starts.

```APIDOC
## setPluginLoadAtStartup()

### Description
Define whether a plugin should be loaded at startup.

### Method
void setPluginLoadAtStartup(const QString &key, bool b)
```

--------------------------------

### NebulaMgr Get Latest Selected DSO Designation

Source: https://stellarium.org/doc/26.0/classNebulaMgr.html

Gets the designation for the latest selected Deep Sky Object (DSO) with priority.

```APIDOC
## getLatestSelectedDSODesignation

### Description
Get designation for latest selected DSO with priority.

### Method
QString

### Parameters
None
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classConstellationMgr.html

Initializes the Constellation Manager.

```APIDOC
## init()

### Description
Initializes the ConstellationMgr. It reads configuration settings and updates the loading bar as constellation objects are loaded for the required sky culture. This method implements StelModule.

### Method Signature
`void ConstellationMgr::init()`
```

--------------------------------

### Get Equinox Equatorial Position Auto

Source: https://stellarium.org/doc/26.0/classTelescopeClientDirectLx200.html

Gets the observer-centered equatorial coordinate at the current equinox, with automatic refraction correction if the atmosphere is active.

```APIDOC
## getEquinoxEquatorialPosAuto

### Description
Gets the observer-centered equatorial coordinate at the current equinox, adding refraction correction to the position if the atmosphere is active.

### Method
GET

### Endpoint
/getEquinoxEquatorialPosAuto

### Parameters
#### Query Parameters
- **core** (const StelCore *) - Pointer to the core object.

### Returns
- **Vec3d** - The observer-centered equatorial coordinate with automatic refraction correction.
```

--------------------------------

### NebulaMgr Get Latest Selected DSO Designation (WIC)

Source: https://stellarium.org/doc/26.0/classNebulaMgr.html

Gets the designation for the latest selected DSO with priority, ignoring catalog availability.

```APIDOC
## getLatestSelectedDSODesignationWIC

### Description
Get designation for latest selected DSO with priority and ignorance of availability of catalogs.

### Method
QString

### Parameters
None
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/group__satellites.html

Initializes the Satellites module. Progress should be displayed on the loading bar if initialization is time-consuming.

```APIDOC
## init()

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Signature
`void Satellites::init()`

### Remarks
Implements StelModule.
```

--------------------------------

### ViewService GET Operation

Source: https://stellarium.org/doc/26.0/group__remoteControl.html

Implements the HTTP GET operations for the ViewService. This method allows retrieving data related to the view by specifying an operation and parameters.

```APIDOC
## GET /api/view/

### Description
Implements the HTTP GET operations for the ViewService.

### Method
GET

### Endpoint
/api/view/

### Parameters
#### Query Parameters
- **operation** (QByteArray) - Required - The specific GET operation to perform.
- **parameters** (APIParameters) - Required - The parameters for the GET operation.

### Response
#### Success Response (200)
- **response** (APIServiceResponse) - The response from the GET operation.
```

--------------------------------

### setEnableAtStartup

Source: https://stellarium.org/doc/26.0/functions_func_s.html

Enables a feature at startup.

```APIDOC
## setEnableAtStartup()

### Description
Configures a feature to be enabled automatically when Stellarium starts.

### Method
Not specified (likely a method call on MeteorShowersMgr object).

### Endpoint
Not applicable (SDK/API method).

### Parameters
None explicitly defined in the source, but implies a boolean enable parameter.

### Request Example
```
meteorShowersMgr.setEnableAtStartup(true);
```

### Response
- **MeteorShowersMgr**: Returns the modified MeteorShowersMgr object.
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classGLExtFuncs.html

Initializes the OpenGL context for extended functions.

```APIDOC
## init

### Description
Initializes the OpenGL context with the provided `QOpenGLContext`. This function is crucial for setting up the environment to use the extended OpenGL functions defined in this class.

### Method
`void init(QOpenGLContext *ctx)`

### Endpoint
N/A (This is an SDK function)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Start Telescope at Slot

Source: https://stellarium.org/doc/26.0/group__telescopeControl.html

Starts a telescope at the specified slot. This method creates a TelescopeClient object and initiates a server process if needed. It retrieves the telescope's description using getTelescopeAtSlot().

```c++
bool TelescopeControl::startTelescopeAtSlot(int _slot_){
    // ... implementation details ...
}
```

--------------------------------

### init

Source: https://stellarium.org/doc/26.0/classCustomObjectMgr.html

Initializes the CustomObjectMgr. If initialization is time-consuming, progress should be displayed.

```APIDOC
## init()

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.
```

--------------------------------

### getArtwork

Source: https://stellarium.org/doc/26.0/classscm_1_1ScmConstellationArtwork.html

Gets the artwork.

```APIDOC
## getArtwork() const

### Description
Gets the artwork.

### Returns
const QImage & - The artwork.
```

--------------------------------

### init()

Source: https://stellarium.org/doc/26.0/group__mosaicCamera.html

Initializes the MosaicCamera module. If initialization is time-consuming, progress should be displayed on the loading bar.

```APIDOC
## init()

### Description
Initialize itself. If the initialization takes significant time, the progress should be displayed on the loading bar.

### Method Signature
`void MosaicCamera::init()`

### Remarks
Implements StelModule.
```

--------------------------------

### y()

Source: https://stellarium.org/doc/26.0/classV3f.html

Gets the Y component of the vector.

```APIDOC
## y()

### Description
Returns the Y component of the vector.

### Method
GET

### Endpoint
N/A (Method Call)

### Returns
* **float** - The Y component.
```

--------------------------------

### create (basic parameters)

Source: https://stellarium.org/doc/26.0/classLandscapeFisheye.html

Creates a fisheye landscape from basic parameters without needing an INI file.

```APIDOC
## void create (const QString name, const QString &maptex, float texturefov, float angleRotateZ)

### Description
Creates a fisheye landscape using provided name, texture, field of view, and Z-axis rotation.

### Parameters
* **name** (const QString) - The name of the landscape.
* **maptex** (const QString &) - The texture file path for the landscape.
* **texturefov** (float) - The field of view for the landscape texture.
* **angleRotateZ** (float) - The rotation angle around the Z-axis.
```

--------------------------------

### Scenery3dRemoteControlService::get

Source: https://stellarium.org/doc/26.0/classScenery3dRemoteControlService.html

Implement this to define reactions to HTTP GET requests. GET requests generally should only query data or program state, and not change it. If there is an error with the request, use APIServiceResponse::writeRequestError to notify the client.

```APIDOC
## GET /Scenery3dRemoteControlService

### Description
Implement this to define reactions to HTTP GET requests. GET requests generally should only query data or program state, and not change it. If there is an error with the request, use APIServiceResponse::writeRequestError to notify the client.

### Method
GET

### Endpoint
/Scenery3dRemoteControlService

### Parameters
#### Query Parameters
- **operation** (QByteArray) - Required - The operation string of the request (i.e. the part of the request URL after the service name, without parameters)
- **parameters** (APIParameters) - Required - The extracted service parameters (extracted from the URL)

### Response
#### Success Response (200)
- **response** (APIServiceResponse) - Description - The response object, write your response into this

Note
    The thread this is called in depends on the supportThreadedOperation() return value
```

--------------------------------

### Navigate to Plugin Build Directory

Source: https://stellarium.org/doc/26.0/plugins.html

Change into the plugin's source directory and create a build directory. The structure varies between Unix-like systems and Windows.

```bash
cd /home/me/builds/stellarium-dynamic-plugin
mkdir -p builds/unix
cd builds/unix

```

--------------------------------

### create()

Source: https://stellarium.org/doc/26.0/classLandscapeFisheye.html

Creates a fisheye landscape from basic parameters without needing an ini file.

```APIDOC
## create()

### Description
Creates a fisheye landscape from basic parameters (no ini file needed).

### Parameters
* **_name_** (const QString) - Landscape name.
* **_maptex_** (const QString &) - The fisheye texture.
* **_maptexIllum_** (const QString &) - The fisheye texture that is overlaid in the night (streetlights, skyglow, ...).
* **_texturefov_** (float) - Field of view for the photo, degrees.
* **_angleRotateZ_** (float) - Azimuth rotation angle, degrees.
```

--------------------------------

### Configure Static File Controller Settings

Source: https://stellarium.org/doc/26.0/group__qtWebApp.html

Example configuration for the StaticFileController. Settings are typically read from a config file.

```config
path=../docroot
encoding=UTF-8
maxAge=60000
cacheTime=60000
cacheSize=1000000
maxCachedFileSize=65536

```

--------------------------------

### getHeight

Source: https://stellarium.org/doc/26.0/functions_g.html

Gets the height from a heightmap.

```APIDOC
## getHeight()

### Description
Retrieves the height value from a Heightmap object.

### Returns
- Heightmap
```

--------------------------------

### getGrsLongitude

Source: https://stellarium.org/doc/26.0/functions_g.html

Gets the longitude of the GRS.

```APIDOC
## getGrsLongitude()

### Description
Retrieves the longitude of the Great Red Spot (GRS).

### Returns
- SolarSystem
```

--------------------------------

### setPluginLoadAtStartup()

Source: https://stellarium.org/doc/26.0/functions_s.html

Sets whether a plugin should load at startup for StelModuleMgr.

```APIDOC
## setPluginLoadAtStartup()

### Description
Sets whether a plugin should load at startup.

### Method
Not applicable (function call)

### Endpoint
Not applicable (function call)

### Parameters
None explicitly documented.

### Request Example
```
StelModuleMgr.setPluginLoadAtStartup(pluginName, load);
```

### Response
Returns the StelModuleMgr object for chaining.
```

--------------------------------

### setupArt

Source: https://stellarium.org/doc/26.0/classscm_1_1ScmConstellationArtwork.html

Sets up the artwork in the frame based on the anchors.

```APIDOC
## setupArt()

### Description
Setups the artwork in the frame based on the anchors.

### Method
void
```

--------------------------------

### getGrid

Source: https://stellarium.org/doc/26.0/functions_g.html

Gets the grid object.

```APIDOC
## getGrid()

### Description
Retrieves the grid object, likely used for display or calculations.

### Returns
- ToastTile
```

--------------------------------

### getFrame

Source: https://stellarium.org/doc/26.0/functions_g.html

Gets the frame from a HipsSurvey.

```APIDOC
## getFrame()

### Description
Retrieves the frame information from a HipsSurvey object.

### Returns
- HipsSurvey
```
Tokens:
Raw