diff --git a/.github/actions/build-lin/README.md b/.github/actions/build-lin/README.md index ed6a3342..355d9c11 100644 --- a/.github/actions/build-lin/README.md +++ b/.github/actions/build-lin/README.md @@ -1,13 +1,13 @@ # build-lin -This is a custom GitHub action to build an X-Plane plugin on Linux based on a prepared CMake setup. +This is a custom GitHub action to build a library on Linux based on a prepared CMake setup. ## Parameters Parameter|Requied|Default|Description ---------|-------|-------|------------ -`pluginName`|yes||Plugin's name, used both as top-level folder name and as file name as required by X-Plane -`archFolder`|yes|`lin_x64`|Subfolder in which the executable is placed, is based on architecture like 'lin_x64' +`libName`|yes | |Library's name, used as file name +`flags` |no | |Flags to be passed to CMake ## What it does @@ -19,4 +19,4 @@ Parameter|Requied|Default|Description Output|Description ------|----------- -`xpl-file-name`|path to the produced xpl file +`lib-file-name`|path to the produced library diff --git a/.github/actions/build-lin/action.yml b/.github/actions/build-lin/action.yml index 24957ffe..94230501 100644 --- a/.github/actions/build-lin/action.yml +++ b/.github/actions/build-lin/action.yml @@ -1,20 +1,19 @@ name: Build Linux / CMake -description: Build on Linux based on a CMake setup +description: Build library on Linux based on a CMake setup author: TwinFan inputs: - pluginName: - description: "Plugin's name, used both as top-level folder name and as file name as required by X-Plane" + libName: + description: "Library's name, used as file name" required: true - archFolder: - description: "Subfolder in which the executable is placed, is based on architecture like 'lin_x64'" - required: true - default: lin_x64 + flags: + description: "Flags to be passed to CMake" + required: false outputs: - xpl-file-name: - description: Path to the resulting xpl file - value: ${{ steps.return.outputs.xpl-file-name }} + lib-file-name: + description: Path to the resulting lib file + value: ${{ steps.return.outputs.lib-file-name }} runs: using: "composite" @@ -33,25 +32,25 @@ runs: run: | cd build-lin pwd - cmake -G Ninja .. + cmake -G Ninja ${{ inputs.flags }} .. - name: Build shell: bash run: | cd build-lin pwd - ninja XPMP2 XPMP2-Sample XPMP2-Remote + ninja - name: Test for Target shell: bash env: - TARGET_XPL: build-lin/${{ inputs.archFolder }}/${{ inputs.pluginName }}.xpl + TARGET_LIB: build-lin/lib${{ inputs.libName }}.a run: | - if [[ ! -f "$TARGET_XPL" ]]; then - echo Expected target build not found: "$TARGET_XPL" + if [[ ! -f "$TARGET_LIB" ]]; then + echo Expected target build not found: "$TARGET_LIB" exit 1 fi - name: Return Value id: return shell: bash env: - TARGET_XPL: build-lin/${{ inputs.archFolder }}/${{ inputs.pluginName }}.xpl - run: echo "::set-output name=xpl-file-name::$(echo $TARGET_XPL)" + TARGET_LIB: build-lin/lib${{ inputs.libName }}.a + run: echo "lib-file-name=$(echo $TARGET_LIB)" >> $GITHUB_OUTPUT diff --git a/.github/actions/build-mac/README.md b/.github/actions/build-mac/README.md index 0ed2cf8b..4e1e0a11 100644 --- a/.github/actions/build-mac/README.md +++ b/.github/actions/build-mac/README.md @@ -1,22 +1,23 @@ # build-mac -This is a custom GitHub action to build an X-Plane plugin on and for MacOS based on a prepared CMake setup. +This is a custom GitHub action to build a framwork for MacOS based on a prepared CMake setup. ## Inputs Parameter|Requied|Default|Description ---------|-------|-------|------------ -`pluginName`|yes||Plugin's name, used both as top-level folder name and as file name as required by X-Plane -`archFolder`|yes|`mac_x64`|Subfolder in which the executable is placed, is based on architecture like 'mac_x64' +`libName`|yes | |Library's name, used as file name +`flags` |no | |Flags to be passed to CMake ## What it does - Installs Ninja - Creates build folder `build-mac` - There, runs `cmake`, then `ninja` to build +- Zips the framework, including the `-y` parameter to preserve symlinks ## Outputs Output|Description ------|----------- -`xpl-file-name`|path to the produced xpl file +`lib-file-name`|path to the produced zip archive of the framework diff --git a/.github/actions/build-mac/action.yml b/.github/actions/build-mac/action.yml index e34b65e6..36342d90 100644 --- a/.github/actions/build-mac/action.yml +++ b/.github/actions/build-mac/action.yml @@ -3,18 +3,17 @@ description: Build a MacOS plugin based on a CMake setup author: TwinFan inputs: - pluginName: - description: "Plugin's name, used both as top-level folder name and as file name as required by X-Plane" + libName: + description: "Library's name, used both as top-level folder name and as file name as required by X-Plane" required: true - archFolder: - description: "Subfolder in which the executable is placed, is based on architecture like 'mac_x64'" - required: true - default: mac_x64 + flags: + description: "Flags to be passed to CMake" + required: false outputs: - xpl-file-name: - description: Path to the resulting xpl file - value: ${{ steps.return.outputs.xpl-file-name }} + lib-file-name: + description: Path to the resulting lib file + value: ${{ steps.return.outputs.lib-file-name }} runs: using: "composite" @@ -32,25 +31,27 @@ runs: run: | cd build-mac pwd - cmake -G Ninja .. + cmake -G Ninja ${{ inputs.flags }} .. - name: Build shell: bash run: | cd build-mac pwd - ninja XPMP2 XPMP2-Sample XPMP2-Remote - - name: Test for Target + ninja + - name: Test for and Zip Framework shell: bash env: - TARGET_XPL: build-mac/${{ inputs.archFolder }}/${{ inputs.pluginName }}.xpl + TARGET_LIB: build-mac/${{ inputs.libName }}.framework run: | - if [[ ! -f "$TARGET_XPL" ]]; then - echo Expected target build not found: "$TARGET_XPL" + if [[ ! -d "$TARGET_LIB" ]]; then + echo Expected target build not found: "$TARGET_LIB" exit 1 fi + cd build-mac + zip -9ry ${{ inputs.libName }}.framework.zip ${{ inputs.libName }}.framework - name: Return Value id: return shell: bash env: - TARGET_XPL: build-mac/${{ inputs.archFolder }}/${{ inputs.pluginName }}.xpl - run: echo "::set-output name=xpl-file-name::$(echo $TARGET_XPL)" + TARGET_ZIP: build-mac/${{ inputs.libName }}.framework.zip + run: echo "lib-file-name=$(echo $TARGET_ZIP)" >> $GITHUB_OUTPUT diff --git a/.github/actions/build-win/README.md b/.github/actions/build-win/README.md index 0ed2cf8b..09cac992 100644 --- a/.github/actions/build-win/README.md +++ b/.github/actions/build-win/README.md @@ -1,22 +1,22 @@ -# build-mac +# build-win -This is a custom GitHub action to build an X-Plane plugin on and for MacOS based on a prepared CMake setup. +This is a custom GitHub action to build a library on and for Windows based on a prepared CMake setup. ## Inputs Parameter|Requied|Default|Description ---------|-------|-------|------------ -`pluginName`|yes||Plugin's name, used both as top-level folder name and as file name as required by X-Plane -`archFolder`|yes|`mac_x64`|Subfolder in which the executable is placed, is based on architecture like 'mac_x64' +`libName`|yes | |Library's name, used as file name +`flags` |no | |Flags to be passed to CMake ## What it does -- Installs Ninja -- Creates build folder `build-mac` -- There, runs `cmake`, then `ninja` to build +- Runs a separate command file, `build-win.cmd`, which in tun +- Creates build folder `build-win` +- There, runs `CMAKE`, then `NMAKE` to build ## Outputs Output|Description ------|----------- -`xpl-file-name`|path to the produced xpl file +`lib-file-name`|path to the produced lib file diff --git a/.github/actions/build-win/action.yml b/.github/actions/build-win/action.yml index 63129f0d..02ad4289 100644 --- a/.github/actions/build-win/action.yml +++ b/.github/actions/build-win/action.yml @@ -1,45 +1,38 @@ name: Build Windows / MSVC / CMake -description: Build a Windows plugin with MS Visual Studio based on a CMake setup +description: Build a Windows library with MS Visual Studio based on a CMake setup author: TwinFan inputs: - pluginName: - description: "Plugin's name, used both as top-level folder name and as file name as required by X-Plane" + libName: + description: "Library's name, used as file name" required: true - archFolder: - description: "Subfolder in which the executable is placed, is based on architecture like 'win_x64'" - required: true - default: win_x64 + flags: + description: "Flags to be passed to CMake" + required: false outputs: - xpl-file-name: - description: Path to the resulting xpl file - value: ${{ steps.return.outputs.xpl-file-name }} - pdb-file-name: - description: Path to the resulting pdb file (debug symbol info) - value: ${{ steps.return.outputs.pdb-file-name }} + lib-file-name: + description: Path to the resulting lib + value: ${{ steps.return.outputs.lib-file-name }} runs: using: "composite" steps: - name: Build shell: cmd - run: ${{ github.action_path }}\build-win.cmd "C:\Program Files\Microsoft Visual Studio\2022\Enterprise" build-win + run: ${{ github.action_path }}\build-win.cmd "C:\Program Files\Microsoft Visual Studio\2022\Enterprise" build-win "${{ inputs.flags }}" - name: Test for Target shell: bash env: - TARGET_XPL: build-win/${{ inputs.archFolder }}/${{ inputs.pluginName }}.xpl + TARGET_LIB: build-win/${{ inputs.libName }}.lib run: | - if [[ ! -f "$TARGET_XPL" ]]; then - echo Expected target build not found: "$TARGET_XPL" + if [[ ! -f "$TARGET_LIB" ]]; then + echo Expected target build not found: "$TARGET_LIB" exit 1 fi - name: Return Value id: return shell: bash env: - TARGET_XPL: build-win/${{ inputs.archFolder }}/${{ inputs.pluginName }}.xpl - TARGET_PDB: build-win/${{ inputs.archFolder }}/${{ inputs.pluginName }}.pdb - run: | - echo "::set-output name=xpl-file-name::$(echo $TARGET_XPL)" - echo "::set-output name=pdb-file-name::$(echo $TARGET_PDB)" + TARGET_LIB: build-win/${{ inputs.libName }}.lib + run: echo "lib-file-name=$(echo $TARGET_LIB)" >> $GITHUB_OUTPUT diff --git a/.github/actions/build-win/build-win.cmd b/.github/actions/build-win/build-win.cmd index d580408a..4bf36ac8 100644 --- a/.github/actions/build-win/build-win.cmd +++ b/.github/actions/build-win/build-win.cmd @@ -1,6 +1,7 @@ @ECHO OFF REM We expect 2 parameters +REM Additional parameters are passed through to CMake IF "%~1"=="" GOTO :PRINT_HELP IF "%~2"=="" GOTO :PRINT_HELP @@ -20,11 +21,11 @@ PUSHD "%MY_BUILD_DIR%" IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL% REM Create Makefile from CMakeLists.txt, using NMake output beacause NMake happens to be available -CMAKE -G "NMake Makefiles" -DCMAKE_BUILD_TYPE:STRING="RelWithDebInfo" -DCMAKE_MAKE_PROGRAM="nmake.exe" -DCMAKE_TOOLCHAIN_FILE="..\docker\Toolchain-msvc-x86-64.cmake" .. +CMAKE -G "NMake Makefiles" -DCMAKE_BUILD_TYPE:STRING="RelWithDebInfo" -DCMAKE_MAKE_PROGRAM="nmake.exe" -DCMAKE_TOOLCHAIN_FILE="..\docker\Toolchain-msvc-x86-64.cmake" %~3 %~4 %~5 .. IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL% REM Perform the actual build -NMAKE /A XPMP2 XPMP2-Sample XPMP2-Remote +NMAKE /A IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL% ECHO Windows Build: SUCCESS! diff --git a/.github/actions/sign-notarize/README.md b/.github/actions/sign-notarize/README.md deleted file mode 100644 index 0bf799fc..00000000 --- a/.github/actions/sign-notarize/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# sign-notarize - -This is a custom GitHub action to sign and then notarize a MacOS X-Plane plugin. -It waits for Apple's answer to notarization, which can take a couple of minutes! - -## Inputs - -Parameter|Requied|Default|Description ----------|-------|-------|------------ -`xplFileName`|yes||Path to just built xpl plugin -`certificate`|yes||Base64 encoded .p12 certificate file -`certPwd`|yes||Password of the .p12 certificate file -`notarizeUser`|yes||Apple ID for notarization service (parameter `--apple-id` to `notarytool`) -`notarizeTeam`|yes||Team ID for notarization service (parameter `--team-id` to `notarytool`) -`notarizeAppPwd`|yes||[App-specific password](https://support.apple.com/en-gb/HT204397) for notarization service (parameter `--password` to `notarytool`) - -## What it does - -All actions are performed by script `sign-notarize`, which -- Creates a temporary keychain to store the passed-in certificate -- Signs the file provided in `xplFileName` -- Zips the file and sends it to Apple's notarization service -- Waits for notarization to finish, which can take a few minutes diff --git a/.github/actions/sign-notarize/action.yml b/.github/actions/sign-notarize/action.yml deleted file mode 100644 index e7fd4e63..00000000 --- a/.github/actions/sign-notarize/action.yml +++ /dev/null @@ -1,33 +0,0 @@ -name: Sign/Notarize MacOS plugin -description: Signs, then notarizes the plugin -author: TwinFan - -inputs: - xplFileName: - description: "Path to just built xpl plugin" - required: true - certificate: - description: "Base64 encoded .p12 certificate file" - required: true - certPwd: - description: "Password of the .p12 certificate file" - required: true - notarizeUser: - description: "Apple-ID for notarization" - required: true - notarizeTeam: - description: "Team-ID for notarization" - required: true - notarizeAppPwd: - description: "App-specific password for notarization" - required: true - -runs: - using: "composite" - steps: - - name: Sign and Notarize # is actually all in a shell script - shell: bash - run: | - echo ${{ inputs.certificate }} | base64 --decode > certificate.p12 - chmod a+x ${{ github.action_path }}/sign-notarize - ${{ github.action_path }}/sign-notarize "${{ inputs.xplFileName }}" certificate.p12 "${{ inputs.certPwd }}" "${{ inputs.notarizeUser }}" "${{ inputs.notarizeTeam }}" "${{ inputs.notarizeAppPwd }}" diff --git a/.github/actions/sign-notarize/sign-notarize b/.github/actions/sign-notarize/sign-notarize deleted file mode 100755 index 59793698..00000000 --- a/.github/actions/sign-notarize/sign-notarize +++ /dev/null @@ -1,74 +0,0 @@ -#!/bin/sh -# Signs and notarizes a MacOS build -# -# Parameters -# 1. Path to file to sign, then notarize -# 2. Signing ID file like 'certificate.p12' -# 3. Password for above p12 file -# 4. Apple ID for notarization (parameter --apple-id to notarytool) -# 5. Team ID for notarization (parmeter --team-id to notarytool) -# 6. App-specific password for notarization (parameter --password to notarytool) - -set -eu - -# --- Cleanup in case of faulty exit - -function cleanup { - echo ">>> Cleanup <<<" - security delete-keychain build.keychain -} - -# ================================================================== -# Read parameters - -if (( $# < 6 )) -then - echo "$0 requires 6 parameters, check script!" - exit 1 -fi - -PATH_TO_FILE=$1 -SIGN_ID_FILE=$2 -SIGN_ID_PWD=$3 -NOTAR_USER=$4 -NOTAR_TEAM=$5 -NOTAR_PWD=$6 - -# --- Sign - -echo . -echo "--- Sign ---" -echo . - -# Taken from https://localazy.com/blog/how-to-automatically-sign-macos-apps-using-github-actions -# Create a temporary keychain and import the given certificate -security create-keychain -p NotSoSecretAPwd build.keychain -trap cleanup EXIT # Make sure the keychain gets removed in case of failure exit -security default-keychain -s build.keychain -security unlock-keychain -p NotSoSecretAPwd build.keychain -security import "$SIGN_ID_FILE" -P "$SIGN_ID_PWD" -k build.keychain -T /usr/bin/codesign -# Allow some tools to use the keychain -security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k NotSoSecretAPwd build.keychain -# Actually sign -security find-identity -v build.keychain -export MACOS_IDENTITY=`security find-identity -v build.keychain | egrep -o '[0-9A-F]{40}'` -echo MACOS_IDENTITY = $MACOS_IDENTITY -codesign --force --keychain build.keychain -s $MACOS_IDENTITY "$PATH_TO_FILE" -v -codesign --verify --verbose "$PATH_TO_FILE" - -# --- Notarize LiveTraffic and XPMP2-Remote --- - -echo . -echo "--- Notarize ---" -echo . - -# Can only send zip archives to notarization -zip -v "$PATH_TO_FILE.zip" "$PATH_TO_FILE" -xcrun notarytool submit --wait --apple-id "$NOTAR_USER" --password "$NOTAR_PWD" --team-id "$NOTAR_TEAM" "$PATH_TO_FILE.zip" -rm "$PATH_TO_FILE.zip" - -# Note: No stapling possible to .xpl files - -echo . -echo "*** SIGNED and NOTARIZED ***" -exit 0 \ No newline at end of file diff --git a/.github/actions/upload-plugin/README.md b/.github/actions/upload-plugin/README.md deleted file mode 100644 index 009d501d..00000000 --- a/.github/actions/upload-plugin/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# upload-plugin - -This is a custom GitHub action to upload a just built X-Plane plugin to Github's artifacts for later deployment or download. - -## Parameters - -Parameter|Requied|Default|Description ----------|-------|-------|------------ -`pluginName`|yes||Plugin's name, used both as top-level folder name and as file name as required by X-Plane -`archFolder`|yes||Subfolder in which the executable is placed, is based on architecture like 'lin_x64' -`xplFileName`|yes||Path to the just built xpl file - -## What it does - -- Organizes the produced plugin in the correct folder structure for deployment -- and adds it to artifacts. \ No newline at end of file diff --git a/.github/actions/upload-plugin/action.yml b/.github/actions/upload-plugin/action.yml deleted file mode 100644 index 6d74b1e3..00000000 --- a/.github/actions/upload-plugin/action.yml +++ /dev/null @@ -1,35 +0,0 @@ -name: Upload Plugin -description: Organizes plugin files in correct structure, then uploads as artifact -author: TwinFan - -inputs: - pluginName: - description: "Plugin's name, used both as top-level folder name and as file name as required by X-Plane" - required: true - archFolder: - description: "Subfolder in which the executable is placed, is based on architecture like 'lin_x64'" - required: true - xplFileName: - description: "Path to just built xpl plugin" - required: true - pdbFileName: - description: "Path to just built pdb file" - required: false - -runs: - using: "composite" - steps: - - name: Prepare Deployment Structure # moves the plugin, like "build-lin/lin_x64/MyPlugin.xpl", to a deployment structure like "deploy-MyPlugin/MyPlugin/lin_x64/MyPlugin.xpl" - shell: bash - run: | - mkdir -p "deploy-${{ inputs.pluginName }}/${{ inputs.pluginName }}/${{ inputs.archFolder }}" - mv "${{ inputs.xplFileName }}" "deploy-${{ inputs.pluginName }}/${{ inputs.pluginName }}/${{ inputs.archFolder }}" - if [[ -n "${{ inputs.pdbFileName }}" ]]; then - mv "${{ inputs.pdbFileName }}" "deploy-${{ inputs.pluginName }}/${{ inputs.pluginName }}/${{ inputs.archFolder }}" - fi - - name: Upload plugin - uses: actions/upload-artifact@v2 - with: - name: ${{ inputs.pluginName }} - path: deploy-${{ inputs.pluginName }}/* # this way the top folder in the artifacts is "MyPlugin" - if-no-files-found: error diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0fe03816..1ee40d6c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -4,11 +4,17 @@ on: push: pull_request: branches: [ main ] - workflow_dispatch: # Can also be called manually for whatever reason + workflow_dispatch: # Can also be called manually for whatever reason, e.g. if wanting to build with FMOD sound + inputs: + flags: + description: "Flags to be passed to CMake" + required: false + type: string + default: '-DINCLUDE_FMOD_SOUND=1' # Let's set all project specific definitions globally env: - PRJ_NAME: XPMP2-Remote # The plugin's name, expected to be the .xpl file's name and used as the plugin folder name + PRJ_NAME: XPMP2 jobs: ##################################### @@ -17,32 +23,21 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Code - uses: actions/checkout@v2 # must checkout before we can use our own actions + uses: actions/checkout@v3 # must checkout before we can use our own actions - name: Build uses: ./.github/actions/build-lin id: build with: - pluginName: ${{ env.PRJ_NAME }} - - name: Upload XPMP2-Remote - uses: ./.github/actions/upload-plugin - with: - pluginName: ${{ env.PRJ_NAME }} - archFolder: lin_x64 - xplFileName: "${{ steps.build.outputs.xpl-file-name }}" - - name: Upload XPMP2-Sample - uses: ./.github/actions/upload-plugin - with: - pluginName: XPMP2-Sample - archFolder: lin_x64 - xplFileName: "./build-lin/lin_x64/XPMP2-Sample.xpl" + libName: ${{ env.PRJ_NAME }} + flags: ${{ inputs.flags }} - name: Prepare XPMP2 lib shell: bash run: | mkdir -p deploy-lib/lib/lin cp -a ./inc deploy-lib - mv ./build-lin/libXPMP2.a deploy-lib/lib/lin + mv ${{ steps.build.outputs.lib-file-name }} deploy-lib/lib/lin - name: Upload XPMP2 lib - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: XPMP2-lib path: deploy-lib/* # this way we keep the folder structure in the artifact @@ -54,52 +49,20 @@ jobs: runs-on: macos-latest steps: - name: Checkout Code - uses: actions/checkout@v2 # must checkout before we can use our own actions + uses: actions/checkout@v3 # must checkout before we can use our own actions - name: Build uses: ./.github/actions/build-mac id: build with: - pluginName: ${{ env.PRJ_NAME }} - - name: Check if Secrets available - id: checksecrets - env: - MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }} - shell: bash - run: | - if [ "$MACOS_CERTIFICATE" == "" ]; then - echo ::set-output name=secretspresent:: - else - echo ::set-output name=secretspresent::true - fi - - name: Codesign and Notarization - if: ${{ steps.checksecrets.outputs.secretspresent }} - uses: ./.github/actions/sign-notarize - with: - xplFileName: ${{ steps.build.outputs.xpl-file-name }} - certificate: ${{ secrets.MACOS_CERTIFICATE }} - certPwd: ${{ secrets.MACOS_CERT_PWD }} - notarizeUser: ${{ secrets.NOTARIZATION_USERNAME }} - notarizeTeam: ${{ secrets.NOTARIZATION_TEAM }} - notarizeAppPwd: ${{ secrets.NOTARIZATION_PASSWORD }} - - name: Upload XPMP2-Remote - uses: ./.github/actions/upload-plugin - with: - pluginName: ${{ env.PRJ_NAME }} - archFolder: mac_x64 - xplFileName: ${{ steps.build.outputs.xpl-file-name }} - - name: Upload XPMP2-Sample - uses: ./.github/actions/upload-plugin - with: - pluginName: XPMP2-Sample - archFolder: mac_x64 - xplFileName: "./build-mac/mac_x64/XPMP2-Sample.xpl" + libName: ${{ env.PRJ_NAME }} + flags: ${{ inputs.flags }} - name: Prepare XPMP2 Framework shell: bash run: | mkdir -p deploy-lib/lib - mv ./build-mac/XPMP2.framework deploy-lib/lib + mv ${{ steps.build.outputs.lib-file-name }} deploy-lib/lib - name: Upload XPMP2 Framework - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: XPMP2-lib path: deploy-lib/* # this way we keep the folder structure in the artifact @@ -111,33 +74,20 @@ jobs: runs-on: windows-2022 steps: - name: Checkout Code - uses: actions/checkout@v2 # must checkout before we can use our own actions + uses: actions/checkout@v3 # must checkout before we can use our own actions - name: Build uses: ./.github/actions/build-win id: build with: - pluginName: ${{ env.PRJ_NAME }} - - name: Upload Artifact - uses: ./.github/actions/upload-plugin - with: - pluginName: ${{ env.PRJ_NAME }} - archFolder: win_x64 - xplFileName: "${{ steps.build.outputs.xpl-file-name }}" - pdbFileName: "${{ steps.build.outputs.pdb-file-name }}" - - name: Upload XPMP2-Sample - uses: ./.github/actions/upload-plugin - with: - pluginName: XPMP2-Sample - archFolder: win_x64 - xplFileName: "./build-win/win_x64/XPMP2-Sample.xpl" - pdbFileName: "./build-win/win_x64/XPMP2-Sample.pdb" + libName: ${{ env.PRJ_NAME }} + flags: ${{ inputs.flags }} - name: Prepare XPMP2 lib shell: bash run: | mkdir -p deploy-lib/lib/win - cp ./build-win/XPMP2.lib deploy-lib/lib/win + cp ${{ steps.build.outputs.lib-file-name }} deploy-lib/lib/win - name: Upload XPMP2 lib - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: XPMP2-lib path: deploy-lib/* # this way we keep the folder structure in the artifact diff --git a/CMakeLists.txt b/CMakeLists.txt index 277963c7..e834566f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -4,6 +4,12 @@ # Targets XPMP2-Remote and XPMP2-Sample are EXCLUDE_FROM_ALL. # If you want to build them you have to explicitely state them on the command line, like # ninja XPMP2-Sample XPMP2-Remote +# +# If you want to build with FMOD sound support, +# 1. Make sure to understand the FMOD license and attribution requirements: +# https://www.fmod.com/licensing +# https://www.fmod.com/attribution +# 2. Define INCLUDE_FMOD_SOUND cache entry, e.g. using `cmake -G Ninja -D INCLUDE_FMOD_SOUND=1 ..` cmake_minimum_required(VERSION 3.16) @@ -23,7 +29,7 @@ else() endif() project(XPMP2 - VERSION 2.50 + VERSION 2.60 DESCRIPTION "Multiplayer library for X-Plane 11 and 12") # Provide compile macros from the above project version definition @@ -33,6 +39,7 @@ add_compile_definitions( XPMP2_VER_MINOR=${PROJECT_VERSION_MINOR} ) +message ("== Building: ${PROJECT_NAME} ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH} ==") message ("Compiler Info:") message ("CMAKE_CXX_COMPILER_ID = ${CMAKE_CXX_COMPILER_ID}") message ("CMAKE_CXX_COMPILER_VERSION = ${CMAKE_CXX_COMPILER_VERSION}") @@ -84,7 +91,7 @@ if (MSVC) add_compile_options(/wd4996 /wd4068) add_compile_definitions(_CRT_SECURE_NO_WARNINGS) else() - add_compile_options(-Wall -Wshadow -Wfloat-equal -Wextra -Wno-deprecated-declarations) + add_compile_options(-Wall -Wshadow -Wextra -Wno-deprecated-declarations) if (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 9.0 AND NOT APPLE) add_compile_options(-Wno-stringop-truncation) endif() @@ -105,7 +112,7 @@ if(CMAKE_BUILD_TYPE MATCHES "Debug") if (MSVC) add_compile_options(/Zi) else() - add_compile_options(-O0 -g) + add_compile_options(-O0 -g -fPIC) endif() else() add_compile_definitions(NDEBUG=1) @@ -122,10 +129,10 @@ else() endif() endif() -# Mingw Threads -if (MINGW) +# Mingw Threads (if not already defined by an outer target) +if (MINGW AND NOT TARGET mingw_stdthreads) option(MINGW_STDTHREADS_GENERATE_STDHEADERS "" ON) - add_subdirectory(XPMP2-Sample/mingw-std-threads) + add_subdirectory(lib/mingw-std-threads) endif() ################################################################################ @@ -170,17 +177,38 @@ target_include_directories(XPMP2 PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/inc PRIVATE - ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/SDK/CHeaders/XPLM + ${CMAKE_CURRENT_SOURCE_DIR}/lib/SDK/CHeaders/XPLM ${CMAKE_CURRENT_SOURCE_DIR}/src ) +# Some files are known to do float comparison, but are good with that +if (NOT MSVC) + set_source_files_properties( + src/Remote.cpp + src/Sound.cpp + PROPERTIES + COMPILE_FLAGS -Wno-float-equal) +endif() + # Include MingW threads if (MINGW) target_link_libraries(XPMP2 mingw_stdthreads) endif() +# FMOD Library support if requested +# (The actual FMOD lib is not included here, that needs to be done by the plugin target) +if(INCLUDE_FMOD_SOUND) + # Compile options + add_compile_definitions(INCLUDE_FMOD_SOUND) + target_include_directories(XPMP2 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/lib/fmod/inc) + target_sources(XPMP2 PRIVATE + src/Sound.h + src/Sound.cpp + ) +endif() + +# make it a framework if(APPLE) - # make it a framework list(APPEND XPMP2_PUB_HEADERS ../inc/XPCAircraft.h ../inc/XPMPAircraft.h @@ -199,191 +227,3 @@ if(APPLE) PUBLIC_HEADER "${XPMP2_PUB_HEADERS}" ) endif() - -# Copy the resulting framework/library also into the 'lib' directory of the sample plugin -if(APPLE) - add_custom_command(TARGET XPMP2 POST_BUILD - COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/lib/XPMP2.framework - COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/lib/XPMP2.framework - COMMAND cp -a $/../.. ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/lib/XPMP2.framework - ) -elseif(UNIX OR WIN32) - add_custom_command(TARGET XPMP2 POST_BUILD - COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/lib/$ENV{platform} - COMMAND ${CMAKE_COMMAND} -E copy $ ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/lib/$ENV{platform} - ) -endif() - -################################################################################ -# XPMP2-Remote plugin -################################################################################ - -# To be able to build here we use header files from the original location. -# And we use the SDK from XPMP2-Sample so that we don't need to keep 2 copies. -add_library(XPMP2-Remote MODULE EXCLUDE_FROM_ALL - # Public XPMP2 header files, usually taken from the XPMP2 framework - inc/XPCAircraft.h - inc/XPMPAircraft.h - inc/XPMPMultiplayer.h - inc/XPMPRemote.h - inc/XPMPPlaneRenderer.h - # X-Plane SDK - XPMP2-Sample/SDK/CHeaders/XPLM/XPLMDataAccess.h - XPMP2-Sample/SDK/CHeaders/XPLM/XPLMUtilities.h - XPMP2-Sample/SDK/CHeaders/XPLM/XPLMPlugin.h - XPMP2-Sample/SDK/CHeaders/XPLM/XPLMGraphics.h - XPMP2-Sample/SDK/CHeaders/XPLM/XPLMMenus.h - # actual XPMP2-Remote client code - XPMP2-Remote/Client.h - XPMP2-Remote/Client.cpp - XPMP2-Remote/Utilities.h - XPMP2-Remote/Utilities.cpp - XPMP2-Remote/XPMP2-Remote.h - XPMP2-Remote/XPMP2-Remote.cpp -) - -# Header include directories -target_include_directories(XPMP2-Remote PRIVATE - ${CMAKE_CURRENT_SOURCE_DIR}/inc - ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/SDK/CHeaders/XPLM - ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Remote -) - -# Which depends on XPMP2 -add_dependencies(XPMP2-Remote XPMP2) - -# Link to the just built XPMP2 library -target_link_libraries(XPMP2-Remote XPMP2) - -# Link X-Plane plugin system libraries. They are only provided for OS X and Windows. -if (WIN32 OR APPLE) - # Specify library search location for X-Plane SDK - if (APPLE) - list(APPEND CMAKE_FRAMEWORK_PATH "${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/SDK/Libraries/Mac") - else () - list(APPEND CMAKE_LIBRARY_PATH "${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/SDK/Libraries/Win") - endif () - find_library(XPLM_LIBRARY XPLM REQUIRED NAMES XPLM XPLM_64.lib) - target_link_libraries(XPMP2-Remote ${XPLM_LIBRARY}) -endif () - -if (WIN32) - # Link with winsock for network and iphlpap for GetAdaptersAddresses - target_link_libraries(XPMP2-Remote wsock32 ws2_32 iphlpapi) - if (MINGW) - # Include MingW threads - target_link_libraries(XPMP2-Remote mingw_stdthreads) - # When cross-compiling we link the standard libraries statically - target_link_options(XPMP2-Remote PRIVATE -static-libgcc -static-libstdc++) - endif() -elseif (APPLE) - # Link OS X core system libraries. - find_library(IOKIT_LIBRARY IOKit REQUIRED) - find_library(CORE_FOUNDATION_LIBRARY CoreFoundation REQUIRED) - target_link_libraries(XPMP2-Remote ${IOKIT_LIBRARY} ${CORE_FOUNDATION_LIBRARY}) - # Restrict set of symbols exported from the plugin to the ones required by XPLM: - target_link_options(XPMP2-Remote PRIVATE "-exported_symbols_list ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/XPMP2-Sample.sym_mac") -elseif (UNIX) - # Link library for dynamic loading of shared objects on UNIX systems. - find_library(DL_LIBRARY dl REQUIRED) - # Threads - set(CMAKE_THREAD_PREFER_PTHREAD TRUE) - set(THREADS_PREFER_PTHREAD_FLAG TRUE) - find_package(Threads REQUIRED) - target_link_libraries(XPMP2-Remote ${DL_LIBRARY} Threads::Threads) - # Specify additional runtime search paths for dynamically-linked libraries. - # Restrict set of symbols exported from the plugin to the ones required by XPLM: - target_link_options(XPMP2-Remote PRIVATE -Wl,--version-script -Wl,${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/XPMP2-Sample.sym) -endif () - - -# Target directory and file name -if (WIN32) - set_target_properties(XPMP2-Remote PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/win_x64") -elseif (APPLE) - set_target_properties(XPMP2-Remote PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/mac_x64") -elseif (UNIX) - set_target_properties(XPMP2-Remote PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lin_x64") -endif () - -set_target_properties(XPMP2-Remote PROPERTIES - PREFIX "" - OUTPUT_NAME "XPMP2-Remote" - SUFFIX ".xpl" -) - - -################################################################################ -# XPMP2-Sample plugin -################################################################################ - -# To be able to build here we use header files from the original location. -add_library(XPMP2-Sample MODULE EXCLUDE_FROM_ALL - # Public XPMP2 header files, usually taken from the XPMP2 framework - inc/XPCAircraft.h - inc/XPMPAircraft.h - inc/XPMPMultiplayer.h - inc/XPMPRemote.h - inc/XPMPPlaneRenderer.h - # X-Plane SDK - XPMP2-Sample/SDK/CHeaders/XPLM/XPLMDataAccess.h - XPMP2-Sample/SDK/CHeaders/XPLM/XPLMUtilities.h - XPMP2-Sample/SDK/CHeaders/XPLM/XPLMPlugin.h - XPMP2-Sample/SDK/CHeaders/XPLM/XPLMGraphics.h - XPMP2-Sample/SDK/CHeaders/XPLM/XPLMMenus.h - # actual XPMP2-Sample code - XPMP2-Sample/XPMP2-Sample.cpp -) - -# Header include directories -target_include_directories(XPMP2-Sample PRIVATE - ${CMAKE_CURRENT_SOURCE_DIR}/inc - ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/SDK/CHeaders/XPLM - ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Remote -) - -# Which depends on XPMP2 -add_dependencies(XPMP2-Sample XPMP2) - -# Link to the just built XPMP2 library -target_link_libraries(XPMP2-Sample XPMP2) - -# Link X-Plane plugin system libraries. They are only provided for OS X and Windows. -if (WIN32 OR APPLE) - target_link_libraries(XPMP2-Sample ${XPLM_LIBRARY}) -endif () - -if (WIN32) - # Link with winsock for network and iphlpapi for GetAdaptersAddresses - target_link_libraries(XPMP2-Sample wsock32 ws2_32 iphlpapi) - if (MINGW) - # Include MingW threads - target_link_libraries(XPMP2-Sample mingw_stdthreads) - # When cross-compiling we link the standard libraries statically - target_link_options(XPMP2-Sample PRIVATE -static-libgcc -static-libstdc++) - endif() -elseif (APPLE) - target_link_libraries(XPMP2-Sample ${IOKIT_LIBRARY} ${CORE_FOUNDATION_LIBRARY}) - # Restrict set of symbols exported from the plugin to the ones required by XPLM: - target_link_options(XPMP2-Sample PRIVATE "-exported_symbols_list ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/XPMP2-Sample.sym_mac") -elseif (UNIX) - target_link_libraries(XPMP2-Sample ${DL_LIBRARY} Threads::Threads) - # Restrict set of symbols exported from the plugin to the ones required by XPLM: - target_link_options(XPMP2-Sample PRIVATE -Wl,--version-script -Wl,${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample/XPMP2-Sample.sym) -endif () - -# Target directory and file name -if (WIN32) - set_target_properties(XPMP2-Sample PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/win_x64") -elseif (APPLE) - set_target_properties(XPMP2-Sample PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/mac_x64") -elseif (UNIX) - set_target_properties(XPMP2-Sample PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lin_x64") -endif () - -set_target_properties(XPMP2-Sample - PROPERTIES - PREFIX "" - OUTPUT_NAME "XPMP2-Sample" - SUFFIX ".xpl" -) diff --git a/Info.plist b/Info.plist index 4ac0f5c7..39c60c1b 100644 --- a/Info.plist +++ b/Info.plist @@ -19,6 +19,6 @@ CFBundleVersion $(CURRENT_PROJECT_VERSION) NSHumanReadableCopyright - Copyright © 2020 B. Hoppe. All rights reserved. + Copyright © 2022 B. Hoppe. All rights reserved. diff --git a/README.md b/README.md index 479f59eb..6c4e2cc1 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,9 @@ to stay backward compatible. The XPMP2 library has been successfully tested with - X-Plane 11.5x under OpenGL, Vulkan, and Metal, -- X-Plane 12 Alpha and Beta version, -- the enclosed [XPMP2 Remote Client](#XPMP2-Remote-Client-Synchronizing-Planes-across-the-Network), -- the enclosed sample plugin, +- X-Plane 12 Alpha and Beta versions, +- the [XPMP2 Remote Client](#XPMP2-Remote-Client-Synchronizing-Planes-across-the-Network), +- the [`XPMP2-Sample` plugin](https://github.com/TwinFan/XPMP2-Remote), - [LiveTraffic v2.20](https://forums.x-plane.org/index.php?/files/file/49749-livetraffic/) - [X-Pilot 1.3](http://xpilot-project.org/) - X-Plane version of [IVAO Altitude](https://www.ivao.aero/softdev/beta/altitudebeta.asp) @@ -67,6 +67,8 @@ The XPMP2 library has been successfully tested with - XPMP2 implements [instancing](https://developer.x-plane.com/sdk/XPLMInstance/), so it **requires X-Plane 11.10** or later - CSL models in **OBJ8 format** (ie. older OBJ7 models are no longer supported) +- Potentially an FMOD license if built with sound support, see below in + [Sound Support by FMOD](#sound-support-by-fmod) ## Documentation: See [GitHub pages](https://twinfan.github.io/XPMP2/) ## @@ -76,9 +78,10 @@ and more is available in the ### Sample Plugin ### -This package comes with a sample plugin in the `XPMP2-Sample` folder. It is a complete -plugin including build projects and CMake setup. It displays 3 aircraft flying circles -in front of the user's plane. Each of the 3 aircraft is using a different technology: +The separate _Public Template_ repository `XPMP2-Sample` provides a complete +plugin including build projects and CMake setup and can be the basis for your plugin project. +It displays 3 aircraft flying circles in front of the user's plane. +Each of the 3 aircraft is using a different technology: the now recommended way of subclassing `XPMP2::Aircraft`, the legacy way of subclassing `XPCAircraft` (as used by LiveTraffic v1.x), and by calling standard C functions. @@ -134,6 +137,21 @@ precice results. Find [more details here](https://twinfan.github.io/XPMP2/Wake.html). +### Sound Support by FMOD ### + +All displayed aircraft can produce sound in the 3D world for +engine, reversers, taxiing, gear and flap movement. + +XPMP2's Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. +Understand FMOD [licensing](https://www.fmod.com/licensing) and +[attribution requirements](https://www.fmod.com/attribution) first, +as they will apply to _your_ plugin if using XPMP2 with sound support. + +Because of the licensing requirements, XPMP2 by default is built +**without** sound support. +See the [Sound Support documentation](https://twinfan.github.io/XPMP2/Sound.html) +for details how to enable sound support and how to include it into your plugin. + ### Map Layer ### XPMP2 creates an additional layer in X-Plane's internal map, named after the diff --git a/XPMP2-Remote/Client.cpp b/XPMP2-Remote/Client.cpp deleted file mode 100755 index 4397fdbb..00000000 --- a/XPMP2-Remote/Client.cpp +++ /dev/null @@ -1,636 +0,0 @@ -/// @file Client.cpp -/// @brief Main Client functionality, processing received data -/// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -#include "XPMP2-Remote.h" - -#define INFO_NEW_SENDER_PLUGIN "First data received from %.*s (%u) @ %s" -#define INFO_SENDER_PLUGIN_LOST "Sender %.*s (%u) @ %s fell silent, removed" -#define WARN_LOST_PLANE_CONTACT "Lost contact to plane 0x%06X of %.*s (%u) @ %s" -#define INFO_GOT_AI_CONTROL "Have TCAS / AI control now" -#define INFO_DEACTIVATED "Deactivated, stopped listening to network" - -// -// MARK: Aircraft Administration -// - -/// Contains 'now' at the time the flight loop starts -std::chrono::time_point nowFlightLoop; - -// Constructor for use in network thread: Does _not_ Create the aircraft but only stores the passed information -RemoteAC::RemoteAC (SenderTy& _sender, const XPMP2::RemoteAcDetailTy& _acDetails) : -XPMP2::Aircraft(), // do _not_ create an actual plane! -senderId(_acDetails.modeS_id), -pkgHash(_acDetails.pkgHash), -sShortId(STR_N(_acDetails.sShortId)), -sender(_sender) -{ - // Initialization - histPos[0] = {sizeof(XPLMDrawInfo_t), NAN, NAN, NAN, 0.0f, 0.0f, 0.0f}; - histPos[1] = histPos[0]; - - // store the a/c detail information - Update(_acDetails); -} - -// Destructor -RemoteAC::~RemoteAC() -{} - -// Actually create the aircraft, ultimately calls XPMP2::Aircraft::Create() -void RemoteAC::Create () -{ - // Create the actual plane - Aircraft::Create(acIcaoType, acIcaoAirline, acLivery, senderId, "", - XPMP2::CSLModelByPkgShortId(pkgHash, sShortId)); - bCSLModelChanged = false; -} - -// Update data from a a/c detail structure -void RemoteAC::Update (const XPMP2::RemoteAcDetailTy& _acDetails) -{ - acIcaoType = STR_N(_acDetails.icaoType); - acIcaoAirline = STR_N(_acDetails.icaoOp); - acLivery.clear(); - - // CSL Model: Did it change? (Will be set during UpdatePosition()) - bCSLModelChanged = (pkgHash != _acDetails.pkgHash) || (sShortId != _acDetails.sShortId); - if (bCSLModelChanged) { - pkgHash = _acDetails.pkgHash; - sShortId = _acDetails.sShortId; - } - - label = STR_N(_acDetails.label); - _acDetails.GetLabelCol(colLabel); - // Labels are forced on if our local config says so - bDrawLabel = _acDetails.bDrawLabel || (rcGlob.eDrawLabels == XPMP2RCGlobals::LABELS_ON); - - // We might be in a worker thread...only temporarily store the position - lat = _acDetails.lat; - lon = _acDetails.lon; - alt_ft = double(_acDetails.alt_ft); - diffTime = std::chrono::duration>(_acDetails.dTime); - bWorldCoordUpdated = true; // flag for UpdatePosition() to read fresh data - - drawInfo.pitch = _acDetails.GetPitch(); - drawInfo.heading = _acDetails.GetHeading(); - drawInfo.roll = _acDetails.GetRoll(); - aiPrio = _acDetails.aiPrio; - bOnGrnd = _acDetails.bOnGrnd; - - // Info texts -#if defined(__GNUC__) && (__GNUC__ >= 9) -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wclass-memaccess" -#endif - std::memset(&acInfoTexts, 0, sizeof(acInfoTexts)); -#if defined(__GNUC__) && (__GNUC__ >= 9) -#pragma GCC diagnostic pop -#endif -#define memcpy_min(to,from) std::memcpy(to,from,std::min(sizeof(from),sizeof(to))) - memcpy_min(acInfoTexts.tailNum, _acDetails.tailNum); - memcpy_min(acInfoTexts.icaoAcType, _acDetails.icaoType); - memcpy_min(acInfoTexts.manufacturer, _acDetails.manufacturer); - memcpy_min(acInfoTexts.model, _acDetails.model); - memcpy_min(acInfoTexts.icaoAirline, _acDetails.icaoOp); - memcpy_min(acInfoTexts.airline, _acDetails.airline); - memcpy_min(acInfoTexts.flightNum, _acDetails.flightNum); - memcpy_min(acInfoTexts.aptFrom, _acDetails.aptFrom); - memcpy_min(acInfoTexts.aptTo, _acDetails.aptTo); - - // Don't render local planes (the local plugin does already), - // or if explicitely instructed so by the sender - SetRender(sender.bLocal ? false : _acDetails.bRender); - - // Validity and Visibility - SetVisible(_acDetails.bVisible); - if (!_acDetails.bValid) - SetInvalid(); - - // Animation dataRefs - for (size_t i = 0; i < XPMP2::V_COUNT; ++i) - v[i] = XPMP2::REMOTE_DR_DEF[i].unpack(_acDetails.v[i]); -/* - LOG_MSG(logDEBUG, " 0x%06X: %.7f / %.7f, %.1f", - GetModeS_ID(), lat, lon, alt_ft);*/ -} - -// Update data from an a/c position update -void RemoteAC::Update (const XPMP2::RemoteAcPosUpdateTy& _acPosUpd) -{ - // Update position information based on diff values in the position update - lat += XPMP2::REMOTE_DEGREE_RES * double(_acPosUpd.dLat); - lon += XPMP2::REMOTE_DEGREE_RES * double(_acPosUpd.dLon); - alt_ft += XPMP2::REMOTE_ALT_FT_RES * double(_acPosUpd.dAlt_ft); - diffTime = std::chrono::duration>(_acPosUpd.dTime); - bWorldCoordUpdated = true; // flag for UpdatePosition() to read fresh data - - drawInfo.pitch = _acPosUpd.GetPitch(); - drawInfo.heading = _acPosUpd.GetHeading(); - drawInfo.roll = _acPosUpd.GetRoll(); -/* - LOG_MSG(logDEBUG, "0x%06X: %.7f / %.7f, %.1f <-- %+.7f / %+.7f, %+.1f", - GetModeS_ID(), lat, lon, alt_ft, - _acPosUpd.dLat * XPMP2::REMOTE_DEGREE_RES, - _acPosUpd.dLon * XPMP2::REMOTE_DEGREE_RES, - _acPosUpd.dAlt_ft * XPMP2::REMOTE_ALT_FT_RES); */ -} - -// Update data from an a/c animation dataRefs message -void RemoteAC::Update (const XPMP2::RemoteAcAnimTy& _acAnim) -{ - // Loop over all includes values and update the respective dataRef values - for (std::uint8_t idx = 0; idx < _acAnim.numVals; ++idx) { - const XPMP2::RemoteAcAnimTy::DataRefValTy& dr = _acAnim.v[idx]; - v[dr.idx] = XPMP2::REMOTE_DR_DEF[dr.idx].unpack(dr.v); - } -} - -// Called by XPMP2 for position updates, extrapolates from historic positions -void RemoteAC::UpdatePosition (float _elapsed, int) -{ - // Did the CSL model change? - if (bCSLModelChanged) { - bCSLModelChanged = false; - XPMP2::CSLModel *pNewCSLModel = XPMP2::CSLModelByPkgShortId(pkgHash, sShortId); - if (pNewCSLModel && pNewCSLModel != pCSLMdl) - AssignModel("", pNewCSLModel); - } - - // If we have a fresh world position then that's the one that counts - if (bWorldCoordUpdated) { - SetLocation(lat, lon, alt_ft); // Convert to local, stored in drawInfo - bWorldCoordUpdated = false; - - // cycle the historic positions and save the new one - histPos[0] = histPos[1]; - histPos[1] = drawInfo; - // Timestamp: This one [1] is valid _now_ - histTs[1] = nowFlightLoop; - histTs[0] = histTs[1] - diffTime; - - // Special handling for heading as [0] and [1] could be on different sides of 0 / 360 degrees: - // We push things towards positive figures larger than 360 - // as we can then just use fmod(h,360) and don't care about negatives - if (histPos[0].heading >= 360.0f) // if we increased the value last time we need to normalize it before re-calculation - histPos[0].heading -= 360.0f; - const float diffHead = histPos[0].heading - histPos[1].heading; - if (diffHead > 180.0f) - histPos[1].heading += 360.0f; - else if (diffHead < -180.0f) - histPos[0].heading += 360.0f; - } - // extrapolate based on last 2 positions if 2 positions are known with differing timestamps - else if (!std::isnan(histPos[0].x) && histTs[1] > histTs[0]) { - const std::chrono::steady_clock::duration dHist = histTs[1] - histTs[0]; - const std::chrono::steady_clock::duration dNow = nowFlightLoop - histTs[0]; - - // We extrapolate only for a maximum of 1s, after that planes just stop - // (If the sender is, e.g., stuck in an X-Plane dialog then that sender - // will not send position updates, so stopping is fairly close to reality.) - if (dNow - dHist <= std::chrono::seconds(1)) { - try { - const float f = float(dNow.count()) / float(dHist.count()); - drawInfo.x = histPos[0].x + f * (histPos[1].x - histPos[0].x); - drawInfo.y = histPos[0].y + f * (histPos[1].y - histPos[0].y); - drawInfo.z = histPos[0].z + f * (histPos[1].z - histPos[0].z); - drawInfo.pitch = histPos[0].pitch + f * (histPos[1].pitch - histPos[0].pitch); - drawInfo.heading = std::fmod(histPos[0].heading + f * (histPos[1].heading - histPos[0].heading), 360.0f); - drawInfo.roll = histPos[0].roll + f * (histPos[1].roll - histPos[0].roll); - -/* LOG_MSG(logDEBUG, "0x%06X: %.2f / %.2f / %.2f ==> %+8.2f / %+8.2f / %+8.2f [%.4f]", - GetModeS_ID(), drawInfo.x, drawInfo.y, drawInfo.z, - drawInfo.x-prevDraw.x, - drawInfo.y-prevDraw.y, - drawInfo.z-prevDraw.z, f); */ - } - catch (...) { - drawInfo = histPos[1]; - } - } else { - // This plane has no updates...but the sender is updated? - // Then we lost contact to this plane and shall remove it - if (nowFlightLoop - sender.lastMsg < std::chrono::milliseconds(500)) { - LOG_MSG(logWARN, WARN_LOST_PLANE_CONTACT, senderId, - (int)sizeof(sender.settings.name), sender.settings.name, - sender.settings.pluginId, sender.sFrom.c_str()); - SetInvalid(); - } - } - } - - // Special handling for rotational dataRefs: - // These are the only ones we move ourselves as they need to keep going every frame - // for good looks. - // Idea: Turn them based on defined speed - if (GetTireRotRpm() > 1.0f) SetTireRotAngle(std::fmod(GetTireRotAngle() + GetTireRotRpm()/60.0f * _elapsed * 360.0f, 360.0f)); - if (GetEngineRotRpm() > 1.0f) SetEngineRotAngle(std::fmod(GetEngineRotAngle() + GetEngineRotRpm()/60.0f * _elapsed * 360.0f, 360.0f)); - for (size_t i = 1; i <= 4; i++) - if (GetEngineRotRpm(i) > 1.0f) SetEngineRotAngle(i, std::fmod(GetEngineRotAngle(i) + GetEngineRotRpm(i)/60.0f * _elapsed * 360.0f, 360.0f)); - if (GetPropRotRpm() > 1.0f) SetPropRotAngle(std::fmod(GetPropRotAngle() + GetPropRotRpm()/60.0f * _elapsed * 360.0f, 360.0f)); -} - -// -// MARK: Sender Administration -// - -// uses memcmp to compare sender addresses -bool SenderAddrTy::operator< (const SenderAddrTy& o) const -{ - return memcmp(this, &o, sizeof(*this)) < 0; -} - -// Constructor copies values and sets lastMsg to now -SenderTy::SenderTy (const std::string& _from, const XPMP2::RemoteMsgSettingsTy& _s) : -sFrom(_from), bLocal(_s.bLocalSender), -settings(_s), lastMsg(std::chrono::steady_clock::now()) -{ - // Remove port number from IP adress - const size_t posColon = sFrom.rfind(':'); - if (posColon != std::string::npos) - sFrom.erase(posColon); -} - -// Find a sender based on plugin id and IP address -SenderTy* SenderTy::Find (XPLMPluginID _id, const std::uint32_t _from[4]) -{ - SenderAddrTy senderId (_id, _from); - mapSenderTy::iterator itSender = rcGlob.gmapSender.find(senderId); - if (itSender != rcGlob.gmapSender.end()) - return &itSender->second; - return nullptr; -} - -// -// MARK: Process Messages -// - -bool bWaitingForAI = false; ///< have we requested AI access and are now waiting for a callback? -std::mutex gmutexData; ///< the mutex controlling access to all data between network and main thread -/// The lock used by _main thread_ functions to acquire data access -std::unique_lock glockDataMain(gmutexData, std::defer_lock); -/// Indicates if it is needed in the main thread to process updates to settings -std::atomic_flag gbSkipSettingsUpdate = ATOMIC_FLAG_INIT; -/// Indicates if it is needed in the main thread to process new aircraft -std::atomic_flag gbSkipAcMaintenance = ATOMIC_FLAG_INIT; - -void ClientTryGetAI (); - -/// Callback for requesting TCAS: Maybe now we have a chance? -void ClientCBRetryGetAI (void*) -{ - bWaitingForAI = false; - - // If we still want to have TCAS we just try again - if (rcGlob.mergedS.bHaveTCASControl && !XPMPHasControlOfAIAircraft()) - ClientTryGetAI(); -} - -// Try getting TCAS/AI control -void ClientTryGetAI () -{ - // make sure we do this from the main thread only! - assert (rcGlob.IsXPThread()); - - // no need to try (again)? - if (bWaitingForAI || XPMPHasControlOfAIAircraft()) - return; - - // Try getting AI control, pass callback for the case we couldn't get it - const char* cszResult = XPMPMultiplayerEnable(ClientCBRetryGetAI); - if ( cszResult[0] ) { - bWaitingForAI = true; - LOG_MSG(logWARN, "%s", cszResult); - } else if (XPMPHasControlOfAIAircraft()) { - bWaitingForAI = false; - LOG_MSG(logINFO, INFO_GOT_AI_CONTROL); - } -} - -// Stop TCAS/AI control -void ClientReleaseAI () -{ - XPMPMultiplayerDisable(); - bWaitingForAI = false; -} - -/// @brief Handles a received Settings message, which also identifies a sending plugin -/// @details 1. Plugin information is stored in gmapSender. -/// 2. A "merged" version of all sender plugins' settings is created, -/// make a per-field decision for the more significant value. -/// This merged version shall become our local settings. -/// 3. In a last step the changes to current actual settings are determined -/// and necessary action taken. -void ClientProcSettings (const std::uint32_t from[4], - const std::string& sFrom, - const XPMP2::RemoteMsgSettingsTy& _msgSettings) -{ - // Require access - std::lock_guard lk(gmutexData); - - // 1. Store sender information - SenderTy* pSender = SenderTy::Find(_msgSettings.pluginId, from); - if (!pSender) { - // Seeing this plugin the first time! - LOG_MSG(logINFO, INFO_NEW_SENDER_PLUGIN, - (int)sizeof(_msgSettings.name), _msgSettings.name, - _msgSettings.pluginId, - (_msgSettings.bLocalSender ? sFrom + " (local)" : sFrom).c_str()); - rcGlob.gmapSender.emplace(std::piecewise_construct, - std::forward_as_tuple(_msgSettings.pluginId, from), - std::forward_as_tuple(sFrom, _msgSettings)); - - // If this one also happens to be the first plugin at all then it defines - // some settings that cannot be well merged - if (rcGlob.gmapSender.size() == 1) { - // packed config structure does not have zero-termination - std::string defAc = STR_N(_msgSettings.defaultIcao); - std::string defCar = STR_N(_msgSettings.carIcaoType); - XPMPSetDefaultPlaneICAO(defAc.c_str(), defCar.c_str()); - } - } - else - { - // plugin is known, update its settings - pSender->settings = _msgSettings; - pSender->lastMsg = std::chrono::steady_clock::now(); - } - - // 2. Consolidate/merge the settings of all plugins - mapSenderTy::iterator itSender = rcGlob.gmapSender.begin(); - LOG_ASSERT(itSender != rcGlob.gmapSender.end()); - rcGlob.mergedS = itSender->second.settings; - for (++itSender; itSender != rcGlob.gmapSender.end(); ++itSender) - { - const XPMP2::RemoteMsgSettingsTy& otherS = itSender->second.settings; - if (otherS.logLvl < rcGlob.mergedS.logLvl) rcGlob.mergedS.logLvl = otherS.logLvl; - if ( otherS.bLogMdlMatch) rcGlob.mergedS.bLogMdlMatch = true; - if ( otherS.bObjReplDataRefs) rcGlob.mergedS.bLogMdlMatch = true; - if ( otherS.bObjReplTextures) rcGlob.mergedS.bLogMdlMatch = true; - if (!otherS.bLabelCutOffAtVisibility) rcGlob.mergedS.bLabelCutOffAtVisibility = false; - if ( otherS.bMapEnabled) rcGlob.mergedS.bMapEnabled = true; - if ( otherS.bMapLabels) rcGlob.mergedS.bMapLabels = true; - if ( otherS.bHaveTCASControl) rcGlob.mergedS.bHaveTCASControl = true; - } - - // 3. Take action based on whatever settings differ between mergedS and my current settings - XPMPSetAircraftLabelDist(rcGlob.mergedS.maxLabelDist / XPMP2::M_per_NM, - rcGlob.mergedS.bLabelCutOffAtVisibility); - // The next flight loop cycle needs to update some stuff - gbSkipSettingsUpdate.clear(); -} - -// Called at the beginning of each flight loop processing: Get the data lock, create waiting planes -void ClientFlightLoopBegins () -{ - // Any main thread stuff to do due to settings updates? - if (!gbSkipSettingsUpdate.test_and_set()) { - XPMPEnableMap(rcGlob.mergedS.bMapEnabled, - rcGlob.mergedS.bMapLabels); - if (rcGlob.mergedS.bHaveTCASControl) - ClientTryGetAI(); - } - - // Store current time once for all position calculations - nowFlightLoop = std::chrono::steady_clock::now(); - - // Acquire the data access lock once and keep it while the flight loop is running - if (!glockDataMain) - glockDataMain.lock(); - - // Every 10 seconds clean up outdated senders - static float lastSenderCleanup = 0; - if (GetMiscNetwTime() - lastSenderCleanup > 10.0f) { - lastSenderCleanup = GetMiscNetwTime(); - for (mapSenderTy::iterator sIter = rcGlob.gmapSender.begin(); - sIter != rcGlob.gmapSender.end();) - { - const SenderTy& sdr = sIter->second; - if (nowFlightLoop - sdr.lastMsg > std::chrono::seconds(2 * XPMP2::REMOTE_SEND_SETTINGS_INTVL)) { - LOG_MSG(logINFO, INFO_SENDER_PLUGIN_LOST, - (int)sizeof(sdr.settings.name), sdr.settings.name, - sdr.settings.pluginId, sdr.sFrom.c_str()); - sIter = rcGlob.gmapSender.erase(sIter); - } - else - sIter++; - } - } - - // If needed create new or remove deleted aircraft that have been prepared in the meantime - if (gbSkipAcMaintenance.test_and_set()) { - for (auto& s: rcGlob.gmapSender) { // loop all senders - // loop all a/c of that sender - mapRemoteAcTy::iterator acIter = s.second.mapAc.begin(); - while (acIter != s.second.mapAc.end()) { - // a/c to be deleted? - if (acIter->second.IsToBeDeleted()) - acIter = s.second.mapAc.erase(acIter); - // create a/c if not created - else if (acIter->second.GetModeS_ID() == 0) - (acIter++)->second.Create(); - else - acIter++; - } - } - } -} - -// Called at the end of each flight loop processing: Release the data lock -void ClientFlightLoopEnds () noexcept -{ - // Release the data access lock - try { glockDataMain.unlock(); } - catch(...) { /* ignore all errors */ } -} - -/// @brief Handle A/C Details messages, called by XPMP2 via callback -/// @details 1. If the aircraft does not exist create it -/// 2. Else update it's data -void ClientProcAcDetails (const std::uint32_t _from[4], size_t _msgLen, - const XPMP2::RemoteMsgAcDetailTy& _msgAcDetails) -{ - // Find the sender, bail if we don't know it - SenderTy* pSender = SenderTy::Find(_msgAcDetails.pluginId, _from); - if (!pSender) return; - pSender->lastMsg = std::chrono::steady_clock::now(); - - // Loop over all aircraft contained in the message - const size_t numAc = _msgAcDetails.NumElem(_msgLen); - for (size_t i = 0; i < numAc; ++i) { - const XPMP2::RemoteAcDetailTy& acDetails = _msgAcDetails.arr[i]; - // Is the aircraft known? - mapRemoteAcTy::iterator iAc = pSender->mapAc.find(acDetails.modeS_id); - // Now require access (for each plane, because we want to give the main thread's flight loop a better change to grab the lock if needed) - std::unique_lock lk(gmutexData); - // Is the aircraft known? - if (iAc == pSender->mapAc.end()) { - // new aircraft, create an object for it, but not yet the actual plane (as this is the network thread) - pSender->mapAc.emplace(std::piecewise_construct, - std::forward_as_tuple(acDetails.modeS_id), - std::forward_as_tuple(*pSender, acDetails)); - // tell the main thread that it shall process new a/c - gbSkipAcMaintenance.clear(); - } else { - // known aircraft, update its data - iAc->second.Update(acDetails); - } - lk.unlock(); - } -} - -/// Handle A/C Position Update message, called by XPMP2 via callback -void ClientProcAcPosUpdate (const std::uint32_t _from[4], size_t _msgLen, - const XPMP2::RemoteMsgAcPosUpdateTy& _msgAcPosUpdate) -{ - // Find the sender, bail if we don't know it - SenderTy* pSender = SenderTy::Find(_msgAcPosUpdate.pluginId, _from); - if (!pSender) return; - pSender->lastMsg = std::chrono::steady_clock::now(); - - // Loop over all aircraft contained in the message - const size_t numAc = _msgAcPosUpdate.NumElem(_msgLen); - for (size_t i = 0; i < numAc; ++i) { - const XPMP2::RemoteAcPosUpdateTy& acPosUpd = _msgAcPosUpdate.arr[i]; - // Is the aircraft known? - mapRemoteAcTy::iterator iAc = pSender->mapAc.find(XPMPPlaneID(acPosUpd.modeS_id)); - if (iAc != pSender->mapAc.end()) { - // Now require access (for each plane, because we want to give the main thread's flight loop a better change to grab the lock if needed) - std::lock_guard lk(gmutexData); - // known aircraft, update its data - iAc->second.Update(acPosUpd); - } - } - -} - -/// Handle A/C Animation dataRef messages, called by XPMP2 via callback -void ClientProcAcAnim (const std::uint32_t _from[4], size_t _msgLen, - const XPMP2::RemoteMsgAcAnimTy& _msgAcAnim) -{ - // Find the sender, bail if we don't know it - SenderTy* pSender = SenderTy::Find(_msgAcAnim.pluginId, _from); - if (!pSender) return; - pSender->lastMsg = std::chrono::steady_clock::now(); - - // Loop all animation data elements in the message - for (const XPMP2::RemoteAcAnimTy* pAnim = _msgAcAnim.next(_msgLen); - pAnim; - pAnim = _msgAcAnim.next(_msgLen, pAnim)) - { - // Is the aircraft known? - mapRemoteAcTy::iterator iAc = pSender->mapAc.find(XPMPPlaneID(pAnim->modeS_id)); - if (iAc != pSender->mapAc.end()) { - // Now require access (for each plane, because we want to give the main thread's flight loop a better change to grab the lock if needed) - std::lock_guard lk(gmutexData); - // known aircraft, update its data - iAc->second.Update(*pAnim); - } - } -} - -/// Handle A/C Removal message, called by XPMP2 via callback -void ClientProcAcRemove (const std::uint32_t _from[4], size_t _msgLen, - const XPMP2::RemoteMsgAcRemoveTy& _msgAcRemove) -{ - // Find the sender, bail if we don't know it - SenderTy* pSender = SenderTy::Find(_msgAcRemove.pluginId, _from); - if (!pSender) return; - pSender->lastMsg = std::chrono::steady_clock::now(); - - // Loop over all aircraft contained in the message - const size_t numAc = _msgAcRemove.NumElem(_msgLen); - for (size_t i = 0; i < numAc; ++i) { - const XPMP2::RemoteAcRemoveTy& acRemove = _msgAcRemove.arr[i]; - // Is the aircraft known? - mapRemoteAcTy::iterator iAc = pSender->mapAc.find(XPMPPlaneID(acRemove.modeS_id)); - if (iAc != pSender->mapAc.end()) { - // Now require access (for each plane, because we want to give the main thread's flight loop a better change to grab the lock if needed) - std::lock_guard lk(gmutexData); - // mark this a/c for deletion (which must happen in XP's main thread) - iAc->second.MarkForDeletion(); - // tell the main thread that it shall process removed a/c - gbSkipAcMaintenance.clear(); - } - } -} - - - -// -// MARK: Global Functions -// - -// Initializes the module -void ClientInit() -{ - // Initialize the atomic flags to 'set' - gbSkipSettingsUpdate.test_and_set(); - gbSkipAcMaintenance.test_and_set(); -} - -// Shuts down the module gracefully -void ClientCleanup() -{ - // Force off - ClientToggleActive(-1); -} - - -// Toggles the cient's activitiy status, as based on menu command -void ClientToggleActive (int nForce) -{ - // Need to start? - if (nForce > 0 || - XPMP2::RemoteGetStatus() == XPMP2::REMOTE_OFF) - { - // Try already to get TCAS control so we have it before others can snatch it away. - // This is not in accordance with what is laid out in "TCAS Override" - // https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/#Plugin_coordination - // but we serve a good deed here: We can combine several plugins' TCAS needs, - // but only if we are in control: - ClientTryGetAI(); - - // Start the listener to receive message - XPMP2::RemoteCBFctTy rmtCBFcts = { - ClientFlightLoopBegins, // before flight loop processing starts - ClientFlightLoopEnds, // after flight loop processing ends - ClientProcSettings, // Settings - ClientProcAcDetails, // Aircraft Details - ClientProcAcPosUpdate, // Aircraft Position Update - ClientProcAcAnim, // Aircraft Animarion dataRef values - ClientProcAcRemove, // Aircraft Removal - }; - XPMP2::RemoteRecvStart(rmtCBFcts); - } - // Need to stop? - else if (nForce < 0 || - XPMP2::RemoteGetStatus() != XPMP2::REMOTE_OFF) - { - // Release the data access lock, just a safety measure so that we don't hinder shutdown in case we f--- up - try { glockDataMain.unlock(); } - catch (...) { /* ignore all errors */ } - // Stop the listener - XPMP2::RemoteRecvStop(); - // Shut down everything - ClientReleaseAI(); - rcGlob.gmapSender.clear(); // removes aircraft in turn - LOG_MSG(logINFO, INFO_DEACTIVATED); - } -} diff --git a/XPMP2-Remote/Client.h b/XPMP2-Remote/Client.h deleted file mode 100644 index 539c6a44..00000000 --- a/XPMP2-Remote/Client.h +++ /dev/null @@ -1,137 +0,0 @@ -/// @file Client.h -/// @brief Main Client functionality, processing received data -/// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -#pragma once - -// -// MARK: Aircraft Administration -// - -struct SenderTy; - -/// Representation of a remote aircraft -class RemoteAC : public XPMP2::Aircraft { -protected: - // A few defining information taken over from the sender - XPMPPlaneID senderId = 0; ///< sender's plane id (might be different here in case of deduplication) - std::uint16_t pkgHash = 0; ///< hash value of CSL model package - std::string sShortId; ///< CSL model's short id - bool bDeleteMe = false; ///< flag that this a/c needs to removed - - /// @brief We keep 2 historic positions to be able to calculate simple linear extrapolation - /// @details Index 0 is the older one, index 1 the newer one - XPLMDrawInfo_t histPos[2]; - /// Timestamps when these two positions were valid - std::chrono::time_point histTs[2]; - - // World coordinates - double lat = NAN; ///< latitude - double lon = NAN; ///< longitude - double alt_ft = NAN; ///< altitude [ft] - std::chrono::duration> diffTime; ///< time difference to previous historic position as passed in by the sender - bool bWorldCoordUpdated = false; ///< shall freshly set values be used in the next UpdatePosition callback? - - // Did the CSL model change? Will force model-reload during UpdatePosition() - bool bCSLModelChanged = false; - - // The sending plugin this plane came from - SenderTy& sender; - -public: - /// Constructor for use in network thread: Does _not_ Create the aircraft but only stores the passed information - RemoteAC (SenderTy& _sender, const XPMP2::RemoteAcDetailTy& _acDetails); - /// Destructor - virtual ~RemoteAC(); - - /// Actually create the aircraft, ultimately calls XPMP2::Aircraft::Create() - void Create (); - - /// Update data from an a/c detail structure - void Update (const XPMP2::RemoteAcDetailTy& _acDetails); - /// Update data from an a/c position update - void Update (const XPMP2::RemoteAcPosUpdateTy& _acPosUpd); - /// Update data from an a/c animation dataRefs message - void Update (const XPMP2::RemoteAcAnimTy& _acAnim); - - /// Called by XPMP2 for position updates, extrapolates from historic positions - void UpdatePosition (float, int) override; - - /// Mark this aircraft as to-be-deleted in the next flight loop (can't do in worker thread) - void MarkForDeletion () { bDeleteMe = true; } - /// To be deleted? - bool IsToBeDeleted () const { return bDeleteMe; } -}; - -/// Map of remote aircraft; key is the plane id as sent by the sending plugin (while the _modeS_id of the local copy could differ) -typedef std::map mapRemoteAcTy; - -// -// MARK: Sender Administration -// - -/// Uniquely identifies a sending plugin -struct SenderAddrTy { - const XPLMPluginID pluginId; ///< sender's plugin id within X-Plane (first to speed up memcmp as usually this will already differ between plugins) - std::uint32_t from[4]; ///< numerical part of sender's IP address (only differentiating in rare cases of two plugins on different PCs having the same plugin id) - bool operator< (const SenderAddrTy& o) const; ///< uses memcmp to compare this - /// Constructor just fills values - SenderAddrTy (XPLMPluginID _id, const std::uint32_t _from[4]) : - pluginId(_id) { memcpy(from, _from, sizeof(from)); } -}; - -struct SenderTy { - std::string sFrom; ///< string representaton of the sender's IP address - const bool bLocal; ///< is this a local sender on the same computer? - XPMP2::RemoteMsgSettingsTy settings;///< that plugin's settings - std::chrono::time_point lastMsg; - mapRemoteAcTy mapAc; ///< map of aircraft sent by this plugin - - /// Constructor copies values and sets lastMsg to now - SenderTy (const std::string& _from, const XPMP2::RemoteMsgSettingsTy& _s); - - /// Find a sender based on plugin id and IP address - static SenderTy* Find (XPLMPluginID _id, const std::uint32_t _from[4]); -}; - -/// map of sender information -typedef std::map mapSenderTy; - -// -// MARK: Global Functions -// - -/// Initializes the module -void ClientInit(); -/// Shuts down the module gracefully -void ClientCleanup(); - -/// Try getting TCAS/AI control -void ClientTryGetAI (); -/// Stop TCAS/AI control -void ClientReleaseAI (); - -/// @brief Toggles the cient's activitiy status, as based on menu command -/// @param nForce 3-way toggle: `-1? force off, `0` toggle, `+1` force on -void ClientToggleActive (int nForce = 0); - -/// Called at the beginning of each flight loop processing: Get the data lock, create waiting planes -void ClientFlightLoopBegins (); -/// Called at the end of each flight loop processing: Release the data lock -void ClientFlightLoopEnds () noexcept; diff --git a/XPMP2-Remote/README.md b/XPMP2-Remote/README.md deleted file mode 100644 index a59be1e4..00000000 --- a/XPMP2-Remote/README.md +++ /dev/null @@ -1,27 +0,0 @@ -XPMP2 Remote Client -========= - -**Synchronizing Planes across the Network** - -Planes displayed using XPMP2 can by synchronized across the network. -The **XPMP2 Remote Client** needs to run on all remote computers, -receives aircraft data from any number of XPMP2-based plugins anywhere -in the network, and displays the aircraft using the same CSL model, -at the same world location with the same animation dataRefs. - -This supports usage in setups like -- [Networking Multiple Computers for Multiple Displays](https://x-plane.com/manuals/desktop/#networkingmultiplecomputersformultipledisplays), -- [Networked Multiplayer](https://x-plane.com/manuals/desktop/#networkedmultiplayer), -- but also just locally as a **TCAS Concentrator**, which collects plane - information from other local plugins and forwards them combined to TCAS - and classic multiplayer dataRefs for 3rd party add-ons. - -For end user documentation refer to -[LiveTraffic/XPMP2 Remote Client](https://twinfan.gitbook.io/livetraffic/setup/installation/xpmp2-remote-client) -documentation. - -For more background information refer to -[GitHub XPMP2 documentation](https://twinfan.github.io/XPMP2/Remote.html). - -One of many possible setups: -![XPMP2 in a Standard Networked Setup](../docs/pic/XPMP2_Remote_Standard.png) diff --git a/XPMP2-Remote/Utilities.cpp b/XPMP2-Remote/Utilities.cpp deleted file mode 100755 index bb347ee2..00000000 --- a/XPMP2-Remote/Utilities.cpp +++ /dev/null @@ -1,143 +0,0 @@ -/// @file Utilities.cpp -/// @brief Miscellaneous utility functions, including logging -/// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -#include "XPMP2-Remote.h" - -/// The one global variable object -XPMP2RCGlobals rcGlob; - -// -// MARK: Misc -// - -// Get total running time from X-Plane (sim/time/total_running_time_sec) -float GetMiscNetwTime() -{ - // must not use dataRefs from worker threads - if (!rcGlob.IsXPThread()) - return rcGlob.now; - - // In main thread we can fetch a new time - static XPLMDataRef drMiscNetwTime = XPLMFindDataRef("sim/network/misc/network_time_sec"); - return rcGlob.now = XPLMGetDataf(drMiscNetwTime); -} - -// Convenience function to check on something at most every x seconds -bool CheckEverySoOften (float& _lastCheck, float _interval, float _now) -{ - if (_lastCheck < 0.00001f || - _now >= _lastCheck + _interval) { - _lastCheck = _now; - return true; - } - return false; -} - -// Return a plugin's name -std::string GetPluginName (XPLMPluginID who) -{ - char whoName[256]; - XPLMGetPluginInfo(who, whoName, nullptr, nullptr, nullptr); - return whoName; -} - -// -// MARK: String functions -// - -// Copy _at most_ `n` chars from location, or less if zero-terminated. -std::string str_n (const char* s, size_t max) -{ - // find end of string, stopping at max - size_t i = 0; - for (; i < max && *(s+i) != '\0'; ++i); - return std::string(s,i); -} - - -// -//MARK: Log -// - -#if IBM -#define PATH_DELIM_STD '\\' -#else -#define PATH_DELIM_STD '/' -#endif - -const char* LOG_LEVEL[] = { - "DEBUG", "INFO ", "WARN ", "ERROR", "FATAL", "MSG " -}; - -// returns ptr to static buffer filled with log string -const char* LogGetString (const char* szPath, int ln, const char* szFunc, - logLevelTy lvl, const char* szMsg, va_list args ) -{ - static char aszMsg[2048]; - float runS = GetMiscNetwTime(); - const unsigned runH = unsigned(runS / 3600.0f); - runS -= runH * 3600.0f; - const unsigned runM = unsigned(runS / 60.0f); - runS -= runM * 60.0f; - - // prepare timestamp - if ( lvl < logMSG ) // normal messages without, all other with location info - { - const char* szFile = strrchr(szPath, PATH_DELIM_STD); // extract file from path - if ( !szFile ) szFile = szPath; else szFile++; - snprintf(aszMsg, sizeof(aszMsg), "%u:%02u:%06.3f %s %s %s:%d/%s: ", - runH, runM, runS, // Running time stamp - REMOTE_CLIENT_LOG, LOG_LEVEL[lvl], - szFile, ln, szFunc); - } - else - snprintf(aszMsg, sizeof(aszMsg), "%u:%02u:%06.3f %s: ", - runH, runM, runS, // Running time stamp - REMOTE_CLIENT_LOG); - - // append given message - if (args) { - vsnprintf(&aszMsg[strlen(aszMsg)], - sizeof(aszMsg)-strlen(aszMsg)-1, // we save one char for the CR - szMsg, - args); - } - - // ensure there's a trailing CR - size_t l = strlen(aszMsg); - if ( aszMsg[l-1] != '\n' ) - { - aszMsg[l] = '\n'; - aszMsg[l+1] = 0; - } - - // return the static buffer - return aszMsg; -} - -void LogMsg ( const char* szPath, int ln, const char* szFunc, logLevelTy lvl, const char* szMsg, ... ) -{ - va_list args; - - va_start (args, szMsg); - // write to log (flushed immediately -> expensive!) - XPLMDebugString ( LogGetString(szPath, ln, szFunc, lvl, szMsg, args) ); - va_end (args); -} diff --git a/XPMP2-Remote/Utilities.h b/XPMP2-Remote/Utilities.h deleted file mode 100644 index c47fb55f..00000000 --- a/XPMP2-Remote/Utilities.h +++ /dev/null @@ -1,134 +0,0 @@ -/// @file Utilities.h -/// @brief Miscellaneous utility functions, including logging -/// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -#pragma once - -// -// MARK: General texts -// - -#define ERR_ASSERT "ASSERT FAILED: %s" -#define ERR_EXCEPTION "EXCEPTION CAUGHT: %s" - -// -// MARK: Misc -// - -/// Get synched network time from X-Plane (sim/network/misc/network_time_sec) as used in Log.txt -float GetMiscNetwTime (); - -/// @brief Convenience function to check on something at most every x seconds -/// @param _lastCheck Provide a float which holds the time of last check (init with `0.0f`) -/// @param _interval [seconds] How often to perform the check? -/// @param _now Current time, possibly from a call to GetTotalRunningTime() -/// @return `true` if more than `_interval` time has passed since `_lastCheck` -bool CheckEverySoOften (float& _lastCheck, float _interval, float _now); - -/// @brief Convenience function to check on something at most every x seconds -/// @param _lastCheck Provide a float which holds the time of last check (init with `0.0f`) -/// @param _interval [seconds] How often to perform the check? -/// @return `true` if more than `_interval` time has passed since `_lastCheck` -inline bool CheckEverySoOften (float& _lastCheck, float _interval) -{ return CheckEverySoOften(_lastCheck, _interval, GetMiscNetwTime()); } - -/// Return a plugin's name -std::string GetPluginName (XPLMPluginID who); - -// -// MARK: String functions -// - -/// @brief Copy _at most_ `n` chars from location, or less if zero-terminated. -/// @details Unlike std::string(char*, n) this will _not_ copy null chars -std::string str_n (const char* s, size_t max); - -/// Simplify using str_n() with char arrays -#define STR_N(s) str_n(s,sizeof(s)) - -// -// MARK: Logging Support -// - -/// @brief To apply printf-style warnings to our functions. -/// @see Taken from imgui.h's definition of IM_FMTARGS -#if defined(__clang__) || defined(__GNUC__) -#define XPMP2RC_FMTARGS(FMT) __attribute__((format(printf, FMT, FMT+1))) -#else -#define XPMP2RC_FMTARGS(FMT) -#endif - -/// Logging level -enum logLevelTy : std::uint8_t { - logDEBUG = 0, ///< Debug, highest level of detail - logINFO, ///< regular info messages - logWARN, ///< warnings, i.e. unexpected, but uncritical events, maybe leading to unwanted display, but still: display of aircraft - logERR, ///< errors mean, aircraft can potentially not be displayed - logFATAL, ///< fatal is shortly before a crash - logMSG ///< will always be output, no matter what has been configured, cannot be suppressed -}; - -/// Returns ptr to static buffer filled with formatted log string -const char* LogGetString ( const char* szFile, int ln, const char* szFunc, logLevelTy lvl, const char* szMsg, va_list args ); - -/// Log Text to log file -void LogMsg ( const char* szFile, int ln, const char* szFunc, logLevelTy lvl, const char* szMsg, ... ) XPMP2RC_FMTARGS(5); - -// -// MARK: Logging macros -// - -/// @brief Log a message if lvl is greater or equal currently defined log level -/// @note First parameter after lvl must be the message text, -/// which can be a format string with its parameters following like in sprintf -#define LOG_MSG(lvl,...) { \ - if (lvl >= rcGlob.mergedS.logLvl) \ - {LogMsg(__FILE__, __LINE__, __func__, lvl, __VA_ARGS__);} \ -} - -/// @brief Throws an exception using XPMP2Error -/// @note First parameter after lvl must be the message text, -/// which can be a format string with its parameters following like in sprintf -#define THROW_ERROR(...) \ -throw XPMP2::XPMP2Error(__FILE__, __LINE__, __func__, __VA_ARGS__); - -/// @brief Throw in an assert-style (logging takes place in XPMP2Error constructor) -/// @note This conditional check _always_ takes place, independend of any build or logging settings! -#define LOG_ASSERT(cond) \ - if (!(cond)) { \ - THROW_ERROR(ERR_ASSERT,#cond); \ - } - -// -// MARK: Compiler differences -// - -// MARK: Thread names -#ifdef DEBUG -// This might not work on older Windows version, which is why we don't publish it in release builds -#if IBM -#define SET_THREAD_NAME(sName) SetThreadDescription(GetCurrentThread(), L##sName) -#elif APL -#define SET_THREAD_NAME(sName) pthread_setname_np(sName) -#elif LIN -#define SET_THREAD_NAME(sName) pthread_setname_np(pthread_self(),sName) -#endif -#else -#define SET_THREAD_NAME(sName) -#endif diff --git a/XPMP2-Remote/XPMP2-Remote.cpp b/XPMP2-Remote/XPMP2-Remote.cpp deleted file mode 100644 index 7e17c162..00000000 --- a/XPMP2-Remote/XPMP2-Remote.cpp +++ /dev/null @@ -1,431 +0,0 @@ -/// @file XPMP2-Remote.cpp -/// @brief XPMP2 Remote Client: Displays aircraft served from other -/// XPMP2-based plugins in the network -/// @details This plugin is intended to be used in a multi-computer simulator -/// setup, usually in the PCs used for external visuals.\n -/// The typical setup would be: -/// - There is a multi-computer setup of one X-Plane Master PC, -/// which also runs one or more XPMP2-based plugins like LiveTraffic, -/// which create additional traffic, let's call them "traffic master". -/// - Other PCs serve to compute additional external visuals. -/// For them to be able to show the very same additional traffic -/// they run XPMP2 Remote Client, which will display a copy -/// of the traffic generated by the XPMP2-based plugin on the master. -/// -/// Technically, this works as follows: -/// - The "traffic masters" will first _listen_ -/// on the network if anyone is interested in their data. -/// - The XPMP2 Remote Client will first send a "beacon of interest" -/// message to the network. -/// - This messages tells the master plugins to start feeding their data. -/// - All communication is UDP multicast on the same multicast -/// group that X-Plane uses, too: 239.255.1.1, but on a different -/// port: 49788 -/// - This generic way allows for many different setups: -/// - While the above might be typical, it is not of interest if the -/// "traffic master" is running on the X-Plane Master or any -/// other X-Plane instance in the network, for example to -/// better balance the load. -/// - It could even be an X-Plane PC not included in the -/// External Visuals setup, like for example in a Networked -/// Multiplayer setup. -/// - Multiple XPMP2-based traffic masters can be active, and -/// they can even run on different PCs. The one XPMP2 Remote Client -/// per PC will still collect all traffic. -/// - If several traffic masters run on different PCs, then _all_ -/// PCs, including the ones running one of the traffic masters, -/// will need to run the XPMP2 Remote Client, so that they -/// pick up the traffic generated on the _other_ traffic masters. -/// -/// @see For multi-computer setup of external visual: -/// https://x-plane.com/manuals/desktop/#networkingmultiplecomputersformultipledisplays -/// @see For Networked Multiplayer: -/// https://x-plane.com/manuals/desktop/#networkedmultiplayer -/// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -// All headers are collected in one -#include "XPMP2-Remote.h" - -// -// MARK: Utility Functions -// - -/// This is a callback the XPMP2 calls regularly to learn about configuration settings. -/// Only 3 are left, all of them integers. -int CBIntPrefsFunc (const char *, [[maybe_unused]] const char * item, int defaultVal) -{ - // We always want to replace dataRefs and textures upon load to make the most out of the .obj files - if (!strcmp(item, XPMP_CFG_ITM_REPLDATAREFS)) return rcGlob.mergedS.bObjReplDataRefs; // taken from sending plugins - if (!strcmp(item, XPMP_CFG_ITM_REPLTEXTURE)) return rcGlob.mergedS.bObjReplTextures; // taken from sending plugins - if (!strcmp(item, XPMP_CFG_ITM_CLAMPALL)) return 0; // Never needed: The defining coordinates are sent to us, don't interpret them here in any way - if (!strcmp(item, XPMP_CFG_ITM_HANDLE_DUP_ID)) return 1; // must be on: if receiving from different plugins we can easily run in duplicate ids, which shall be handled - if (!strcmp(item, XPMP_CFG_ITM_SUPPORT_REMOTE)) return -1; // We don't want this plugin to ever _send_ traffic! - if (!strcmp(item, XPMP_CFG_ITM_LOGLEVEL)) return (int)rcGlob.mergedS.logLvl; // taken from sending plugins - if (!strcmp(item, XPMP_CFG_ITM_MODELMATCHING)) return rcGlob.mergedS.bLogMdlMatch; // taken from sending plugins - // Otherwise we just accept defaults - return defaultVal; -} - -// -// MARK: Menu / Command functionality -// - -XPLMMenuID hMenu = nullptr; ///< menu id of our plugin's menu -XPLMMenuID hLabels = nullptr; ///< menu id of the Labels submenu -XPLMMenuID hSenders = nullptr; ///< menu id of the Senders submenu -int numSendersInMenu = 0; ///< how many lines to we currently server in the menu? - -// menu indexes -constexpr std::uintptr_t MENU_ACTIVE = 0; -constexpr std::uintptr_t MENU_TCAS = 1; -constexpr std::uintptr_t MENU_LABELS = 2; -constexpr std::uintptr_t MENU_SENDER = 3; - -/// Command definition per menu item -struct CmdMenuDefTy { - const char* cmdName = nullptr; ///< command's name - const char* menuName = nullptr; ///< (initial) menu item's name - const char* description = nullptr; ///< human-readable command description - XPLMCommandRef hCmd = nullptr; ///< command reference assigned by X-Plane -} CMD_MENU_DEF[2] = { - { "XPMP2-Remote/Activate", "Active", "Toggle if Remote Client is active" }, - { "XPMP2-Remote/TCAS", "TCAS Control", "Toggle if Remote Client shall have TCAS control" }, -}; - -/// Sets all menu checkmarks according to current status -void MenuUpdateCheckmarks () -{ - // Menu item "Active" - switch (XPMP2::RemoteGetStatus()) { - case XPMP2::REMOTE_RECV_WAITING: - XPLMSetMenuItemName(hMenu, MENU_ACTIVE, "Active (waiting for data)", 0); - XPLMCheckMenuItem(hMenu, MENU_ACTIVE, xplm_Menu_Checked); - break; - - case XPMP2::REMOTE_RECEIVING: { - char s[50]; - snprintf (s, sizeof(s), "Active (%ld aircraft)", XPMPCountPlanes()); - XPLMSetMenuItemName(hMenu, MENU_ACTIVE, s, 0); - XPLMCheckMenuItem(hMenu, MENU_ACTIVE, xplm_Menu_Checked); - break; - } - - default: - XPLMSetMenuItemName(hMenu, MENU_ACTIVE, "Activate (currently inactive)", 0); - XPLMCheckMenuItem(hMenu, MENU_ACTIVE, xplm_Menu_Unchecked); - break; - } - - // Menu item "TCAS Control" (status display) - XPLMCheckMenuItem(hMenu, MENU_TCAS, XPMPHasControlOfAIAircraft() ? xplm_Menu_Checked : xplm_Menu_Unchecked); - - // Sub menu "Labels" - for (XPMP2RCGlobals::DrawLabelsTy e = XPMP2RCGlobals::LABELS_SYNCH; - e <= XPMP2RCGlobals::LABELS_OFF; e = XPMP2RCGlobals::DrawLabelsTy(e + 1)) - XPLMCheckMenuItem(hLabels, e, rcGlob.eDrawLabels == e ? xplm_Menu_Checked : xplm_Menu_Unchecked); -} - -/// (Re)Create the submenu listing information about connected senders -void MenuUpdateSenders () -{ - // Simple case first: There is no sender - if (rcGlob.gmapSender.empty()) { - // If we show anything we must remove it - if (numSendersInMenu > 0) { - XPLMClearAllMenuItems(hSenders); - XPLMAppendMenuItem(hSenders, "(none)", (void*)MENU_SENDER, 0); - numSendersInMenu = 0; - } - return; - } - - // There are senders, fill in their details - if (numSendersInMenu == 0) // physically there's always one menu item that we can re-use - numSendersInMenu++; - - // Cycle over senders and update textual information - int idx = 0; - for (const mapSenderTy::value_type& p: rcGlob.gmapSender) - { - const SenderTy& snd = p.second; - - // Put together plugin name, IP address, number of aircraft - std::string s (STR_N(snd.settings.name)); - if (!snd.bLocal) { - s += " @ "; - s += snd.sFrom; - } - s += ": "; - s += std::to_string(snd.mapAc.size()); - s += " aircraft"; - - // Do we need a new menu item or can we update an existing one? - if (idx < numSendersInMenu) - XPLMSetMenuItemName(hSenders, idx, s.c_str(), 0); - else { - XPLMAppendMenuItem(hSenders, s.c_str(), (void*)MENU_SENDER, 0); - numSendersInMenu++; - } - idx++; - } - - // Remove left-over menu items - while (idx < numSendersInMenu) - XPLMRemoveMenuItem(hSenders, --numSendersInMenu); -} - - -/// Callback function for menu -int CmdCallback (XPLMCommandRef cmdRef, XPLMCommandPhase inPhase, void*) -{ - // entry point into plugin...catch exceptions latest here - try { - if (inPhase == xplm_CommandBegin) { - if (cmdRef == CMD_MENU_DEF[0].hCmd) { - // Toggle activation of plugin - ClientToggleActive(); - } - else if (cmdRef == CMD_MENU_DEF[1].hCmd) { - // Toggle TCAS/AI status - if (XPMPHasControlOfAIAircraft()) - ClientReleaseAI(); - else - ClientTryGetAI(); - } - - // Update check marks...things might have changed - MenuUpdateCheckmarks(); - } - } - catch (const std::exception& e) { - LOG_MSG(logFATAL, ERR_EXCEPTION, e.what()); - } - return 1; -} - - -/// Callback function for the Labels submenu -void MenuLabelsCB (void* /*inMenuRef*/, void* inItemRef) -{ - // entry point into plugin...catch exceptions latest here - try { - XPMP2RCGlobals::DrawLabelsTy eDrawLabels = - XPMP2RCGlobals::DrawLabelsTy(reinterpret_cast(inItemRef)); - switch (eDrawLabels) { - // Enable label-drawing in principal - case XPMP2RCGlobals::LABELS_SYNCH: - case XPMP2RCGlobals::LABELS_ON: - rcGlob.eDrawLabels = eDrawLabels; - XPMPEnableAircraftLabels(); - break; - - // Disable label drawing completely - case XPMP2RCGlobals::LABELS_OFF: - rcGlob.eDrawLabels = XPMP2RCGlobals::LABELS_OFF; - XPMPDisableAircraftLabels(); - break; - } - // Update check marks...things might have changed - MenuUpdateCheckmarks(); - } - catch (const std::exception& e) { - LOG_MSG(logFATAL, ERR_EXCEPTION, e.what()); - } -} - -// -// MARK: Regular Tasks -// - -/// ID of our flight loop callback for regular tasks -XPLMFlightLoopID flId = nullptr; - -/// Regular tasks, called by flight loop -float FlightLoopCallback(float, float, int, void*) -{ - // entry point into plugin...catch exceptions latest here - try { - GetMiscNetwTime(); // update rcGlob.now, e.g. for logging from worker threads - // if there aren't any planes yet then the XPMP2 library won't call ClientFlightLoopBegins(), instead we do - if (XPMPCountPlanes() == 0) { - try { - // The first plane(s) would be instanciated here, and that could fail, e.g. if there are no CSL models installed - ClientFlightLoopBegins(); - } - catch (const std::exception& e) { - LOG_MSG(logFATAL, ERR_EXCEPTION, e.what()); - } - ClientFlightLoopEnds(); - } - MenuUpdateCheckmarks(); // update menu - MenuUpdateSenders(); - } - catch (const std::exception& e) { - LOG_MSG(logFATAL, ERR_EXCEPTION, e.what()); - } - - // call me every second only - return 1.0f; -} - -// -// MARK: Standard Plugin Callbacks -// - -PLUGIN_API int XPluginStart(char* outName, char* outSig, char* outDesc) -{ -#ifdef DEBUG - rcGlob.mergedS.logLvl = logDEBUG; -#endif - // this is the XP main thread - rcGlob.xpThread = std::this_thread::get_id(); - GetMiscNetwTime(); - - LOG_MSG(logMSG, "%s %.2f starting up...", REMOTE_CLIENT_NAME, REMOTE_CLIENT_VER); - - std::snprintf(outName, 255, "%s %.2f", REMOTE_CLIENT_NAME, REMOTE_CLIENT_VER); - std::strcpy(outSig, XPMP2::REMOTE_SIGNATURE); - std::strcpy(outDesc, "Remote Client displaying traffic generated by XPMP2-based plugins on the network"); - - // use native paths, i.e. Posix style (as opposed to HFS style) - // https://developer.x-plane.com/2014/12/mac-plugin-developers-you-should-be-using-native-paths/ - XPLMEnableFeature("XPLM_USE_NATIVE_PATHS",1); - - // The path separation character, one out of /\: - char pathSep = XPLMGetDirectorySeparator()[0]; - // The plugin's path, results in something like ".../Resources/plugins/XPMP2-Remote/64/XPMP2-Remote.xpl" - char szPath[256]; - rcGlob.mergedS.pluginId = std::uint16_t(XPLMGetMyID()); - XPLMGetPluginInfo(XPLMGetMyID(), nullptr, szPath, nullptr, nullptr); - *(std::strrchr(szPath, pathSep)) = 0; // Cut off the plugin's file name - *(std::strrchr(szPath, pathSep) + 1) = 0; // Cut off the "64" directory name, but leave the dir separation character - // We search in a subdirectory named "Resources" for all we need - std::string resourcePath = szPath; - resourcePath += "Resources"; // should now be something like ".../Resources/plugins/XPMP2-Sample/Resources" - - // Try initializing XPMP2: - const char* res = XPMPMultiplayerInit(REMOTE_CLIENT_NAME, // plugin name, - resourcePath.c_str(), // path to supplemental files - CBIntPrefsFunc, // configuration callback function - "A320", // default ICAO type - REMOTE_CLIENT_LOG2); // plugin short name - if (res[0]) { - LOG_MSG(logFATAL, "Initialization of XPMP2 failed: %s", res); - return 0; - } - - // Load our CSL models - res = XPMPLoadCSLPackage(resourcePath.c_str()); // CSL folder root path - if (res[0]) { - LOG_MSG(logERR, "Error while loading CSL packages: %s", res); - } - - // Create the menu for the plugin - int my_slot = XPLMAppendMenuItem(XPLMFindPluginsMenu(), REMOTE_CLIENT_NAME, NULL, 0); - hMenu = XPLMCreateMenu(REMOTE_CLIENT_NAME, XPLMFindPluginsMenu(), my_slot, NULL, NULL); - - // No CSL models installed? - if (XPMPGetNumberOfInstalledModels() <= 0) { - XPLMAppendMenuItem(hMenu, "Disabled - No CSL models installed!", (void*)MENU_ACTIVE, 0); - XPLMEnableMenuItem(hMenu, 0, false); - LOG_MSG(logFATAL, "There are no CSL models installed, XPMP2 Remote Client CANNOT START!"); - LOG_MSG(logFATAL, "Make sure the same set of CSL models is available under XPMP2-Remote/Resources as is for your sending plugins."); - return 1; - } - - // Define "proper" command and menu items - for (CmdMenuDefTy& cmdDef: CMD_MENU_DEF) { - cmdDef.hCmd = XPLMCreateCommand(cmdDef.cmdName, cmdDef.description); - XPLMRegisterCommandHandler(cmdDef.hCmd, CmdCallback, 1, NULL); - XPLMAppendMenuItemWithCommand(hMenu, cmdDef.menuName, cmdDef.hCmd); - } - - // The Labels submenu has 3 options - XPLMAppendMenuItem(hMenu, "Labels", (void*)MENU_LABELS, 0); - hLabels = XPLMCreateMenu("Labels", hMenu, MENU_LABELS, MenuLabelsCB, NULL); - XPLMAppendMenuItem(hLabels, "Synchronize", (void*)XPMP2RCGlobals::LABELS_SYNCH, 0); - XPLMAppendMenuItem(hLabels, "On", (void*)XPMP2RCGlobals::LABELS_ON, 0); - XPLMAppendMenuItem(hLabels, "Off", (void*)XPMP2RCGlobals::LABELS_OFF, 0); - - // The Senders submenu lists connected plugins with IP address and number of aircraft - XPLMAppendMenuItem(hMenu, "Senders", (void*)MENU_SENDER, 0); - hSenders = XPLMCreateMenu("Senders", hMenu, MENU_SENDER, NULL, NULL); - XPLMAppendMenuItem(hSenders, "(none)", (void*)MENU_SENDER, 0); - - MenuUpdateCheckmarks(); - - return 1; -} - -PLUGIN_API void XPluginStop(void) -{ - // Properly clean up - XPMPMultiplayerCleanup(); - -} - -PLUGIN_API int XPluginEnable(void) -{ - // Initialize the Client module - ClientInit(); - - // No CSL models installed? Then don't try starting - if (XPMPGetNumberOfInstalledModels() <= 0) { - return 1; - } - - // Create a flight loop callback for some regular tasks, called every second - XPLMCreateFlightLoop_t flParams = { - sizeof(flParams), // structSize - xplm_FlightLoop_Phase_BeforeFlightModel, // phase - FlightLoopCallback, // callbackFunc, - nullptr // refcon - }; - flId = XPLMCreateFlightLoop(&flParams); - XPLMScheduleFlightLoop(flId, 1.0f, true); - - // Activate the listener - ClientToggleActive(); - MenuUpdateCheckmarks(); - - // Success - LOG_MSG(logINFO, "Enabled"); - return 1; -} - -PLUGIN_API void XPluginDisable(void) -{ - // Stop our flight loop callback - if (flId) - XPLMDestroyFlightLoop(flId); - flId = nullptr; - - // Cleanup the client, also removes all planes - ClientCleanup(); - - LOG_MSG(logINFO, "Disabled"); -} - -PLUGIN_API void XPluginReceiveMessage(XPLMPluginID who, long inMsg, void*) -{ - // Some other plugin wants TCAS/AI control, but we never release automatically - if (inMsg == XPLM_MSG_RELEASE_PLANES) { - LOG_MSG(logINFO, "%s requested TCAS access, but we don't release automatically", GetPluginName(who).c_str()) - } -} diff --git a/XPMP2-Remote/XPMP2-Remote.h b/XPMP2-Remote/XPMP2-Remote.h deleted file mode 100644 index bfad09b0..00000000 --- a/XPMP2-Remote/XPMP2-Remote.h +++ /dev/null @@ -1,143 +0,0 @@ -/// @file XPMP2-Remote.h -/// @brief XPMP2 Remote Client: Displays aircraft served from other -/// XPMP2-based plugins in the network -/// @details This plugin is intended to be used in a multi-computer simulator -/// setup, usually in the PCs used for external visuals.\n -/// The typical setup would be: -/// - There is a multi-computer setup of one X-Plane Master PC, -/// which also runs one or more XPMP2-based plugins like LiveTraffic, -/// which create additional traffic, let's call them "traffic master". -/// - Other PCs serve to compute additional external visuals. -/// For them to be able to show the very same additional traffic -/// they run XPMP2 Remote Client, which will display a copy -/// of the traffic generated by the XPMP2-based plugin on the master. -/// -/// Technically, this works as follows: -/// - The "traffic masters" will first _listen_ -/// on the network if anyone is interested in their data. -/// - The XPMP2 Remote Client will first send a "beacon of interest" -/// message to the network. -/// - This messages tells the master plugins to start feeding their data. -/// - All communication is UDP multicast on the same multicast -/// group that X-Plane uses, too: 239.255.1.1, but on a different -/// port: 49788 -/// - This generic way allows for many different setups: -/// - While the above might be typical, it is not of interest if the -/// "traffic master" is running on the X-Plane Master or any -/// other X-Plane instance in the network, for example to -/// better balance the load. -/// - It could even be an X-Plane PC not included in the -/// External Visuals setup, like for example in a Networked -/// Multiplayer setup. -/// - Multiple XPMP2-based traffic masters can be active, and -/// they can even run on different PCs. The one XPMP2 Remote Client -/// per PC will still collect all traffic. -/// - If several traffic masters run on different PCs, then _all_ -/// PCs, including the ones running one of the traffic masters, -/// will need to run the XPMP2 Remote Client, so that they -/// pick up the traffic generated on the _other_ traffic masters. -/// -/// @see For multi-computer setup of external visual: -/// https://x-plane.com/manuals/desktop/#networkingmultiplecomputersformultipledisplays -/// @see For Networked Multiplayer: -/// https://x-plane.com/manuals/desktop/#networkedmultiplayer -/// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -#pragma once - -// Standard C headers -#include -#include -#include -#include -#include - -// Standard C++ headers -#include -#include -#include -#include -#include -#include -#include -#include - -// X-Plane SDK -#include "XPLMDataAccess.h" -#include "XPLMUtilities.h" -#include "XPLMPlugin.h" -#include "XPLMMenus.h" -#include "XPLMProcessing.h" - -// Include XPMP2 headers -#include "XPMPAircraft.h" -#include "XPMPMultiplayer.h" -#include "XPMPRemote.h" - -// Include XPMP2-Remote headers -#include "Utilities.h" -#include "Client.h" - -// Windows: I prefer the proper SDK variants of min and max -#ifdef min -#undef min -#endif -#ifdef max -#undef max -#endif - -// -// MARK: Constants -// - -constexpr const char* REMOTE_CLIENT_NAME = "XPMP2 Remote Client"; ///< Plugin name -constexpr const char* REMOTE_CLIENT_LOG = "XPMP2_RC"; ///< ID used in own log entries -constexpr const char* REMOTE_CLIENT_LOG2 = "RC"; ///< Short ID used in XPMP2 log entries -constexpr float REMOTE_CLIENT_VER = 1.20f; ///< Version number for the XPMP2 Remote plugin - -// -// MARK: Globals -// - -/// Holds all global variables -struct XPMP2RCGlobals { - - /// Config values reconciled from sending plugins - XPMP2::RemoteMsgSettingsTy mergedS; - /// Shall aircraft labels be drawn at remote site? - enum DrawLabelsTy { - LABELS_SYNCH = 0, ///< Synchronize drawing of labels with sending client - LABELS_ON, ///< Always draw labels - LABELS_OFF, ///< Don't draw labels - } eDrawLabels = LABELS_SYNCH; ///< Shall aircraft labels be drawn at remote site? - - /// The global map of all sending plugins we've ever heard of - mapSenderTy gmapSender; - - /// Latest timestamp read from network_time_sec - float now = 0.0f; - - ///< id of X-Plane's thread (when it is OK to use XP API calls) - std::thread::id xpThread; - /// Is this thread XP's main thread? - bool IsXPThread() const { return std::this_thread::get_id() == xpThread; } -}; - -/// the one and only instance of XPMP2RCGlobals -extern XPMP2RCGlobals rcGlob; diff --git a/XPMP2-Remote/readme.html b/XPMP2-Remote/readme.html deleted file mode 100755 index 82129565..00000000 --- a/XPMP2-Remote/readme.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - XPMP2 Remote Client Readme - - - -

XPMP2 Remote Client Readme

- -

Documentation

- -

- For full documentation please visit - LiveTraffic/XPMP2 Remote Client on GitBook, - which also includes more details on installation. -

- -

Installation / External Visuals

- -

The typical basic installation is very simple:

- -
    -
  • You run a networked setup, in which one computer is the master. - The master also runs the latest version of XPMP2-based plugins - (like LiveTraffic, xPilot) just as usual - (the senders, because they will send the traffic);
    • -
  • On all other computers on the network install the - XPMP2 Remote Client as follows: -
      -
    • Move the XPMP2-Remote folder under X-Plane's - Resources/plugins folder as with any other plugin.
      • -
    • Install the same set of CSL Models, that your senders use, under the - XPMP2-Remote/Resources folder. - It is not required to rebuild the same folder structure - as CSL models are identified by internal names, - but all models need to be in reach if you want planes - to appear the same way as at your senders.
      • -
    -
    • -
- -

Installation / Local TCAS Concentrator

- -

You have several XPMP2-based plugins (like LiveTraffic, xPilot, - referred to as the senders) running in parallel and want to see - all their traffic on TCAS - (and not only the traffic of the plugin which happens to have TCAS control):

- -

Install XPMP2-Remote on the computer running the senders:

- -
    -
  • Move the XPMP2-Remote folder under X-Plane's - Resources/plugins folder as with any other plugin.
    • -
  • In this setup you don't even need to add all your CSL models - as the Remote Client doesn't actually render planes, - but for technical reasons at least one - model is still required.
    • -
- -

Resulting Directory Structure

- -

...under X-Plane's Resources/plugins folder:

- -

- XPMP2-Remote/
- XPMP2-Remote/lin_x64/XPMP2-Remote.xpl
- XPMP2-Remote/mac_x64/XPMP2-Remote.xpl
- XPMP2-Remote/win_x64/XPMP2-Remote.xpl
- XPMP2-Remote/Resources/CSL/... (here follow the CSL package folders)
- XPMP2-Remote/Resources/Doc8643.txt
- XPMP2-Remote/Resources/MapIcons.png
- XPMP2-Remote/Resources/Obj8DataRefs.txt
- XPMP2-Remote/Resources/related.txt
- XPMP2-Remote/Resources/XPMP2.example.prf
-

- -

Release Notes

- -

v1.x

- -

v1.20

- -

Update: In case of doubt you can always just copy all files from the archive over the files of your existing installation.

- -

At least copy the following files, which have changed compared to v1.10:

-
    -
  • lin|mac|win_x64/XPMP2-Remote.xpl
    • -
  • Resources/Doc8643.txt
    • -
  • Resources/related.txt
    • -
- -

Change log:

- -
    -
  • - ADDED #49 - control of aircraft labels via new sub-menu Labels: -
      -
    • - Synchronized (default) takes over the state of displaying labels - from the senders.
      - Note: Senders will require an update to send this info! - Until then, On is assumed. -
      • -
    • On always displays labels
      • -
    • Off switches off display of labels
      • -
    -
    • -
  • - Universal Mac binary for native support of Apple Silicon with XP12. -
    • -
- -

v1.10

- -

For updating coming from v1.00 -

    -
  • copy lin|mac|win_x64/XPMP2-Remote.xpl. -
-

- -

Change log:

- -
    -
  • ADDED #28 - commands XPMP2-Remote/Activate and - XPMP2-Remote/TCAS for menu items - Activate and TCAS Control - to bind keyboard shortcuts to them or trigger them via CMND network message.
    • -
  • ADDED #26 and - #27 - remote support for the set of - textual shared dataRefs.
    • -
  • ADDED #29 - signature and notarization to the Mac version.
    • -
- -

v1.00

- -

First public version.

- - - diff --git a/XPMP2-Sample/.gitignore b/XPMP2-Sample/.gitignore deleted file mode 100644 index b9ee09a9..00000000 --- a/XPMP2-Sample/.gitignore +++ /dev/null @@ -1,16 +0,0 @@ -.DS_Store -.localized -.image* -.vs/ -.vscode/ - -# Build directories -build*/* - -# XCode user specific files -xcuserdata/ -*.xcworkspace/ -*.mode1v3 -*.mode2v3 -*.perspectivev3 -*.pbxuser diff --git a/XPMP2-Sample/CMakeLists.txt b/XPMP2-Sample/CMakeLists.txt deleted file mode 100644 index 0b891f66..00000000 --- a/XPMP2-Sample/CMakeLists.txt +++ /dev/null @@ -1,210 +0,0 @@ -# XPMP2 - Set up to be used in the provided docker environment to build lin and mac -# Set up to be used in a Visual Studio environment to build win (File > Open > Folder, then VS recognized the CMAKE configuration) - -cmake_minimum_required(VERSION 3.16) - -# Mac: Need to tell early on that we want a cross platform build -if(DEFINED ENV{platform}) - message ("-- Platform is $ENV{platform}") - if($ENV{platform} STREQUAL "mac-x86") - message (" Building cross-platform for mac/x86_64") - set(CMAKE_OSX_ARCHITECTURES "x86_64" CACHE STRING "Archs to build") - elseif($ENV{platform} STREQUAL "mac-arm") - message (" Building cross-platform for mac/arm64") - set(CMAKE_OSX_ARCHITECTURES "arm64" CACHE STRING "Archs to build") - endif() -else() - # No 'platform' defined could mean running from command line, assume we build universal image in one go via XCode - set(CMAKE_OSX_ARCHITECTURES "x86_64;arm64" CACHE STRING "Archs to build") -endif() - -project(XPMP2-Sample - VERSION 2.50 - DESCRIPTION "XPMP2-Sample X-Plane plugin") - -# Provide compile macros from the above project version definition -add_compile_definitions( - XPMP2_VERSION="${PROJECT_VERSION}" - XPMP2_VER_MAJOR=${PROJECT_VERSION_MAJOR} - XPMP2_VER_MINOR=${PROJECT_VERSION_MINOR} -) - -message ("Compiler Info:") -message ("CMAKE_CXX_COMPILER_ID = ${CMAKE_CXX_COMPILER_ID}") -message ("CMAKE_CXX_COMPILER_VERSION = ${CMAKE_CXX_COMPILER_VERSION}") -message ("CMAKE_CXX_COMPILER = ${CMAKE_CXX_COMPILER}") -message ("WIN32 / MSVC / MINGW = ${WIN32} / ${MSVC} / ${MINGW}") -message ("UNIX / APPLE = ${UNIX} / ${APPLE}") -if (APPLE) - message ("OSX_SDK_PATH = $ENV{OSX_SDK_PATH}") - message ("CMAKE_OSX_ARCHITECTURES = ${CMAKE_OSX_ARCHITECTURES}") -endif() - -################################################################################ -# Target Systems -################################################################################ - -# Windows: Target Windows 7.0 and later -if (WIN32) - add_compile_definitions(_WIN32_WINNT=0x0601) - if (NOT DEFINED ENV{platform}) - set(ENV{platform} "win") - endif() -elseif(APPLE) - set(CMAKE_OSX_DEPLOYMENT_TARGET 11.0) - add_compile_options(-mmacosx-version-min=11.0) - add_link_options(-mmacosx-version-min=11.0) -endif() - -################################################################################ -# C++ Standard required -################################################################################ - -set(CMAKE_CXX_STANDARD 17) -set_property(GLOBAL PROPERTY CXX_STANDARD_REQUIRED 17) -set_property(GLOBAL PROPERTY CXX_STANDARD 17) - -################################################################################ -# Compile Options -################################################################################ - -# Enable all X-Plane SDK APIs up to the newest version. -add_compile_definitions(XPLM200=1 XPLM210=1 XPLM300=1 XPLM301=1 XPLM303=1) - -# Define platform macros. -add_compile_definitions(APL=$ IBM=$ LIN=$,$>>) - -# Enable stricter warnings and then disable some we are not interested in. -# For XPMP2 compile, we don't need to be warned about our self-defined depreciations -if (MSVC) - add_compile_options(/wd4996 /wd4068) - add_compile_definitions(_CRT_SECURE_NO_WARNINGS) -else() - add_compile_options(-Wall -Wshadow -Wno-float-equal -Wextra -Wno-deprecated-declarations -Wno-unknown-pragmas) - if (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 9.0 AND NOT APPLE) - add_compile_options(-Wno-stringop-truncation) - endif() - - # Force-enable exception support. This is most likely redundant, although for C - # code the default is the opposite. Since we are mixing C++ and C libraries, - # safer to set it on? - add_compile_options(-fexceptions -fpermissive) - - # Makes symbols non-exported by default. - add_compile_options(-fvisibility=hidden) -endif() - - -# Debug vs Release build -if(CMAKE_BUILD_TYPE MATCHES "Debug") - add_compile_definitions(DEBUG=1) - if (MSVC) - add_compile_options(/Zi) - else() - add_compile_options(-O0 -g) - endif() -else() - add_compile_definitions(NDEBUG=1) - if(MSVC) - # Use highest optimization level in Release builds - add_compile_options(/GL) - elseif(APPLE) - add_compile_options(-O3 -fPIC) - elseif (UNIX OR MINGW) - # Use position-independent code and highest optimization level (FPS!). - add_compile_options(-O3 -fPIC) - # Strip symbols during linking - add_link_options(-s) - endif() -endif() - -################################################################################ -# Source Files -################################################################################ -add_library(XPMP2-Sample MODULE - lib/XPMP2.framework/Versions/${PROJECT_VERSION}/Headers/XPCAircraft.h - lib/XPMP2.framework/Versions/${PROJECT_VERSION}/Headers/XPMPAircraft.h - lib/XPMP2.framework/Versions/${PROJECT_VERSION}/Headers/XPMPMultiplayer.h - SDK/CHeaders/XPLM/XPLMDataAccess.h - SDK/CHeaders/XPLM/XPLMUtilities.h - SDK/CHeaders/XPLM/XPLMPlugin.h - SDK/CHeaders/XPLM/XPLMGraphics.h - SDK/CHeaders/XPLM/XPLMMenus.h - XPMP2-Sample.cpp -) - -# Header include directories -target_include_directories(XPMP2-Sample PRIVATE - ${ADDITIONAL_INCLUDES} - ${CMAKE_CURRENT_SOURCE_DIR}/SDK/CHeaders/XPLM - ${CMAKE_CURRENT_SOURCE_DIR}/lib/XPMP2.framework/Versions/${PROJECT_VERSION}/Headers -) - - -################################################################################ -# Link Libraries -################################################################################ - -# Specify library search locations, especially for X-Plane SDK -# XPMP2 path is hard-coded. Couldn't convince find_library to distinguish libXPMP2.a from XPMP2.lib in Mingw vs MSVC build. -if (APPLE) - list(APPEND CMAKE_FRAMEWORK_PATH "${CMAKE_CURRENT_SOURCE_DIR}/lib" "${CMAKE_CURRENT_SOURCE_DIR}/SDK/Libraries/Mac") -else () - list(APPEND CMAKE_LIBRARY_PATH "${CMAKE_CURRENT_SOURCE_DIR}/SDK/Libraries/Win" "${CMAKE_CURRENT_SOURCE_DIR}/lib/$ENV{platform}") -endif () - -# Link the XPMP2 library -find_library(XPMP2_LIBRARY XPMP2 REQUIRED) -message ("XPMP2_LIBRARY = ${XPMP2_LIBRARY}") -target_link_libraries(XPMP2-Sample ${XPMP2_LIBRARY}) - - -# Link X-Plane plugin system libraries. They are only provided for OS X and Windows. -if (WIN32 OR APPLE) - find_library(XPLM_LIBRARY XPLM REQUIRED NAMES XPLM_64.lib) - message ("XPLM_LIBRARY = ${XPLM_LIBRARY}") - target_link_libraries(XPMP2-Sample ${XPLM_LIBRARY}) -endif () - - -if (WIN32) - # Link with winsock for network and iphlpapi for GetAdaptersAddresses - target_link_libraries(XPMP2-Sample wsock32 ws2_32 iphlpapi) - if (MINGW) - # When cross-compiling we link the standard libraries statically - target_link_options(XPMP2-Sample PRIVATE -static-libgcc -static-libstdc++) - endif() -elseif (APPLE) - # Link OS X core system libraries. - find_library(IOKIT_LIBRARY IOKit REQUIRED) - find_library(CORE_FOUNDATION_LIBRARY CoreFoundation REQUIRED) - target_link_libraries(XPMP2-Sample ${IOKIT_LIBRARY} ${CORE_FOUNDATION_LIBRARY}) - # Restrict set of symbols exported from the plugin to the ones required by XPLM: - target_link_options(XPMP2-Sample PRIVATE "-exported_symbols_list ${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample.sym_mac") -elseif (UNIX) - # Threads and dynamic loading - find_library(DL_LIBRARY dl REQUIRED) - set(CMAKE_THREAD_PREFER_PTHREAD TRUE) - set(THREADS_PREFER_PTHREAD_FLAG TRUE) - find_package(Threads REQUIRED) - target_link_libraries(XPMP2-Sample ${DL_LIBRARY} Threads::Threads) - # Restrict set of symbols exported from the plugin to the ones required by XPLM: - target_link_options(XPMP2-Sample PRIVATE -Wl,--version-script -Wl,${CMAKE_CURRENT_SOURCE_DIR}/XPMP2-Sample.sym) -endif () - - -# Target directory and file name -if (WIN32) - set_target_properties(XPMP2-Sample PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/win_x64") -elseif (APPLE) - set_target_properties(XPMP2-Sample PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/mac_x64") -elseif (UNIX) - set_target_properties(XPMP2-Sample PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lin_x64") -endif () - -set_target_properties(XPMP2-Sample - PROPERTIES - PREFIX "" - OUTPUT_NAME "XPMP2-Sample" - SUFFIX ".xpl" -) diff --git a/XPMP2-Sample/CMakeSettings.json b/XPMP2-Sample/CMakeSettings.json deleted file mode 100644 index ff228eaf..00000000 --- a/XPMP2-Sample/CMakeSettings.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "configurations": [ - { - "name": "x64-Debug", - "generator": "Ninja", - "configurationType": "Debug", - "inheritEnvironments": [ "msvc_x64_x64" ], - "buildRoot": "${projectDir}\\build-win\\${name}", - "installRoot": "${projectDir}\\build-win\\install\\${name}", - "cmakeCommandArgs": "", - "buildCommandArgs": "-v", - "ctestCommandArgs": "", - "variables": [ - { - "name": "CMAKE_CXX_FLAGS", - "value": "/DWIN32 /D_WINDOWS /DWIN32_LEAN_AND_MEAN /D_CRT_SECURE_NO_WARNINGS /GS- /Gd /Gy- /Zc:wchar_t /Zc:forScope /Zc:inline /Zc:__cplusplus /W4 /EHsc /fp:precise /diagnostics:column", - "type": "STRING" - }, - { - "name": "CMAKE_CXX_FLAGS_DEBUG", - "value": "/MDd /Od /RTC1 /Zi /DDEBUG", - "type": "STRING" - }, - { - "name": "CMAKE_MODULE_LINKER_FLAGS", - "value": "/machine:x64", - "type": "STRING" - }, - { - "name": "CMAKE_MODULE_LINKER_FLAGS_DEBUG", - "value": "/debug /INCREMENTAL:NO", - "type": "STRING" - } - ] - }, - { - "name": "x64-Release", - "generator": "Ninja", - "configurationType": "RelWithDebInfo", - "buildRoot": "${projectDir}\\build-win\\${name}", - "installRoot": "${projectDir}\\build-win\\install\\${name}", - "cmakeCommandArgs": "", - "buildCommandArgs": "-v", - "ctestCommandArgs": "", - "inheritEnvironments": [ "msvc_x64_x64" ], - "variables": [ - { - "name": "CMAKE_CXX_FLAGS", - "value": "/DWIN32 /D_WINDOWS /DWIN32_LEAN_AND_MEAN /D_CRT_SECURE_NO_WARNINGS /GS- /Gd /Gy- /Zc:wchar_t /Zc:forScope /Zc:inline /Zc:__cplusplus /W4 /EHsc /fp:precise /diagnostics:column", - "type": "STRING" - }, - { - "name": "CMAKE_CXX_FLAGS_RELWITHDEBINFO", - "value": "/MD /Zi /GL /O2 /DNDEBUG", - "type": "STRING" - }, - { - "name": "CMAKE_MODULE_LINKER_FLAGS", - "value": "/machine:x64", - "type": "STRING" - }, - { - "name": "CMAKE_MODULE_LINKER_FLAGS_RELWITHDEBINFO", - "value": "/LTCG /debug /INCREMENTAL:NO", - "type": "STRING" - } - ] - } - ] -} \ No newline at end of file diff --git a/XPMP2-Sample/README.md b/XPMP2-Sample/README.md deleted file mode 100644 index 7c2f6f91..00000000 --- a/XPMP2-Sample/README.md +++ /dev/null @@ -1,60 +0,0 @@ -XPMP2 Sample Plugin -========= - -This is a fully functional sample implementation that you can use to play with -XPMP2 features and as a starting point for your own implementations. - -I am also using it as a testbed for new features, so the implementation -is regularly built, tested, and sometimes even enhanced to make use of -latest features. - -## Build ## - -There are separate projects available to only build the XPMP2-Sample plugin, -serving as a starting point for your projects. - -Please refer to the -[GitHub Build documentation](https://twinfan.github.io/XPMP2/Building.html) -for details. - -## Features ## - -This plugin creates 3 planes, one with each of the available ways of using the XPMP2 library. -All planes move in a circle around a position 200m in front of the user's plane -(even if the user plane moves). -1. Subclassing `XPMP2::Aircraft` in `class SampleAircraft`, - which is the recommended way for any new plugin. This plane flies - highest, 100m above the user plane. -2. Subclassing the legacy `class XPCAircraft`. This plane flies in the middle, - 50m above the user plane. -3. Using direct C functions. This plane always rolls on the ground, no matter how - high the user plane flies. - -Three menu items are provided: - - 1. "Toggle Planes" creates/removes the planes. - 2. "Toggle Visibility" shows/temporary hides the planes without destroying them. - 3. "Cycle Models" changes the CSL model used per plane. - Also, it flips the visibility of labels in the map view...just for a change. - -## Installation ## - -For the plugin to work properly some CSL models are necessary in some folders -under `Resources` (all folders under `Resources` are scanned for -`xsb_aircraft.txt` file, so the actual structure underneath `Resources` does not matter). - -The directory structure would look as follows: -``` -XPMP2-Sample/ -  lin_x64/ -    XPMP2-Sample.xpl -  mac_x64/ -    XPMP2-Sample.xpl -  win_x64/ -    XPMP2-Sample.xpl -  Resources/ - CSL/ <-- install CSL models here -    Doc8643.txt - MapIcons.png - Obj8DataRefs.txt -    related.txt diff --git a/XPMP2-Sample/XPMP2-Sample.cpp b/XPMP2-Sample/XPMP2-Sample.cpp deleted file mode 100644 index 16ac10ce..00000000 --- a/XPMP2-Sample/XPMP2-Sample.cpp +++ /dev/null @@ -1,1020 +0,0 @@ -/// @file XPMP2-Sample.cpp -/// @brief Example plugin demonstrating XPMP2 techniques -/// @details This plugin creates 3 planes, one with each of the available ways of using the XPMP2 library. -/// All planes move in a circle around a position 200m in front of the user's plane -/// (even if the user plane moves). -/// -/// 1. Subclassing XPMP2::Aircraft, which is the recommended way. This plane flies -/// highest, 100m above the user plane. -/// 2. Subclassing the legacy class XPCAircraft. This plane flies in the middle, 50m above the user plane. -/// 3. Using direct C functions. This plane always rolls on the ground, no matter how -/// high the user plane flies. -/// -/// Three menu items are provided: -/// -/// 1. "Toggle Planes" creates/removes the planes. -/// 2. "Toggle Visibility" shows/temporary hides the planes without destroying them. -/// 3. "Cycle Models" changes the CSL model used per plane. -/// Also, it flips the visibility of labels in the map view...just for a change. -/// -/// For the plugin to work properly some CSL models are necessary in some folders -/// under `Resources` (all folders under `Resources` are scanned for -/// `xsb_aircraft.txt` file, so the actual structure underneath `Resources` does not matter). -/// -/// The directory structure would look as follows:\n -/// `XPMP2-Sample/`\n -/// `  lin_x64/`\n -/// `    XPMP2-Sample.xpl`\n -/// `  mac_x64/`\n -/// `    XPMP2-Sample.xpl`\n -/// `  win_x64/`\n -/// `    XPMP2-Sample.xpl`\n -/// `  Resources/`\n -/// ` CSL/ <-- install CSL models here`\n -/// `    Doc8643.txt`\n -/// ` MapIcons.png`\n -/// ` Obj8DataRefs.txt`\n -/// `    related.txt`\n -/// -/// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -// Standard C headers -#include -#include -#include -#include - -// X-Plane SDK -#include "XPLMDataAccess.h" -#include "XPLMUtilities.h" -#include "XPLMPlugin.h" -#include "XPLMGraphics.h" -#include "XPLMMenus.h" - -// Include XPMP2 headers -#include "XPCAircraft.h" -#include "XPMPAircraft.h" -#include "XPMPMultiplayer.h" - -#if !XPLM300 - #error This plugin requires version 300 of the SDK -#endif - -/// Initial type / airline / livery to be used to create our 3 planes -/// @see https://www.icao.int/publications/DOC8643/Pages/Search.aspx for ICAO aircraft types - -/// @see https://forums.x-plane.org/index.php?/files/file/37041-bluebell-obj8-csl-packages/ for the Bluebell package, which includes the models named here -std::string PLANE_MODEL[3][3] = { - { "DH8A", "BER", "" }, - { "B06", "TXB", "" }, - { "A321", "", "" }, // Not specifying the airline means: XPMP2 will randomly take any airline's model - with every switch of models -}; - -// -// MARK: Utility Functions -// - -/// Log a message to X-Plane's Log.txt with sprintf-style parameters -void LogMsg (const char* szMsg, ... ) -{ - char buf[512]; - va_list args; - // Write all the variable parameters - va_start (args, szMsg); - std::vsnprintf(buf, sizeof(buf)-2, szMsg, args); - va_end (args); - std::strcat(buf, "\n"); - // write to log (flushed immediately -> expensive!) - XPLMDebugString(buf); -} - -/// This is a callback the XPMP2 calls regularly to learn about configuration settings. -/// Only 3 are left, all of them integers. -int CBIntPrefsFunc (const char *, [[maybe_unused]] const char * item, int defaultVal) -{ - // We always want to replace dataRefs and textures upon load to make the most out of the .obj files - if (!strcmp(item, XPMP_CFG_ITM_REPLDATAREFS)) return 1; - if (!strcmp(item, XPMP_CFG_ITM_REPLTEXTURE)) return 1; // actually...this is ON by default anyway, just to be sure -#if DEBUG - // in debug version of the plugin we provide most complete log output - if (!strcmp(item, XPMP_CFG_ITM_MODELMATCHING)) return 1; - if (!strcmp(item, XPMP_CFG_ITM_LOGLEVEL)) return 0; // DEBUG logging level -#endif - // Otherwise we just accept defaults - return defaultVal; -} - -/// This is the callback for the plane notifier function, which just logs some info to Log.txt -/// @note Plane notifier functions are completely optional and actually rarely used, -/// because you should know already by other means when your plugin creates/modifies/deletes a plane. -/// So this is for pure demonstration (and testing) purposes. -void CBPlaneNotifier(XPMPPlaneID inPlaneID, - XPMPPlaneNotification inNotification, - void * /*inRefcon*/) -{ - XPMP2::Aircraft* pAc = XPMP2::AcFindByID(inPlaneID); - if (pAc) { - LogMsg("XPMP2-Sample: Plane of type %s, airline %s, model %s, label '%s' %s", - pAc->acIcaoType.c_str(), - pAc->acIcaoAirline.c_str(), - pAc->GetModelName().c_str(), - pAc->label.c_str(), - inNotification == xpmp_PlaneNotification_Created ? "created" : - inNotification == xpmp_PlaneNotification_ModelChanged ? "changed" : "destroyed"); - } -} - -// -// MARK: Helper functions for position calculations -// - -/// Distance of our simulated planes to the user's plane's position? [m] -constexpr float PLANE_DIST_M = 200.0f; -/// Radius of the circle the planes do [m] -constexpr float PLANE_RADIUS_M = 100.0f; -/// Altitude difference to stack the 3 planes one above the other [m] -constexpr float PLANE_STACK_ALT_M = 50.0f; -/// Time it shall take to fly/roll a full circle [seconds] -constexpr float PLANE_CIRCLE_TIME_S = 20.0f; -/// Time it shall take to fly/roll a full circle [minutes] -constexpr float PLANE_CIRCLE_TIME_MIN = PLANE_CIRCLE_TIME_S / 60.0f; -/// Assumed circumfence of one plane's tire (rough guess for commercial jet planes) -constexpr float PLANE_TIRE_CIRCUMFENCE_M = 3.2f; -/// Engine / prop rotation assumptions: rotations per minute -constexpr float PLANE_PROP_RPM = 300.0f; - -/// PI -constexpr double PI = 3.1415926535897932384626433832795028841971693993751; - -/// Summarizes the 3 values of a position in the local coordinate system -struct positionTy { - double x = 0.0f; - double y = 0.0f; - double z = 0.0f; -}; - -/// Position of user's plane -static XPLMDataRef dr_x = XPLMFindDataRef("sim/flightmodel/position/local_x"); // double -static XPLMDataRef dr_y = XPLMFindDataRef("sim/flightmodel/position/local_y"); // double -static XPLMDataRef dr_z = XPLMFindDataRef("sim/flightmodel/position/local_z"); // double -static XPLMDataRef dr_heading = XPLMFindDataRef("sim/flightmodel/position/psi"); // float -static XPLMDataRef dr_time = XPLMFindDataRef("sim/time/total_running_time_sec"); // float - -/// Returns a number between 0.0 and 1.0, increasing over the course of 10 seconds, then restarting -inline float GetTimeFragment () -{ - const float t = XPLMGetDataf(dr_time); - return std::fmod(t, PLANE_CIRCLE_TIME_S) / PLANE_CIRCLE_TIME_S; -} - -/// Returns a number between 0.0 and 1.0, going up and down over the course of 10 seconds -inline float GetTimeUpDown () -{ - return std::abs(std::fmod(XPLMGetDataf(dr_time), PLANE_CIRCLE_TIME_S) / (PLANE_CIRCLE_TIME_S/2.0f) - 1.0f); -} - -/// Convert from degree to radians -inline double deg2rad (const double deg) { return (deg * PI / 180.0); } - -/// Save string copy -inline char* strScpy (char* dest, const char* src, size_t size) -{ - strncpy(dest, src, size); - dest[size-1] = 0; // this ensures zero-termination! - return dest; -} - -/// Finds a position 200m in front of the user's plane serving as the center for further operations -positionTy FindCenterPos (float dist) -{ - // Current user's plane's position and heading (relative to Z) - positionTy pos = { - XPLMGetDatad(dr_x), - XPLMGetDatad(dr_y), - XPLMGetDatad(dr_z) - }; - float heading = XPLMGetDataf(dr_heading); - - // Move point 200m away from aircraft, direction of its heading - const double head_rad = deg2rad(heading); - pos.x += sin(head_rad) * dist; // east axis - pos.z -= cos(head_rad) * dist; // south axis - - return pos; -} - -/// Put the position on a circle around itself -void CirclePos (positionTy& pos, - float heading, - float radius) -{ - const double head_rad = deg2rad(heading); - pos.x += radius * sin(head_rad); // east axis - pos.z -= radius * cos(head_rad); // south axis -} - -/// Convert local position to world coordinates -void ConvLocalToWorld (const positionTy& pos, - double& lat, double& lon, double& alt) -{ - XPLMLocalToWorld(pos.x, pos.y, pos.z, - &lat, &lon, &alt); -} - -// -// MARK: Using XPMP2 - New XPMP2::Aircraft class -// This is the new and recommended way of using the library: -// Deriving a class from XPMP2::Aircraft and providing -// a custom implementation for UpdatePosition(), -// which provides all current values in one go directly into -// the member variables, which are later on used for -// controlling the plane objects. This avoids any unnecessary copying -// within the library - -using namespace XPMP2; - -/// Subclassing XPMP2::Aircraft to create our own class -class SampleAircraft : public Aircraft -{ -public: - /// Constructor just passes on all parameters to library - SampleAircraft(const std::string& _icaoType, - const std::string& _icaoAirline, - const std::string& _livery, - XPMPPlaneID _modeS_id = 0, - const std::string& _cslId = "") : - Aircraft(_icaoType, _icaoAirline, _livery, _modeS_id, _cslId) - { - // in our sample implementation, label, radar and info texts - // are not dynamic. In others, they might be, then update them - // in UpdatePosition() - - // Label - label = "XPMP2::Aircraft"; - colLabel[0] = 0.0f; // green - colLabel[1] = 1.0f; - colLabel[2] = 0.0f; - - // Radar - acRadar.code = 7654; - acRadar.mode = xpmpTransponderMode_ModeC; - - // informational texts - strScpy(acInfoTexts.icaoAcType, _icaoType.c_str(), sizeof(acInfoTexts.icaoAcType)); - strScpy(acInfoTexts.icaoAirline, _icaoAirline.c_str(), sizeof(acInfoTexts.icaoAirline)); - strScpy(acInfoTexts.tailNum, "D-EVEL", sizeof(acInfoTexts.tailNum)); - } - - /// Custom implementation for the virtual function providing updates values - virtual void UpdatePosition (float, int) - { - // Calculate the plane's position - const float angle = std::fmod(360.0f * GetTimeFragment(), 360.0f); - positionTy pos = FindCenterPos(PLANE_DIST_M); // relative to user's plane - CirclePos(pos, angle, PLANE_RADIUS_M); // turning around a circle - pos.y += PLANE_STACK_ALT_M * 2; // 100m above user's aircraft - - // Strictly speaking...this is not necessary, we could just write - // directly to drawInfo.x/y/z with above values (for y: + GetVertOfs()), - // but typically in a real-world application you would actually - // have lat/lon/elev...and then the call to SetLocation() is - // what you shall do: - double lat, lon, elev; - // location in lat/lon/feet - XPLMLocalToWorld(pos.x, pos.y, pos.z, &lat, &lon, &elev); - elev /= M_per_FT; // we need elevation in feet - - // So, here we tell the plane its position, which takes care of vertical offset, too - SetLocation(lat, lon, elev, false); - - // further attitude information - SetPitch(0.0f); - SetHeading(std::fmod(90.0f + angle, 360.0f)); - SetRoll(20.0f); - - // Plane configuration info - // This fills a large array of float values: - const float r = GetTimeUpDown(); // a value between 0 and 1 - SetGearRatio(r); - SetNoseWheelAngle(r * 90.0f - 45.0f); // turn nose wheel -45°..+45° - SetFlapRatio(r); - SetSpoilerRatio(r); - SetSpeedbrakeRatio(r); - SetSlatRatio(r); - SetWingSweepRatio(0.0f); - SetThrustRatio(0.5f); - SetYokePitchRatio(r); - SetYokeHeadingRatio(r); - SetYokeRollRatio(r); - - // lights - SetLightsTaxi(false); - SetLightsLanding(false); - SetLightsBeacon(true); - SetLightsStrobe(true); - SetLightsNav(true); - - // tires don't roll in the air - SetTireDeflection(0.0f); - SetTireRotAngle(0.0f); - SetTireRotRpm(0.0f); // also sets the rad/s value! - - // For simplicity, we keep engine and prop rotation identical...probably unrealistic - SetEngineRotRpm(1,PLANE_PROP_RPM); // also sets the rad/s value! - // 2nd engine shall turn 4 times slower... - SetEngineRotRpm(2,PLANE_PROP_RPM/4); // also sets the rad/s value! - - SetPropRotRpm(PLANE_PROP_RPM); // also sets the rad/s value! - - // Current position of engine / prop: keeps turning as per engine/prop speed: - float deg = std::fmod(PLANE_PROP_RPM * PLANE_CIRCLE_TIME_MIN * GetTimeFragment() * 360.0f, - 360.0f); - SetEngineRotAngle(1,deg); - // 2nd engine shall turn 4 times slower... - deg = std::fmod(PLANE_PROP_RPM/4 * PLANE_CIRCLE_TIME_MIN * GetTimeFragment() * 360.0f, - 360.0f); - SetEngineRotAngle(2,deg); - - SetPropRotAngle(deg); - - // no reversers and no moment of touch-down in flight - SetThrustReversRatio(0.0f); - SetReversDeployRatio(0.0f); - SetTouchDown(false); - } - -}; - -/// The one aircraft of this type that we manage -SampleAircraft* pSamplePlane = nullptr; - - -// -// MARK: Using XPMP2 - Legacy XPCAircraft class -// XPCAircraft was a wrapper class offered in the original library -// already. It now is derived from XPMP2's main class, -// XPMP2::Aircraft, to provide the same interface as before. -// Still, it is deprecated and should not be used in new applications. -// Derive directly from XPMP2::Aircraft instead. -// -// This plane will be 50m higher than user's plane, -// circling 200m in front of user's plane. -// - -/// Subclassing XPCAircraft to create our own class -class LegacySampleAircraft : public XPCAircraft -{ -public: - /// Constructor just passes on all parameters to library - LegacySampleAircraft(const char* inICAOCode, - const char* inAirline, - const char* inLivery, - XPMPPlaneID _modeS_id = 0, - const char* inModelName = nullptr) : - XPCAircraft(inICAOCode, inAirline, inLivery, _modeS_id, inModelName) {} - - // My own class overwrites the individual data provision functions - - /// Called before rendering to query plane's current position, overwritten to provide your implementation - virtual XPMPPlaneCallbackResult GetPlanePosition(XPMPPlanePosition_t* outPosition) - { - // Calculate the plane's position - const float angle = std::fmod(120.0f + 360.0f * GetTimeFragment(), 360.0f); - positionTy pos = FindCenterPos(PLANE_DIST_M); // relative to user's plane - CirclePos(pos, angle, PLANE_RADIUS_M); // turning around a circle - pos.y += PLANE_STACK_ALT_M; // 50m above user's aircraft - - // fill the XPMP2 data structure - - // The size is pre-filled and shall support version differences. - // We make the check simple here and only proceed if the library - // has at least as much storage as we expected for everything: - if (outPosition->size < (long)sizeof(XPMPPlanePosition_t)) - return xpmpData_Unavailable; - - // location in lat/lon/feet - XPLMLocalToWorld(pos.x, pos.y, pos.z, - &outPosition->lat, - &outPosition->lon, - &outPosition->elevation); // elevation is now given in meter - outPosition->elevation /= M_per_FT; // put it is expected in feet! - - outPosition->pitch = 0.0f; - outPosition->roll =20.0f; // rolled 20° right (tight curve!) - outPosition->heading = std::fmod(90.0f + angle, 360.0f); - strcpy ( outPosition->label, "XPCAircraft subclassed"); - outPosition->offsetScale = 1.0f; // so that full vertical offset is applied and plane sits on its wheels (should probably always be 1.0) - outPosition->clampToGround = false; - outPosition->aiPrio = 1; - outPosition->label_color[0] = 1.0f; // yellow - outPosition->label_color[1] = 1.0f; - outPosition->label_color[2] = 0.0f; - outPosition->label_color[3] = 1.0f; - return xpmpData_NewData; - } - - /// Called before rendering to query plane's current configuration, overwritten to provide your implementation - virtual XPMPPlaneCallbackResult GetPlaneSurfaces(XPMPPlaneSurfaces_t* outSurfaces) - { - // The size is pre-filled and shall support version differences. - // We make the check simple here and only proceed if the library - // has at least as much storage as we expected for everything: - if (outSurfaces->size < (long)sizeof(XPMPPlaneSurfaces_t)) - return xpmpData_Unavailable; - - // gear & flight surfaces keep moving for show - outSurfaces->yokePitch = - outSurfaces->yokeHeading = - outSurfaces->yokeRoll = - outSurfaces->gearPosition = - outSurfaces->flapRatio = - outSurfaces->spoilerRatio = - outSurfaces->speedBrakeRatio = - outSurfaces->slatRatio = GetTimeUpDown(); - outSurfaces->thrust = 0.5f; - - // lights: taxi, beacon, and nav lights - outSurfaces->lights.timeOffset = 0; // unused in XPMP2 - outSurfaces->lights.taxiLights = 1; - outSurfaces->lights.landLights = 1; - outSurfaces->lights.bcnLights = 1; - outSurfaces->lights.strbLights = 1; - outSurfaces->lights.navLights = 1; - outSurfaces->lights.flashPattern = xpmp_Lights_Pattern_Default; // unused in XPMP2 - - // tires don't roll in the air - outSurfaces->tireDeflect = 0; - outSurfaces->tireRotDegree = 0; - outSurfaces->tireRotRpm = 0; - - // For simplicity, we keep engine and prop rotation identical...probably unrealistic - constexpr float PROP_REVOLUTIONS = PLANE_PROP_RPM * PLANE_CIRCLE_TIME_MIN; - outSurfaces->engRotRpm = - outSurfaces->propRotRpm = PLANE_PROP_RPM; - outSurfaces->engRotDegree = - outSurfaces->propRotDegree = std::fmod(PROP_REVOLUTIONS * GetTimeFragment() * 360.0f, - 360.0f); - // no reversers in flight - outSurfaces->reversRatio = 0.0f; - - outSurfaces->touchDown = false; - - return xpmpData_NewData; - } - - /// Called before rendering to query plane's current radar visibility, overwritten to provide your implementation - virtual XPMPPlaneCallbackResult GetPlaneRadar(XPMPPlaneRadar_t* outRadar) - { - // The size is pre-filled and shall support version differences. - // We make the check simple here and only proceed if the library - // has at least as much storage as we expected for everything: - if (outRadar->size < (long)sizeof(XPMPPlaneRadar_t)) - return xpmpData_Unavailable; - - if (outRadar->code != 4711) { - outRadar->code = 4711; - outRadar->mode = xpmpTransponderMode_ModeC; - return xpmpData_NewData; - } - else - return xpmpData_Unchanged; - } - - /// @brief Called before rendering to query plane's textual information, overwritten to provide your implementation (optional) - /// @details Handling this requests is completely optional. The texts are - /// provided on shared dataRefs and used only by few other plugins, - /// one of it is FSTramp.\n - /// Here in the example we keep it simple and just return some known data. - virtual XPMPPlaneCallbackResult GetInfoTexts(XPMPInfoTexts_t * outInfoTexts) - { - // The size is pre-filled and shall support version differences. - // We make the check simple here and only proceed if the library - // has at least as much storage as we expected for everything: - if (outInfoTexts->size < (long)sizeof(XPMPInfoTexts_t)) - return xpmpData_Unavailable; - - if (acIcaoType != outInfoTexts->icaoAcType || - acIcaoAirline != outInfoTexts->icaoAirline) { - strScpy(outInfoTexts->icaoAcType, acIcaoType.c_str(), sizeof(outInfoTexts->icaoAcType)); - strScpy(outInfoTexts->icaoAirline, acIcaoAirline.c_str(), sizeof(outInfoTexts->icaoAirline)); - strScpy(outInfoTexts->flightNum, "LH1234", sizeof(outInfoTexts->flightNum)); - return xpmpData_NewData; - } - else - return xpmpData_Unchanged; - } - -}; - -/// The one aircraft of this type that we manage -LegacySampleAircraft* pLegacyPlane = nullptr; - -// -// MARK: Using XPMP2 - Standard C Functions -// This plane will always be on the ground, ie. its altitude is -// calculated to be on ground level, gear is down. -// The plane's label for display is "Standard C" in red. -// - -/// We handle just one aircraft with standard functions, this one: -XPMPPlaneID hStdPlane = 0; - -/// @brief Handles requests for plane's position data -/// @see LegacySampleAircraft::GetPlanePosition(), which basically is the very same thing. -XPMPPlaneCallbackResult SetPositionData (XPMPPlanePosition_t& data) -{ - // Calculate the plane's position - const float angle = std::fmod(240.0f + 360.0f * GetTimeFragment(), 360.0f); - positionTy pos = FindCenterPos(PLANE_DIST_M); // relative to user's plane - CirclePos(pos, angle, PLANE_RADIUS_M); // turning around a circle - - // fill the XPMP2 data structure - - // The size is pre-filled and shall support version differences. - // We make the check simple here and only proceed if the library - // has at least as much storage as we expected for everything: - if (data.size < (long)sizeof(XPMPPlanePosition_t)) - return xpmpData_Unavailable; - - // location in lat/lon/feet - XPLMLocalToWorld(pos.x, pos.y, pos.z, - &data.lat, - &data.lon, - &data.elevation); // elevation is now given in meter - - // We place this plane firmly on the ground using XPMP2's "ground clamping" - data.elevation = -500.0f; // below ground - data.clampToGround = true; // move on ground - - data.pitch = 0.0f; // plane stays level - data.roll = 0.0f; - data.heading = std::fmod(90.0f + angle, 360.0f); - strcpy ( data.label, "Standard C"); - data.offsetScale = 1.0f; // so that full vertical offset is applied and plane sits on its wheels (should probably always be 1.0) - data.aiPrio = 1; - data.label_color[0] = 1.0f; // red - data.label_color[1] = 0.0f; - data.label_color[2] = 0.0f; - data.label_color[3] = 1.0f; - return xpmpData_NewData; -} - -/// @brief Handles requests for plane's surface data -/// @see LegacySampleAircraft::GetPlaneSurfaces(), which basically is the very same thing. -XPMPPlaneCallbackResult SetSurfaceData (XPMPPlaneSurfaces_t& data) -{ - // The size is pre-filled and shall support version differences. - // We make the check simple here and only proceed if the library - // has at least as much storage as we expected for everything: - if (data.size < (long)sizeof(XPMPPlaneSurfaces_t)) - return xpmpData_Unavailable; - - // gear & flight surfaces - data.gearPosition = 1.0; // gear is always down - data.yokePitch = // flight surfaces cycle up and down - data.yokeHeading = - data.yokeRoll = - data.flapRatio = - data.spoilerRatio = - data.speedBrakeRatio = - data.slatRatio = GetTimeUpDown(); - data.thrust = 0.2f; - - // lights: taxi, beacon, and nav lights - data.lights.timeOffset = 0; // unused in XPMP2 - data.lights.taxiLights = 1; - data.lights.landLights = 0; - data.lights.bcnLights = 1; - data.lights.strbLights = 0; - data.lights.navLights = 1; - data.lights.flashPattern = xpmp_Lights_Pattern_Default; // unused in XPMP2 - - // tires (assuming a tire circumfence of 3.2m and a circumfence of 628m of the - // circle the plane moves around a center position we try to simulate - // more or less accurate tire rolling, so the tire turns 196 times for - // a full plane's circle, which in turn shall take 10s. - constexpr float ROLL_CIRCUMFENCE = float(2.0 * PI * PLANE_RADIUS_M); - constexpr float TIRE_REVOLUTIONS = ROLL_CIRCUMFENCE / PLANE_TIRE_CIRCUMFENCE_M; - data.tireDeflect = 0; - data.tireRotDegree = std::fmod(TIRE_REVOLUTIONS * GetTimeFragment() * 360.0f, - 360.0f); - data.tireRotRpm = TIRE_REVOLUTIONS / PLANE_CIRCLE_TIME_MIN; - data.tireDeflect = GetTimeUpDown() * 1.5f; // 1.5m up/down of tire deflections - - // For simplicity, we keep engine and prop rotation identical...probably unrealistic - constexpr float PROP_REVOLUTIONS = PLANE_PROP_RPM * PLANE_CIRCLE_TIME_MIN; - data.engRotRpm = - data.propRotRpm = PLANE_PROP_RPM; - data.engRotDegree = - data.propRotDegree = std::fmod(PROP_REVOLUTIONS * GetTimeFragment() * 360.0f, - 360.0f); - // for the show of it we open/close reversers - data.reversRatio = GetTimeUpDown(); - - // Some models produces tire smoke at the moment of touch down, - // so at 0° we tell the model we would touch down right now - data.touchDown = GetTimeFragment() <= 0.05f; - - return xpmpData_NewData; -} - -/// @brief Handles requests for plane's radar data (doesn't actually change over time) -/// @see LegacySampleAircraft::GetPlaneRadar(), which basically is the very same thing. -XPMPPlaneCallbackResult SetRadarData (XPMPPlaneRadar_t& data) -{ - // The size is pre-filled and shall support version differences. - // We make the check simple here and only proceed if the library - // has at least as much storage as we expected for everything: - if (data.size < (long)sizeof(XPMPPlaneRadar_t)) - return xpmpData_Unavailable; - - if (data.code != 1234) { - data.code = 1234; - data.mode = xpmpTransponderMode_ModeC; - return xpmpData_NewData; - } else - return xpmpData_Unchanged; -} - -/// @brief Handles requests for plane's informational texts -/// @details Handling this requests is completely optional. The texts are -/// provided on shared dataRefs and used only by few other plugins, -/// one of it is FSTramp.\n -/// Here in the example we keep it simple and just return the ICAO plane type. -/// @see LegacySampleAircraft::GetInfoTexts(), which basically is the very same thing. -XPMPPlaneCallbackResult SetInfoData (XPMPInfoTexts_t& data) -{ - // The size is pre-filled and shall support version differences. - // We make the check simple here and only proceed if the library - // has at least as much storage as we expected for everything: - if (data.size < (long)sizeof(XPMPInfoTexts_t)) - return xpmpData_Unavailable; - - XPMPGetPlaneICAOAndLivery(hStdPlane, // get ICAO type from XPMP2 - data.icaoAcType, - NULL); - strScpy(data.tailNum, "D-ABCD", sizeof(data.tailNum)); - - return xpmpData_NewData; -} - - -/// Callback function handed to XPMP2, will be called in every drawing frame to deliver plane position and configuration -XPMPPlaneCallbackResult CBPlaneData (XPMPPlaneID inPlane, - XPMPPlaneDataType inDataType, - void * ioData, - void * /* inRefcon */) -{ - // sanity check: our plane? - if (inPlane != hStdPlane) return xpmpData_Unavailable; - - // There is 4 requests to deal with - switch (inDataType) { - case xpmpDataType_Position: - return SetPositionData (*(XPMPPlanePosition_t*)ioData); - case xpmpDataType_Surfaces: - return SetSurfaceData(*(XPMPPlaneSurfaces_t*)ioData); - case xpmpDataType_Radar: - return SetRadarData(*(XPMPPlaneRadar_t*)ioData); - case xpmpDataType_InfoTexts: - return SetInfoData(*(XPMPInfoTexts_t*)ioData); - default: - return xpmpData_Unavailable; - } -} - -// -// MARK: Menu functionality -// - -/// menu id of our plugin's menu -XPLMMenuID hMenu = nullptr; - -/// Planes currently visible? -bool gbVisible = true; - -/// Labels currently shown in map view? -bool gbMapLabels = true; - -/// for cycling CSL models: what is the index used for the first plane? -int gModelIdxBase = 0; - -/// Is any plane object created? -inline bool ArePlanesCreated () { return pSamplePlane || pLegacyPlane || hStdPlane; } - -/// Create our 3 planes (if they don't exist already) -void PlanesCreate () -{ - // 1. New interface of XPMP2::Aircraft class - if (!pSamplePlane) try { - pSamplePlane = new SampleAircraft(PLANE_MODEL[gModelIdxBase][0], // type - PLANE_MODEL[gModelIdxBase][1], // airline - PLANE_MODEL[gModelIdxBase][2], // livery - 0xABCDEF); // manually set Mode S id - } - catch (const XPMP2::XPMP2Error& e) { - LogMsg("Could not create object of type SampleAircraft: %s", e.what()); - pSamplePlane = nullptr; - } - - // 2. Subclassing the Legacy XPCAircraft class - // Creating the plane can now (this is new in XPMP2) throw an exception - if (!pLegacyPlane) try { - pLegacyPlane = new LegacySampleAircraft(PLANE_MODEL[(gModelIdxBase+1)%3][0].c_str(), // type - PLANE_MODEL[(gModelIdxBase+1)%3][1].c_str(), // airline - PLANE_MODEL[(gModelIdxBase+1)%3][2].c_str(), // livery - 0x123456); // manually set Mode S id - } - catch (const XPMP2::XPMP2Error& e) { - LogMsg("Could not create object of type LegacySampleAircraft: %s", e.what()); - pLegacyPlane = nullptr; - } - - // 3. Using Standard Legacy C interface - if (!hStdPlane) - hStdPlane = XPMPCreatePlane(PLANE_MODEL[(gModelIdxBase+2)%3][0].c_str(), // type - PLANE_MODEL[(gModelIdxBase+2)%3][1].c_str(), // airline - PLANE_MODEL[(gModelIdxBase+2)%3][2].c_str(), // livery - CBPlaneData, NULL); - - // Put a checkmark in front of menu item if planes are visible - XPLMCheckMenuItem(hMenu, 0, ArePlanesCreated() ? xplm_Menu_Checked : xplm_Menu_Unchecked); - XPLMCheckMenuItem(hMenu, 1, gbVisible ? xplm_Menu_Checked : xplm_Menu_Unchecked); -} - -/// Remove all planes -void PlanesRemove () -{ - if (pSamplePlane) { - delete pSamplePlane; - pSamplePlane = nullptr; - } - - if (pLegacyPlane) { - delete pLegacyPlane; - pLegacyPlane = nullptr; - } - - if (hStdPlane) { - XPMPDestroyPlane(hStdPlane); - hStdPlane = 0; - } - - // Remove the checkmark in front of menu item - XPLMCheckMenuItem(hMenu, 0, xplm_Menu_Unchecked); - XPLMCheckMenuItem(hMenu, 1, xplm_Menu_Unchecked); -} - -/// Show/hide the planes (temporarily, without destroying the plane objects) -void PlanesShowHide () -{ - gbVisible = !gbVisible; // toggle setting - if (pSamplePlane) - pSamplePlane->SetVisible(gbVisible); - if (pLegacyPlane) - pLegacyPlane->SetVisible(gbVisible); - if (hStdPlane) - XPMPSetPlaneVisibility(hStdPlane, gbVisible); - - // Put a checkmark in front of menu item if planes are visible - XPLMCheckMenuItem(hMenu, 1, gbVisible ? xplm_Menu_Checked : xplm_Menu_Unchecked); -} - -/// Cycle the CSL models of the 3 planes -void PlanesCycleModels () -{ - // increase the index into our list of CSL models - // (this is the index used by the first plane, the XPMP2::Aircraft one) - gModelIdxBase = (gModelIdxBase + 1) % 3; - - // Now apply the new model to the 3 planes - if (pSamplePlane) - pSamplePlane->ChangeModel(PLANE_MODEL[gModelIdxBase][0], // type - PLANE_MODEL[gModelIdxBase][1], // airline - PLANE_MODEL[gModelIdxBase][2]); // livery - if (pLegacyPlane) - pLegacyPlane->ChangeModel(PLANE_MODEL[(gModelIdxBase+1)%3][0], // type - PLANE_MODEL[(gModelIdxBase+1)%3][1], // airline - PLANE_MODEL[(gModelIdxBase+1)%3][2]); // livery - if (hStdPlane) - XPMPChangePlaneModel(hStdPlane, - PLANE_MODEL[(gModelIdxBase+2)%3][0].c_str(), // type - PLANE_MODEL[(gModelIdxBase+2)%3][1].c_str(), // airline - PLANE_MODEL[(gModelIdxBase+2)%3][2].c_str()); // livery - - if (pSamplePlane) { - // Demonstrate how to get detailed info of the model in use - XPMP2::CSLModelInfo_t cslInfo = pSamplePlane->GetModelInfo(); - LogMsg("XPMP2-Sample: SamplePlane now using model %s of type %s as defined in line %d of %s", - cslInfo.modelName.c_str(), cslInfo.icaoType.c_str(), - cslInfo.xsbAircraftLn, cslInfo.xsbAircraftPath.c_str()); - for (const XPMP2::CSLModelInfo_t::MatchCrit_t& crit : cslInfo.vecMatchCrit) - LogMsg(" Matches: %s | %s", crit.icaoAirline.c_str(), crit.livery.c_str()); - } - - // Completely unrelated...just for a change and for testing that functionality: - // We also toggle the display of labels in the map: - gbMapLabels = !gbMapLabels; - XPMPEnableMap(true, gbMapLabels); -} - -/// @brief Rematch CSL models based on existing definition -/// @details This will pick a different (partly random) CSL model -/// for those planes, for which no exact match has been found. -/// The A321 is defined without operator code, so each re-match -/// will pick any of the available A321 models. -void PlanesRematch () -{ - if (pSamplePlane) - pSamplePlane->ReMatchModel(); - if (pLegacyPlane) - pLegacyPlane->ReMatchModel(); - if (hStdPlane) { - // There is no standard C function for this task. If really want it - // we need to go the detour of fetching the underlying aircraft object - XPMP2::Aircraft* pStdAc = XPMPGetAircraft(hStdPlane); - if (pStdAc) - pStdAc->ReMatchModel(); - } - -} - -void MenuUpdateCheckmarks () -{ - XPLMCheckMenuItem(hMenu, 0, ArePlanesCreated() ? xplm_Menu_Checked : xplm_Menu_Unchecked); - XPLMCheckMenuItem(hMenu, 1, gbVisible ? xplm_Menu_Checked : xplm_Menu_Unchecked); - XPLMCheckMenuItem(hMenu, 4, XPMPHasControlOfAIAircraft() ? xplm_Menu_Checked : xplm_Menu_Unchecked); -} - -/// Callback function for the case that we might get AI access later -void CPRequestAIAgain (void*) -{ - // Well...we just try again ;-) - XPMPMultiplayerEnable(CPRequestAIAgain); - MenuUpdateCheckmarks(); -} - -/// Callback function for menu -void CBMenu (void* /*inMenuRef*/, void* inItemRef) -{ - // Toggle plane visibility? - if (inItemRef == (void*)1) - { - if (ArePlanesCreated()) - PlanesRemove(); - else - PlanesCreate(); - } - // Show/Hide Planes? - else if (inItemRef == (void*)2) - { - PlanesShowHide(); - } - // Cycle Models? - else if (inItemRef == (void*)3) - { - PlanesCycleModels(); - } - // Rematch Models? - else if (inItemRef == (void*)4) - { - PlanesRematch(); - } - // Toggle AI control? - else if (inItemRef == (void*)5) - { - if (XPMPHasControlOfAIAircraft()) - XPMPMultiplayerDisable(); - else - // When requested by menu we actually wait via callback to get control - XPMPMultiplayerEnable(CPRequestAIAgain); - } - // Update menu items' checkmarks - MenuUpdateCheckmarks(); -} - -// -// MARK: Standard Plugin Callbacks -// - -PLUGIN_API int XPluginStart(char* outName, char* outSig, char* outDesc) -{ - std::strcpy(outName, "XPMP2-Sample"); - std::strcpy(outSig, "TwinFan.plugin.XPMP2-Sample"); - std::strcpy(outDesc, "Sample plugin demonstrating using XPMP2 library"); - - // use native paths, i.e. Posix style (as opposed to HFS style) - // https://developer.x-plane.com/2014/12/mac-plugin-developers-you-should-be-using-native-paths/ - - /* Disable next line only for testing purposes: Does XPMP2 also handle HFS well? */ - XPLMEnableFeature("XPLM_USE_NATIVE_PATHS",1); - - // Create the menu for the plugin - int my_slot = XPLMAppendMenuItem(XPLMFindPluginsMenu(), "XPMP2 Sample", NULL, 0); - hMenu = XPLMCreateMenu("XPMP2 Sample", XPLMFindPluginsMenu(), my_slot, CBMenu, NULL); - XPLMAppendMenuItem(hMenu, "Toggle Planes", (void*)1, 0); - XPLMAppendMenuItem(hMenu, "Toggle Visibility", (void*)2, 0); - XPLMAppendMenuItem(hMenu, "Cycle Models", (void*)3, 0); - XPLMAppendMenuItem(hMenu, "Rematch Models", (void*)4, 0); - XPLMAppendMenuItem(hMenu, "Toggle AI control", (void*)5, 0); - MenuUpdateCheckmarks(); - return 1; -} - -PLUGIN_API void XPluginStop(void) -{ -} - -PLUGIN_API int XPluginEnable(void) -{ - // The path separation character, one out of /\: - char pathSep = XPLMGetDirectorySeparator()[0]; - // The plugin's path, results in something like ".../Resources/plugins/XPMP2-Sample/64/XPMP2-Sample.xpl" - char szPath[256]; - XPLMGetPluginInfo(XPLMGetMyID(), nullptr, szPath, nullptr, nullptr); - *(std::strrchr(szPath, pathSep)) = 0; // Cut off the plugin's file name - *(std::strrchr(szPath, pathSep)+1) = 0; // Cut off the "64" directory name, but leave the dir separation character - // We search in a subdirectory named "Resources" for all we need - std::string resourcePath = szPath; - resourcePath += "Resources"; // should now be something like ".../Resources/plugins/XPMP2-Sample/Resources" - - // Try initializing XPMP2: - const char *res = XPMPMultiplayerInit ("XPMP2-Sample", // plugin name, - resourcePath.c_str(), // path to supplemental files - CBIntPrefsFunc, // configuration callback function - "C172"); // default ICAO type - if (res[0]) { - LogMsg("XPMP2-Sample: Initialization of XPMP2 failed: %s", res); - return 0; - } - - // Load our CSL models - res = XPMPLoadCSLPackage(resourcePath.c_str()); // CSL folder root path - if (res[0]) { - LogMsg("XPMP2-Sample: Error while loading CSL packages: %s", res); - } - - // Now we also try to get control of AI planes. That's optional, though, - // other plugins (like LiveTraffic, XSquawkBox, X-IvAp...) - // could have control already - res = XPMPMultiplayerEnable(CPRequestAIAgain); - if (res[0]) { - LogMsg("XPMP2-Sample: Could not enable AI planes: %s", res); - } - - // Register the plane notifer function - // (this is rarely used in actual applications, but used here for - // demonstration and testing purposes) - XPMPRegisterPlaneNotifierFunc(CBPlaneNotifier, NULL); - - // *** Create the planes *** - PlanesCreate(); - - // Success - MenuUpdateCheckmarks(); - LogMsg("XPMP2-Sample: Enabled"); - return 1; -} - -PLUGIN_API void XPluginDisable(void) -{ - // Remove the planes - PlanesRemove(); - - // Give up AI plane control - XPMPMultiplayerDisable(); - - // Unregister plane notifier (must match function _and_ refcon) - XPMPUnregisterPlaneNotifierFunc(CBPlaneNotifier, NULL); - - // Properly cleanup the XPMP2 library - XPMPMultiplayerCleanup(); - - LogMsg("XPMP2-Sample: Disabled"); -} - -PLUGIN_API void XPluginReceiveMessage(XPLMPluginID, long inMsg, void*) -{ - // Some other plugin wants TCAS/AI control, so we (as an artificial - // traffic plugin) give up - if (inMsg == XPLM_MSG_RELEASE_PLANES) { - XPMPMultiplayerDisable(); - MenuUpdateCheckmarks(); - } -} diff --git a/XPMP2-Sample/XPMP2-Sample.sym b/XPMP2-Sample/XPMP2-Sample.sym deleted file mode 100644 index 3820a9b8..00000000 --- a/XPMP2-Sample/XPMP2-Sample.sym +++ /dev/null @@ -1,8 +0,0 @@ -{ global: -XPluginDisable; -XPluginEnable; -XPluginReceiveMessage; -XPluginStart; -XPluginStop; -local: *; }; - diff --git a/XPMP2-Sample/XPMP2-Sample.sym_mac b/XPMP2-Sample/XPMP2-Sample.sym_mac deleted file mode 100644 index 9339b39e..00000000 --- a/XPMP2-Sample/XPMP2-Sample.sym_mac +++ /dev/null @@ -1,6 +0,0 @@ -_XPluginDisable -_XPluginEnable -_XPluginReceiveMessage -_XPluginStart -_XPluginStop - diff --git a/XPMP2-Sample/XPMP2-Sample.xcodeproj/project.pbxproj b/XPMP2-Sample/XPMP2-Sample.xcodeproj/project.pbxproj deleted file mode 100644 index 116e7f6f..00000000 --- a/XPMP2-Sample/XPMP2-Sample.xcodeproj/project.pbxproj +++ /dev/null @@ -1,437 +0,0 @@ -// !$*UTF8*$! -{ - archiveVersion = 1; - classes = { - }; - objectVersion = 46; - objects = { - -/* Begin PBXBuildFile section */ - 2572C40623D88802006A7726 /* XPMP2-Sample.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 2572C40523D88802006A7726 /* XPMP2-Sample.cpp */; }; - 2575F45123ECC49100747524 /* XPMP2.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2575F44C23ECC34F00747524 /* XPMP2.framework */; }; - D6A7BDC116A1DEC000D1426A /* CoreFoundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = D6A7BDC016A1DEC000D1426A /* CoreFoundation.framework */; }; - D6A7BDF116A1DED200D1426A /* XPLM.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = D6A7BDF016A1DED200D1426A /* XPLM.framework */; }; -/* End PBXBuildFile section */ - -/* Begin PBXCopyFilesBuildPhase section */ - 2575F44F23ECC35000747524 /* Embed Frameworks */ = { - isa = PBXCopyFilesBuildPhase; - buildActionMask = 2147483647; - dstPath = ""; - dstSubfolderSpec = 10; - files = ( - ); - name = "Embed Frameworks"; - runOnlyForDeploymentPostprocessing = 0; - }; - 25A334CA2444FD5E00D4F988 /* CopyFiles */ = { - isa = PBXCopyFilesBuildPhase; - buildActionMask = 2147483647; - dstPath = ""; - dstSubfolderSpec = 0; - files = ( - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXCopyFilesBuildPhase section */ - -/* Begin PBXFileReference section */ - 2572C40523D88802006A7726 /* XPMP2-Sample.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = "XPMP2-Sample.cpp"; sourceTree = ""; }; - 2575F44623ECAAF300747524 /* Toolchain-ubuntu-osxcross-10.11.cmake */ = {isa = PBXFileReference; lastKnownFileType = text; path = "Toolchain-ubuntu-osxcross-10.11.cmake"; sourceTree = ""; }; - 2575F44C23ECC34F00747524 /* XPMP2.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = XPMP2.framework; path = lib/XPMP2.framework; sourceTree = ""; }; - 25A0F26D23E8B85E007D6B6E /* Dockerfile */ = {isa = PBXFileReference; lastKnownFileType = text; path = Dockerfile; sourceTree = ""; }; - 25A0F26E23E8B85E007D6B6E /* Makefile */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.make; path = Makefile; sourceTree = ""; }; - 25A0F26F23E8B85E007D6B6E /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = ""; }; - 25A0F27023E8B85F007D6B6E /* build.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = build.sh; sourceTree = ""; }; - 25A0F27123E8B85F007D6B6E /* .gitignore */ = {isa = PBXFileReference; lastKnownFileType = text; path = .gitignore; sourceTree = ""; }; - 25A0F27323E8B906007D6B6E /* CMakeLists.txt */ = {isa = PBXFileReference; lastKnownFileType = text; path = CMakeLists.txt; sourceTree = ""; }; - D607B19909A556E400699BC3 /* XPMP2-Sample.xpl */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.dylib"; includeInIndex = 0; path = "XPMP2-Sample.xpl"; sourceTree = BUILT_PRODUCTS_DIR; }; - D6A7BDA916A1DEA200D1426A /* OpenGL.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = OpenGL.framework; path = System/Library/Frameworks/OpenGL.framework; sourceTree = SDKROOT; }; - D6A7BDC016A1DEC000D1426A /* CoreFoundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreFoundation.framework; path = System/Library/Frameworks/CoreFoundation.framework; sourceTree = SDKROOT; }; - D6A7BDF016A1DED200D1426A /* XPLM.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = XPLM.framework; path = SDK/Libraries/Mac/XPLM.framework; sourceTree = ""; }; -/* End PBXFileReference section */ - -/* Begin PBXFrameworksBuildPhase section */ - D607B19709A556E400699BC3 /* Frameworks */ = { - isa = PBXFrameworksBuildPhase; - buildActionMask = 2147483647; - files = ( - D6A7BDC116A1DEC000D1426A /* CoreFoundation.framework in Frameworks */, - 2575F45123ECC49100747524 /* XPMP2.framework in Frameworks */, - D6A7BDF116A1DED200D1426A /* XPLM.framework in Frameworks */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXFrameworksBuildPhase section */ - -/* Begin PBXGroup section */ - 25A0F26B23E8B85E007D6B6E /* docker */ = { - isa = PBXGroup; - children = ( - 2575F44623ECAAF300747524 /* Toolchain-ubuntu-osxcross-10.11.cmake */, - 25A0F26D23E8B85E007D6B6E /* Dockerfile */, - 25A0F26E23E8B85E007D6B6E /* Makefile */, - 25A0F26F23E8B85E007D6B6E /* README.md */, - 25A0F27023E8B85F007D6B6E /* build.sh */, - 25A0F27123E8B85F007D6B6E /* .gitignore */, - ); - path = docker; - sourceTree = ""; - }; - AC4E46B809C2E0B3006B7E1B /* Source */ = { - isa = PBXGroup; - children = ( - 2572C40523D88802006A7726 /* XPMP2-Sample.cpp */, - ); - name = Source; - sourceTree = ""; - }; - D607B15F09A5563000699BC3 = { - isa = PBXGroup; - children = ( - 25A0F27323E8B906007D6B6E /* CMakeLists.txt */, - 25A0F26B23E8B85E007D6B6E /* docker */, - D6A7BDAD16A1DEA700D1426A /* Frameworks */, - AC4E46B809C2E0B3006B7E1B /* Source */, - D607B19A09A556E400699BC3 /* Products */, - ); - sourceTree = ""; - }; - D607B19A09A556E400699BC3 /* Products */ = { - isa = PBXGroup; - children = ( - D607B19909A556E400699BC3 /* XPMP2-Sample.xpl */, - ); - name = Products; - sourceTree = ""; - }; - D6A7BDAD16A1DEA700D1426A /* Frameworks */ = { - isa = PBXGroup; - children = ( - 2575F44C23ECC34F00747524 /* XPMP2.framework */, - D6A7BDC016A1DEC000D1426A /* CoreFoundation.framework */, - D6A7BDA916A1DEA200D1426A /* OpenGL.framework */, - D6A7BDF016A1DED200D1426A /* XPLM.framework */, - ); - name = Frameworks; - sourceTree = ""; - }; -/* End PBXGroup section */ - -/* Begin PBXNativeTarget section */ - D607B19809A556E400699BC3 /* XPMP2-Sample */ = { - isa = PBXNativeTarget; - buildConfigurationList = D607B19B09A556E400699BC3 /* Build configuration list for PBXNativeTarget "XPMP2-Sample" */; - buildPhases = ( - D607B19609A556E400699BC3 /* Sources */, - D607B19709A556E400699BC3 /* Frameworks */, - 2575F44F23ECC35000747524 /* Embed Frameworks */, - 25A334CA2444FD5E00D4F988 /* CopyFiles */, - ); - buildRules = ( - ); - dependencies = ( - ); - name = "XPMP2-Sample"; - productName = StarterPlugin; - productReference = D607B19909A556E400699BC3 /* XPMP2-Sample.xpl */; - productType = "com.apple.product-type.library.dynamic"; - }; -/* End PBXNativeTarget section */ - -/* Begin PBXProject section */ - D607B16109A5563100699BC3 /* Project object */ = { - isa = PBXProject; - attributes = { - LastUpgradeCheck = 1130; - }; - buildConfigurationList = D607B16209A5563100699BC3 /* Build configuration list for PBXProject "XPMP2-Sample" */; - compatibilityVersion = "Xcode 3.2"; - developmentRegion = en; - hasScannedForEncodings = 0; - knownRegions = ( - en, - Base, - ); - mainGroup = D607B15F09A5563000699BC3; - productRefGroup = D607B19A09A556E400699BC3 /* Products */; - projectDirPath = ""; - projectRoot = ""; - targets = ( - D607B19809A556E400699BC3 /* XPMP2-Sample */, - ); - }; -/* End PBXProject section */ - -/* Begin PBXSourcesBuildPhase section */ - D607B19609A556E400699BC3 /* Sources */ = { - isa = PBXSourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - 2572C40623D88802006A7726 /* XPMP2-Sample.cpp in Sources */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXSourcesBuildPhase section */ - -/* Begin XCBuildConfiguration section */ - D607B16309A5563100699BC3 /* Debug */ = { - isa = XCBuildConfiguration; - buildSettings = { - ALWAYS_SEARCH_USER_PATHS = NO; - CLANG_ANALYZER_NONNULL = YES; - CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; - CLANG_ANALYZER_SECURITY_FLOATLOOPCOUNTER = YES; - CLANG_CXX_LANGUAGE_STANDARD = "c++17"; - CLANG_CXX_LIBRARY = "libc++"; - CLANG_WARN_ASSIGN_ENUM = YES; - CLANG_WARN_ATOMIC_IMPLICIT_SEQ_CST = YES; - CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; - CLANG_WARN_BOOL_CONVERSION = YES; - CLANG_WARN_COMMA = YES; - CLANG_WARN_CONSTANT_CONVERSION = YES; - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; - CLANG_WARN_EMPTY_BODY = YES; - CLANG_WARN_ENUM_CONVERSION = YES; - CLANG_WARN_FLOAT_CONVERSION = YES; - CLANG_WARN_IMPLICIT_SIGN_CONVERSION = YES; - CLANG_WARN_INFINITE_RECURSION = YES; - CLANG_WARN_INT_CONVERSION = YES; - CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; - CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; - CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; - CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; - CLANG_WARN_STRICT_PROTOTYPES = YES; - CLANG_WARN_SUSPICIOUS_IMPLICIT_CONVERSION = YES; - CLANG_WARN_SUSPICIOUS_MOVE = YES; - CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; - CLANG_WARN_UNREACHABLE_CODE = YES; - CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; - COPY_PHASE_STRIP = NO; - CURRENT_PROJECT_VERSION = 0.1; - DEBUG_INFORMATION_FORMAT = dwarf; - DSTROOT = "$(XPLANE11_ROOT)/Resources/plugins/$(PROJECT)"; - DYLIB_COMPATIBILITY_VERSION = ""; - DYLIB_CURRENT_VERSION = ""; - ENABLE_STRICT_OBJC_MSGSEND = YES; - ENABLE_TESTABILITY = YES; - EXECUTABLE_EXTENSION = xpl; - FRAMEWORK_SEARCH_PATHS = ( - lib, - SDK/Libraries/Mac, - ); - GCC_C_LANGUAGE_STANDARD = c11; - GCC_NO_COMMON_BLOCKS = YES; - GCC_OPTIMIZATION_LEVEL = 0; - GCC_PREPROCESSOR_DEFINITIONS = ( - "DEBUG=1", - "APL=1", - "IBM=0", - "LIN=0", - "XPLM200=1", - "XPLM210=1", - "XPLM300=1", - "XPLM301=1", - "XPLM303=1", - ); - GCC_SYMBOLS_PRIVATE_EXTERN = YES; - GCC_WARN_64_TO_32_BIT_CONVERSION = YES; - GCC_WARN_ABOUT_MISSING_FIELD_INITIALIZERS = YES; - GCC_WARN_ABOUT_MISSING_NEWLINE = YES; - GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; - GCC_WARN_FOUR_CHARACTER_CONSTANTS = YES; - GCC_WARN_HIDDEN_VIRTUAL_FUNCTIONS = YES; - GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED = YES; - GCC_WARN_NON_VIRTUAL_DESTRUCTOR = YES; - GCC_WARN_SHADOW = YES; - GCC_WARN_SIGN_COMPARE = YES; - GCC_WARN_UNDECLARED_SELECTOR = YES; - GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; - GCC_WARN_UNKNOWN_PRAGMAS = YES; - GCC_WARN_UNUSED_FUNCTION = YES; - GCC_WARN_UNUSED_LABEL = YES; - GCC_WARN_UNUSED_PARAMETER = YES; - GCC_WARN_UNUSED_VARIABLE = YES; - HEADER_SEARCH_PATHS = ( - SDK/CHeaders/XPLM, - lib/XPMP2.framework/Headers, - "$(HEADER_SEARCH_PATHS)", - ); - MACH_O_TYPE = mh_bundle; - MACOSX_DEPLOYMENT_TARGET = 10.12; - ONLY_ACTIVE_ARCH = YES; - OTHER_LDFLAGS = ( - "$(OTHER_LDFLAGS)", - "-Wl,-exported_symbol", - "-Wl,_XPluginStart", - "-Wl,-exported_symbol", - "-Wl,_XPluginEnable", - "-Wl,-exported_symbol", - "-Wl,_XPluginReceiveMessage", - "-Wl,-exported_symbol", - "-Wl,_XPluginDisable", - "-Wl,-exported_symbol", - "-Wl,_XPluginStop", - ); - PRODUCT_BUNDLE_IDENTIFIER = "com.twinfan.XPMP2-Sample"; - PRODUCT_NAME = "${TARGET_NAME}"; - SDKROOT = macosx; - XPLANE11_ROOT = "$(USER_APPS_DIR)/X-Plane/Release"; - }; - name = Debug; - }; - D607B16409A5563100699BC3 /* Release */ = { - isa = XCBuildConfiguration; - buildSettings = { - ALWAYS_SEARCH_USER_PATHS = NO; - CLANG_ANALYZER_NONNULL = YES; - CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; - CLANG_ANALYZER_SECURITY_FLOATLOOPCOUNTER = YES; - CLANG_CXX_LANGUAGE_STANDARD = "c++17"; - CLANG_CXX_LIBRARY = "libc++"; - CLANG_WARN_ASSIGN_ENUM = YES; - CLANG_WARN_ATOMIC_IMPLICIT_SEQ_CST = YES; - CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; - CLANG_WARN_BOOL_CONVERSION = YES; - CLANG_WARN_COMMA = YES; - CLANG_WARN_CONSTANT_CONVERSION = YES; - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; - CLANG_WARN_EMPTY_BODY = YES; - CLANG_WARN_ENUM_CONVERSION = YES; - CLANG_WARN_FLOAT_CONVERSION = YES; - CLANG_WARN_IMPLICIT_SIGN_CONVERSION = YES; - CLANG_WARN_INFINITE_RECURSION = YES; - CLANG_WARN_INT_CONVERSION = YES; - CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; - CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; - CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; - CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; - CLANG_WARN_STRICT_PROTOTYPES = YES; - CLANG_WARN_SUSPICIOUS_IMPLICIT_CONVERSION = YES; - CLANG_WARN_SUSPICIOUS_MOVE = YES; - CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; - CLANG_WARN_UNREACHABLE_CODE = YES; - CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; - COPY_PHASE_STRIP = NO; - CURRENT_PROJECT_VERSION = 0.1; - DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; - DSTROOT = "$(XPLANE11_ROOT)/Resources/plugins/$(PROJECT)"; - DYLIB_COMPATIBILITY_VERSION = ""; - DYLIB_CURRENT_VERSION = ""; - ENABLE_NS_ASSERTIONS = NO; - ENABLE_STRICT_OBJC_MSGSEND = YES; - EXECUTABLE_EXTENSION = xpl; - FRAMEWORK_SEARCH_PATHS = ( - lib, - SDK/Libraries/Mac, - ); - GCC_C_LANGUAGE_STANDARD = c11; - GCC_NO_COMMON_BLOCKS = YES; - GCC_PREPROCESSOR_DEFINITIONS = ( - "APL=1", - "IBM=0", - "LIN=0", - "XPLM200=1", - "XPLM210=1", - "XPLM300=1", - "XPLM301=1", - "XPLM303=1", - ); - GCC_SYMBOLS_PRIVATE_EXTERN = YES; - GCC_WARN_64_TO_32_BIT_CONVERSION = YES; - GCC_WARN_ABOUT_MISSING_FIELD_INITIALIZERS = YES; - GCC_WARN_ABOUT_MISSING_NEWLINE = YES; - GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; - GCC_WARN_FOUR_CHARACTER_CONSTANTS = YES; - GCC_WARN_HIDDEN_VIRTUAL_FUNCTIONS = YES; - GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED = YES; - GCC_WARN_NON_VIRTUAL_DESTRUCTOR = YES; - GCC_WARN_SHADOW = YES; - GCC_WARN_SIGN_COMPARE = YES; - GCC_WARN_UNDECLARED_SELECTOR = YES; - GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; - GCC_WARN_UNKNOWN_PRAGMAS = YES; - GCC_WARN_UNUSED_FUNCTION = YES; - GCC_WARN_UNUSED_LABEL = YES; - GCC_WARN_UNUSED_PARAMETER = YES; - GCC_WARN_UNUSED_VARIABLE = YES; - HEADER_SEARCH_PATHS = ( - SDK/CHeaders/XPLM, - lib/XPMP2.framework/Headers, - "$(HEADER_SEARCH_PATHS)", - ); - MACH_O_TYPE = mh_bundle; - MACOSX_DEPLOYMENT_TARGET = 10.12; - OTHER_LDFLAGS = ( - "$(OTHER_LDFLAGS)", - "-Wl,-exported_symbol", - "-Wl,_XPluginStart", - "-Wl,-exported_symbol", - "-Wl,_XPluginEnable", - "-Wl,-exported_symbol", - "-Wl,_XPluginReceiveMessage", - "-Wl,-exported_symbol", - "-Wl,_XPluginDisable", - "-Wl,-exported_symbol", - "-Wl,_XPluginStop", - ); - PRODUCT_BUNDLE_IDENTIFIER = "com.twinfan.XPMP2-Sample"; - PRODUCT_NAME = "${TARGET_NAME}"; - SDKROOT = macosx; - XPLANE11_ROOT = "$(USER_APPS_DIR)/X-Plane/Release"; - }; - name = Release; - }; - D607B19C09A556E400699BC3 /* Debug */ = { - isa = XCBuildConfiguration; - buildSettings = { - CLANG_ENABLE_OBJC_WEAK = YES; - DEPLOYMENT_LOCATION = YES; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/lib", - ); - INSTALL_PATH = mac_x64; - VALID_ARCHS = x86_64; - }; - name = Debug; - }; - D607B19D09A556E400699BC3 /* Release */ = { - isa = XCBuildConfiguration; - buildSettings = { - CLANG_ENABLE_OBJC_WEAK = YES; - DEPLOYMENT_LOCATION = YES; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/lib", - ); - INSTALL_PATH = mac_x64; - VALID_ARCHS = x86_64; - }; - name = Release; - }; -/* End XCBuildConfiguration section */ - -/* Begin XCConfigurationList section */ - D607B16209A5563100699BC3 /* Build configuration list for PBXProject "XPMP2-Sample" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - D607B16309A5563100699BC3 /* Debug */, - D607B16409A5563100699BC3 /* Release */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; - D607B19B09A556E400699BC3 /* Build configuration list for PBXNativeTarget "XPMP2-Sample" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - D607B19C09A556E400699BC3 /* Debug */, - D607B19D09A556E400699BC3 /* Release */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; -/* End XCConfigurationList section */ - }; - rootObject = D607B16109A5563100699BC3 /* Project object */; -} diff --git a/XPMP2-Sample/docker/.gitignore b/XPMP2-Sample/docker/.gitignore deleted file mode 100755 index 5f697067..00000000 --- a/XPMP2-Sample/docker/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.image* -MacOSX* \ No newline at end of file diff --git a/XPMP2-Sample/docker/Dockerfile_Bionic b/XPMP2-Sample/docker/Dockerfile_Bionic deleted file mode 100755 index eecb9795..00000000 --- a/XPMP2-Sample/docker/Dockerfile_Bionic +++ /dev/null @@ -1,35 +0,0 @@ -# Linux compile environment, based on Ubuntu Bionic Beaver - -### Ubuntu basics ######################################################## - -FROM ubuntu:18.04 - -# set up package manager with latest mirrors and certificates -RUN sed -i -e 's/http:\/\/archive.ubuntu.com\/ubuntu\//mirror:\/\/mirrors.ubuntu.com\/mirrors.txt/' /etc/apt/sources.list \ - && apt-get update \ - && apt-get install -y --no-install-recommends ca-certificates - - -### Linux ################################################################ - -# Install Linux toolchain (GCC) including CMake -RUN apt-get install -y --no-install-recommends build-essential ninja-build sudo bash coreutils curl libcurl4-openssl-dev \ - && apt-get clean \ - && curl -sSL https://github.com/Kitware/CMake/releases/download/v3.19.2/cmake-3.19.2-Linux-x86_64.tar.gz | tar -xz -C /usr/local/ --strip-components=1 \ - # Install dependency libraries under Linux. - && apt-get install -y --no-install-recommends freeglut3-dev libudev-dev libopenal-dev \ - && apt-get clean - -### User / Entrypoint ####################################################expor - -# Add essential users to the docker image -RUN echo "" | adduser --uid 1000 --disabled-password --gecos "" xpbuild && adduser xpbuild sudo -RUN echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers - -VOLUME /build -USER xpbuild -ADD build.sh /usr/bin/build.sh - -# Entrypoint is the build.sh script, which takes care of actual building -WORKDIR /build -ENTRYPOINT ["build.sh"] diff --git a/XPMP2-Sample/docker/Dockerfile_Focal b/XPMP2-Sample/docker/Dockerfile_Focal deleted file mode 100644 index 438f25c0..00000000 --- a/XPMP2-Sample/docker/Dockerfile_Focal +++ /dev/null @@ -1,294 +0,0 @@ -# Linux, Windows, MacOS cross compile environment, based on Ubuntu Focal Fossa -# NOTE: This script does _not_ download the MacOS SDK from somewhere! -# Instead it is expected to sit in the current folder as MacOSX11.1.sdk.tar.xz -# or its location be passed via Docker ARGs "DARWIN_SDK_VERSION" and/or "DARWIN_SDK_PATH". - -FROM ubuntu:20.04 - -### MingW64 setup taken over from mmozeiko/mingw-w64 ##################### -# but I want Win32 threads, so I need to configure gcc differently - -WORKDIR /mnt - -ENV MINGW=/mingw - -ARG PKG_CONFIG_VERSION=0.29.2 -ARG CMAKE_VERSION=3.19.2 -ARG BINUTILS_VERSION=2.35.1 -ARG MINGW_VERSION=8.0.0 -ARG GCC_VERSION=10.2.0 -ARG NASM_VERSION=2.15.02 -ARG NVCC_VERSION=11.2.0 - -SHELL [ "/bin/bash", "-c" ] - -RUN set -ex \ - \ - && apt-get update \ - && DEBIAN_FRONTEND=noninteractive apt-get upgrade --no-install-recommends -y \ - && DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y \ - ca-certificates \ - gcc-10 \ - g++-10 \ - zlib1g-dev \ - libssl-dev \ - libgmp-dev \ - libmpfr-dev \ - libmpc-dev \ - libisl-dev \ - libssl1.1 \ - libgmp10 \ - libmpfr6 \ - libmpc3 \ - libisl22 \ - xz-utils \ - python \ - python-lxml \ - python-mako \ - ninja-build \ - texinfo \ - meson \ - gnupg \ - bzip2 \ - patch \ - gperf \ - bison \ - file \ - flex \ - make \ - yasm \ - wget \ - zip \ - git \ - \ - && update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 1000 --slave /usr/bin/g++ g++ /usr/bin/g++-10 \ - \ - && wget -q https://pkg-config.freedesktop.org/releases/pkg-config-${PKG_CONFIG_VERSION}.tar.gz -O - | tar -xz \ - && wget -q https://github.com/Kitware/CMake/releases/download/v${CMAKE_VERSION}/cmake-${CMAKE_VERSION}.tar.gz -O - | tar -xz \ - && wget -q https://ftp.gnu.org/gnu/binutils/binutils-${BINUTILS_VERSION}.tar.xz -O - | tar -xJ \ - && wget -q https://sourceforge.net/projects/mingw-w64/files/mingw-w64/mingw-w64-release/mingw-w64-v${MINGW_VERSION}.tar.bz2 -O - | tar -xj \ - && wget -q https://ftp.gnu.org/gnu/gcc/gcc-${GCC_VERSION}/gcc-${GCC_VERSION}.tar.xz -O - | tar -xJ \ - && wget -q https://www.nasm.us/pub/nasm/releasebuilds/${NASM_VERSION}/nasm-${NASM_VERSION}.tar.xz -O - | tar -xJ \ - \ - && wget -q https://raw.githubusercontent.com/msys2/MINGW-packages/master/mingw-w64-gcc/0020-libgomp-Don-t-hard-code-MS-printf-attributes.patch -O - | \ - patch -d gcc-${GCC_VERSION} -p 1 \ - \ - && mkdir -p ${MINGW}/include ${MINGW}/lib/pkgconfig \ - && chmod 0777 -R /mnt ${MINGW} \ - \ - && cd pkg-config-${PKG_CONFIG_VERSION} \ - && ./configure \ - --prefix=/usr/local \ - --with-pc-path=${MINGW}/lib/pkgconfig \ - --with-internal-glib \ - --disable-shared \ - --disable-nls \ - && make -j`nproc` \ - && make install \ - && cd .. \ - \ - && cd cmake-${CMAKE_VERSION} \ - && ./configure \ - --prefix=/usr/local \ - --parallel=`nproc` \ - && make -j`nproc` \ - && make install \ - && cd .. \ - \ - && cd binutils-${BINUTILS_VERSION} \ - && ./configure \ - --prefix=/usr/local \ - --target=x86_64-w64-mingw32 \ - --disable-shared \ - --enable-static \ - --disable-lto \ - --disable-plugins \ - --disable-multilib \ - --disable-nls \ - --disable-werror \ - --with-system-zlib \ - && make -j`nproc` \ - && make install \ - && cd .. \ - \ - && mkdir mingw-w64 \ - && cd mingw-w64 \ - && ../mingw-w64-v${MINGW_VERSION}/mingw-w64-headers/configure \ - --prefix=/usr/local/x86_64-w64-mingw32 \ - --host=x86_64-w64-mingw32 \ - --enable-sdk=all \ - --enable-secure-api \ - && make install \ - && cd .. \ - \ - && mkdir gcc \ - && cd gcc \ - && ../gcc-${GCC_VERSION}/configure \ - --prefix=/usr/local \ - --target=x86_64-w64-mingw32 \ - --enable-languages=c,c++ \ - --disable-shared \ - --enable-static \ - --enable-threads=win32 \ - --with-system-zlib \ - --enable-libgomp \ - --enable-libatomic \ - --enable-graphite \ - --disable-libstdcxx-pch \ - --disable-libstdcxx-debug \ - --disable-multilib \ - --disable-lto \ - --disable-nls \ - --disable-werror \ - && make -j`nproc` all-gcc \ - && make install-gcc \ - && cd .. \ - \ - && cd mingw-w64 \ - && ../mingw-w64-v${MINGW_VERSION}/mingw-w64-crt/configure \ - --prefix=/usr/local/x86_64-w64-mingw32 \ - --host=x86_64-w64-mingw32 \ - --enable-wildcard \ - --disable-lib32 \ - --enable-lib64 \ - && make -j`nproc` \ - && make install \ - && cd .. \ - \ - && cd mingw-w64 \ - && ../mingw-w64-v${MINGW_VERSION}/mingw-w64-libraries/winpthreads/configure \ - --prefix=/usr/local/x86_64-w64-mingw32 \ - --host=x86_64-w64-mingw32 \ - --enable-static \ - --disable-shared \ - && make -j`nproc` \ - && make install \ - && cd .. \ - \ - && cd gcc \ - && make -j`nproc` \ - && make install \ - && cd .. \ - \ - && cd nasm-${NASM_VERSION} \ - && ./configure --prefix=/usr/local \ - && make -j`nproc` \ - && make install \ - && cd .. \ - \ - && rm -r pkg-config-${PKG_CONFIG_VERSION} \ - && rm -r cmake-${CMAKE_VERSION} \ - && rm -r binutils-${BINUTILS_VERSION} \ - && rm -r mingw-w64 mingw-w64-v${MINGW_VERSION} \ - && rm -r gcc gcc-${GCC_VERSION} \ - && rm -r nasm-${NASM_VERSION} \ - \ - && apt-get remove --purge -y file gcc-10 g++-10 zlib1g-dev libssl-dev libgmp-dev libmpfr-dev libmpc-dev libisl-dev python-lxml python-mako \ - \ - && apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2004/x86_64/7fa2af80.pub \ - && echo "deb https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2004/x86_64/ /" > /etc/apt/sources.list.d/cuda.list \ - && apt-get update \ - \ - && DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y \ - cuda-nvcc-${NVCC_VERSION:0:2}-${NVCC_VERSION:3:1} \ - \ - && ln -s /usr/local/cuda-${NVCC_VERSION:0:2}.${NVCC_VERSION:3:1} /usr/local/cuda \ - && ln -s /usr/bin/gcc-9 /usr/local/cuda/bin/gcc \ - && ln -s /usr/bin/g++-9 /usr/local/cuda/bin/g++ \ - \ - && apt-get remove --purge -y gnupg \ - && apt-get autoremove --purge -y \ - && apt-get clean - -### -- End of MingW64 setup taken over from mmozeiko/mingw-w64 --- ####### - - -### MacOS ################################################################ - -# Install OS X cross-compiling toolchain (clang). -RUN apt-get install -y --no-install-recommends git sudo clang llvm-dev libxml2-dev uuid-dev libssl-dev bash patch make tar xz-utils bzip2 gzip sed cpio libbz2-dev zlib1g-dev && apt-get clean -#Build arguments -ARG OSXCROSS_REPO="tpoechtrager/osxcross" -ARG DARWIN_SDK_VERSION="11.1" -ARG DARWIN_SDK_PATH="MacOSX${DARWIN_SDK_VERSION}.sdk.tar.xz" -ARG DARWIN_TOOLCHAIN="x86_64-apple-darwin20.2" - -# ENV available in docker image -ENV CROSSBUILD=1 \ - OSX_SDK_PATH="/usr/osxcross/SDK/MacOSX${DARWIN_SDK_VERSION}.sdk" \ - OSX_TOOLCHAIN_PREFIX=${DARWIN_TOOLCHAIN} - -# Clone the OSXCross repo, latest master -RUN git clone 'https://github.com/tpoechtrager/osxcross' /tmp/osxcross - -# Copy the _provided_ MacOS SDK into the image as a tar ball (don't unpack yet! osxcross build.sh will do that later) -COPY ${DARWIN_SDK_PATH} /tmp/osxcross/tarballs/ - -# Build OSXCross -RUN cd /tmp/osxcross \ - && UNATTENDED=1 JOBS=4 SDK_VERSION=${DARWIN_SDK_VERSION} ./build.sh \ - && mv target /usr/osxcross \ - && mv tools /usr/osxcross/ \ - && sudo ldconfig /usr/osxcross/lib \ - && rm -rf "${OSX_SDK_PATH}/usr/share/man" \ - && rm -rf "/tmp/osxcross" \ - && true - - -### Linux ################################################################ - -# Install Linux toolchain (GCC) including CMake -RUN apt-get install -y --no-install-recommends \ - build-essential ninja-build \ - sudo bash coreutils curl \ - libcurl4-openssl-dev freeglut3-dev libudev-dev libopenal-dev \ - && apt-get clean \ -# && curl -sSL https://github.com/Kitware/CMake/releases/download/v3.19.2/cmake-3.19.2-Linux-x86_64.tar.gz | tar -xz -C /usr/local/ --strip-components=1 \ - && true - - -### CURL ################################################################# - -# Download and build libCURL (in a limited version for our purposes: static only for HTTP and FTP) -RUN apt-get install -y --no-install-recommends curl \ - && mkdir /tmp/build-curl \ - && cd /tmp/build-curl \ - && curl -sSL https://curl.se/download/curl-7.74.0.tar.gz | tar -xz -C . --strip-components=1 -ARG MY_CURL_OPT="--enable-static --disable-shared --enable-optimize --without-zlib --enable-http --enable-ipv6 --disable-dict --disable-file --disable-gopher --disable-imap --disable-ldap --disable-mqtt --disable-pop3 --disable-rtsp --disable-smtp --disable-telnet" -ARG WIN_TOOLCHAIN_PREFIX="x86_64-w64-mingw32" - -# --- Mingw64 (Windows) --- -RUN cd /tmp/build-curl \ - && ./configure --host=${WIN_TOOLCHAIN_PREFIX} --prefix=/usr/${WIN_TOOLCHAIN_PREFIX} --exec-prefix=/usr/${WIN_TOOLCHAIN_PREFIX} --disable-pthreads --with-winssl ${MY_CURL_OPT} \ - # install header files - && cd include \ - && make install \ - # make and install libcurl - && cd ../lib \ - && make \ - && make install \ - # remove the temporary build directory - && cd / \ - && rm -Rf /tmp/build-curl \ - && true - -### Add OSXCross and Mingw paths -ENV PATH="${PATH}:/usr/osxcross/bin" \ - MINGW_TOOLCHAIN_PREFIX="x86_64-w64-mingw32" \ - MINGW_PATH="/usr/x86_64-w64-mingw32" -RUN sudo ldconfig /usr/osxcross/lib - -### User / Entrypoint ####################################################expor - -# Add essential users to the docker image -RUN apt-get install -y --no-install-recommends sudo && apt-get clean \ - && echo "" | adduser --uid 1000 --disabled-password --gecos "" xpbuild && adduser xpbuild sudo \ - && echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers - -VOLUME /build -USER xpbuild -ADD build.sh /usr/bin/build.sh - -# Entrypoint is the build.sh script, which takes care of actual building -WORKDIR /build -ENTRYPOINT ["build.sh"] diff --git a/XPMP2-Sample/docker/Makefile b/XPMP2-Sample/docker/Makefile deleted file mode 100755 index 87cced53..00000000 --- a/XPMP2-Sample/docker/Makefile +++ /dev/null @@ -1,39 +0,0 @@ -platforms=win mac lin lin-bionic -container_focal=twinfan/focal-win-mac-lin-compile-env:02.00 -container_bionic=twinfan/bionic-lin-compile-env:01.00 - -all: $(platforms) - -.image_bionic: - docker image pull $(container_bionic) - docker inspect -f "{{ .ID}}" $(container_bionic) > .image_bionic - -.image_focal: - docker image pull $(container_focal) - docker inspect -f "{{ .ID}}" $(container_focal) > .image_focal - -bash_bionic: .image_bionic - docker run -it --rm -v "$(realpath ..):/build" --entrypoint bash $(container_bionic) - -bash_focal: .image_focal - docker run -it --rm -v "$(realpath ..):/build" --entrypoint bash $(container_focal) - -lin-bionic: .image_bionic - docker run -i --rm -v "$(realpath ..):/build" --entrypoint docker/build.sh $(container_bionic) $@ - -lin win mac-arm mac-x86: .image_focal - docker run -i --rm -v "$(realpath ..):/build" --entrypoint docker/build.sh $(container_focal) $@ - -mac: mac-arm mac-x86 - mkdir -p ../build-mac/mac_x64 - docker run -i --rm -v "$(realpath ..):/build" --entrypoint bash $(container_focal) -c 'lipo -create -output build-mac/mac_x64/XPMP2-Sample.xpl build-mac-x86/mac_x64/XPMP2-Sample.xpl build-mac-arm/mac_x64/XPMP2-Sample.xpl' - -clean: - rm -rf ../build-lin - rm -rf ../build-lin-bionic - rm -rf ../build-mac - rm -rf ../build-mac-arm - rm -rf ../build-mac-x86 - rm -rf ../build-win - -.PHONY: clean doc $(platforms) bash_bionic bash_focal diff --git a/XPMP2-Sample/docker/README.md b/XPMP2-Sample/docker/README.md deleted file mode 100644 index 8ccb9205..00000000 --- a/XPMP2-Sample/docker/README.md +++ /dev/null @@ -1,50 +0,0 @@ -# Docker Build environment - -This directory contains a setup to build all 3 platforms -(Windows, Linux, MacOS) via Docker environments in a -reproducible way. This allows to verify all three environments -compile and link fine. The resulting binaries are supposed -to actually work, though native build environments -(like Visual Studio or XCode) might produce smaller binaries. - -## Just Build - -If you "just want to build" then - -1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop) - and make sure it is running -2. `cd docker` -3. `make` - -During the very first invocaton this can take several minutes -as the two(!) involved Docker images are build for the first ime. -Subsequent builds will run in a matter of seconds. - -Find results in - -- `build-lin` -- `build-mac` -- `build-win` - -## Setup - -### Linux and MacOS based on Ubunto 18.04 - -For Linux and MacOS builds an environment based on Ubuntu 18.04 -is created, defined in `Dockerfile_Bionix` which installs -Linux build and MacOS cross compile tools. - -The resulting image is tagged `bionic-lin-mac-compile-env`. - -### Windows based on Ubuntu 20.04 with Mingw64 - -Windows is cross-compiled on an Ubuntu 20.04-based setup -using Mingw 8.0. Creating this image takes especially long -as several tools including Mingw intself are built from sources. - -`Dockerfile_Mingw` is based on the image -[`mmozeiko/mingw-w64`](https://hub.docker.com/r/mmozeiko/mingw-w64), -the only change is that the Mingw64/gcc compilers are configured -to use Win32 threads instead of pthreads library. - -When finished it is tagged `mingw-compile-env`. diff --git a/XPMP2-Sample/docker/Toolchain-mingw-w64-x86-64.cmake b/XPMP2-Sample/docker/Toolchain-mingw-w64-x86-64.cmake deleted file mode 100755 index cd68f430..00000000 --- a/XPMP2-Sample/docker/Toolchain-mingw-w64-x86-64.cmake +++ /dev/null @@ -1,15 +0,0 @@ -# Sample toolchain file for building for Windows from an Ubuntu Linux system. -# -# Expected environment variables and example values: -# MINGW_TOOLCHAIN_PREFIX = "x86_64-w64-mingw32" -# OSX_SDK_PATH = "/usr/x86_64-w64-mingw32" - -set(CMAKE_SYSTEM_NAME Windows) -set(CMAKE_INSTALL_PREFIX $ENV{MINGW_PATH}) -set(CMAKE_FIND_ROOT_PATH $ENV{MINGW_PATH}) -set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) -set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY BOTH) -set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) -set(CMAKE_C_COMPILER $ENV{MINGW_TOOLCHAIN_PREFIX}-gcc) -set(CMAKE_CXX_COMPILER $ENV{MINGW_TOOLCHAIN_PREFIX}-g++) -set(CMAKE_RC_COMPILER $ENV{MINGW_TOOLCHAIN_PREFIX}-windres) diff --git a/XPMP2-Sample/docker/Toolchain-ubuntu-osxcross.cmake b/XPMP2-Sample/docker/Toolchain-ubuntu-osxcross.cmake deleted file mode 100755 index 6e182cfe..00000000 --- a/XPMP2-Sample/docker/Toolchain-ubuntu-osxcross.cmake +++ /dev/null @@ -1,24 +0,0 @@ -# Sample toolchain file for building for Mac OS X from an Ubuntu Linux system. -# -# Expected environment variables and example values: -# OSX_TOOLCHAIN_PREFIX = "x86_64-apple-darwin20.2" -# OSX_SDK_PATH = "/usr/osxcross/SDK/MacOSX11.1.sdk" - -set(CMAKE_SYSTEM_NAME Darwin) -set(TOOLCHAIN_PREFIX $ENV{OSX_TOOLCHAIN_PREFIX}) - -# cross compilers to use for C and C++ -set(CMAKE_C_COMPILER ${TOOLCHAIN_PREFIX}-clang) -set(CMAKE_CXX_COMPILER ${TOOLCHAIN_PREFIX}-clang++-libc++) - - -# target environment on the build host system -# set 1st to dir with the cross compiler's C/C++ headers/libs -set(CMAKE_FIND_ROOT_PATH $ENV{OSX_SDK_PATH}) - -# modify default behavior of FIND_XXX() commands to -# search for headers/libs in the target environment and -# search for programs in the build host environment -set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM BOTH) -set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY BOTH) -set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE BOTH) diff --git a/XPMP2-Sample/docker/build.sh b/XPMP2-Sample/docker/build.sh deleted file mode 100755 index a46b9213..00000000 --- a/XPMP2-Sample/docker/build.sh +++ /dev/null @@ -1,35 +0,0 @@ -#!/bin/bash -set -eu - -function build() { - local src_dir="$1" - export platform="$2" - echo "----------------- Building for $platform -----------------" - - local build_dir="$src_dir/build-$platform" - - echo "pwd = $(pwd)" - echo "src_dir = $src_dir" - echo "build_dir = $build_dir" - - local flags=() - local cmake="cmake" - case "$platform" in - win) - flags+=('-DCMAKE_TOOLCHAIN_FILE=../docker/Toolchain-mingw-w64-x86-64.cmake') - ;; - mac*) - flags+=('-DCMAKE_TOOLCHAIN_FILE=../docker/Toolchain-ubuntu-osxcross.cmake') - ;; - esac - - mkdir -p "$build_dir" && cd "$build_dir" - "$cmake" -G Ninja "${flags[@]}" .. - ninja -} - -src_dir="$(pwd)" - -for platform in $@; do - build "$src_dir" "$platform" -done diff --git a/XPMP2-Sample/lib/.gitignore b/XPMP2-Sample/lib/.gitignore deleted file mode 100644 index 5f4af658..00000000 --- a/XPMP2-Sample/lib/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -XPMP2.framework/Headers -XPMP2.framework/Modules -XPMP2.framework/Resources -XPMP2.framework/Current -XPMP2.framework/XPMP2 diff --git a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPCAircraft.h b/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPCAircraft.h deleted file mode 100644 index 26ad637a..00000000 --- a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPCAircraft.h +++ /dev/null @@ -1,75 +0,0 @@ -/// @file XPCAircraft.h -/// @brief XPMP2::Aircraft / XPCAircraft represent an aircraft as managed by XPMP2 -/// @deprecated XPCAircraft bases on and is compile-compatible to the XPCAircraft wrapper -/// class provided with the original libxplanemp. -/// In XPMP2, however, this class is not a wrapper but derived from -/// XPMP2::Aircraft, which is the actual means of managing aircraft, -/// Hence, it includes a lot more members.\n -/// New implementations should derive directly from XPMP2::Aircraft. -/// @author Birger Hoppe -/// @copyright The original XPCAircraft.h file in libxplanemp had no copyright note. -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -#ifndef _XPCAircraft_h_ -#define _XPCAircraft_h_ - -#include "XPMPAircraft.h" - -/// @brief Legacy wrapper class as provided by original libxplanemp -/// @deprecated Only provided for backwards compile-compatibility. -/// New implementations should subclass XPMP2::Aircraft directly. -class [[deprecated("Subclass XPMP2::Aircraft instead")]] -XPCAircraft : public XPMP2::Aircraft { - -public: - /// Last position data. GetPlanePosition() passes a pointer to this member variable - XPMPPlanePosition_t acPos; - /// Last surface data. GetPlaneSurfaces() passes a pointer to this member variable - XPMPPlaneSurfaces_t acSurfaces; - -public: - - /// @brief Legacy constructor creates a plane and puts it under control of XPlaneMP - /// @exception XPMP2::XPMP2Error Mode S id invalid or duplicate, no model found during model matching - /// @param _icaoType ICAO aircraft type designator, like 'A320', 'B738', 'C172' - /// @param _icaoAirline ICAO airline code, like 'BAW', 'DLH', can be an empty string - /// @param _livery Special livery designator, can be an empty string - /// @param _modeS_id (optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given - /// @param _modelId (optional) specific model id to be used (no folder/package name, just the id as defined in the `OBJ8_AIRCRAFT` line) - XPCAircraft(const char* _icaoType, - const char* _icaoAirline, - const char* _livery, - XPMPPlaneID _modeS_id = 0, // new parameters are defaulted, so that old code should compile - const char* _modelId = nullptr); - - /// Legacy: Called before rendering to query plane's current position, overwrite to provide your implementation - virtual XPMPPlaneCallbackResult GetPlanePosition(XPMPPlanePosition_t* outPosition) = 0; - /// Legacy: Called before rendering to query plane's current configuration, overwrite to provide your implementation - virtual XPMPPlaneCallbackResult GetPlaneSurfaces(XPMPPlaneSurfaces_t* outSurfaces) = 0; - /// Legacy: Called before rendering to query plane's current radar visibility, overwrite to provide your implementation - virtual XPMPPlaneCallbackResult GetPlaneRadar(XPMPPlaneRadar_t* outRadar) = 0; - /// Legacy: Called before rendering to query plane's textual information, overwrite to provide your implementation (optional) - virtual XPMPPlaneCallbackResult GetInfoTexts(XPMPInfoTexts_t * /*outInfoTexts*/) - { return xpmpData_Unavailable; } - - /// Just calls all 4 previous `Get...` functions and copies the provided values into `drawInfo` and `v` - virtual void UpdatePosition (float _elapsedSinceLastCall, int _flCounter); - -}; - -#endif diff --git a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPAircraft.h b/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPAircraft.h deleted file mode 100644 index 8ebccfb5..00000000 --- a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPAircraft.h +++ /dev/null @@ -1,623 +0,0 @@ -/// @file XPMPAircraft.h -/// @brief XPMP2::Aircraft represent an aircraft as managed by XPMP2 -/// @details New implementations should derive directly from XPMP2::Aircraft. -/// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -#ifndef _XPMPAircraft_h_ -#define _XPMPAircraft_h_ - -#include "XPMPMultiplayer.h" -#include "XPLMInstance.h" -#include "XPLMCamera.h" -#include "XPLMMap.h" - -#include -#include -#include -#include -#include -#include - -// -// MARK: XPMP2 New Definitions -// - -namespace XPMP2 { - -class CSLModel; - -/// Convert revolutions-per-minute (RPM) to radians per second (rad/s) by multiplying with PI/30 -constexpr float RPM_to_RADs = 0.10471975511966f; -/// Convert feet to meters, e.g. for altitude calculations -constexpr double M_per_FT = 0.3048; // meter per 1 foot -/// Convert nautical miles to meters -constexpr int M_per_NM = 1852; // meter per one nautical mile -/// @brief standard gravitational acceleration [m/s²] -/// @see https://en.wikipedia.org/wiki/Gravity_of_Earth -constexpr float G_EARTH = 9.80665f; - -/// The dataRefs provided by XPMP2 to the CSL models -enum DR_VALS : std::uint8_t { - V_CONTROLS_GEAR_RATIO = 0, ///< `libxplanemp/controls/gear_ratio` and \n`sim/cockpit2/tcas/targets/position/gear_deploy` - V_CONTROLS_NWS_RATIO, ///< `libxplanemp/controls/nws_ratio`, the nose wheel angle, actually in degrees - V_CONTROLS_FLAP_RATIO, ///< `libxplanemp/controls/flap_ratio` and \n`sim/cockpit2/tcas/targets/position/flap_ratio` and `...flap_ratio2` - V_CONTROLS_SPOILER_RATIO, ///< `libxplanemp/controls/spoiler_ratio` - V_CONTROLS_SPEED_BRAKE_RATIO, ///< `libxplanemp/controls/speed_brake_ratio` and \n`sim/cockpit2/tcas/targets/position/speedbrake_ratio` - V_CONTROLS_SLAT_RATIO, ///< `libxplanemp/controls/slat_ratio` and \n`sim/cockpit2/tcas/targets/position/slat_ratio` - V_CONTROLS_WING_SWEEP_RATIO, ///< `libxplanemp/controls/wing_sweep_ratio` and \n`sim/cockpit2/tcas/targets/position/wing_sweep` - V_CONTROLS_THRUST_RATIO, ///< `libxplanemp/controls/thrust_ratio` and \n`sim/cockpit2/tcas/targets/position/throttle` - V_CONTROLS_YOKE_PITCH_RATIO, ///< `libxplanemp/controls/yoke_pitch_ratio` and \n`sim/cockpit2/tcas/targets/position/yolk_pitch` - V_CONTROLS_YOKE_HEADING_RATIO, ///< `libxplanemp/controls/yoke_heading_ratio` and \n`sim/cockpit2/tcas/targets/position/yolk_yaw` - V_CONTROLS_YOKE_ROLL_RATIO, ///< `libxplanemp/controls/yoke_roll_ratio` and \n`sim/cockpit2/tcas/targets/position/yolk_roll` - V_CONTROLS_THRUST_REVERS, ///< `libxplanemp/controls/thrust_revers` - - V_CONTROLS_TAXI_LITES_ON, ///< `libxplanemp/controls/taxi_lites_on` and \n`sim/cockpit2/tcas/targets/position/lights` - V_CONTROLS_LANDING_LITES_ON, ///< `libxplanemp/controls/landing_lites_on` and \n`sim/cockpit2/tcas/targets/position/lights` - V_CONTROLS_BEACON_LITES_ON, ///< `libxplanemp/controls/beacon_lites_on` and \n`sim/cockpit2/tcas/targets/position/lights` - V_CONTROLS_STROBE_LITES_ON, ///< `libxplanemp/controls/strobe_lites_on` and \n`sim/cockpit2/tcas/targets/position/lights` - V_CONTROLS_NAV_LITES_ON, ///< `libxplanemp/controls/nav_lites_on` and \n`sim/cockpit2/tcas/targets/position/lights` - - V_GEAR_NOSE_GEAR_DEFLECTION_MTR, ///< `libxplanemp/gear/nose_gear_deflection_mtr` - V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR, ///< `libxplanemp/gear/tire_vertical_deflection_mtr` - V_GEAR_TIRE_ROTATION_ANGLE_DEG, ///< `libxplanemp/gear/tire_rotation_angle_deg` - V_GEAR_TIRE_ROTATION_SPEED_RPM, ///< `libxplanemp/gear/tire_rotation_speed_rpm` - V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC, ///< `libxplanemp/gear/tire_rotation_speed_rad_sec` - - V_ENGINES_ENGINE_ROTATION_ANGLE_DEG, ///< `libxplanemp/engines/engine_rotation_angle_deg` - V_ENGINES_ENGINE_ROTATION_SPEED_RPM, ///< `libxplanemp/engines/engine_rotation_speed_rpm` - V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC, ///< `libxplanemp/engines/engine_rotation_speed_rad_sec` - V_ENGINES_PROP_ROTATION_ANGLE_DEG, ///< `libxplanemp/engines/prop_rotation_angle_deg` - V_ENGINES_PROP_ROTATION_SPEED_RPM, ///< `libxplanemp/engines/prop_rotation_speed_rpm` - V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC, ///< `libxplanemp/engines/prop_rotation_speed_rad_sec` - V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO, ///< `libxplanemp/engines/thrust_reverser_deploy_ratio` - - V_ENGINES_ENGINE_ROTATION_ANGLE_DEG1, ///< `libxplanemp/engines/engine_rotation_angle_deg1` - V_ENGINES_ENGINE_ROTATION_ANGLE_DEG2, ///< `libxplanemp/engines/engine_rotation_angle_deg2` - V_ENGINES_ENGINE_ROTATION_ANGLE_DEG3, ///< `libxplanemp/engines/engine_rotation_angle_deg3` - V_ENGINES_ENGINE_ROTATION_ANGLE_DEG4, ///< `libxplanemp/engines/engine_rotation_angle_deg4` - V_ENGINES_ENGINE_ROTATION_SPEED_RPM1, ///< `libxplanemp/engines/engine_rotation_speed_rpm1` - V_ENGINES_ENGINE_ROTATION_SPEED_RPM2, ///< `libxplanemp/engines/engine_rotation_speed_rpm2` - V_ENGINES_ENGINE_ROTATION_SPEED_RPM3, ///< `libxplanemp/engines/engine_rotation_speed_rpm3` - V_ENGINES_ENGINE_ROTATION_SPEED_RPM4, ///< `libxplanemp/engines/engine_rotation_speed_rpm4` - V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC1, ///< `libxplanemp/engines/engine_rotation_speed_rad_sec1` - V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC2, ///< `libxplanemp/engines/engine_rotation_speed_rad_sec2` - V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC3, ///< `libxplanemp/engines/engine_rotation_speed_rad_sec3` - V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC4, ///< `libxplanemp/engines/engine_rotation_speed_rad_sec4` - - - V_MISC_TOUCH_DOWN, ///< `libxplanemp/misc/touch_down` - - V_COUNT ///< always last, number of dataRefs XPMP2 pre-defines -}; - -/// @brief Collates some information on the CSL model -/// @details The XPMP2::CSLModel class definition is private to the XPMP2 library -/// as it contains many technical implementation details. -/// This structure contains some of the CSLModel information in a public -/// definition, returned by XPMP2::Aircraft::GetModelInfo(). -struct CSLModelInfo_t { - /// id, just an arbitrary label read from `xsb_aircraft.txt::OBJ8_AIRCRAFT` - std::string cslId; - /// name, formed by last part of path plus id - std::string modelName; - /// Path to the xsb_aircraft.txt file from where this model is loaded - std::string xsbAircraftPath; - /// Line number in the xsb_aircraft.txt file where the model definition starts - int xsbAircraftLn = 0; - /// ICAO aircraft type this model represents: `xsb_aircraft.txt::ICAO` - std::string icaoType; - /// Doc8643 information: Classification, like L1P, L4J, H1T - std::string doc8643Classification; - /// Doc8643 information: wake turbulence class, like M, L/M, L, H - std::string doc8643WTC; - - /// Any number of airline codes and/or liveries can be assigned to a model for matching purpose - struct MatchCrit_t { - std::string icaoAirline; ///< ICAO airine/operator code - std::string livery; ///< special livery (not often used) - }; - typedef std::vector vecMatchCrit_t; - // List of match criteria defined for the model, can be empty - vecMatchCrit_t vecMatchCrit; - - /// Default constructor does nothing - CSLModelInfo_t() {} - /// Constructor copies from XPMP2::CSLModel - CSLModelInfo_t(const XPMP2::CSLModel& csl); -}; - -/// @brief Actual representation of all aircraft in XPMP2. -/// @note In modern implementations, this class shall be subclassed by your plugin's code. -class Aircraft { - -public: - -protected: - /// @brief A plane is uniquely identified by a 24bit number [0x01..0xFFFFFF] - /// @details This number is directly used as `modeS_id` n the new - /// [TCAS override](https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/) - /// approach. - XPMPPlaneID modeS_id = 0; - -public: - /// @brief ICAO aircraft type designator of this plane - /// @see https://www.icao.int/publications/DOC8643/Pages/Search.aspx - std::string acIcaoType; - std::string acIcaoAirline; ///< ICAO Airline code of this plane - std::string acLivery; ///< Livery code of this plane - - /// @brief Holds position (in local coordinates!) and orientation (pitch, heading roll) of the aircraft. - /// @details This is where the plane will be placed in this drawing cycle.\n - /// @note When filling `y` directly (instead of using SetLocation()) remember to add - /// GetVertOfs() for accurate placement on the ground - XPLMDrawInfo_t drawInfo; - - /// Is the aircraft on the ground? - bool bOnGrnd = false; - - /// @brief actual dataRef values to be provided to the CSL model - /// @details XPMP2 provides a minimum set of dataRefs and also getter/setter - /// member functions, see below. This is the one place where - /// current dataRef values are stored. This array is passed on - /// _directly_ to the XP instance.\n - /// The size of the vector can increase if adding user-defined - /// dataRefs through XPMPAddModelDataRef(). - std::vector v; - - /// aircraft label shown in the 3D world next to the plane - std::string label; - float colLabel[4] = {1.0f,1.0f,0.0f,1.0f}; ///< label base color (RGB) - bool bDrawLabel = true; ///< Shall this aircraft's label be drawn? - - /// How much of the vertical offset shall be applied? (This allows phasing out the vertical offset in higher altitudes.) [0..1] - float vertOfsRatio = 1.0f; - - /// @brief By how much of the gear deflection shall the plane's altitude be reduced? - /// @details This is to keep the wheels on the ground when gear deflection is applied. - /// Unfortunately, the exact factor is model-dependend. `0.5` seems an OK compromise.\n - /// If you know better, then overwrite.\n - /// If you don't want XPMP2 to correct for gear deflection, set `0.0`. - float gearDeflectRatio = 0.5f; - - /// @brief Shall this plane be clamped to ground (ie. never sink below ground)? - /// @note This involves Y-Testing, which is a bit expensive, see [SDK](https://developer.x-plane.com/sdk/XPLMScenery). - /// If you know your plane is not close to the ground, - /// you may want to avoid clamping by setting this to `false`. - /// @see configuration item `XPMP2_CFG_ITM_CLAMPALL` - bool bClampToGround = false; - - /// @brief Priority for display in one of the limited number of TCAS target slots - /// @details The lower the earlier will a plane be considered for TCAS. - /// Increase this value if you want to make a plane less likely - /// to occupy one of the limited TCAS slots. - int aiPrio = 1; - - /// @brief Current radar status - /// @note Only the condition `mode != Standby` is of interest to XPMP2 for considering the aircraft for TCAS display - XPMPPlaneRadar_t acRadar; - - /// @brief Wake dataRef support - /// @see https://developer.x-plane.com/article/plugin-traffic-wake-turbulence/ - /// @details If values aren't set during aircraft creation, ie. remain at `NAN`, then defaults will be applied - /// based on the aircraft's wake turbulence category, - /// looked up from the Doc8643 list via ICAO aircraft type designator. - struct wakeTy { - float wingSpan_m = NAN; ///< wing span of the aircraft creating wake turbulence - float wingArea_m2 = NAN; ///< wing area (total area of both wings combined) of the aircraft creating wake turbulence - float mass_kg = NAN; ///< actual mass of the aircraft creating the wake - - void clear() { *this = wakeTy(); } ///< clear all values to defaults - bool needsDefaults() const; ///< any value left at `NAN`, ie. requires setting from Doc8643 WTC defaults? - /// based on Doc8643 WTC fill with defaults - void applyDefaults(const std::string& _wtc, bool _bOverwriteAllFields = true); - /// Copies values only for non-NAN fields - void fillUpFrom(const wakeTy& o); - } wake; ///< wake-support data - - /// Informational texts passed on via multiplayer shared dataRefs - XPMPInfoTexts_t acInfoTexts; - -protected: - bool bValid = true; ///< is this object valid? (Will be reset in case of exceptions) - bool bVisible = true; ///< Shall this plane be drawn at the moment and be visible to TCAS/interfaces? - bool bRender = true; ///< Shall the CSL model be drawn in 3D world? (if !bRender && bVivile then still visible on TCAS/interfaces, Remote Client uses this for local senders' planes to take over TCAS but not drawing) - - XPMP2::CSLModel* pCSLMdl = nullptr; ///< the CSL model in use - int matchQuality = -1; ///< quality of the match with the CSL model - int acRelGrp = 0; ///< related group, ie. line in `related.txt` in which this a/c appears, if any - - // this is data from about a second ago to calculate cartesian velocities - float prev_x = 0.0f, prev_y = 0.0f, prev_z = 0.0f; - float prev_ts = 0.0f; ///< last update of `prev_x/y/z` in XP's network time - - /// Set by SetOnGrnd() with the timestamp when to reset SetTouchDown() - float tsResetTouchDown = NAN; - - /// X-Plane instance handles for all objects making up the model - std::list listInst; - /// Which `sim/cockpit2/tcas/targets`-index does this plane occupy? [1..63], `-1` if none - int tcasTargetIdx = -1; - - /// Timestamp of last update of camera dist/bearing - float camTimLstUpd = 0.0f; - /// Distance to camera in meters (updated internally regularly) - float camDist = 0.0f; - /// Bearing from camera in degrees (updated internally regularly) - float camBearing = 0.0f; - - /// Y Probe for terrain testing, needed in ground clamping - XPLMProbeRef hProbe = nullptr; - - // Data used for drawing icons in X-Plane's map - int mapIconRow = 0; ///< map icon coordinates, row - int mapIconCol = 0; ///< map icon coordinates, column - float mapX = 0.0f; ///< temporary: map coordinates (NAN = not to be drawn) - float mapY = 0.0f; ///< temporary: map coordinates (NAN = not to be drawn) - std::string mapLabel; ///< label for map drawing - -private: - bool bDestroyInst = false; ///< Instance to be destroyed in next flight loop callback? -public: - /// @brief Constructor creates a new aircraft object, which will be managed and displayed - /// @exception XPMP2::XPMP2Error Mode S id invalid or duplicate, no model found during model matching - /// @param _icaoType ICAO aircraft type designator, like 'A320', 'B738', 'C172' - /// @param _icaoAirline ICAO airline code, like 'BAW', 'DLH', can be an empty string - /// @param _livery Special livery designator, can be an empty string - /// @param _modeS_id (optional) **Unique** identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given - /// @param _cslId (optional) specific unique model id to be used (package name/short id, as defined in the `OBJ8_AIRCRAFT` line) - Aircraft (const std::string& _icaoType, - const std::string& _icaoAirline, - const std::string& _livery, - XPMPPlaneID _modeS_id = 0, - const std::string& _cslId = ""); - /// Default constructor creates an empty, invalid(!) and invisible shell; call XPMP2::Aircraft::Create() to actually create a plane - Aircraft (); - /// Destructor cleans up all resources acquired - virtual ~Aircraft(); - - /// Aircraft must not be copied as they reference non-copyable resources like XP instances - Aircraft (const Aircraft&) = delete; - /// Aircraft must not be copied as they reference non-copyable resources like XP instances - Aircraft& operator=(const Aircraft&) = delete; - - /// @brief Creates a plane, only a valid operation if object was created using the default constructor - /// @exception Tried on already defined object; XPMP2::XPMP2Error Mode S id invalid or duplicate, no model found during model matching - /// @param _icaoType ICAO aircraft type designator, like 'A320', 'B738', 'C172' - /// @param _icaoAirline ICAO airline code, like 'BAW', 'DLH', can be an empty string - /// @param _livery Special livery designator, can be an empty string - /// @param _modeS_id (optional) **Unique** identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given - /// @param _cslId (optional) specific unique model id to be used (package name/short id, as defined in the `OBJ8_AIRCRAFT` line) - /// @param _pCSLModel (optional) The actual model to use (no matching or search by `_cslId` if model is given this way) - void Create (const std::string& _icaoType, - const std::string& _icaoAirline, - const std::string& _livery, - XPMPPlaneID _modeS_id = 0, - const std::string& _cslId = "", - CSLModel* _pCSLModel = nullptr); - - /// return the XPMP2 plane id - XPMPPlaneID GetModeS_ID () const { return modeS_id; } - /// Is this object a ground vehicle? - bool IsGroundVehicle() const; - /// @brief Is this object "related" to the given ICAO code? (named in the same line in related.txt) - /// @param _icaoType ICAO aircraft type designator, to which `*this` is compared - /// @details For example, `IsRelatedTo("GLID")` returns if `*this` is a glider - bool IsRelatedTo (const std::string& _icaoType) const; - /// @brief return the current TCAS target index (into `sim/cockpit2/tcas/targets`), 1-based, `-1` if not used - int GetTcasTargetIdx () const { return tcasTargetIdx; } - /// Is this plane currently also being tracked as a TCAS target, ie. will appear on TCAS? - bool IsCurrentlyShownAsTcasTarget () const { return tcasTargetIdx >= 1; } - /// Is this plane currently also being tracked by X-Plane's classic AI/multiplayer? - bool IsCurrentlyShownAsAI () const; - /// Is this plane to be drawn on TCAS? (It will if transponder is not switched off) - bool ShowAsAIPlane () const { return IsVisible() && acRadar.mode != xpmpTransponderMode_Standby; } - /// Reset TCAS target slot index to `-1` - void ResetTcasTargetIdx () { tcasTargetIdx = -1; } - - /// @brief Return a value for dataRef .../tcas/target/flight_id - /// @returns The first non-empty string out of: flight number, registration, departure/arrival airports - virtual std::string GetFlightId() const; - - /// @brief (Potentially) changes the plane's model after doing a new match attempt - /// @param _icaoType ICAO aircraft type designator, like 'A320', 'B738', 'C172' - /// @param _icaoAirline ICAO airline code, like 'BAW', 'DLH', can be an empty string - /// @param _livery Special livery designator, can be an empty string - /// @return match quality, the lower the better - int ChangeModel (const std::string& _icaoType, - const std::string& _icaoAirline, - const std::string& _livery); - - /// @brief Finds a match again, using the existing parameters, eg. after more models have been loaded - /// @return match quality, the lower the better - int ReMatchModel () { return ChangeModel(acIcaoType,acIcaoAirline,acLivery); } - - /// @brief Assigns the given model - /// @param _cslId Search for this id (package/short) - /// @param _pCSLModel (optional) If given use this model and don't search - /// @return Successfuly found and assigned a model? - bool AssignModel (const std::string& _cslId, - CSLModel* _pCSLModel = nullptr); - - /// return a pointer to the CSL model in use (Note: The CSLModel structure is not public.) - XPMP2::CSLModel* GetModel () const { return pCSLMdl; } - /// return the name of the CSL model in use - const std::string& GetModelName () const; - /// return an information structure for the CSL model associated with the aircraft - CSLModelInfo_t GetModelInfo() const { return pCSLMdl ? CSLModelInfo_t(*pCSLMdl) : CSLModelInfo_t(); } - /// quality of the match with the CSL model - int GetMatchQuality () const { return matchQuality; } - /// Vertical offset, ie. the value that needs to be added to `drawInfo.y` to make the aircraft appear on the ground - float GetVertOfs () const; - - /// Is the a/c object valid? - bool IsValid() const { return bValid; } - /// Mark the plane invalid, e.g. after exceptions occured on the data - virtual void SetInvalid(); - - /// Make the plane (in)visible - virtual void SetVisible (bool _bVisible); - /// Is the plane visible? - bool IsVisible () const { return bVisible && bValid; } - - /// Switch rendering of the CSL model on or off - virtual void SetRender (bool _bRender); - /// Is this plane to be rendered? - bool IsRendered () const { return bRender && IsVisible(); } - - /// Are instances created for this aircraft? - bool IsInstanciated () const { return !listInst.empty(); } - - /// Define if this aircraft's label is to be drawn (provided label drawing is enabled globally) - void SetDrawLabel (bool _b) { bDrawLabel = _b; } - /// Shall this aircraft's label be drawn? - bool ShallDrawLabel () const { return bDrawLabel; } - - /// Distance to camera [m] - float GetCameraDist () const { return camDist; } - /// Bearing from camera [°] - float GetCameraBearing () const { return camBearing; } - - /// @brief Called right before updating the aircraft's placement in the world - /// @details Abstract virtual function. Override in derived classes and fill - /// `drawInfo`, the `v` array of dataRefs by calling the `Set`ters, - /// `label`, and `infoTexts` with current values. - /// @see See [XPLMFlightLoop_f](https://developer.x-plane.com/sdk/XPLMProcessing/#XPLMFlightLoop_f) - /// for background on the two passed-on parameters: - /// @param _elapsedSinceLastCall The wall time since last call - /// @param _flCounter A monotonically increasing counter, bumped once per flight loop dispatch from the sim. - virtual void UpdatePosition (float _elapsedSinceLastCall, int _flCounter) = 0; - - /// Is the aircraft on the ground? - bool IsOnGrnd () const { return bOnGrnd; } - /// @brief Set if the aircraft is on the ground - /// @param on_grnd Is the aircraft on the ground? - /// @param setTouchDownTime [opt] If not `NAN` activates SetTouchDown(), and automatically resets it after the given time in seconds - void SetOnGrnd (bool on_grnd, float setTouchDownTime = NAN); - - // --- Getters and Setters for the values in `drawInfo` --- - - /// @brief Converts world coordinates to local coordinates, writes to Aircraft::drawInfo - /// @note Alternatively, the calling plugin can set local coordinates in Aircraft::drawInfo directly - /// @param lat Latitude in degress -90..90 - /// @param lon Longitude in degrees -180..180 - /// @param alt_ft Altitude in feet above MSL - /// @param on_grnd Is the aircraft on the ground? - /// @param setTouchDownTime [opt] If not `NAN` activates SetTouchDown(), and automatically resets it after the given time in seconds - void SetLocation (double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime = NAN) { - SetLocation(lat, lon, alt_ft); - SetOnGrnd(on_grnd, setTouchDownTime); - } - - /// Legacy version of above version of SetLocatiion(), here without setting ground flag - void SetLocation (double lat, double lon, double alt_ft); - - /// @brief Converts aircraft's local coordinates to lat/lon values - /// @warning This isn't exactly precice. If you need precise location keep it in your derived class yourself. - void GetLocation (double& lat, double& lon, double& alt_ft) const; - - /// Sets location in local world coordinates - void SetLocalLoc (float _x, float _y, float _z) { drawInfo.x = _x; drawInfo.y = _y; drawInfo.z = _z; } - /// Gets all location info (including local coordinates) - const XPLMDrawInfo_t& GetLocation () const { return drawInfo; } - - float GetPitch () const { return drawInfo.pitch; } ///< pitch [degree] - void SetPitch (float _deg) { drawInfo.pitch = _deg; } ///< pitch [degree] - float GetHeading () const { return drawInfo.heading; } ///< heading [degree] - void SetHeading (float _deg) { drawInfo.heading = _deg; } ///< heading [degree] - float GetRoll () const { return drawInfo.roll; } ///< roll [degree] - void SetRoll (float _deg) { drawInfo.roll = _deg; } ///< roll [degree] - - // --- Getters and Setters for the values in the `v` array --- - float GetGearRatio () const { return v[V_CONTROLS_GEAR_RATIO]; } ///< Gear deploy ratio - void SetGearRatio (float _f) { v[V_CONTROLS_GEAR_RATIO] = _f; } ///< Gear deploy ratio - float GetNoseWheelAngle () const { return v[V_CONTROLS_NWS_RATIO]; } ///< Nose Wheel angle in degrees - void SetNoseWheelAngle (float _f) { v[V_CONTROLS_NWS_RATIO] = _f; } ///< Nose Wheel angle in degrees - float GetFlapRatio () const { return v[V_CONTROLS_FLAP_RATIO]; } ///< Flaps deploy ratio - void SetFlapRatio (float _f) { v[V_CONTROLS_FLAP_RATIO] = _f; } ///< Flaps deploy ratio - float GetSpoilerRatio () const { return v[V_CONTROLS_SPOILER_RATIO]; } ///< Spoilers deploy ratio - void SetSpoilerRatio (float _f) { v[V_CONTROLS_SPOILER_RATIO] = _f; } ///< Spoilers deploy ratio - float GetSpeedbrakeRatio () const { return v[V_CONTROLS_SPEED_BRAKE_RATIO]; } ///< Speedbrakes deploy ratio - void SetSpeedbrakeRatio (float _f) { v[V_CONTROLS_SPEED_BRAKE_RATIO] = _f; } ///< Speedbrakes deploy ratio - float GetSlatRatio () const { return v[V_CONTROLS_SLAT_RATIO]; } ///< Slats deploy ratio - void SetSlatRatio (float _f) { v[V_CONTROLS_SLAT_RATIO] = _f; } ///< Slats deploy ratio - float GetWingSweepRatio () const { return v[V_CONTROLS_WING_SWEEP_RATIO]; } ///< Wing sweep ratio - void SetWingSweepRatio (float _f) { v[V_CONTROLS_WING_SWEEP_RATIO] = _f; } ///< Wing sweep ratio - float GetThrustRatio () const { return v[V_CONTROLS_THRUST_RATIO]; } ///< Thrust ratio - void SetThrustRatio (float _f) { v[V_CONTROLS_THRUST_RATIO] = _f; } ///< Thrust ratio - float GetYokePitchRatio () const { return v[V_CONTROLS_YOKE_PITCH_RATIO]; } ///< Yoke pitch ratio - void SetYokePitchRatio (float _f) { v[V_CONTROLS_YOKE_PITCH_RATIO] = _f; } ///< Yoke pitch ratio - float GetYokeHeadingRatio () const { return v[V_CONTROLS_YOKE_HEADING_RATIO]; } ///< Yoke heading ratio - void SetYokeHeadingRatio (float _f) { v[V_CONTROLS_YOKE_HEADING_RATIO] = _f; } ///< Yoke heading ratio - float GetYokeRollRatio () const { return v[V_CONTROLS_YOKE_ROLL_RATIO]; } ///< Yoke roll ratio - void SetYokeRollRatio (float _f) { v[V_CONTROLS_YOKE_ROLL_RATIO] = _f; } ///< Yoke roll ratio - float GetThrustReversRatio () const { return v[V_CONTROLS_THRUST_REVERS]; } ///< Thrust reversers ratio - void SetThrustReversRatio (float _f){ v[V_CONTROLS_THRUST_REVERS] = _f; } ///< Thrust reversers ratio - - bool GetLightsTaxi () const { return v[V_CONTROLS_TAXI_LITES_ON] > 0.5f; } ///< Taxi lights - void SetLightsTaxi (bool _b) { v[V_CONTROLS_TAXI_LITES_ON] = float(_b); } ///< Taxi lights - bool GetLightsLanding () const { return v[V_CONTROLS_LANDING_LITES_ON] > 0.5f; } ///< Landing lights - void SetLightsLanding (bool _b) { v[V_CONTROLS_LANDING_LITES_ON] = float(_b); } ///< Landing lights - bool GetLightsBeacon () const { return v[V_CONTROLS_BEACON_LITES_ON] > 0.5f; } ///< Beacon lights - void SetLightsBeacon (bool _b) { v[V_CONTROLS_BEACON_LITES_ON] = float(_b); } ///< Beacon lights - bool GetLightsStrobe () const { return v[V_CONTROLS_STROBE_LITES_ON] > 0.5f; } ///< Strobe lights - void SetLightsStrobe (bool _b) { v[V_CONTROLS_STROBE_LITES_ON] = float(_b); } ///< Strobe lights - bool GetLightsNav () const { return v[V_CONTROLS_NAV_LITES_ON] > 0.5f; } ///< Navigation lights - void SetLightsNav (bool _b) { v[V_CONTROLS_NAV_LITES_ON] = float(_b); } ///< Navigation lights - - float GetNoseGearDeflection () const { return v[V_GEAR_NOSE_GEAR_DEFLECTION_MTR]; } ///< Vertical nose gear deflection [meter] - void SetNoseGearDeflection (float _mtr) { v[V_GEAR_NOSE_GEAR_DEFLECTION_MTR] = _mtr; } ///< Vertical nose gear deflection [meter] - float GetTireDeflection () const { return v[V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR]; } ///< Vertical (main) gear deflection [meter] - void SetTireDeflection (float _mtr) { v[V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR] = _mtr; } ///< Vertical (main) gear deflection [meter] - float GetTireRotAngle () const { return v[V_GEAR_TIRE_ROTATION_ANGLE_DEG]; } ///< Tire rotation angle [degree] - void SetTireRotAngle (float _deg) { v[V_GEAR_TIRE_ROTATION_ANGLE_DEG] = _deg; } ///< Tire rotation angle [degree] - float GetTireRotRpm () const { return v[V_GEAR_TIRE_ROTATION_SPEED_RPM]; } ///< Tire rotation speed [rpm] - void SetTireRotRpm (float _rpm) { v[V_GEAR_TIRE_ROTATION_SPEED_RPM] = _rpm; ///< Tire rotation speed [rpm], also sets [rad/s] - v[V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC] = _rpm * RPM_to_RADs; } - float GetTireRotRad () const { return v[V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC]; } ///< Tire rotation speed [rad/s] - void SetTireRotRad (float _rad) { v[V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC] = _rad; ///< Tire rotation speed [rad/s], also sets [rpm] - v[V_GEAR_TIRE_ROTATION_SPEED_RPM] = _rad / RPM_to_RADs; } - - float GetEngineRotAngle () const { return v[V_ENGINES_ENGINE_ROTATION_ANGLE_DEG]; } ///< Engine rotation angle [degree] - void SetEngineRotAngle (float _deg); ///< Engine rotation angle [degree], also sets engines 1..4 - float GetEngineRotRpm () const { return v[V_ENGINES_ENGINE_ROTATION_SPEED_RPM]; } ///< Engine rotation speed [rpm] - void SetEngineRotRpm (float _rpm); ///< Engine rotation speed [rpm], also sets [rad/s] and engines 1..4 - float GetEngineRotRad () const { return v[V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC]; } ///< Engine rotation speed [rad/s] - void SetEngineRotRad (float _rad); ///< Engine rotation speed [rad/s], also sets [rpm] and engines 1..4 - - float GetEngineRotAngle (size_t idx) const ///< Engine rotation angle [degree] for engine `idx` (1..4) - { return 1 <= idx && idx <= 4 ? v[V_ENGINES_ENGINE_ROTATION_ANGLE_DEG1+idx-1] : 0.0f; } - void SetEngineRotAngle (size_t idx, float _deg); ///< Engine rotation angle [degree] for engine `idx` (1..4) - float GetEngineRotRpm (size_t idx) const ///< Engine rotation speed [rpm] for engine `idx` (1..4) - { return 1 <= idx && idx <= 4 ? v[V_ENGINES_ENGINE_ROTATION_SPEED_RPM1+idx-1] : 0.0f; } - void SetEngineRotRpm (size_t idx, float _rpm); ///< Engine rotation speed [rpm] for engine `idx` (1..4), also sets [rad/s] - float GetEngineRotRad (size_t idx) const ///< Engine rotation speed [rad/s] for engine `idx` (1..4) - { return 1 <= idx && idx <= 4 ? v[V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC+idx-1] : 0.0f; } - void SetEngineRotRad (size_t idx, float _rad); ///< Engine rotation speed [rad/s] for engine `idx` (1..4), also sets [rpm] - - float GetPropRotAngle () const { return v[V_ENGINES_PROP_ROTATION_ANGLE_DEG]; } ///< Propellor rotation angle [degree] - void SetPropRotAngle (float _deg) { v[V_ENGINES_PROP_ROTATION_ANGLE_DEG] = _deg; } ///< Propellor rotation angle [degree] - float GetPropRotRpm () const { return v[V_ENGINES_PROP_ROTATION_SPEED_RPM]; } ///< Propellor rotation speed [rpm] - void SetPropRotRpm (float _rpm) { v[V_ENGINES_PROP_ROTATION_SPEED_RPM] = _rpm; ///< Propellor rotation speed [rpm], also sets [rad/s] - v[V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC] = _rpm * RPM_to_RADs; } - float GetPropRotRad () const { return v[V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC]; } ///< Propellor rotation speed [rad/s] - void SetPropRotRad (float _rad) { v[V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC] = _rad; ///< Propellor rotation speed [rad/s], also sets [rpm] - v[V_ENGINES_PROP_ROTATION_SPEED_RPM] = _rad / RPM_to_RADs; } - - float GetReversDeployRatio () const { return v[V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO]; } ///< Thrust reversers deploy ratio - void SetReversDeployRatio (float _f){ v[V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO] = _f; } ///< Thrust reversers deploy ratio - - bool GetTouchDown () const { return v[V_MISC_TOUCH_DOWN] > 0.5f; } ///< Moment of touch down - void SetTouchDown (bool _b) { v[V_MISC_TOUCH_DOWN] = float(_b); } ///< Moment of touch down - - // Wake support as per X-Plane 12 - - /// @brief Fill in default wake turbulence support data based on Doc8643 wake turbulence category - /// @param _bOverwriteAllFields If `false` only overwrites `NAN` values in `wakeTy` - void WakeApplyDefaults(bool _bOverwriteAllFields = true); - - float GetWingSpan () const { return wake.wingSpan_m; } ///< Wing span [m] - void SetWingSpan (float _m) { wake.wingSpan_m = _m; } ///< Wing span [m] - - float GetWingArea() const { return wake.wingArea_m2; } ///< Wing area [m²] - void SetWingArea (float _m2) { wake.wingArea_m2 = _m2; } ///< Wing area [m²] - - int GetWakeCat() const; ///< Category between 0=light and 3=Super, derived from WTC - - float GetMass() const { return wake.mass_kg; } ///< Mass [kg] - void SetMass(float _kg) { wake.mass_kg = _kg; } ///< Mass [kg] - - // Overridables: - virtual float GetAoA() const { return GetPitch(); } ///< Angle of Attach, returns pitch (but you can override in your class) - virtual float GetLift() const { return GetMass() * G_EARTH; } ///< Lift produced. You _should_ override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag - - // The following is implemented in Map.cpp: - /// Determine which map icon to use for this aircraft - void MapFindIcon (); - /// Prepare map coordinates - void MapPreparePos (XPLMMapProjectionID projection, - const float boundsLTRB[4]); - /// Actually draw the map icon - void MapDrawIcon (XPLMMapLayerID inLayer, float acSize); - /// Actually draw the map label - void MapDrawLabel (XPLMMapLayerID inLayer, float yOfs); - -protected: - /// Internal: Flight loop callback function controlling update and movement of all planes - static float FlightLoopCB (float, float, int, void*); - /// Internal: This puts the instance into XP's sky and makes it move - void DoMove (); - /// Internal: Update the plane's distance/bearing from the camera location - void UpdateDistBearingCamera (const XPLMCameraPosition_t& posCam); - /// Clamp to ground: Make sure the plane is not below ground, corrects Aircraft::drawInfo if needed. - void ClampToGround (); - /// Create the instances required to represent the plane, return if successful - bool CreateInstances (); - /// Destroy all instances - void DestroyInstances (); - - /// @brief Put together the map label - /// @details Called about once a second. Label depends on tcasTargetIdx - virtual void ComputeMapLabel (); - - // The following functions are implemented in AIMultiplayer.cpp: - /// Define the TCAS target index in use - virtual void SetTcasTargetIdx (int _idx) { tcasTargetIdx = _idx; } - // These functions perform the TCAS target / multiplayer data updates - friend void AIMultiUpdate (); - friend size_t AIUpdateTCASTargets (); - friend size_t AIUpdateMultiplayerDataRefs (); -}; - -/// Find aircraft by its plane ID, can return nullptr -Aircraft* AcFindByID (XPMPPlaneID _id); - -/// (Re)Define default wake turbulence values per WTC -bool AcSetDefaultWakeData(const std::string& _wtc, const Aircraft::wakeTy& _wake); - -// -// MARK: XPMP2 Exception class -// - -/// XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft -class XPMP2Error : public std::logic_error { -protected: - std::string fileName; ///< filename of the line of code where exception occurred - int ln; ///< line number of the line of code where exception occurred - std::string funcName; ///< function of the line of code where exception occurred - std::string msg; ///< additional text message -public: - /// Constructor puts together a formatted exception text - XPMP2Error (const char* szFile, int ln, const char* szFunc, const char* szMsg, ...); -public: - /// returns msg.c_str() - virtual const char* what() const noexcept; - -public: - // copy/move constructor/assignment as per default - XPMP2Error (const XPMP2Error& o) = default; - XPMP2Error (XPMP2Error&& o) = default; - XPMP2Error& operator = (const XPMP2Error& o) = default; - XPMP2Error& operator = (XPMP2Error&& o) = default; -}; - - - -} // namespace XPMP2 - -#endif diff --git a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPMultiplayer.h b/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPMultiplayer.h deleted file mode 100644 index 7beae655..00000000 --- a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPMultiplayer.h +++ /dev/null @@ -1,717 +0,0 @@ -/// @file XPMPMultiplayer.h -/// @brief Initialization and general control functions for XPMP2 -/// -/// @note This file bases on and should be largely compile-compatible to -/// the header provided with the original libxplanemp. -/// @note Some functions are marked deprecated, reason is given with -/// each function. They are only provided for backward -/// compatibility. -/// -/// @details This is one of two main header files for using XPMP2. -/// (The other is `XPMPAircraft.h`). -/// XPMP2 is a library allowing an X-Plane plugin to have -/// planes rendered in X-Plane's 3D world based on OBJ8 -/// CSL models, which need to be installed separately. -/// The plugin shall subclass XPMP2::Aircraft:: and override -/// the abstract virtual function XPMP2::Aircraft::UpdatePosition() -/// to provide updated position and attitude information. -/// XPMP2 takes care of reading and initializaing CSL models, -/// instanciating and updating the aircraft objects in X-Plane, -/// display in a map layer, provisioning information via X-Plane's -/// TCAS targets and AI/multiplayer (and more) dataRefs. -/// -/// @see For more developer's information see -/// https://twinfan.github.io/XPMP2/ -/// -/// @see For TCAS Override approach see -/// https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/ -/// -/// @see For a definition of ICAO aircraft type designators see -/// https://www.icao.int/publications/DOC8643/Pages/Search.aspx -/// -/// @see For a list of ICAO airline/operator codes see -/// https://en.wikipedia.org/wiki/List_of_airline_codes -/// -/// @author Ben Supnik and Chris Serio -/// @copyright Copyright (c) 2004, Ben Supnik and Chris Serio. -/// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -#ifndef _XPLMMultiplayer_h_ -#define _XPLMMultiplayer_h_ - -#include -#include "XPLMDefs.h" - -#ifdef __cplusplus -extern "C" { -#endif - -// defined in XPMPAircraft -namespace XPMP2 { class Aircraft; } - -/************************************************************************************ - * MARK: PLANE DATA TYPES - ************************************************************************************/ - -/// XPMPPosition_t -/// -/// @brief This data structure contains the basic position info for an aircraft. -/// @note This structure is only used with deprecated concepts -/// (class XPCAircraft and direct use of callback functions.) -/// @note There is no notion of aircraft velocity or acceleration; you will be queried for -/// your position every rendering frame. Higher level APIs can use velocity and acceleration. -struct XPMPPlanePosition_t { - long size = sizeof(XPMPPlanePosition_t); ///< size of structure - double lat = 0.0; ///< current position of aircraft (latitude) - double lon = 0.0; ///< current position of aircraft (longitude) - double elevation = 0.0; ///< current altitude of aircraft [ft above MSL] - float pitch = 0.0f; ///< pitch [degrees, psitive up] - float roll = 0.0f; ///< roll [degrees, positive right] - float heading = 0.0f; ///< heading [degrees] - char label[32] = ""; ///< label to show with the aircraft - float offsetScale = 1.0f; ///< how much of the surface contact correction offset should be applied [0..1] - bool clampToGround = false; ///< enables ground-clamping for this aircraft (can be expensive, see XPMP2::Aircraft::bClampToGround) - int aiPrio = 1; ///< Priority for AI/TCAS consideration, the lower the earlier - float label_color[4] = {1.0f,1.0f,0.0f,1.0f}; ///< label base color (RGB), defaults to yellow - int multiIdx = 0; ///< OUT: set by XPMP2 to inform application about TCAS target index in use [1..63], with [1..19] also being available via classic multiplayer dataRefs, `< 1` means 'none' -}; - - -/// @brief Light flash patterns -/// @note Unused in XPMP2 -/// @note Not changed to proper enum type as it is used in bitfields in xpmp_LightStatus, -/// which causes misleading, non-suppressable warnings in gcc:\n -/// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=51242 -enum { - xpmp_Lights_Pattern_Default = 0, ///< Jets: one strobe flash, short beacon (-*---*---*---) - xpmp_Lights_Pattern_EADS = 1, ///< Airbus+EADS: strobe flashes twice (-*-*-----*-*--), short beacon - xpmp_Lights_Pattern_GA = 2 ///< GA: one strobe flash, long beacon (-*--------*---) -}; -typedef unsigned int XPMPLightsPattern; ///< Light flash pattern (unused in XPMP2) - - -#if __GNUC__ -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wpedantic" // because we don't want to change the anonymous structure following here as that would require code change in legacy plugins -#elif _MSC_VER -#pragma warning(push) -#pragma warning(disable: 4202 4201) -#endif -/// @brief Defines, which lights of the aircraft are on -/// @note This structure is only used with deprecated concepts -/// (class XPCAircraft and direct use of callback functions.) -union xpmp_LightStatus { - unsigned int lightFlags = 0x150000; ///< this defaults to taxi | beacon | nav lights on - struct { - unsigned int timeOffset : 16; ///< time offset to avoid lights across planes blink in sync (unused in XPMP2) - - unsigned int taxiLights : 1; ///< taxi lights on? - unsigned int landLights : 1; ///< landing lights on? - unsigned int bcnLights : 1; ///< beacon on? - unsigned int strbLights : 1; ///< strobe lights on? - unsigned int navLights : 1; ///< navigation lights on? - - /// light pattern (unused in XPMP2) - XPMPLightsPattern flashPattern : 4; - }; -}; -#if __GNUC__ -#pragma GCC diagnostic pop -#elif _MSC_VER -#pragma warning(pop) -#endif - - -/// @brief External physical configuration of the plane -/// @note This structure is only used with deprecated concepts -/// (class XPCAircraft and direct use of callback functions.) -/// @details This data structure will contain information about the external physical configuration of the plane, -/// things you would notice if you are seeing it from outside. This includes flap position, gear position, -/// etc. -struct XPMPPlaneSurfaces_t { - long size = sizeof(XPMPPlaneSurfaces_t); ///< structure size - float gearPosition = 0.0f; ///< gear position [0..1] - float flapRatio = 0.0f; ///< flap extension ratio [0..1] - float spoilerRatio = 0.0f; ///< spoiler extension ratio [0..1] - float speedBrakeRatio = 0.0f; ///< speed brake extension ratio [0..1] - float slatRatio = 0.0f; ///< slats extension ratio [0..1] - float wingSweep = 0.0f; ///< wing sweep ratio [0..1] - float thrust = 0.0f; ///< thrust ratio [0..1] - float yokePitch = 0.0f; ///< yoke pitch ratio [0..1] - float yokeHeading = 0.0f; ///< yoke heading ratio [0..1] - float yokeRoll = 0.0f; ///< yoke roll ratio [0..1] - - xpmp_LightStatus lights; ///< status of lights - - float tireDeflect = 0.0f; ///< tire deflection (meters) - float tireRotDegree = 0.0f; ///< tire rotation angle (degrees 0..360) - float tireRotRpm = 0.0f; ///< tire rotation speed (rpm) - - float engRotDegree = 0.0f; ///< engine rotation angle (degrees 0..360) - float engRotRpm = 0.0f; ///< engine rotation speed (rpm) - float propRotDegree = 0.0f; ///< prop rotation angle (degrees 0..360) - float propRotRpm = 0.0f; ///< prop rotation speed (rpm) - float reversRatio = 0.0f; ///< thrust reversers ratio - - bool touchDown = false; ///< just now is moment of touch down? -}; - - -/// @brief These enumerations define the way the transponder of a given plane is operating. -/// @note Only information used by XPMP2 is `"mode != xpmpTransponderMode_Standby"`, -/// in which case the plane is considered for TCAS display. -enum XPMPTransponderMode { - xpmpTransponderMode_Standby, ///< transponder is in standby, not currently sending -> aircraft not visible on TCAS - xpmpTransponderMode_Mode3A, ///< transponder is on - xpmpTransponderMode_ModeC, ///< transponder is on - xpmpTransponderMode_ModeC_Low, ///< transponder is on - xpmpTransponderMode_ModeC_Ident ///< transponder is on -}; - - -/// @brief defines information about an aircraft visible to radar. -struct XPMPPlaneRadar_t { - long size = sizeof(XPMPPlaneRadar_t); ///< structure size - long code = 0; ///< current radar code, published via dataRef `sim/cockpit2/tcas/targets/modeC_code` - XPMPTransponderMode mode = xpmpTransponderMode_ModeC; ///< current radar mode, if _not_ `xpmpTransponderMode_Standby` then is plane considered for TCAS display -}; - - -/// @brief Textual information of planes to be passed on -/// via shared dataRefs to other plugins. -/// @details The texts are not used within XPMP2 in any way, just passed on to dataRefs -struct XPMPInfoTexts_t { - long size = sizeof(XPMPInfoTexts_t);///< structure size - char tailNum[10] = {0}; ///< registration, tail number - char icaoAcType[5] = {0}; ///< ICAO aircraft type designator, 3-4 chars - char manufacturer[40] = {0}; ///< a/c manufacturer, human readable - char model[40] = {0}; ///< a/c model, human readable - char icaoAirline[4] = {0}; ///< ICAO airline code - char airline[40] = {0}; ///< airline, human readable - char flightNum [10] = {0}; ///< flight number - char aptFrom [5] = {0}; ///< Origin airport (ICAO) - char aptTo [5] = {0}; ///< Destination airport (ICAO) -}; - - -/// @brief This enum defines the different categories of aircraft information we can query about. -/// @note While these enums are defined in a way that they could be combined together, -/// there is no place, which makes use of this possibility. Each value will be used -/// individually only. Because of this, the definition has been changed in XPMP2 -/// to an actual enum type for clarity. -/// @note This enum is only used with deprecated concepts -/// (class XPCAircraft and direct use of callback functions.) -enum XPMPPlaneDataType { - xpmpDataType_Position = 1L << 1, ///< position data in XPMPPlanePosition_t - xpmpDataType_Surfaces = 1L << 2, ///< physical appearance in XPMPPlaneSurfaces_t - xpmpDataType_Radar = 1L << 3, ///< radar information in XPMPPlaneRadar_t - xpmpDataType_InfoTexts = 1L << 4, ///< informational texts in XPMPInfoTexts_t -}; - - -/// @brief Definfes the different responses to asking for information. -/// @note This enum is only used with deprecated concepts -/// (class XPCAircraft and direct use of callback functions.) -enum XPMPPlaneCallbackResult { - xpmpData_Unavailable = 0, /* The information has never been specified. */ - xpmpData_Unchanged = 1, /* The information from the last time the plug-in was asked. */ - xpmpData_NewData = 2 /* The information has changed this sim cycle. */ -}; - - -/// @brief Unique ID for an aircraft created by a plugin. -/// @note In XPMP2 this value is no longer a pointer to an internal memory address, -/// but will directly be used as `modeS_id` in the new -/// [TCAS override](https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/) -/// approach. -typedef unsigned XPMPPlaneID; - -/// Minimum allowed XPMPPlaneID / mode S id -constexpr XPMPPlaneID MIN_MODE_S_ID = 0x00000001; -/// Maximum allowed XPMPPlaneID / mode S id -constexpr XPMPPlaneID MAX_MODE_S_ID = 0x00FFFFFF; - - -/************************************************************************************ -* MARK: INITIALIZATION -************************************************************************************/ - -// Config section is defined for legacy reasons only -#define XPMP_CFG_SEC_MODELS "models" ///< Config section "models" -#define XPMP_CFG_SEC_PLANES "planes" ///< Config section "planes" -#define XPMP_CFG_SEC_DEBUG "debug" ///< Config section "debug" - -// Config key definitions -#define XPMP_CFG_ITM_REPLDATAREFS "replace_datarefs" ///< Config key: Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!) -#define XPMP_CFG_ITM_REPLTEXTURE "replace_texture" ///< Config key: Replace textures in OBJ8 files upon load if needed (specified on the OBJ8 line in xsb_aircraft.txt), creating new OBJ8 files -#define XPMP_CFG_ITM_CLAMPALL "clamp_all_to_ground" ///< Config key: Ensure no plane sinks below ground, no matter of XPMP2::Aircraft::bClampToGround -#define XPMP_CFG_ITM_HANDLE_DUP_ID "handle_dup_id" ///< Config key: Boolean: If XPMP2::Aircraft::modeS_id already exists then assign a new unique one, overwrites XPMP2::Aircraft::modeS_id -#define XPMP_CFG_ITM_SUPPORT_REMOTE "support_remote" ///< Config key: Support remote connections? `<0` force off, `0` default: on if in a networked or multiplayer setup, `>0` force on -#define XPMP_CFG_ITM_LOGLEVEL "log_level" ///< Config key: General level of logging into `Log.txt` (0 = Debug, 1 = Info, 2 = Warning, 3 = Error, 4 = Fatal) -#define XPMP_CFG_ITM_MODELMATCHING "model_matching" ///< Config key: Write information on model matching into `Log.txt` - -/// @brief Definition for the type of configuration callback function -/// @details The plugin using XPMP2 can provide such a callback function via XPMPMultiplayerInit(). -/// It will be called max. every 2s to fetch each of the following configuration values:\n -/// \n -/// `section | key                 | type | default | description`\n -/// `------- | ------------------- | ---- | ------- | -------------------------------------------------------------------------`\n -/// `models  | replace_datarefs    | int  |    0    | Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!)`\n -/// `models  | replace_texture     | int  |    1    | Replace textures in OBJ8 files upon load if needed (specified on the OBJ8 line in xsb_aircraft.txt), creating new OBJ8 files`\n -/// `planes  | clamp_all_to_ground | int  |    1    | Ensure no plane sinks below ground, no matter of XPMP2::Aircraft::bClampToGround`\n -/// `planes  | handle_dup_id       | int  |    0    | Boolean: If XPMP2::Aircraft::modeS_id already exists then assign a new unique one, overwrites XPMP2::Aircraft::modeS_id`\n -/// `planes  | support_remote      | int  |    0    | 3-state integer: Support remote connections? <0 force off, 0 default: on if in a networked or multiplayer setup, >0 force on`\n -/// `debug   | log_level           | int  |    2    | General level of logging into Log.txt (0 = Debug, 1 = Info, 2 = Warning, 3 = Error, 4 = Fatal)`\n -/// `debug   | model_matching      | int  |    0    | Write information on model matching into Log.txt`\n -/// @note There is no immediate requirement to check the value of `_section` in your implementation. -/// `_key` by itself is unique. Compare it with any of the `XPMP_CFG_ITM_*` values and return your value. -/// @param _section Configuration section, ie. group of values, any of the `XPMP_CFG_SEC_...` values -/// @param _key Any of the `XPMP_CFG_ITM_*` values to indicate which config value is to be returned. -/// @param _default A default provided by XPMP2. Have your callback return `_default` if you don't want to explicitely set a value or don't know the `_key`. -/// @return Your callback shall return your config value for config item `_key` -typedef int (*XPMPIntPrefsFuncTy)(const char* _section, const char* _key, int _default); - -/// @brief Deprecated legacy initialization of XPMP2. -/// @note Parameters changed compared to libxplanemp! -/// @details Effectively calls, in this order, -/// XPMPMultiplayerInit() and XPMPLoadCSLPackage(). -/// @see XPMPMultiplayerInit() and XPMPLoadCSLPackage() for details on the parameters. -[[deprecated("Use XPMPMultiplayerInit and XPMPLoadCSLPackages")]] -const char * XPMPMultiplayerInitLegacyData(const char* inCSLFolder, - const char* inPluginName, - const char* resourceDir, - XPMPIntPrefsFuncTy inIntPrefsFunc = nullptr, - const char* inDefaultICAO = nullptr, - const char* inPluginLogAcronym = nullptr); - -/// @brief Initializes the XPMP2 library. This shall be your first call to the library. -/// @note Parameters changed compared to libxplanemp! -/// @param inPluginName Your plugin's name, mainly used as map layer name and for logging -/// @param resourceDir The directory where XPMP2 finds all required supplemental files (`Doc8643.txt`, `MapIcons.png`, `related.txt`, optionally `Obj8DataRefs.txt`) -/// @param inIntPrefsFunc (optional) A pointer to a callback function providing integer config values. See ::XPMPIntPrefsFuncTy for details. -/// @param inDefaultICAO (optional) A fallback aircraft type if no type can be deduced otherwise for an aircraft. -/// @param inPluginLogAcronym (optional) A short text to be used in log output. If not given then `inPluginName` is used also for this purpose. -/// @return Empty string in case of success, otherwise a human-readable error message. -const char * XPMPMultiplayerInit(const char* inPluginName, - const char* resourceDir, - XPMPIntPrefsFuncTy inIntPrefsFunc = nullptr, - const char* inDefaultICAO = nullptr, - const char* inPluginLogAcronym = nullptr); - -/// @brief Overrides the plugin's name to be used in Log output -/// @details The same as providing a plugin name with XPMPMultiplayerInit(). -/// If no name is provided, it defaults to the plugin's name as set in XPluginStart(). -/// @note Replaces the compile-time macro `XPMP_CLIENT_LONGNAME` needed in `libxplanemp`. -/// @param inPluginName Your plugin's name, used as map layer name, and as folder name under `Aircraft` -/// @param inPluginLogAcronym (optional) A short text to be used in log output. If not given then `inPluginName` is used also for this purpse. -void XPMPSetPluginName (const char* inPluginName, - const char* inPluginLogAcronym = nullptr); - - -/// @brief Clean up the multiplayer library -/// @details This shall be your last call to XPMP2. -/// Call this latest from XPluginStop for proper and controlled -/// cleanup of resources used by XPMP2. -void XPMPMultiplayerCleanup(); - - -/// @brief Used to set the light textures for old OBJ7 models. -/// @note Unsupported with XPMP2, will always return "OBJ7 format is no longer supported" -[[deprecated("Unsupported feature, will alsways return 'OBJ7 format is no longer supported'")]] -const char * XPMPMultiplayerOBJ7SupportEnable(const char * inTexturePath); - - -/************************************************************************************ -* MARK: AI / Multiplayer plane control -************************************************************************************/ - - -/// @brief Tries to grab control of TCAS targets (formerly known as AI/multiplayer) from X-Plane -/// @details Only one plugin can have TCAS targets control at any one time. -/// So be prepared to properly handle an non-empty response -/// that indicates that you did not get control now. -/// The returned message includes the name of the plugin -/// currently having control.\n -/// If successful, XPMP2's aircraft will appear on TCAS and are -/// available to 3rd-party plugins relying on TCAS tagrtes or multiplayer dataRefs.\n -/// Typically, a plugin calls this function -/// just before the first aircraft are created. But it could also -/// be bound to a menu item, for example. -/// @param _callback (optional) You can provide a callback function, -/// which is called directly by X-Plane when control of -/// TCAS targets is not successful now but becomes available later. -/// @param _refCon (optional) A value just passed through to the callback. -/// @see X-Plane SDK documentation on -/// [XPLMAcquirePlanes](https://developer.x-plane.com/sdk/XPLMPlanes/#XPLMPlanesAvailable_f) -/// for more details about the callback. -/// @return Empty string on success, human-readable error message otherwise, -/// includes name of plugin currently having TCAS tagrets control -const char * XPMPMultiplayerEnable(void (*_callback)(void*) = nullptr, - void* _refCon = nullptr); - - -/// @brief Release TCAS targets control. -/// @details Afterwards, XPMP2's aircraft will no longer appear on TCAS or -/// on 3rd-party plugins relying on TCAS targets dataRefs.\n -/// Is called during XPMPMultiplayerCleanup() automatically. -void XPMPMultiplayerDisable(); - - -/// @brief Has XPMP2 control of TCAS targets? -/// @see XPMPMultiplayerEnable() -bool XPMPHasControlOfAIAircraft(); - -/************************************************************************************ -* MARK: CSL Package Handling -************************************************************************************/ - -/// @brief Loads CSL packages from the given folder, searching up to 5 folder levels deep. -/// @details This function mainly searches the given folder for packages. -/// It traverses all folders in search for `xsb_aircraft.txt` files. -/// It will find all `xsb_aircraft.txt` files situated at or below -/// the given root path, up to 5 levels deep.\n -/// As soon as such a file is found it is read and processed. -/// Depth search then ends. (But searching parallel folders may -/// still continue.)\n -/// The `xsb_aircraft.txt` is loaded and processed. Duplicate models -/// (by package _and_ CSL model name, -/// tags `EXPORT_NAME` _and_ `OBJ8_AIRCRAFT`) are ignored. -/// For others the existence of the `.obj` file is validated, -/// but not the existence of files in turn needed by the `.obj` -/// file, like textures. If validated successfully the model is added to an -/// internal catalogue.\n -/// Actual loading of objects is done later and asynchronously only -/// when needed during aircraft creation. -/// @param inCSLFolder Root folder to start the search. -const char * XPMPLoadCSLPackage(const char * inCSLFolder); - - -/// @brief Legacy function only provided for backwards compatibility. Does not actually do anything. -[[deprecated("No longer needed, does not do anything.")]] -void XPMPLoadPlanesIfNecessary(); - - -/// @brief Returns the number of loaded CSL models -int XPMPGetNumberOfInstalledModels(); - - -/// @brief Fetch information about a CSL model identified by an index -/// @note Index numbers may change if more models are loaded, don't rely on them. -/// Model name is unique. -/// @deprecated Instead, use XPMPGetModelInfo2().\n -/// This legacy function is defined with pointers to text arrays as -/// return type. This is rather unsafe. XPMP2's internal maps and buffers -/// may change if more models are loaded, hence pointers may become invalid. -/// Don't rely on these pointers staying valid over an extended period of time. -/// @param inIndex Number between `0` and `XPMPGetNumberOfInstalledModels()-1 -/// @param[out] outModelName Receives pointer to model name (id). Optional, can be nullptr. -/// @param[out] outIcao Receives pointer to ICAO aircraft type designator. Optional, can be `nullptr`. -/// @param[out] outAirline Receives pointer to ICAO airline code. Optional, can be `nullptr`. -/// @param[out] outLivery Receives pointer to special livery string. Optional, can be `nullptr`. -[[deprecated("Unsafe, use XPMPGetModelInfo2() instead.")]] -void XPMPGetModelInfo(int inIndex, const char **outModelName, const char **outIcao, const char **outAirline, const char **outLivery); - -/// @brief Fetch information about a CSL model identified by an index -/// @note Index numbers may change if more models are loaded, don't rely on them. -/// Model name is unique. -/// @param inIndex Number between `0` and `XPMPGetNumberOfInstalledModels()-1 -/// @param[out] outModelName Receives model name (id) -/// @param[out] outIcao Receives ICAO aircraft designator -/// @param[out] outAirline Receives ICAO airline code -/// @param[out] outLivery Receives special livery string -void XPMPGetModelInfo2(int inIndex, std::string& outModelName, std::string& outIcao, std::string& outAirline, std::string& outLivery); - - -/// @brief Tests model match quality based on the given parameters. -/// @param inICAO ICAO aircraft type designator, optional, can be `nullptr` -/// @param inAirline ICAO airline code, optional, can be `nullptr` -/// @param inLivery Special livery text, optional, can be `nullptr` -/// @return Match quality, the lower the better -int XPMPModelMatchQuality(const char * inICAO, - const char * inAirline, - const char * inLivery); - - -/// @brief Is `inICAO` a valid ICAO aircraft type designator? -bool XPMPIsICAOValid(const char * inICAO); - -/// @brief Add a user-defined dataRef to the list of dataRefs supported by every plane. -/// @details All planes created by XPMP2 define the same set of dataRefs. -/// See XPMP2::DR_VALS for the definitions that come pre-defined with -/// XPMP2. Here you can add more dataRefs that you want to set -/// in your XPMP2::Aircraft::UpdatePosition() implementation. -/// @return The functions returns the array index you need to use in the -/// XPMP2::Aircraft::v array to provide the actual value. -/// Or `0` when an error occured. -/// @note There is a duplication check: Adding an already existing dataRef, -/// no matter if XPMP2-predefined or by the plugin will return the -/// already existing index. -/// @note Can only be called while no plane exists as it influence the size -/// of important data arrays. Returns `0` if called while planes exist. -/// @note Can only be called from XP's main thread as XPLM SDK functions are called. -/// Returns `0` if called from a worker thread. -/// @note User-defined dataRefs are _not_ transfered to the XPMP2 Remote Client -/// for display on network-connected X-Plane instances. -size_t XPMPAddModelDataRef (const std::string& dataRef); - -/************************************************************************************ - * MARK: PLANE CREATION API - ************************************************************************************/ - - -/// @brief Callback function your plugin provides to return updated plane data -/// @note This type is only used with deprecated concepts -/// (direct use of callback functions.) -/// @details This functions is called by XPMP2 once per cycle per plane per data type. -/// Your implementation returns the requested data, -/// so that XPMP2 can move and update the associated aircraft instance. -/// @param inPlane ID of the plane, for which data is requested -/// @param inDataType The type of data that is requested, see ::XPMPPlaneDataType -/// @param[out] ioData A pointer to a structure XPMP2 provides, for you to fill the data into. -/// For its type see ::XPMPPlaneDataType. -/// @param inRefcon The refcon value you provided when creating the plane -typedef XPMPPlaneCallbackResult (* XPMPPlaneData_f)(XPMPPlaneID inPlane, - XPMPPlaneDataType inDataType, - void * ioData, - void * inRefcon); - - -/// @brief Creates a new plane -/// @deprecated Subclass XPMP2::Aircraft instead -/// @details Effectively calls XPMPCreatePlaneWithModelName() with -/// `inModelName = nullptr` -/// @param inICAOCode ICAO aircraft type designator, like 'A320', 'B738', 'C172' -/// @param inAirline ICAO airline code, like 'BAW', 'DLH', can be an empty string -/// @param inLivery Special livery designator, can be an empty string -/// @param inDataFunc Callback function called by XPMP2 to fetch updated data -/// @param inRefcon A refcon value passed back to you in all calls to the `inDataFunc` -/// @param inModeS_id (optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given -[[deprecated("Subclass XPMP2::Aircraft instead")]] -XPMPPlaneID XPMPCreatePlane(const char * inICAOCode, - const char * inAirline, - const char * inLivery, - XPMPPlaneData_f inDataFunc, - void * inRefcon, - XPMPPlaneID inModeS_id = 0); - -/// @brief Creates a new plane, providing a specific CSL model name -/// @deprecated Subclass XPMP2::Aircraft instead -/// @param inModelName CSL Model name (id) to use, or `nullptr` if normal matching using the next 3 parameters shall be applied -/// @param inICAOCode ICAO aircraft type designator, like 'A320', 'B738', 'C172' -/// @param inAirline ICAO airline code, like 'BAW', 'DLH', can be an empty string -/// @param inLivery Special livery designator, can be an empty string -/// @param inDataFunc Callback function called by XPMP2 to fetch updated data -/// @param inRefcon A refcon value passed back to you in all calls to the `inDataFunc` -/// @param inModeS_id (optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given -[[deprecated("Subclass XPMP2::Aircraft instead")]] -XPMPPlaneID XPMPCreatePlaneWithModelName(const char * inModelName, - const char * inICAOCode, - const char * inAirline, - const char * inLivery, - XPMPPlaneData_f inDataFunc, - void * inRefcon, - XPMPPlaneID inModeS_id = 0); - -/// @brief [Deprecated] Removes a plane previously created with XPMPCreatePlane() -/// @deprecated Delete subclassed XPMP2::Aircraft object instead. -[[deprecated("Delete subclassed XPMP2::Aircraft object instead")]] -void XPMPDestroyPlane(XPMPPlaneID _id); - - -/// @brief Show/Hide the aircraft temporarily without destroying the object -void XPMPSetPlaneVisibility(XPMPPlaneID _id, bool _bVisible); - - -/// @brief Perform model matching again and change the CSL model to the resulting match -/// @note Effectively calls XPMP2::Aircraft::ChangeModel(), -/// so if you have the aircraft object, prefer calling that function directly. -/// @param inPlaneID Which plane to change? -/// @param inICAOCode ICAO aircraft type designator, like 'A320', 'B738', 'C172' -/// @param inAirline ICAO airline code, like 'BAW', 'DLH', can be an empty string -/// @param inLivery Special livery designator, can be an empty string -/// @return Match quality, the lower the better / -1 if `inPlaneID` is invalid -int XPMPChangePlaneModel(XPMPPlaneID inPlaneID, - const char * inICAOCode, - const char * inAirline, - const char * inLivery); - - -/// @brief Return the name of the model, with which the given plane is rendered -/// @note Effectively calls XPMP2::Aircraft::GetModelName(), -/// so if you have the aircraft object, prefer calling that function directly. -/// @param inPlaneID Identifies the plane -/// @param[out] outTxtBuf (optional) Points to a character array to hold the model name. -/// The returned C string is guaranteed to be zero-terminated. -/// Pass in NULL to just receive the string's length -/// @param outTxtBufSize Size of that buffer -/// @return Length of the model name to return -/// (not counting the terminating zero, independend of the passed-in buffer). -/// -1 if `inPlaneID` is invalid -int XPMPGetPlaneModelName(XPMPPlaneID inPlaneID, - char * outTxtBuf, - int outTxtBufSize); - - -/// @brief Returns ICAO aircraft type designator and livery of the given plane -/// @deprecated This legacy function is defined in a rather unsafe way. -/// Instead, use XPMPGetAircraft() and access -/// PMP2::Aircraft::acIcaoType and -/// XPMP2::Aircraft::acLivery directly. -[[deprecated("Unsafe pointer operations")]] -void XPMPGetPlaneICAOAndLivery(XPMPPlaneID inPlane, - char * outICAOCode, // Can be NULL - char * outLivery); // Can be NULL - - -/// @brief Unsupported, don't use. -/// @deprecated Not supported in XPMP2! -/// In the legacy library this is actually more like an internal function, -/// calling all callback functions for querying aircraft data -/// (much like XPCAircraft::UpdatePosition() is now in XPMP2). -/// I doubt that it was intended to be called from the outside in the first place. -/// @return Always `xpmpData_Unavailable` -[[deprecated("Unsupported")]] -XPMPPlaneCallbackResult XPMPGetPlaneData(XPMPPlaneID inPlane, - XPMPPlaneDataType inDataType, - void * outData); - - -/// Returns the match quality of the currently used model, or `-1` if `inPlane` is invalid -int XPMPGetPlaneModelQuality(XPMPPlaneID inPlane); - - -/// Returns the number of planes in existence. -long XPMPCountPlanes(void); - - -/// Returns the plane ID of the Nth plane. -XPMPPlaneID XPMPGetNthPlane(long index); - - -/// Returns the underlying aircraft object, or `nullptr` if `_id` is invalid -XPMP2::Aircraft* XPMPGetAircraft (XPMPPlaneID _id); - - -/// @brief Define default aircraft and ground vehicle ICAO types -/// @param _acIcaoType Default ICAO aircraft type designator, used when matching returns nothing -/// @param _carIcaoType Type used to identify ground vehicels (internally defaults to "ZZZC") -void XPMPSetDefaultPlaneICAO(const char* _acIcaoType, - const char* _carIcaoType = nullptr); - -/************************************************************************************ - * MARK: PLANE OBSERVATION API - ************************************************************************************/ - - -/// Events that trigger a notification callback -enum XPMPPlaneNotification { - xpmp_PlaneNotification_Created = 1, ///< a plane was just created - xpmp_PlaneNotification_ModelChanged = 2, ///< a plane's model changed - xpmp_PlaneNotification_Destroyed = 3, ///< a plane is about to be destroyed -}; - - -/// @brief Type of the callback function you provide, called when one of the -/// events defined in ::XPMPPlaneNotification happens -/// @param inPlaneID Identifies the affected plane -/// @param inNotification The event that took place -/// @param inRefcon A refcon that you provided in XPMPRegisterPlaneNotifierFunc() -typedef void (*XPMPPlaneNotifier_f)(XPMPPlaneID inPlaneID, - XPMPPlaneNotification inNotification, - void * inRefcon); - - -/// @brief Registers a callback, which is called when one of the -/// events defined in ::XPMPPlaneNotification happens -/// @param inFunc Pointer to your callback function -/// @param inRefcon A refcon passed through to your callback -void XPMPRegisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc, - void * inRefcon); - - -/// @brief Unregisters a notification callback. Both function pointer and refcon -/// must match what was registered. -/// @param inFunc Pointer to your callback function -/// @param inRefcon A refcon passed through to your callback -void XPMPUnregisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc, - void * inRefcon); - -/************************************************************************************ - * MARK: PLANE RENDERING API (unsued in XPMP2) - ************************************************************************************/ - -/// @brief The original libxplanemp allowed to override rendering; no longer supported -/// @deprecated Unsupported in XPMP2. The type definition is available to stay -/// compile-time compatible, but the callback will not be called. -[[deprecated("Unsupported, will not be called")]] -typedef void (* XPMPRenderPlanes_f)( - int inIsBlend, - void * inRef); - - -/// @brief The original libxplanemp allowed to override rendering; no longer supported -/// @deprecated Unsupported in XPMP2. The function is available to stay compile-time compatible, -/// but it does nothing. -[[deprecated("Unsupported, doesn't do anything")]] -void XPMPSetPlaneRenderer(XPMPRenderPlanes_f inRenderer, - void * inRef); - - -/// @brief Legacy debug-support function, no longer supported -/// @deprecated No longer supported as rendering is done by X-Plane's instancing -[[deprecated("Unsupported, doesn't do anything")]] -void XPMPDumpOneCycle(void); - - -/// Enable or disable drawing of labels with the aircraft -void XPMPEnableAircraftLabels (bool _enable = true); - - -/// @brief Disable drawing of labels with the aircraft -/// @details Effectively calls XPMPEnableAircraftLabels() -void XPMPDisableAircraftLabels(); - - -/// Returns if labels are currently configured to be drawn -bool XPMPDrawingAircraftLabels(); - - -/// Configure maximum label distance and if labels shall be cut off at reported visibility -/// @param _dist_nm Maximum label distance in nm, default is 3, minimum is 1 -/// @param _bCutOffAtVisibility Shall labels not be drawn further away than XP's reported visibility? -void XPMPSetAircraftLabelDist (float _dist_nm, bool _bCutOffAtVisibility = true); - -// -// MARK: MAP -// Enable or disable the drawing of icons on maps -// - -/// @brief Enable or disable the drawing of aircraft icons on X-Plane's map -/// @param _bEnable Enable or disable entire map functionality -/// @param _bLabels If map is enabled, shall also labels be drawn? -/// @details XPMP2 creates a separate Map Layer named after the plugin for this purposes. -/// By default, the map functionality is enabled including label writing. -void XPMPEnableMap (bool _bEnable, bool _bLabels = true); - -#ifdef __cplusplus -} -#endif - - -#endif diff --git a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPRemote.h b/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPRemote.h deleted file mode 100644 index 8b49fa0e..00000000 --- a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPRemote.h +++ /dev/null @@ -1,455 +0,0 @@ -/// @file XPMPRemote.h -/// @brief Semi-public remote network functionality for master/client operations -/// @details Technically, this is public functionality from a library -/// point of view. But it is intended for the "XPMP Remote Client" only, -/// not for a standard plugin.\n -/// Network messages are packed for space efficiency, but also to avoid -/// layout differences between compilers/platforms. -/// However, manual layout tries to do reasonable alignment of numeric values -/// and 8-byte-alignment of each structure, so that arrays of structures -/// also align well. -/// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe -/// @copyright Permission is hereby granted, free of charge, to any person obtaining a -/// copy of this software and associated documentation files (the "Software"), -/// to deal in the Software without restriction, including without limitation -/// the rights to use, copy, modify, merge, publish, distribute, sublicense, -/// and/or sell copies of the Software, and to permit persons to whom the -/// Software is furnished to do so, subject to the following conditions:\n -/// The above copyright notice and this permission notice shall be included in -/// all copies or substantial portions of the Software.\n -/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -/// THE SOFTWARE. - -#ifndef _XPMPRemote_h_ -#define _XPMPRemote_h_ - -#include -#include -#include -#include -#include -#include - -namespace XPMP2 { - -/// The signature of the XPMP2 Remote Client -constexpr const char* REMOTE_SIGNATURE = "TwinFan.plugin.XPMP2.Remote"; - -// -// MARK: Global Helpers -// - -/// @brief Produces a reproducible(!) hash value for strings -/// @details Result is the same if the same string is provided, across platform -/// and across executions, unlike what std::hash requires.\n -/// It is implemented as a 16-bit version of the PJW hash: -/// @see https://en.wikipedia.org/wiki/PJW_hash_function -std::uint16_t PJWHash16 (const char *s); - -/// @brief Find a model by package name hash and short id -/// @details This approach is used by the remote client to safe network bandwith. -/// If an exact match with `pkgHash` _and_ `shortID` is not found, -/// then a model matching the short id alone is returned if available. -CSLModel* CSLModelByPkgShortId (std::uint16_t _pkgHash, - const std::string& _shortId); - -/// @brief Clamps `v` between `lo` and `hi`: `lo` if `v` < `lo`, `hi` if `hi` < `v`, otherwise `v` -/// @see C++17, https://en.cppreference.com/w/cpp/algorithm/clamp -/// @note Reimplemented here because Docker clang environment doesn't include it -template -constexpr const T& clamp( const T& v, const T& lo, const T& hi ) -{ - assert( !(hi < lo) ); - return (v < lo) ? lo : (hi < v) ? hi : v; -} - -// -// MARK: Network Data Definitions -// - -/// Message type -enum RemoteMsgTy : std::uint8_t { - RMT_MSG_INTEREST_BEACON = 0, ///< beacon sent by a remote client to signal interest in data - RMT_MSG_SEND, ///< internal indicator telling to send out all pending messages - RMT_MSG_SETTINGS, ///< a sender's id and its settings - RMT_MSG_AC_DETAILED, ///< aircraft full details, needed to create new a/c objects and to re-synch all remote data - RMT_MSG_AC_POS_UPDATE, ///< aircraft differences only - RMT_MSG_AC_ANIM, ///< aircraft animation values (dataRef values) only - RMT_MSG_AC_REMOVE, ///< aircraft is removed -}; - -/// Definition for how to map dataRef values to (u)int8, ie. to an integer range of 8 bits -struct RemoteDataRefPackTy { - float minV = 0.0f; ///< minimum transferred value - float range = 0.0f; ///< range of transferred value = maxV - minV - - /// Constructor sets minimum value and range - RemoteDataRefPackTy (float _min, float _max) : minV(_min), range(_max - _min) { assert(range != 0.0f); } - - /// pack afloat value to integer - std::uint8_t pack (float f) const { return std::uint8_t(clamp(f-minV,0.0f,range) * UINT8_MAX / range); } - /// unpack an integer value to float - float unpack (std::uint8_t i) const { return minV + range*float(i)/255.0f; } -}; - -/// An array holding all dataRef packing definitions -extern const std::array REMOTE_DR_DEF; - -// -// MARK: Message Header (Base) -// - -// To ensure best network capacity usage as well as identical alignment across platform we enforce tightly packed structures. -// The approach is very different between Visual C++ and clang / gcc, though: -#ifdef _MSC_VER // Visual C++ -#pragma pack(push,1) // set packing once (ie. not per struct) -#define PACKED -#elif defined(__clang__) || defined(__GNUC__) // Clang (Mac XCode etc) or GNU (Linux) -#define PACKED __attribute__ ((__packed__)) -#else -#error Unhandled Compiler! -#endif - -/// Message header, identical for all message types -struct RemoteMsgBaseTy { - RemoteMsgTy msgTy : 4; ///< message type - std::uint8_t msgVer : 4; ///< message version - bool bLocalSender : 1; ///< is the sender "local", ie. on same machine? - std::uint8_t filler1 : 7; ///< yet unsed - std::uint16_t pluginId = 0; ///< lower 16 bit of the sending plugin's id - std::uint32_t filler2 = 0; ///< yet unused, fills up to size 8 - /// Constructor just sets the values - RemoteMsgBaseTy (RemoteMsgTy _ty, std::uint8_t _ver); -} PACKED; - -// -// MARK: Beacon of Interest -// - -/// Interest Beacon message version number -constexpr std::uint8_t RMT_VER_BEACON = 0; -/// "Beacon of Interest", ie. some message on the multicast just to wake up sender -struct RemoteMsgBeaconTy : public RemoteMsgBaseTy { - // don't need additional data fields - /// Constructor sets appropriate message type - RemoteMsgBeaconTy(); -} PACKED; - -// -// MARK: Settings -// - -/// How often to send settings? [s] -constexpr int REMOTE_SEND_SETTINGS_INTVL = 20; - -/// Setttings message version number -constexpr std::uint8_t RMT_VER_SETTINGS = 0; -/// Settings message, identifying a sending plugin, regularly providing its settings -struct RemoteMsgSettingsTy : public RemoteMsgBaseTy { - char name[16]; ///< plugin's name, not necessarily zero-terminated if using full 12 chars - float maxLabelDist; ///< Maximum distance for drawing labels? [m] - char defaultIcao[4]; ///< Default ICAO aircraft type designator if no match can be found - char carIcaoType[4]; ///< Ground vehicle type identifier - std::uint8_t logLvl :3; ///< logging level - bool bLogMdlMatch :1; ///< Debug model matching? - bool bObjReplDataRefs :1; ///< Replace dataRefs in `.obj` files on load? - bool bObjReplTextures :1; ///< Replace textures in `.obj` files on load if needed? - bool bLabelCutOffAtVisibility :1; ///< Cut off labels at XP's reported visibility mit? - bool bMapEnabled :1; ///< Do we feed X-Plane's maps with our aircraft positions? - bool bMapLabels :1; ///< Do we show labels with the aircraft icons? - bool bHaveTCASControl :1; ///< Do we have AI/TCAS control? - std::uint16_t filler; ///< yet unused, fills size up for a multiple of 8 - - /// Constructor sets most values to zero - RemoteMsgSettingsTy (); - -} PACKED; - -// -// MARK: A/C Details -// - -/// A/C detail message version number -constexpr std::uint8_t RMT_VER_AC_DETAIL = 2; -constexpr std::uint8_t RMT_VER_AC_DETAIL_1 = 1; -constexpr std::uint8_t RMT_VER_AC_DETAIL_0 = 0; -/// A/C details, packed into an array message -struct RemoteAcDetailTy { - std::uint32_t modeS_id; ///< plane's unique id at the sender side (might differ remotely in case of duplicates) - char icaoType[4]; ///< icao a/c type - char icaoOp[4]; ///< icao airline code - char sShortId[20]; ///< CSL model's short id - std::uint16_t pkgHash; ///< hash value of package name - char label[23]; ///< label - std::uint8_t labelCol[3]; ///< label color (RGB) - float alt_ft; ///< [ft] current altitude - // ^ the above has 64 bytes, so that these doubles start on an 8-byte bounday: - double lat; ///< latitude - double lon; ///< longitude - std::int16_t pitch; ///< [0.01°] pitch/100 - std::uint16_t heading; ///< [0.01°] heading/100 - std::int16_t roll; ///< [0.01°] roll/100 - - std::int16_t aiPrio; ///< priority for display in limited TCAS target slots, `-1` indicates "no TCAS display" - std::uint16_t dTime; ///< [0.0001s] time difference to previous position in 1/10000s - bool bValid : 1; ///< is this object valid? (Will be reset in case of exceptions) - bool bVisible : 1; ///< Shall this plane be drawn at the moment? - bool bRender : 1; ///< Shall the CSL model be drawn in 3D world? - bool bDrawLabel : 1; ///< Draw the label of the aircraft? (new with v2) - bool bOnGrnd : 1; ///< Is the aircraft on the ground? - - // selectively taken from XPMPInfoTexts_t and packed: - char tailNum[10]; ///< registration, tail number - char manufacturer[40]; ///< a/c manufacturer, human readable - char model[40]; ///< a/c model, human readable - char airline[40]; ///< airline, human readable - char flightNum [10]; ///< flight number - char aptFrom [5]; ///< Origin airport (ICAO) - char aptTo [5]; ///< Destination airport (ICAO) - - std::uint8_t filler[5]; ///< yet unused - - ///< Array of _packed_ dataRef values for CSL model animation - std::uint8_t v[XPMP2::V_COUNT]; // 42 - - /// Default Constructor sets all to zero - RemoteAcDetailTy (); - /// A/c copy constructor fills from passed-in XPMP2::Aircraft object - RemoteAcDetailTy (const Aircraft& _ac, double _lat, double _lon, float _alt_ft, std::uint16_t _dTime); - /// Copies values from passed-in XPMP2::Aircraft object - void CopyFrom (const Aircraft& _ac, double _lat, double _lon, float _alt_ft, std::uint16_t _dTime); - - void SetLabelCol (const float _col[4]); ///< set the label color from a float array (4th number, alpha, is always considered 1.0) - void GetLabelCol (float _col[4]) const; ///< writes color out into a float array - - void SetPitch (float _p) { pitch = std::int16_t(_p*100.0f); } ///< sets pitch from float - float GetPitch () const { return float(pitch) / 100.0f; } ///< returns float pitch - - /// @brief Sets heading from float - /// @note Only works well for `0 <= _h < 360` - void SetHeading (float _h); - float GetHeading () const { return float(heading) / 100.0f; } ///< returns float heading - - void SetRoll (float _r) { roll = std::int16_t(std::lround(_r*100.0f)); } ///< sets pitch from float - float GetRoll () const { return float(roll) / 100.0f; } ///< returns float pitch - - static constexpr size_t msgSize () { return sizeof(RemoteAcDetailTy); } ///< message size -} PACKED; - -/// A/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements -struct RemoteMsgAcDetailTy : public RemoteMsgBaseTy { - RemoteAcDetailTy arr[1]; ///< basis for the array of actual details - - /// Constructor sets expected message type and version - RemoteMsgAcDetailTy () : RemoteMsgBaseTy(RMT_MSG_AC_DETAILED, RMT_VER_AC_DETAIL) {} - /// Convert msg len to number of arr elements - static constexpr size_t NumElem (size_t _msgLen) { return (_msgLen - sizeof(RemoteMsgBaseTy)) / sizeof(RemoteAcDetailTy); } -} PACKED; - -// -// MARK: A/C Position Update -// - -/// A/C Position update message version number -constexpr std::uint8_t RMT_VER_AC_POS_UPDATE = 0; - -/// What is the maximum difference a RemoteAcPosUpdateTy can hold? -constexpr double REMOTE_DEGREE_RES = 0.00000001; ///< resolution of degree updates -constexpr double REMOTE_MAX_DIFF_DEGREE = REMOTE_DEGREE_RES * INT16_MAX;///< maximum degree difference that can be represented in a pos update msg -constexpr double REMOTE_ALT_FT_RES = 0.01; ///< resolution of altitude[ft] updates -constexpr double REMOTE_MAX_DIFF_ALT_FT = REMOTE_ALT_FT_RES * INT16_MAX;///< maximum altitude[ft] difference that can be represented in a pos update msg -constexpr float REMOTE_TIME_RES = 0.0001f; ///< resolution of time difference -constexpr float REMOTE_MAX_DIFF_TIME = REMOTE_TIME_RES * UINT16_MAX; ///< maximum time difference thatn can be represented in a pos update msg - -/// @brief A/C Position updates based on global coordinates -/// @details for space efficiency only deltas to last msg are given in -/// 0.0000001 degree lat/lon (roughly 1 centimeter resolution) and -/// 0.01 ft altitude -struct RemoteAcPosUpdateTy { - std::uint32_t modeS_id; ///< plane's unique id at the sender side (might differ remotely in case of duplicates) - std::int16_t dLat; ///< [0.0000001 degrees] latitude position difference - std::int16_t dLon; ///< [0.0000001 degrees] longitude position difference - std::int16_t dAlt_ft; ///< [0.01 ft] altitude difference - std::uint16_t dTime; ///< [0.0001s] time difference to previous position in 1/10000s - std::int16_t pitch; ///< [0.01 degree] pitch/100 - std::uint16_t heading; ///< [0.01 degree] heading/100 - std::int16_t roll; ///< [0.01 degree] roll/100 - std::uint16_t filler1; ///< not yet used (for 4-byte alignment) - - /// Default Constructor sets all 0 - RemoteAcPosUpdateTy () { std::memset(this,0,sizeof(*this)); } - /// Constructor sets all values - RemoteAcPosUpdateTy (XPMPPlaneID _modeS_id, - std::int16_t _dLat, std::int16_t _dLon, - std::int16_t _dAlt_ft, std::uint16_t _dTime, - float _pitch, float _heading, float _roll); - - void SetPitch (float _p) { pitch = std::int16_t(_p*100.0f); } ///< sets pitch from float - float GetPitch () const { return float(pitch) / 100.0f; } ///< returns float pitch - - /// @brief Sets heading from float - /// @note Only works well for `0 <= _h < 360` - void SetHeading (float _h); - float GetHeading () const { return float(heading) / 100.0f; } ///< returns float heading - - void SetRoll (float _r) { roll = std::int16_t(std::lround(_r*100.0f)); }///< sets pitch from float - float GetRoll () const { return float(roll) / 100.0f; } ///< returns float pitch - - static constexpr size_t msgSize () { return sizeof(RemoteAcPosUpdateTy); } ///< message size -} PACKED; - -/// A/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements -struct RemoteMsgAcPosUpdateTy : public RemoteMsgBaseTy { - RemoteAcPosUpdateTy arr[1]; ///< basis for the array of actual position updates - - /// Constructor sets expected message type and version - RemoteMsgAcPosUpdateTy () : RemoteMsgBaseTy(RMT_MSG_AC_POS_UPDATE, RMT_VER_AC_POS_UPDATE) {} - /// Convert msg len to number of arr elements - static constexpr size_t NumElem (size_t _msgLen) { return (_msgLen - sizeof(RemoteMsgBaseTy)) / sizeof(RemoteAcPosUpdateTy); } -} PACKED; - -// -// MARK: A/C animation dataRefs -// - -/// A/C Position update message version number -constexpr std::uint8_t RMT_VER_AC_ANIM = 0; - -/// @brief A/C animation dataRef changes -/// @details This structure has variable length depending on the number of -/// actual dataRef values to carry. And several of these variable -/// length structures are added into one variable length network message. -/// @note Structure must stay aligned with XPMP2::RmtDataAcAnimTy -struct RemoteAcAnimTy { - std::uint32_t modeS_id = 0; ///< plane's unique id at the sender side (might differ remotely in case of duplicates) - std::uint8_t numVals = 0; ///< number of dataRef values in the following array - std::uint8_t filler = 0; ///< not yet used - - /// dataRef animation types and value - struct DataRefValTy { - DR_VALS idx; ///< index into XPMP2::Aircraft::v - std::uint8_t v; ///< dataRef animation value - } v[1]; ///< array of dataRef animation types and value - - /// Constructor - RemoteAcAnimTy (XPMPPlaneID _id) : modeS_id(_id) { v[0].idx = DR_VALS(0); v[0].v = 0; } - - /// message size assuming `num` array elements - static constexpr size_t msgSize (std::uint8_t num) - { return sizeof(RemoteAcAnimTy) + (num-1) * sizeof(DataRefValTy); } - /// current message size - size_t msgSize() const { return msgSize(numVals); } -} PACKED; - -/// A/C animation dataRef message, has an inherited header plus an array of _variable sized_ XPMP2::RemoteAcAnimTy elements -struct RemoteMsgAcAnimTy : public RemoteMsgBaseTy { - RemoteAcAnimTy animData; ///< message data starts here but extend beyond this point! - - /// Constructor sets expected message type and version - RemoteMsgAcAnimTy () : RemoteMsgBaseTy(RMT_MSG_AC_ANIM, RMT_VER_AC_ANIM), animData(0) {} - - /// Returns a pointer to the first/next animation data element in the message - const RemoteAcAnimTy* next (size_t _msgLen, const RemoteAcAnimTy* pCurr = nullptr) const; -} PACKED; - - -// -// MARK: A/C Removal -// - - -/// A/C removal message version number -constexpr std::uint8_t RMT_VER_AC_REMOVE = 0; - -/// A/C Removal only includes the plane id, structure required for msgSize() function -struct RemoteAcRemoveTy { - std::uint32_t modeS_id; ///< plane's unique id at the sender side (might differ remotely in case of duplicates) - - /// Constructor sets plane id - RemoteAcRemoveTy (XPMPPlaneID _id = 0) : modeS_id(_id) {} - - static constexpr size_t msgSize () { return sizeof(RemoteAcRemoveTy); } ///< message size -} PACKED; - -/// A/C removal message, an array of plane ids -struct RemoteMsgAcRemoveTy : public RemoteMsgBaseTy { - RemoteAcRemoveTy arr[1]; ///< plane's unique id at the sender side (might differ remotely in case of duplicates) - - /// Constructor sets expected message type and version - RemoteMsgAcRemoveTy () : RemoteMsgBaseTy(RMT_MSG_AC_REMOVE, RMT_VER_AC_REMOVE) {} - /// Convert msg len to number of arr elements - static constexpr size_t NumElem (size_t _msgLen) { return (_msgLen - sizeof(RemoteMsgBaseTy)) / sizeof(arr[0]); } -} PACKED; - -#ifdef _MSC_VER // Visual C++ -#pragma pack(pop) // reseting packing -#endif - -// A few static validations just to make sure that no compiler fiddles with my network message layout. -static_assert(sizeof(RemoteMsgBaseTy) == 8, "RemoteMsgBaseTy doesn't have expected size"); -static_assert(sizeof(RemoteMsgSettingsTy) == 40, "RemoteMsgSettingsTy doesn't have expected size"); -static_assert(sizeof(RemoteAcDetailTy) == 246+42, "RemoteAcDetailTy doesn't have expected size"); -static_assert(sizeof(RemoteMsgAcDetailTy) == 254+42, "RemoteMsgAcDetailTy doesn't have expected size"); -static_assert(sizeof(RemoteAcPosUpdateTy) == 20, "RemoteAcPosUpdateTy doesn't have expected size"); -static_assert(sizeof(RemoteMsgAcPosUpdateTy)== 28, "RemoteMsgAcPosUpdateTy doesn't have expected size"); -static_assert(sizeof(RemoteAcAnimTy) == 8, "RemoteAcAnimTy doesn't have expected size"); -static_assert(RemoteAcAnimTy::msgSize(V_COUNT) == 90, "RemoteAcAnimTy for V_COUNT dataRefs doesn't have expected size"); -static_assert(sizeof(RemoteMsgAcAnimTy) == 16, "RemoteMsgAcAnimTy doesn't have expected size"); -static_assert(sizeof(RemoteMsgAcRemoveTy) == 12, "RemoteMsgAcRemoveTy doesn't have expected size"); - -// -// MARK: Miscellaneous -// - -/// Function prototypes for callback functions to handle the received messages -struct RemoteCBFctTy { - /// Called in flight loop before processing first aircraft - void (*pfBeforeFirstAc)() = nullptr; - /// Called in flight loop after processing last aircraft - void (*pfAfterLastAc)() = nullptr; - /// Callback for processing Settings messages - void (*pfMsgSettings) (const std::uint32_t from[4], - const std::string& sFrom, - const RemoteMsgSettingsTy&) = nullptr; - /// Callback for processing A/C Details messages - void (*pfMsgACDetails) (const std::uint32_t from[4], size_t msgLen, - const RemoteMsgAcDetailTy&) = nullptr; - /// Callback for processing A/C Details messages - void (*pfMsgACPosUpdate) (const std::uint32_t from[4], size_t msgLen, - const RemoteMsgAcPosUpdateTy&) = nullptr; - /// Callback for processing A/C Animation dataRef messages - void (*pfMsgACAnim) (const std::uint32_t from[4], size_t msgLen, - const RemoteMsgAcAnimTy&) = nullptr; - /// Callback for processing A/C Removal messages - void (*pfMsgACRemove) (const std::uint32_t from[4], size_t msgLen, - const RemoteMsgAcRemoveTy&) = nullptr; -}; - -/// State of remote communcations -enum RemoteStatusTy : unsigned { - REMOTE_OFF = 0, ///< no remote connectivtiy, not listening, not sending - REMOTE_SEND_WAITING, ///< listening for a request to send data, but not actively sending data - REMOTE_SENDING, ///< actively sending aircraft data out to the network - REMOTE_RECV_WAITING, ///< waiting to receive data, periodically sending a token of interest - REMOTE_RECEIVING, ///< actively receiving data -}; - -/// Returns the current Remote status -RemoteStatusTy RemoteGetStatus(); - -/// Starts the listener, will call provided callback functions with received messages -void RemoteRecvStart (const RemoteCBFctTy& _rmtCBFcts); - -/// Stops the receiver -void RemoteRecvStop (); - -} - - -#endif diff --git a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Resources/Info.plist b/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Resources/Info.plist deleted file mode 100644 index 4ac0f5c7..00000000 --- a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Resources/Info.plist +++ /dev/null @@ -1,24 +0,0 @@ - - - - - CFBundleDevelopmentRegion - $(DEVELOPMENT_LANGUAGE) - CFBundleExecutable - $(EXECUTABLE_NAME) - CFBundleIdentifier - $(PRODUCT_BUNDLE_IDENTIFIER) - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - $(PRODUCT_NAME) - CFBundlePackageType - $(PRODUCT_BUNDLE_PACKAGE_TYPE) - CFBundleShortVersionString - $(MARKETING_VERSION) - CFBundleVersion - $(CURRENT_PROJECT_VERSION) - NSHumanReadableCopyright - Copyright © 2020 B. Hoppe. All rights reserved. - - diff --git a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/XPMP2 b/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/XPMP2 deleted file mode 100644 index 703f6fdc..00000000 Binary files a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/XPMP2 and /dev/null differ diff --git a/XPMP2-Sample/lib/XPMP2.framework/Versions/Current b/XPMP2-Sample/lib/XPMP2.framework/Versions/Current deleted file mode 120000 index 348c6a7e..00000000 --- a/XPMP2-Sample/lib/XPMP2.framework/Versions/Current +++ /dev/null @@ -1 +0,0 @@ -2.50 \ No newline at end of file diff --git a/XPMP2-Sample/lib/lin-bionic/libXPMP2.a b/XPMP2-Sample/lib/lin-bionic/libXPMP2.a deleted file mode 100644 index f3dab2d9..00000000 Binary files a/XPMP2-Sample/lib/lin-bionic/libXPMP2.a and /dev/null differ diff --git a/XPMP2-Sample/lib/lin/libXPMP2.a b/XPMP2-Sample/lib/lin/libXPMP2.a deleted file mode 100644 index 59e615a7..00000000 Binary files a/XPMP2-Sample/lib/lin/libXPMP2.a and /dev/null differ diff --git a/XPMP2-Sample/lib/win/XPMP2.lib b/XPMP2-Sample/lib/win/XPMP2.lib deleted file mode 100644 index b431585a..00000000 Binary files a/XPMP2-Sample/lib/win/XPMP2.lib and /dev/null differ diff --git a/XPMP2-Sample/lib/win/libXPMP2.a b/XPMP2-Sample/lib/win/libXPMP2.a deleted file mode 100644 index 01d97d9e..00000000 Binary files a/XPMP2-Sample/lib/win/libXPMP2.a and /dev/null differ diff --git a/XPMP2.xcodeproj/project.pbxproj b/XPMP2.xcodeproj/project.pbxproj index 7b7fb67e..1fd46198 100644 --- a/XPMP2.xcodeproj/project.pbxproj +++ b/XPMP2.xcodeproj/project.pbxproj @@ -9,36 +9,27 @@ /* Begin PBXBuildFile section */ 252C01F423E62040007C231F /* AIMultiplayer.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 252C01F223E62040007C231F /* AIMultiplayer.cpp */; }; 252C01F523E62040007C231F /* AIMultiplayer.h in Headers */ = {isa = PBXBuildFile; fileRef = 252C01F323E62040007C231F /* AIMultiplayer.h */; }; - 252FD04E25421C2B00286AE6 /* Client.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 252FD04C25421C2A00286AE6 /* Client.cpp */; }; 25338211253A39060090E0B3 /* Network.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 2533820F253A39060090E0B3 /* Network.cpp */; }; 25338212253A39060090E0B3 /* Network.h in Headers */ = {isa = PBXBuildFile; fileRef = 25338210253A39060090E0B3 /* Network.h */; }; 253485AA23C289E5002BA65A /* XPMPAircraft.h in Headers */ = {isa = PBXBuildFile; fileRef = 253485A923C289E4002BA65A /* XPMPAircraft.h */; settings = {ATTRIBUTES = (Public, ); }; }; 2541FA46253C902200AEA532 /* XPMPRemote.h in Headers */ = {isa = PBXBuildFile; fileRef = 2541FA45253C902200AEA532 /* XPMPRemote.h */; settings = {ATTRIBUTES = (Public, ); }; }; 2541FA4D253CDD6700AEA532 /* Remote.h in Headers */ = {isa = PBXBuildFile; fileRef = 2541FA4B253CDD6700AEA532 /* Remote.h */; }; 2541FA4E253CDD6700AEA532 /* Remote.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 2541FA4C253CDD6700AEA532 /* Remote.cpp */; }; + 255EC99228E3871100F99F93 /* Sound.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 255EC99028E3871100F99F93 /* Sound.cpp */; }; + 255EC99328E3871100F99F93 /* Sound.h in Headers */ = {isa = PBXBuildFile; fileRef = 255EC99128E3871100F99F93 /* Sound.h */; }; 256DC2F724F3141500C1595C /* CSLCopy.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 256DC2F624F3141500C1595C /* CSLCopy.cpp */; }; - 256EE0002540D7EF0007D517 /* XPMP2-Remote.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 256EDFFF2540D7EF0007D517 /* XPMP2-Remote.cpp */; }; - 256EE0102540E39D0007D517 /* Utilities.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 256EE00F2540E39D0007D517 /* Utilities.cpp */; }; 2575F45423EDFC5E00747524 /* Map.h in Headers */ = {isa = PBXBuildFile; fileRef = 2575F45223EDFC5E00747524 /* Map.h */; }; 2575F45523EDFC5E00747524 /* Map.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 2575F45323EDFC5E00747524 /* Map.cpp */; }; 2589B84A23CB4D6F005B76B8 /* RelatedDoc8643.h in Headers */ = {isa = PBXBuildFile; fileRef = 2589B84823CB4D6F005B76B8 /* RelatedDoc8643.h */; }; 2589B84B23CB4D6F005B76B8 /* RelatedDoc8643.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 2589B84923CB4D6F005B76B8 /* RelatedDoc8643.cpp */; }; 2599B91923BF636E00F92BB5 /* Aircraft.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 2599B91823BF636E00F92BB5 /* Aircraft.cpp */; }; 2599B92223BF63F600F92BB5 /* XPMP2.h in Headers */ = {isa = PBXBuildFile; fileRef = 2599B92123BF63F600F92BB5 /* XPMP2.h */; }; - 259FFDFB25A132D400B6D553 /* XPMP2.framework in CopyFiles */ = {isa = PBXBuildFile; fileRef = 2502C17A23BE8A1600578919 /* XPMP2.framework */; }; 25AE8CB523E376E2000BE21E /* 2D.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 25AE8CB323E376E1000BE21E /* 2D.cpp */; }; 25AE8CB623E376E2000BE21E /* 2D.h in Headers */ = {isa = PBXBuildFile; fileRef = 25AE8CB423E376E2000BE21E /* 2D.h */; }; - 25B071F12540D6C400CCDA1D /* XPMP2.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2502C17A23BE8A1600578919 /* XPMP2.framework */; }; - 25B071F22540D6C400CCDA1D /* CoreFoundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 25D86CC7253E285E00424494 /* CoreFoundation.framework */; }; - 25B071F32540D6C400CCDA1D /* XPLM.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 25D86CC9253E288900424494 /* XPLM.framework */; }; 25D680B923BE95FB00C83CC5 /* XPCAircraft.h in Headers */ = {isa = PBXBuildFile; fileRef = 25D680B623BE95FB00C83CC5 /* XPCAircraft.h */; settings = {ATTRIBUTES = (Public, ); }; }; 25D680BA23BE95FB00C83CC5 /* XPMPMultiplayer.h in Headers */ = {isa = PBXBuildFile; fileRef = 25D680B723BE95FB00C83CC5 /* XPMPMultiplayer.h */; settings = {ATTRIBUTES = (Public, ); }; }; 25D680BB23BE95FB00C83CC5 /* XPMPPlaneRenderer.h in Headers */ = {isa = PBXBuildFile; fileRef = 25D680B823BE95FB00C83CC5 /* XPMPPlaneRenderer.h */; settings = {ATTRIBUTES = (Public, ); }; }; 25D680C523BE9DBD00C83CC5 /* XPMPMultiplayer.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 25D680C423BE9DBD00C83CC5 /* XPMPMultiplayer.cpp */; }; - 25D86CC8253E285F00424494 /* CoreFoundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 25D86CC7253E285E00424494 /* CoreFoundation.framework */; }; - 25D86CCA253E288900424494 /* XPLM.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 25D86CC9253E288900424494 /* XPLM.framework */; }; - 25D86CCD253E289100424494 /* XPMP2.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2502C17A23BE8A1600578919 /* XPMP2.framework */; }; - 25D86D7A253E2F3E00424494 /* XPMP2-Sample.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 25D86D06253E2E5900424494 /* XPMP2-Sample.cpp */; }; 25EC1C4023BF6DF1000940BB /* CSLModels.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 25EC1C3F23BF6DF1000940BB /* CSLModels.cpp */; }; 25EC1C4223BF6DFA000940BB /* CSLModels.h in Headers */ = {isa = PBXBuildFile; fileRef = 25EC1C4123BF6DFA000940BB /* CSLModels.h */; }; 25EC1C4723BF7569000940BB /* Utilities.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 25EC1C4523BF7569000940BB /* Utilities.cpp */; }; @@ -46,36 +37,6 @@ 25FF33FE23BFF250001B0AB4 /* Aircraft.h in Headers */ = {isa = PBXBuildFile; fileRef = 25FF33FD23BFF250001B0AB4 /* Aircraft.h */; }; /* End PBXBuildFile section */ -/* Begin PBXContainerItemProxy section */ - 25B071ED2540D6C400CCDA1D /* PBXContainerItemProxy */ = { - isa = PBXContainerItemProxy; - containerPortal = 2502C16023BE3CFC00578919 /* Project object */; - proxyType = 1; - remoteGlobalIDString = 2502C17923BE8A1600578919; - remoteInfo = XPMP2; - }; - 25D86CCF253E289100424494 /* PBXContainerItemProxy */ = { - isa = PBXContainerItemProxy; - containerPortal = 2502C16023BE3CFC00578919 /* Project object */; - proxyType = 1; - remoteGlobalIDString = 2502C17923BE8A1600578919; - remoteInfo = XPMP2; - }; -/* End PBXContainerItemProxy section */ - -/* Begin PBXCopyFilesBuildPhase section */ - 259FFDFA25A1327F00B6D553 /* CopyFiles */ = { - isa = PBXCopyFilesBuildPhase; - buildActionMask = 2147483647; - dstPath = "${PROJECT_DIR}/XPMP2-Sample/lib"; - dstSubfolderSpec = 0; - files = ( - 259FFDFB25A132D400B6D553 /* XPMP2.framework in CopyFiles */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXCopyFilesBuildPhase section */ - /* Begin PBXFileReference section */ 25019BC624919A1500355472 /* HowTo.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = HowTo.md; sourceTree = ""; }; 25019BC724919A1500355472 /* CSLdataRefs.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = CSLdataRefs.md; sourceTree = ""; }; @@ -91,22 +52,17 @@ 252C01F923E6D64F007C231F /* Makefile */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.make; path = Makefile; sourceTree = ""; }; 252C01FA23E6D64F007C231F /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = ""; }; 252C01FB23E6D64F007C231F /* build.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = build.sh; sourceTree = ""; }; - 252FD04C25421C2A00286AE6 /* Client.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Client.cpp; sourceTree = ""; }; - 252FD04D25421C2B00286AE6 /* Client.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Client.h; sourceTree = ""; }; 2533820F253A39060090E0B3 /* Network.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Network.cpp; sourceTree = ""; }; 25338210253A39060090E0B3 /* Network.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Network.h; sourceTree = ""; }; 253485A923C289E4002BA65A /* XPMPAircraft.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = XPMPAircraft.h; sourceTree = ""; }; 2541FA45253C902200AEA532 /* XPMPRemote.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = XPMPRemote.h; sourceTree = ""; }; 2541FA4B253CDD6700AEA532 /* Remote.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Remote.h; sourceTree = ""; }; 2541FA4C253CDD6700AEA532 /* Remote.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Remote.cpp; sourceTree = ""; }; - 2561DA2D2571AE4800E3DE3D /* readme.html */ = {isa = PBXFileReference; lastKnownFileType = text.html; path = readme.html; sourceTree = ""; }; + 255EC99028E3871100F99F93 /* Sound.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; path = Sound.cpp; sourceTree = ""; }; + 255EC99128E3871100F99F93 /* Sound.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = Sound.h; sourceTree = ""; }; 256C287925B4E6270033007D /* Toolchain-ubuntu-osxcross.cmake */ = {isa = PBXFileReference; lastKnownFileType = text; path = "Toolchain-ubuntu-osxcross.cmake"; sourceTree = ""; }; 256DC2F524F3090B00C1595C /* Obj8DataRefs.txt */ = {isa = PBXFileReference; lastKnownFileType = text; path = Obj8DataRefs.txt; sourceTree = ""; }; 256DC2F624F3141500C1595C /* CSLCopy.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = CSLCopy.cpp; sourceTree = ""; }; - 256EDFFF2540D7EF0007D517 /* XPMP2-Remote.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = "XPMP2-Remote.cpp"; sourceTree = ""; }; - 256EE0042540DDE10007D517 /* XPMP2-Remote.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "XPMP2-Remote.h"; sourceTree = ""; }; - 256EE00E2540E39D0007D517 /* Utilities.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Utilities.h; sourceTree = ""; }; - 256EE00F2540E39D0007D517 /* Utilities.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Utilities.cpp; sourceTree = ""; }; 256F4687255C9A6A00FBE18A /* XPMP2.example.prf */ = {isa = PBXFileReference; lastKnownFileType = text; path = XPMP2.example.prf; sourceTree = ""; }; 2571D63525B2591B0055AA1E /* Toolchain-mingw-w64-x86-64.cmake */ = {isa = PBXFileReference; lastKnownFileType = text; path = "Toolchain-mingw-w64-x86-64.cmake"; sourceTree = ""; }; 2571D63825B3196D0055AA1E /* Dockerfile_Bionic */ = {isa = PBXFileReference; lastKnownFileType = text; path = Dockerfile_Bionic; sourceTree = ""; }; @@ -125,7 +81,6 @@ 2599B92123BF63F600F92BB5 /* XPMP2.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = XPMP2.h; sourceTree = ""; }; 25AE8CB323E376E1000BE21E /* 2D.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = 2D.cpp; sourceTree = ""; }; 25AE8CB423E376E2000BE21E /* 2D.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = 2D.h; sourceTree = ""; }; - 25B071F72540D6C400CCDA1D /* XPMP2-Remote.xpl */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.dylib"; includeInIndex = 0; path = "XPMP2-Remote.xpl"; sourceTree = BUILT_PRODUCTS_DIR; }; 25D1D25523C9285300D20D58 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = ""; }; 25D680B123BE936B00C83CC5 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; 25D680B623BE95FB00C83CC5 /* XPCAircraft.h */ = {isa = PBXFileReference; explicitFileType = sourcecode.cpp.h; fileEncoding = 4; path = XPCAircraft.h; sourceTree = ""; }; @@ -135,11 +90,7 @@ 25D680BF23BE9BB900C83CC5 /* MainPage.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = MainPage.md; sourceTree = ""; }; 25D680C023BE9D3200C83CC5 /* .gitignore */ = {isa = PBXFileReference; lastKnownFileType = text; path = .gitignore; sourceTree = ""; }; 25D680C423BE9DBD00C83CC5 /* XPMPMultiplayer.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = XPMPMultiplayer.cpp; sourceTree = ""; }; - 25D86CC0253E281800424494 /* XPMP2-Sample.xpl */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.dylib"; includeInIndex = 0; path = "XPMP2-Sample.xpl"; sourceTree = BUILT_PRODUCTS_DIR; }; 25D86CC7253E285E00424494 /* CoreFoundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreFoundation.framework; path = System/Library/Frameworks/CoreFoundation.framework; sourceTree = SDKROOT; }; - 25D86CC9253E288900424494 /* XPLM.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = XPLM.framework; path = "XPMP2-Sample/SDK/Libraries/Mac/XPLM.framework"; sourceTree = ""; }; - 25D86D06253E2E5900424494 /* XPMP2-Sample.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; path = "XPMP2-Sample.cpp"; sourceTree = ""; }; - 25D86D98253F94F200424494 /* CMakeLists.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = CMakeLists.txt; sourceTree = ""; }; 25EC1C3F23BF6DF1000940BB /* CSLModels.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = CSLModels.cpp; sourceTree = ""; }; 25EC1C4123BF6DFA000940BB /* CSLModels.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CSLModels.h; sourceTree = ""; }; 25EC1C4523BF7569000940BB /* Utilities.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Utilities.cpp; sourceTree = ""; }; @@ -148,23 +99,10 @@ /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ - 25B071F02540D6C400CCDA1D /* Frameworks */ = { - isa = PBXFrameworksBuildPhase; - buildActionMask = 2147483647; - files = ( - 25B071F12540D6C400CCDA1D /* XPMP2.framework in Frameworks */, - 25B071F22540D6C400CCDA1D /* CoreFoundation.framework in Frameworks */, - 25B071F32540D6C400CCDA1D /* XPLM.framework in Frameworks */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; - 25D86CBE253E281800424494 /* Frameworks */ = { + 255EC98D28E381EF00F99F93 /* Frameworks */ = { isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( - 25D86CCD253E289100424494 /* XPMP2.framework in Frameworks */, - 25D86CC8253E285F00424494 /* CoreFoundation.framework in Frameworks */, - 25D86CCA253E288900424494 /* XPLM.framework in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -183,8 +121,6 @@ 25D680B523BE95FB00C83CC5 /* inc */, 2596FD462447226700C6A41E /* Resources */, 25D680BC23BE9B5700C83CC5 /* src */, - 25D86CD7253E2E5900424494 /* XPMP2-Sample */, - 256EDFF32540D7730007D517 /* XPMP2-Remote */, 25D86CC6253E285E00424494 /* Frameworks */, 2502C16923BE3CFC00578919 /* Products */, ); @@ -194,8 +130,6 @@ isa = PBXGroup; children = ( 2502C17A23BE8A1600578919 /* XPMP2.framework */, - 25D86CC0253E281800424494 /* XPMP2-Sample.xpl */, - 25B071F72540D6C400CCDA1D /* XPMP2-Remote.xpl */, ); name = Products; sourceTree = ""; @@ -214,20 +148,6 @@ path = docker; sourceTree = ""; }; - 256EDFF32540D7730007D517 /* XPMP2-Remote */ = { - isa = PBXGroup; - children = ( - 2561DA2D2571AE4800E3DE3D /* readme.html */, - 252FD04C25421C2A00286AE6 /* Client.cpp */, - 252FD04D25421C2B00286AE6 /* Client.h */, - 256EE00F2540E39D0007D517 /* Utilities.cpp */, - 256EE00E2540E39D0007D517 /* Utilities.h */, - 256EE0042540DDE10007D517 /* XPMP2-Remote.h */, - 256EDFFF2540D7EF0007D517 /* XPMP2-Remote.cpp */, - ); - path = "XPMP2-Remote"; - sourceTree = ""; - }; 2596FD462447226700C6A41E /* Resources */ = { isa = PBXGroup; children = ( @@ -272,9 +192,11 @@ 2589B84823CB4D6F005B76B8 /* RelatedDoc8643.h */, 2541FA4C253CDD6700AEA532 /* Remote.cpp */, 2541FA4B253CDD6700AEA532 /* Remote.h */, + 255EC99028E3871100F99F93 /* Sound.cpp */, + 255EC99128E3871100F99F93 /* Sound.h */, 25EC1C4523BF7569000940BB /* Utilities.cpp */, - 2599B92123BF63F600F92BB5 /* XPMP2.h */, 25EC1C4623BF7569000940BB /* Utilities.h */, + 2599B92123BF63F600F92BB5 /* XPMP2.h */, 25D680C423BE9DBD00C83CC5 /* XPMPMultiplayer.cpp */, ); path = src; @@ -302,21 +224,11 @@ 25D86CC6253E285E00424494 /* Frameworks */ = { isa = PBXGroup; children = ( - 25D86CC9253E288900424494 /* XPLM.framework */, 25D86CC7253E285E00424494 /* CoreFoundation.framework */, ); name = Frameworks; sourceTree = ""; }; - 25D86CD7253E2E5900424494 /* XPMP2-Sample */ = { - isa = PBXGroup; - children = ( - 25D86D98253F94F200424494 /* CMakeLists.txt */, - 25D86D06253E2E5900424494 /* XPMP2-Sample.cpp */, - ); - path = "XPMP2-Sample"; - sourceTree = ""; - }; /* End PBXGroup section */ /* Begin PBXHeadersBuildPhase section */ @@ -332,6 +244,7 @@ 253485AA23C289E5002BA65A /* XPMPAircraft.h in Headers */, 25D680BA23BE95FB00C83CC5 /* XPMPMultiplayer.h in Headers */, 25D680B923BE95FB00C83CC5 /* XPCAircraft.h in Headers */, + 255EC99328E3871100F99F93 /* Sound.h in Headers */, 252C01F523E62040007C231F /* AIMultiplayer.h in Headers */, 25338212253A39060090E0B3 /* Network.h in Headers */, 2541FA4D253CDD6700AEA532 /* Remote.h in Headers */, @@ -350,10 +263,9 @@ buildConfigurationList = 2502C17F23BE8A1700578919 /* Build configuration list for PBXNativeTarget "XPMP2" */; buildPhases = ( 2502C17623BE8A1600578919 /* Sources */, + 255EC98D28E381EF00F99F93 /* Frameworks */, 2502C17523BE8A1600578919 /* Headers */, - 259FFDFA25A1327F00B6D553 /* CopyFiles */, 255C338A2544E1FF002C166F /* ShellScript */, - 259FFDFC25A132EC00B6D553 /* ShellScript */, ); buildRules = ( ); @@ -364,56 +276,18 @@ productReference = 2502C17A23BE8A1600578919 /* XPMP2.framework */; productType = "com.apple.product-type.framework"; }; - 25B071EB2540D6C400CCDA1D /* XPMP2-Remote */ = { - isa = PBXNativeTarget; - buildConfigurationList = 25B071F42540D6C400CCDA1D /* Build configuration list for PBXNativeTarget "XPMP2-Remote" */; - buildPhases = ( - 25B071EE2540D6C400CCDA1D /* Sources */, - 25B071F02540D6C400CCDA1D /* Frameworks */, - 255C33772544C9D9002C166F /* ShellScript */, - ); - buildRules = ( - ); - dependencies = ( - 25B071EC2540D6C400CCDA1D /* PBXTargetDependency */, - ); - name = "XPMP2-Remote"; - productName = "XPMP2-Sample"; - productReference = 25B071F72540D6C400CCDA1D /* XPMP2-Remote.xpl */; - productType = "com.apple.product-type.library.dynamic"; - }; - 25D86CBF253E281800424494 /* XPMP2-Sample */ = { - isa = PBXNativeTarget; - buildConfigurationList = 25D86CC3253E281800424494 /* Build configuration list for PBXNativeTarget "XPMP2-Sample" */; - buildPhases = ( - 25D86CBD253E281800424494 /* Sources */, - 25D86CBE253E281800424494 /* Frameworks */, - ); - buildRules = ( - ); - dependencies = ( - 25D86CD0253E289100424494 /* PBXTargetDependency */, - ); - name = "XPMP2-Sample"; - productName = "XPMP2-Sample"; - productReference = 25D86CC0253E281800424494 /* XPMP2-Sample.xpl */; - productType = "com.apple.product-type.library.dynamic"; - }; /* End PBXNativeTarget section */ /* Begin PBXProject section */ 2502C16023BE3CFC00578919 /* Project object */ = { isa = PBXProject; attributes = { - LastUpgradeCheck = 1340; + LastUpgradeCheck = 1400; ORGANIZATIONNAME = TwinFan; TargetAttributes = { 2502C17923BE8A1600578919 = { CreatedOnToolsVersion = 11.3; }; - 25D86CBF253E281800424494 = { - CreatedOnToolsVersion = 12.0.1; - }; }; }; buildConfigurationList = 2502C16323BE3CFC00578919 /* Build configuration list for PBXProject "XPMP2" */; @@ -430,32 +304,11 @@ projectRoot = ""; targets = ( 2502C17923BE8A1600578919 /* XPMP2 */, - 25D86CBF253E281800424494 /* XPMP2-Sample */, - 25B071EB2540D6C400CCDA1D /* XPMP2-Remote */, ); }; /* End PBXProject section */ /* Begin PBXShellScriptBuildPhase section */ - 255C33772544C9D9002C166F /* ShellScript */ = { - isa = PBXShellScriptBuildPhase; - alwaysOutOfDate = 1; - buildActionMask = 2147483647; - files = ( - ); - inputFileListPaths = ( - ); - inputPaths = ( - ); - outputFileListPaths = ( - ); - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "# Skip this in a Travis CI build\n[[ ! -z \"${TRAVIS_BUILD_DIR}\" ]] && exit 0\nTAGS=\"TODO:|FIXME:\"\necho \"Searching ${SRCROOT} for ${TAGS}\"\nfind \"${SRCROOT}/XPMP2-Remote\" \\( -name \"*.cpp\" -or -name \"*.h\" \\) -print0 | xargs -0 egrep --with-filename --line-number --only-matching \"($TAGS).*\\$\" | perl -p -e \"s/($TAGS)/ warning: \\$1/\"\n"; - showEnvVarsInLog = 0; - }; 255C338A2544E1FF002C166F /* ShellScript */ = { isa = PBXShellScriptBuildPhase; alwaysOutOfDate = 1; @@ -475,27 +328,6 @@ shellScript = "# Skip this in a Travis CI build\n[[ ! -z \"${TRAVIS_BUILD_DIR}\" ]] && exit 0\nTAGS=\"TODO:|FIXME:\"\necho \"Searching ${SRCROOT} for ${TAGS}\"\nfind {\"${SRCROOT}/inc\",\"${SRCROOT}/src\"} \\( -name \"*.cpp\" -or -name \"*.h\" \\) -print0 | xargs -0 egrep --with-filename --line-number --only-matching \"($TAGS).*\\$\" | perl -p -e \"s/($TAGS)/ warning: \\$1/\"\n"; showEnvVarsInLog = 0; }; - 259FFDFC25A132EC00B6D553 /* ShellScript */ = { - isa = PBXShellScriptBuildPhase; - alwaysOutOfDate = 1; - buildActionMask = 2147483647; - files = ( - ); - inputFileListPaths = ( - ); - inputPaths = ( - "${BUILT_PRODUCTS_DIR}/${WRAPPER_NAME}", - ); - outputFileListPaths = ( - ); - outputPaths = ( - "${LT_LIB_DIR}/${WRAPPER_NAME}", - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "# Copy to LiveTraffic build dir if that exists (but don't fail)\nLT_LIB_DIR=\"${PROJECT_DIR}/../LiveTraffic/Lib/XPMP2\"\n[[ ! -d \"${LT_LIB_DIR}\" ]] && exit 0\nrm -Rf ${LT_LIB_DIR}/${WRAPPER_NAME}\ncp -af ${BUILT_PRODUCTS_DIR}/${WRAPPER_NAME} ${LT_LIB_DIR}\n"; - showEnvVarsInLog = 0; - }; /* End PBXShellScriptBuildPhase section */ /* Begin PBXSourcesBuildPhase section */ @@ -514,42 +346,12 @@ 2575F45523EDFC5E00747524 /* Map.cpp in Sources */, 25338211253A39060090E0B3 /* Network.cpp in Sources */, 2599B91923BF636E00F92BB5 /* Aircraft.cpp in Sources */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; - 25B071EE2540D6C400CCDA1D /* Sources */ = { - isa = PBXSourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - 256EE0002540D7EF0007D517 /* XPMP2-Remote.cpp in Sources */, - 256EE0102540E39D0007D517 /* Utilities.cpp in Sources */, - 252FD04E25421C2B00286AE6 /* Client.cpp in Sources */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; - 25D86CBD253E281800424494 /* Sources */ = { - isa = PBXSourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - 25D86D7A253E2F3E00424494 /* XPMP2-Sample.cpp in Sources */, + 255EC99228E3871100F99F93 /* Sound.cpp in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXSourcesBuildPhase section */ -/* Begin PBXTargetDependency section */ - 25B071EC2540D6C400CCDA1D /* PBXTargetDependency */ = { - isa = PBXTargetDependency; - target = 2502C17923BE8A1600578919 /* XPMP2 */; - targetProxy = 25B071ED2540D6C400CCDA1D /* PBXContainerItemProxy */; - }; - 25D86CD0253E289100424494 /* PBXTargetDependency */ = { - isa = PBXTargetDependency; - target = 2502C17923BE8A1600578919 /* XPMP2 */; - targetProxy = 25D86CCF253E289100424494 /* PBXContainerItemProxy */; - }; -/* End PBXTargetDependency section */ - /* Begin XCBuildConfiguration section */ 2502C16A23BE3CFC00578919 /* Debug */ = { isa = XCBuildConfiguration; @@ -559,7 +361,6 @@ CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; CLANG_ANALYZER_SECURITY_FLOATLOOPCOUNTER = YES; CLANG_CXX_LANGUAGE_STANDARD = "c++17"; - CLANG_CXX_LIBRARY = "libc++"; CLANG_ENABLE_MODULES = YES; CLANG_ENABLE_OBJC_ARC = YES; CLANG_ENABLE_OBJC_WEAK = YES; @@ -593,10 +394,10 @@ CODE_SIGN_IDENTITY = "-"; COPY_PHASE_STRIP = NO; CURRENT_PROJECT_VERSION = "${XPMP2_VER_MAJOR}.${XPMP2_VER_MINOR}"; + DEAD_CODE_STRIPPING = YES; DEBUG_INFORMATION_FORMAT = dwarf; DEFINES_MODULE = YES; DEVELOPMENT_TEAM = W5UR4ZV2BP; - DSTROOT = "$(XPLANE11_ROOT)/Resources/plugins/$(TARGET_NAME)"; ENABLE_STRICT_OBJC_MSGSEND = YES; ENABLE_TESTABILITY = YES; FRAMEWORK_VERSION = "${CURRENT_PROJECT_VERSION}"; @@ -607,6 +408,7 @@ GCC_PRECOMPILE_PREFIX_HEADER = YES; GCC_PREPROCESSOR_DEFINITIONS = ( "DEBUG=1", + "INCLUDE_FMOD_SOUND=1", "APL=1", "IBM=0", "LIN=0", @@ -637,19 +439,19 @@ GCC_WARN_UNUSED_VARIABLE = YES; HEADER_SEARCH_PATHS = inc; INFOPLIST_FILE = Info.plist; - MACOSX_DEPLOYMENT_TARGET = 10.12; - MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE; - MTL_FAST_MATH = YES; + MACOSX_DEPLOYMENT_TARGET = 11.0; ONLY_ACTIVE_ARCH = YES; PRODUCT_BUNDLE_IDENTIFIER = com.twinfan.XPMP2; PRODUCT_NAME = XPMP2; RUN_CLANG_STATIC_ANALYZER = YES; SDKROOT = macosx; - USER_HEADER_SEARCH_PATHS = "$(XPSDK_ROOT)/CHeaders/XPLM"; - XPLANE11_ROOT = "$(USER_APPS_DIR)/X-Plane/Release"; + USER_HEADER_SEARCH_PATHS = ( + "$(XPSDK_ROOT)/CHeaders/XPLM", + lib/fmod/inc, + ); XPMP2_VER_MAJOR = 2; - XPMP2_VER_MINOR = 50; - XPSDK_ROOT = "XPMP2-Sample/SDK"; + XPMP2_VER_MINOR = 60; + XPSDK_ROOT = lib/SDK; }; name = Debug; }; @@ -661,7 +463,6 @@ CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; CLANG_ANALYZER_SECURITY_FLOATLOOPCOUNTER = YES; CLANG_CXX_LANGUAGE_STANDARD = "c++17"; - CLANG_CXX_LIBRARY = "libc++"; CLANG_ENABLE_MODULES = YES; CLANG_ENABLE_OBJC_ARC = YES; CLANG_ENABLE_OBJC_WEAK = YES; @@ -695,10 +496,10 @@ CODE_SIGN_IDENTITY = "-"; COPY_PHASE_STRIP = NO; CURRENT_PROJECT_VERSION = "${XPMP2_VER_MAJOR}.${XPMP2_VER_MINOR}"; + DEAD_CODE_STRIPPING = YES; DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; DEFINES_MODULE = YES; DEVELOPMENT_TEAM = W5UR4ZV2BP; - DSTROOT = "$(XPLANE11_ROOT)/Resources/plugins/$(TARGET_NAME)"; ENABLE_NS_ASSERTIONS = NO; ENABLE_STRICT_OBJC_MSGSEND = YES; FRAMEWORK_VERSION = "${CURRENT_PROJECT_VERSION}"; @@ -707,6 +508,7 @@ GCC_PRECOMPILE_PREFIX_HEADER = YES; GCC_PREPROCESSOR_DEFINITIONS = ( "NDEBUG=1", + "INCLUDE_FMOD_SOUND=1", "APL=1", "IBM=0", "LIN=0", @@ -737,18 +539,18 @@ GCC_WARN_UNUSED_VARIABLE = YES; HEADER_SEARCH_PATHS = inc; INFOPLIST_FILE = Info.plist; - MACOSX_DEPLOYMENT_TARGET = 10.12; - MTL_ENABLE_DEBUG_INFO = NO; - MTL_FAST_MATH = YES; + MACOSX_DEPLOYMENT_TARGET = 11.0; PRODUCT_BUNDLE_IDENTIFIER = com.twinfan.XPMP2; PRODUCT_NAME = XPMP2; RUN_CLANG_STATIC_ANALYZER = YES; SDKROOT = macosx; - USER_HEADER_SEARCH_PATHS = "$(XPSDK_ROOT)/CHeaders/XPLM"; - XPLANE11_ROOT = "$(USER_APPS_DIR)/X-Plane/Release"; + USER_HEADER_SEARCH_PATHS = ( + "$(XPSDK_ROOT)/CHeaders/XPLM", + lib/fmod/inc, + ); XPMP2_VER_MAJOR = 2; - XPMP2_VER_MINOR = 50; - XPSDK_ROOT = "XPMP2-Sample/SDK"; + XPMP2_VER_MINOR = 60; + XPSDK_ROOT = lib/SDK; }; name = Release; }; @@ -757,9 +559,17 @@ buildSettings = { CODE_SIGN_IDENTITY = ""; COMBINE_HIDPI_IMAGES = YES; + DEAD_CODE_STRIPPING = YES; DEVELOPMENT_TEAM = ""; - DSTROOT = "$(PROJECT_DIR)"; + FRAMEWORK_SEARCH_PATHS = ( + "$(inherited)", + "$(PROJECT_DIR)/XPMP2-Sample/lib/SDK/Libraries/Mac", + ); GCC_PREFIX_HEADER = src/XPMP2.h; + HEADER_SEARCH_PATHS = ( + inc, + "XPMP2-Sample/lib/fmod/inc", + ); INSTALL_PATH = "XPMP2-Sample/lib"; LD_DYLIB_INSTALL_NAME = "$(DYLIB_INSTALL_NAME_BASE:standardizepath)/$(PRODUCT_MODULE_NAME)"; LD_RUNPATH_SEARCH_PATHS = ( @@ -767,6 +577,10 @@ "@executable_path/../Frameworks", "@loader_path/Frameworks", ); + LIBRARY_SEARCH_PATHS = ( + "$(inherited)", + "$(PROJECT_DIR)/XPMP2-Sample/lib/fmod", + ); MACH_O_TYPE = staticlib; PRODUCT_BUNDLE_IDENTIFIER = com.twinfan.XPMP2; PRODUCT_NAME = XPMP2; @@ -778,9 +592,17 @@ buildSettings = { CODE_SIGN_IDENTITY = ""; COMBINE_HIDPI_IMAGES = YES; + DEAD_CODE_STRIPPING = YES; DEVELOPMENT_TEAM = ""; - DSTROOT = "$(PROJECT_DIR)"; + FRAMEWORK_SEARCH_PATHS = ( + "$(inherited)", + "$(PROJECT_DIR)/XPMP2-Sample/lib/SDK/Libraries/Mac", + ); GCC_PREFIX_HEADER = src/XPMP2.h; + HEADER_SEARCH_PATHS = ( + inc, + "XPMP2-Sample/lib/fmod/inc", + ); INSTALL_PATH = "XPMP2-Sample/lib"; LD_DYLIB_INSTALL_NAME = "$(DYLIB_INSTALL_NAME_BASE:standardizepath)/$(PRODUCT_MODULE_NAME)"; LD_RUNPATH_SEARCH_PATHS = ( @@ -788,178 +610,16 @@ "@executable_path/../Frameworks", "@loader_path/Frameworks", ); + LIBRARY_SEARCH_PATHS = ( + "$(inherited)", + "$(PROJECT_DIR)/XPMP2-Sample/lib/fmod", + ); MACH_O_TYPE = staticlib; PRODUCT_BUNDLE_IDENTIFIER = com.twinfan.XPMP2; PRODUCT_NAME = XPMP2; }; name = Release; }; - 25B071F52540D6C400CCDA1D /* Debug */ = { - isa = XCBuildConfiguration; - buildSettings = { - CLANG_ENABLE_MODULES = NO; - CLANG_ENABLE_OBJC_ARC = NO; - CODE_SIGN_IDENTITY = "Developer ID Application"; - CODE_SIGN_STYLE = Manual; - DEFINES_MODULE = NO; - DEPLOYMENT_LOCATION = YES; - DYLIB_COMPATIBILITY_VERSION = ""; - DYLIB_CURRENT_VERSION = ""; - ENABLE_HARDENED_RUNTIME = YES; - EXECUTABLE_EXTENSION = xpl; - EXECUTABLE_PREFIX = ""; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/XPMP2-Sample/SDK/Libraries/Mac", - ); - GCC_PRECOMPILE_PREFIX_HEADER = YES; - GCC_PREFIX_HEADER = "XPMP2-Remote/XPMP2-Remote.h"; - GCC_SYMBOLS_PRIVATE_EXTERN = YES; - HEADER_SEARCH_PATHS = ""; - INFOPLIST_FILE = ""; - INSTALL_PATH = mac_x64; - MACH_O_TYPE = mh_bundle; - OTHER_CODE_SIGN_FLAGS = "--timestamp"; - OTHER_LDFLAGS = ( - "$(OTHER_LDFLAGS)", - "-Wl,-exported_symbol", - "-Wl,_XPluginStart", - "-Wl,-exported_symbol", - "-Wl,_XPluginEnable", - "-Wl,-exported_symbol", - "-Wl,_XPluginReceiveMessage", - "-Wl,-exported_symbol", - "-Wl,_XPluginDisable", - "-Wl,-exported_symbol", - "-Wl,_XPluginStop", - ); - PRODUCT_NAME = "$(TARGET_NAME)"; - SKIP_INSTALL = NO; - }; - name = Debug; - }; - 25B071F62540D6C400CCDA1D /* Release */ = { - isa = XCBuildConfiguration; - buildSettings = { - CLANG_ENABLE_MODULES = NO; - CLANG_ENABLE_OBJC_ARC = NO; - CODE_SIGN_IDENTITY = "Developer ID Application"; - CODE_SIGN_STYLE = Manual; - DEFINES_MODULE = NO; - DEPLOYMENT_LOCATION = YES; - DYLIB_COMPATIBILITY_VERSION = ""; - DYLIB_CURRENT_VERSION = ""; - ENABLE_HARDENED_RUNTIME = YES; - EXECUTABLE_EXTENSION = xpl; - EXECUTABLE_PREFIX = ""; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/XPMP2-Sample/SDK/Libraries/Mac", - ); - GCC_PRECOMPILE_PREFIX_HEADER = YES; - GCC_PREFIX_HEADER = "XPMP2-Remote/XPMP2-Remote.h"; - GCC_SYMBOLS_PRIVATE_EXTERN = YES; - HEADER_SEARCH_PATHS = ""; - INFOPLIST_FILE = ""; - INSTALL_PATH = mac_x64; - MACH_O_TYPE = mh_bundle; - OTHER_CODE_SIGN_FLAGS = "--timestamp"; - OTHER_LDFLAGS = ( - "$(OTHER_LDFLAGS)", - "-Wl,-exported_symbol", - "-Wl,_XPluginStart", - "-Wl,-exported_symbol", - "-Wl,_XPluginEnable", - "-Wl,-exported_symbol", - "-Wl,_XPluginReceiveMessage", - "-Wl,-exported_symbol", - "-Wl,_XPluginDisable", - "-Wl,-exported_symbol", - "-Wl,_XPluginStop", - ); - PRODUCT_NAME = "$(TARGET_NAME)"; - SKIP_INSTALL = NO; - }; - name = Release; - }; - 25D86CC1253E281800424494 /* Debug */ = { - isa = XCBuildConfiguration; - buildSettings = { - CLANG_ENABLE_MODULES = NO; - CLANG_ENABLE_OBJC_ARC = NO; - DEFINES_MODULE = NO; - DEPLOYMENT_LOCATION = YES; - DYLIB_COMPATIBILITY_VERSION = ""; - DYLIB_CURRENT_VERSION = ""; - EXECUTABLE_EXTENSION = xpl; - EXECUTABLE_PREFIX = ""; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/XPMP2-Sample/SDK/Libraries/Mac", - ); - GCC_PRECOMPILE_PREFIX_HEADER = NO; - GCC_SYMBOLS_PRIVATE_EXTERN = YES; - HEADER_SEARCH_PATHS = ""; - INFOPLIST_FILE = ""; - INSTALL_PATH = mac_x64; - MACH_O_TYPE = mh_bundle; - OTHER_LDFLAGS = ( - "$(OTHER_LDFLAGS)", - "-Wl,-exported_symbol", - "-Wl,_XPluginStart", - "-Wl,-exported_symbol", - "-Wl,_XPluginEnable", - "-Wl,-exported_symbol", - "-Wl,_XPluginReceiveMessage", - "-Wl,-exported_symbol", - "-Wl,_XPluginDisable", - "-Wl,-exported_symbol", - "-Wl,_XPluginStop", - ); - PRODUCT_NAME = "$(TARGET_NAME)"; - SKIP_INSTALL = NO; - }; - name = Debug; - }; - 25D86CC2253E281800424494 /* Release */ = { - isa = XCBuildConfiguration; - buildSettings = { - CLANG_ENABLE_MODULES = NO; - CLANG_ENABLE_OBJC_ARC = NO; - DEFINES_MODULE = NO; - DEPLOYMENT_LOCATION = YES; - DYLIB_COMPATIBILITY_VERSION = ""; - DYLIB_CURRENT_VERSION = ""; - EXECUTABLE_EXTENSION = xpl; - EXECUTABLE_PREFIX = ""; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/XPMP2-Sample/SDK/Libraries/Mac", - ); - GCC_PRECOMPILE_PREFIX_HEADER = NO; - GCC_SYMBOLS_PRIVATE_EXTERN = YES; - HEADER_SEARCH_PATHS = ""; - INFOPLIST_FILE = ""; - INSTALL_PATH = mac_x64; - MACH_O_TYPE = mh_bundle; - OTHER_LDFLAGS = ( - "$(OTHER_LDFLAGS)", - "-Wl,-exported_symbol", - "-Wl,_XPluginStart", - "-Wl,-exported_symbol", - "-Wl,_XPluginEnable", - "-Wl,-exported_symbol", - "-Wl,_XPluginReceiveMessage", - "-Wl,-exported_symbol", - "-Wl,_XPluginDisable", - "-Wl,-exported_symbol", - "-Wl,_XPluginStop", - ); - PRODUCT_NAME = "$(TARGET_NAME)"; - SKIP_INSTALL = NO; - }; - name = Release; - }; /* End XCBuildConfiguration section */ /* Begin XCConfigurationList section */ @@ -981,24 +641,6 @@ defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; - 25B071F42540D6C400CCDA1D /* Build configuration list for PBXNativeTarget "XPMP2-Remote" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 25B071F52540D6C400CCDA1D /* Debug */, - 25B071F62540D6C400CCDA1D /* Release */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; - 25D86CC3253E281800424494 /* Build configuration list for PBXNativeTarget "XPMP2-Sample" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 25D86CC1253E281800424494 /* Debug */, - 25D86CC2253E281800424494 /* Release */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; /* End XCConfigurationList section */ }; rootObject = 2502C16023BE3CFC00578919 /* Project object */; diff --git a/XPMP2.xcodeproj/xcshareddata/xcschemes/XPMP2.xcscheme b/XPMP2.xcodeproj/xcshareddata/xcschemes/XPMP2.xcscheme index 5f412a3c..b8d996ae 100644 --- a/XPMP2.xcodeproj/xcshareddata/xcschemes/XPMP2.xcscheme +++ b/XPMP2.xcodeproj/xcshareddata/xcschemes/XPMP2.xcscheme @@ -1,6 +1,6 @@ Open > Folder", [see here for VS's "Open Folder" functionality](https://docs.microsoft.com/en-us/cpp/build/open-folder-projects-cpp?view=vs-2019)) -- In both cases will VS use the CMake setup to configure building the binaries. +- Open the root folder of the repo using "File > Open > Folder", + [see here for VS's "Open Folder" functionality](https://docs.microsoft.com/en-us/cpp/build/open-folder-projects-cpp?view=vs-2019)) +- VS use the CMake setup to configure building the binaries. - Build from within Visual Studio. -Results are in `build/x64`. - -The `XPMP2.lib` library is also copied into `XPMP2-Sample/lib` to be available in a subsequent build -of the sample plugin. +Results are in `build-win`. ### MacOS My development environment is Mac OS, so expect the XCode environment to be -maintained best. Open `XPMP2.xcodeproj` resp. -`XPMP2-Sample/XPMP2-Sample.xcodeproj` in XCode. +maintained best. Open `XPMP2.xcodeproj` resp. `XPMP2-Sample.xcodeproj` in XCode. -In the XCode Build Settings you may want to change the definition +In the `XPMP2-Sample` XCode Build Settings you may want to change the definition of the User-Defined build macro `XPLANE11_ROOT`: Put in the path to your X-Plane 11 installation's root path, then the XPMP2 binaries will be installed right there in the appropriate `Resources/plugins` sub-folder @@ -62,11 +56,9 @@ which can build all 3 platforms, Linux even in two flavors. - Install [Docker Desktop](https://www.docker.com/products/docker-desktop) and start it. - `cd` to the project's `docker` folder, and enter `make` for all - XPMP2 library targets on all platforms, or -- `cd` to `XPMP2-Sample/docker`, and enter `make` for the sample plugin only - on all platforms. + XPMP2 library targets on all platforms. -9 individual `make` targets are available: +The following `make` targets are available: - `lin` builds Linux on Ubuntu 20.04 - `lin-bionic` builds Linux on Ubuntu 18.04 @@ -76,19 +68,18 @@ which can build all 3 platforms, Linux even in two flavors. - `win` builds Windows using a Mingw64 cross compiler setup - `bash_focal` starts a bash prompt in the Ubuntu 20.04 docker container - `bash_bionic` starts a bash prompt in the Ubuntu 18.04 docker container -- `doc` builds the documentation based on Doxygen, will probably only work on a Mac with Doxygen provided in `Applications/Doxygen.app`. +- `doc` builds the documentation based on Doxygen, will probably only work on a Mac with Doxygen provided in `Applications/Doxygen.app` +- `clean` removes all `build-` folders Find results in the respective `build-` folder, the `XPMP2` library right there, -the Sample and Remote plugins in their proper `_x64` subfolder. - -The resulting library/framework are also copied into `XPMP2-Sample/lib/` so it is accessible if building the Sample plugin from the Sample project only. +the Sample plugins in their proper `_x64` subfolder. For more details and background information on the provided Docker environments see the `docker/README.md`. ## Using CMake -Given a proper local setup with a suitable compile, CMake, and Ninja installed, +Given a proper local setup with a suitable compiler, CMake, and Ninja installed, you can just locally build the sources from the `CMakeList.txt` file, e.g. like this: @@ -110,7 +101,10 @@ each coming with its own `README.md`. The workflow builds Linux, MacOS, and Windows plugin binaries and provides them as artifacts, so you can download the result from the _Actions_ tab on GitHub. -For **MacOS**, the plugin can be **signed and notarized**, provided that the required _Repository Secrets_ are defined in the repository's settings +### Apple: Sign and Notiarize + +The Apple build of the `XPMP2-Sample` plugin can be signed and notarized, +provided that the following _Repository Secrets_ are defined in the repository's settings (Settings > Secrets > Actions): - `MACOS_CERTIFICATE`: Base64-encoded .p12 certificate as [explained here](https://localazy.com/blog/how-to-automatically-sign-macos-apps-using-github-actions#lets-get-started) @@ -118,3 +112,32 @@ For **MacOS**, the plugin can be **signed and notarized**, provided that the req - `NOTARIZATION_USERNAME`: Apple ID for notarization service (parameter `--apple-id` to `notarytool`) - `NOTARIZATION_TEAM`: Team ID for notarization service (parameter `--team-id` to `notarytool`) - `NOTARIZATION_PASSWORD`: [App-specific password](https://support.apple.com/en-gb/HT204397) for notarization service (parameter `--password` to `notarytool`) + +## Including XPMP2 directly in GitHub project and CMake builds + +You can avoid separate builds and instead include `XPMP2` directly into your project. +Recommended steps are: + +1. Include XPMP2 as a Github Submodule into your Github project, using something like + ``` + git submodule add --name XPMP2 'https://github.com/TwinFan/XPMP2' lib/XPMP2 + ``` + To update your local version with changes from the XPMP2 repository run something like + ``` + git submodule update --remote + ``` +2. In your `CMakeLists.txt` file include XPMP2 using something like the following in appropriate places: + 1. If needing FMOD sound support first define + ``` + set (INCLUDE_FMOD_SOUND 1) + add_compile_definitions(INCLUDE_FMOD_SOUND=1) + include_directories("${CMAKE_CURRENT_SOURCE_DIR}/lib/XPMP2/lib/fmod/logo") + target_sources(${CMAKE_PROJECT_NAME} lib/XPMP2/lib/fmod/logo/FMOD_Logo.cpp) + ``` + 2. Including building XPMP2 as follows: + ``` + include_directories("${CMAKE_CURRENT_SOURCE_DIR}/lib/XPMP2/inc") + add_subdirectory(lib/XPMP2) + add_dependencies(${CMAKE_PROJECT_NAME} XPMP2) + target_link_libraries(${CMAKE_PROJECT_NAME} XPMP2) + ``` diff --git a/docs/Calc3DCoord.xlsx b/docs/Calc3DCoord.xlsx new file mode 100644 index 00000000..cc3e09a3 Binary files /dev/null and b/docs/Calc3DCoord.xlsx differ diff --git a/docs/Deploying.md b/docs/Deploying.md index 7a9a77a1..cf7cfab3 100644 --- a/docs/Deploying.md +++ b/docs/Deploying.md @@ -1,13 +1,28 @@ Deploying XPMP2-based Plugins == -XPMP2 needs a couple additional files to work. In your calls to -`XPMPMultiplayerInit` and `XPMPLoadCSLPackage` you provide the locations -to the folders holding these files. +FMOD Sound Support (XP11/Windows) +-- +If you built XPMP2 and your plugin with [FMOD Sound Support](Sound.html), +and you want to allow running your plugin with X-Plane 11 under Windows, +then you should ship the `fmod.dll`, too, as +``` +win_x64/fmod.dll +``` +next to your plugin's Windows version. Find `api/core/lib/x64/fmod.dll` in the Windows version +of the FMOD Core API that you had [downloaded from FMOD](https://www.fmod.com/download#fmodengine). + +The reason is that X-Plane updated the FMOD versions included in X-Plane between XP11 and XP12. +While XPMP2 is built in a way that it can run with either version, +XP11 ships a DLL by the name of `fmod64.dll` while XPMP2 expects it by the name `fmod.dll` as XP12 provides it. Resources -- +XPMP2 needs a couple additional files to work. In your calls to +`XPMPMultiplayerInit` and `XPMPLoadCSLPackage` you provide the locations +to the folders holding these files. + You should ship all the files provided in the `Resources` folder: - `Doc8643.txt` is a list of ICAO aircraft type designators taken from diff --git a/docs/MainPage.md b/docs/MainPage.md index e81c5921..52ab0beb 100644 --- a/docs/MainPage.md +++ b/docs/MainPage.md @@ -30,6 +30,18 @@ The following header file is for use by the "XPMP2 Remote Client": - XPMPRemote.h - Defines network functionality and data structure for synchronizing planes between networked computers. +### Sound Support by FMOD + +XPMP2's Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. +Understand FMOD [licensing](https://www.fmod.com/licensing) and +[attribution requirements](https://www.fmod.com/attribution) first, +as they will apply to _your_ plugin if using XPMP2 with sound support. + +Because of the licensing requirements, XPMP2 by default is built +**without** sound support. +See the [Sound Support documentation](https://twinfan.github.io/XPMP2/Sound.html) +for details how to enable sound support and how to include it into your plugin. + Quick Links to Detailed Documentation: -- diff --git a/docs/Sound.md b/docs/Sound.md new file mode 100644 index 00000000..ca316d4d --- /dev/null +++ b/docs/Sound.md @@ -0,0 +1,219 @@ +## Sound Support by FMOD + +XPMP2's Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. + +While X-Plane supports and uses FMOD, too, for aircraft-specific sounds, +XPMP2 cannot make use of any X-Plane functionality to produce the sounds +as X-Plane at the moment does not allow to dynamically add sounds +to instanced objects. + +Instead, XPMP2 creates its own fully indepent instance of the FMOD system. +This also means that XPMP2 has to provide FMOD with all spacial information +for each aircraft's sound to create a proper 3D sound illusion +relative to the user's current camera position. Which opens a totally new +space for potential bugs... + +### Register with FMOD and Download + +Understand FMOD [licensing](https://www.fmod.com/licensing) and +[attribution requirements](https://www.fmod.com/attribution) first, +as they will apply to _your_ plugin if using XPMP2 with sound support. + +You will need to [register a user with FMOD](https://www.fmod.com/profile/register), +then sign in and [download the latest FMOD Core API](https://www.fmod.com/download#fmodengine) +at least for Windows and Mac (if you ship on those platforms). + +### Building XPMP2 with FMOD Sound Support + +Due to above licencing requirements, +sound support is only included if XPMP2 is consciously built with +CMake cache entry `INCLUDE_FMOD_SOUND`, which in turn defines a +compile-time macro by the same name, e.g. by doing +``` +cmake -G Ninja -DINCLUDE_FMOD_SOUND=1 .. +``` +The Docker `Makefile` allows passing CMake parameters via the `FLAGS` macro: +``` +make FLAGS=-DINCLUDE_FMOD_SOUND=1 {...platform(s)...} +``` +The GitHub Actions triggered by default are building without FMOD support, too. +Running "Build all Platforms" manually, though, allows to specify `FLAGS`. + +### Including FMOD Sound Support in Your Plugin + +In your plugin, you also need to define `INCLUDE_FMOD_SOUND` _before_ including the XPMP2 headers: +``` +#define INCLUDE_FMOD_SOUND 1 // Include FMOD sound support +#include "XPMPMultiplayer.h" +#include "XPMPAircraft.h" +``` +Then link to +- an FMOD-sound-enabled version of `XPMP2`, +- FMOD libraries from the downloaded FMOD Core API, namely + - `api/core/lib/libfmod.dylib` (Mac) and + - `api/core/lib/x64/fmod_vc.ib` (Windows). + +#### CMake + +When building with `CMake` you'll need something like this in your `CMakeLists.txt`: +``` +# Need FMOD Sound Support (from XPMP2) +set (INCLUDE_FMOD_SOUND 1) # tells XPMP2 to build with FMOD +add_compile_definitions(INCLUDE_FMOD_SOUND=1) # tells LiveTraffic compile to include FMOD from XPMP2 headers +[...] +# Incude building XPMP2 +add_subdirectory(Lib/XPMP2) +add_dependencies( XPMP2) +target_link_libraries( XPMP2) +[...] +# Link to FMOD +if (WIN32 OR APPLE) + # Where you put the downloaded FMOD Core API libraries: + list(APPEND CMAKE_LIBRARY_PATH "${CMAKE_CURRENT_SOURCE_DIR}/lib/fmod") + find_library(FMOD_LIBRARY NAMES fmod_vc.lib libfmod.dylib REQUIRED) + target_link_libraries( ${FMOD_LIBRARY}) +endif () +``` +This defines both the `CMake` cache entry as well as the preprocessor macro +to build with FMOD sound support. It then, after having set `INCLUDE_FMOD_SOUND`, +includes `XPMP2` into your build tree. Finally, it links your plugin to the FMOD library, +but only for Windows and Apple builds. A Linux build is not specifically linked with FMOD +(the same way it is also not linked to `XPML` or `OpenGL` libraries), because X-Plane itself +will always load some version of the library on its startup before any plugin. +Linux' dynamic loader will then find that already loaded library and use it also for +your plugin. + +#### Avoid Crash + +If the XPMP2 you linked is compiled with `INCLUDE_FMOD_SOUND` +but your actual plugin without, +then the plugin will crash in `XPMP2::Aircraft::FlightLoopCB()` +at the point when it tries to call `XPMP2::Aircraft::UpdateSound()`, +because the `XPMP2::Aircraft` object created by your plugin +is created with too short a `vtable` as it did not consider the +virtual member functions for sound support. + +You can tell if your XPMP2 library includes FMOD support +latest from the init message in +`Log.txt`, when it says: + +``` +...XPMPMultiplayerInit: XPMP2 2.60 with FMOD support initializing...` +``` + +Solution: Either link to an XPMP2 build without FMOD support. Or make sure to +`#define INCLUDE_FMOD_SOUND 1` in your plugin before including the XPMP2 headers. + +#### FMOD Logo + +Not built into XPMP2 (to avoid a link-time dependency on OpenGL) but provided separately are functions to create the FMOD logo as per [attribution requirements](https://www.fmod.com/attribution). Include `FMOD_Logo.cpp` and `FMOD_Logo.h` from `XPMP2/lib/fmod/logo` into your project. Showing the FMOD logo in a Dear ImGui window is then as simple as +``` +#include "FMOD_Logo.h" +... +int logoId = 0; +if (FMODLogo::GetTexture(logoId)) { + ImGui::Image((void*)(intptr_t)logoId, ImVec2(FMODLogo::IMG_WIDTH, FMODLogo::IMG_HEIGHT)); +} +``` + +### Ship `fmod.dll` + +If your plugin supports X-Plane 11 under Windows, then from the downloaded FMOD Core API +you need to ship `api/core/lib/x64/fmod.dll` in the plugin's `win_x64` folder. +See [Deploying](Deploying.html) for details. + +### Default Sounds + +Your are **not required** to provide any sound-specific coding in your plugin. +As a matter of fact, the XPMP2-Sample plugin has no single line of code +that controls sound (there is only some sample code to enumerate the loaded +sounds into `Log.txt`, purely for my personal testing purposes). +And even the way more complex LiveTraffic only adds a Master Volume control +and the required FMOD logo display, but no line of sound control to its aircraft class. + +Once built with sound support, XPMP2 provides a lot of sounds by default. +XPMP2 distinguishes 5 sound types, see `XPMP2::Aircraft::SoundEventsTy`, +and plays sounds that are included in any X-Plane installation's +`Resources/sounds` folders based on the level of certain dataRefs: + +Event | dataRef | Sound +-------|------|----------- +Engine | Thrust Ratio | Depends on aircraft type, volume changes with Thrust +Reverse | Thrust Reverse Ratio | `XP_SOUND_REVERSE_THRUST`, volume changes with Thrust Reverse +Tire | Tire Rotation RPM | `XP_SOUND_ROLL_RUNWAY`, volume changes with RPM +Gear | Gear Ratio | `XP_SOUND_GEAR` upon a change to the Gear Ratio +Flaps | Flap Ratio | `XP_SOUND_FLAP` once upon a change to the Flap Ratio + +The engine sounds depend on the aircraft type, more specifically on the +[ICAO aircraft type designators](https://www.icao.int/publications/doc8643/pages/search.aspx) +as provided in `Resources/Doc8643.txt`: + +Type Designator | means | Sound +----------------|-------------------|--------------- +`ZZZC` | Ground vehicle | `XP_SOUND_ELECTRIC` +`H??` or `G??` | Heli, Gyrocopter | `XP_SOUND_PROP_HELI` +`E??` | Electric | `XP_SOUND_ELECTRIC` +`J1?` | Jet, single | `XP_SOUND_HIBYPASSJET` +`J??` | Jet, multi | `XP_SOUND_LOBYPASSJET` +`P??` | Piston | `XP_SOUND_PROP_AIRPLANE` +`T??` | Turboprop | `XP_SOUND_TURBOPROP` + +The sounds' volume additionally depends on the number of engines, +which while obvious for the engine sounds is generally an ok indicator +for the plane's size and hence volume. + +### Controlling Sound + +Here are your options to influence sound. + +#### Enable/Disable + +Beside using `XPMPSoundEnable()` directly, you can also provides values +for configuration items `XPMP_CFG_ITM_ACTIVATE_SOUND` and +`XPMP_CFG_ITM_MUTE_ON_PAUSE` in your configuration callback. + +#### General Volume + +`XPMPSoundSetMasterVolume()` and `XPMPSoundMute()` allow controlling +the volume of XPMP2's sounds generally across all aircraft. + +#### Add your own Sounds + +`XPMPSoundAdd()` allows you to add your own sounds. +Sounds can be looping (like engine sounds, which play continuously) +or one-time sounds. + +The function optionally also allows to define **sound cone** parameters. +A sound cone basically is a cone-shaped area, in which the sound +is heared with full volume, while outside of it the sound is reduced +(attenuated) to a lower volume. The default sounds use that for the +jet eingine sounds, which are louder _behind_ the aircraft. +`coneDir` and `conePitch` are defined relative to the aircraft's heading. +XPMP2 takes care of orientating the actual sound cone dynamically with +the actual aircraft orientation. The other three cone-specific +parameters are passed through to FMOD +(see [set3DConeSettings](https://www.fmod.com/docs/api/core-api-sound.html#sound_set3dconesettings)). + +#### Override virtual `Aircraft` member functions + +For more control over the sounds your aircraft emit you can override +`Aircraft`'s virtual member functions: + +- `Aircraft::SoundSetup()` + is called after aircraft creation once the CSL model to use is determined; + called again after CSL model changes. Use to define/override some defaults. + Is a good place to set `aSndCh[SoundEventsTy].bAuto = false` in case + you want to have full control over any of the pre-defined sound types. +- `Aircraft::SoundUpdate()` + is called in every flight loop cycle and decides, + which sounds to start/stop at which volume. You can make calls to + functions like `Aircraft::SoundPlay/SoundStop/SoundVolume()`. +- `Aircraft::SoundGetName()` is called by XPMP2's standard implementation of + `SoundUpdate()`. Override if you just want to have control over which sounds + at which volume to play for the standard event types, but otherwise + want to leave sound handling to XPMP2. You can return any sound name, + ie. also additional names you have registered previously with `XPMPSoundAdd()`. +- `Aircraft::SoundRemoveAll()` is called during object destruction to cleanup + all sound objects. If you have started playing any sounds yourself + you should clean them up here before calling the standard function + to give XPMP2 a chance for cleanup, too. \ No newline at end of file diff --git a/docs/XPMP2.doxygen b/docs/XPMP2.doxygen index a48b633b..7a42a39b 100644 --- a/docs/XPMP2.doxygen +++ b/docs/XPMP2.doxygen @@ -827,7 +827,8 @@ INPUT = inc \ src \ docs \ XPMP2-Remote \ - XPMP2-Sample + XPMP2-Sample \ + XPMP2-Sample/lib/fmod/logo # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -2133,7 +2134,7 @@ MACRO_EXPANSION = NO # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_ONLY_PREDEF = NO +EXPAND_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES, the include files in the # INCLUDE_PATH will be searched if a #include is found. @@ -2165,7 +2166,7 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = +PREDEFINED = INCLUDE_FMOD_SOUND=1 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/docs/html/2D_8cpp.html b/docs/html/2D_8cpp.html index 2476c19e..06182aaf 100644 --- a/docs/html/2D_8cpp.html +++ b/docs/html/2D_8cpp.html @@ -59,6 +59,7 @@

Namespaces

 XPMP2 + Defined by FMOD.
  +

diff --git a/docs/html/2D_8h.html b/docs/html/2D_8h.html index eef2774f..ac772811 100644 --- a/docs/html/2D_8h.html +++ b/docs/html/2D_8h.html @@ -59,6 +59,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

diff --git a/docs/html/2D_8h_source.html b/docs/html/2D_8h_source.html index 8ff34709..7a1a201b 100644 --- a/docs/html/2D_8h_source.html +++ b/docs/html/2D_8h_source.html @@ -63,10 +63,10 @@
36 }
37 
38 #endif
-
XPMP2
Definition: XPMPAircraft.h:41
-
XPMP2::TwoDInit
void TwoDInit()
Initialize the module.
Definition: 2D.cpp:227
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
+
XPMP2::TwoDInit
void TwoDInit()
Initialize the module.
Definition: 2D.cpp:226
XPMP2::TwoDDrawLabels
void TwoDDrawLabels()
Write the labels of all aircraft.
Definition: 2D.cpp:118
-
XPMP2::TwoDCleanup
void TwoDCleanup()
Grace cleanup.
Definition: 2D.cpp:245
+
XPMP2::TwoDCleanup
void TwoDCleanup()
Grace cleanup.
Definition: 2D.cpp:244
diff --git a/docs/html/AIMultiplayer_8cpp.html b/docs/html/AIMultiplayer_8cpp.html index 009fdb2b..147c03b4 100644 --- a/docs/html/AIMultiplayer_8cpp.html +++ b/docs/html/AIMultiplayer_8cpp.html @@ -76,6 +76,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
- +

@@ -161,7 +162,7 @@

 Release TCAS targets control. More...
 
bool XPMPHasControlOfAIAircraft ()
 Has XPMP2 control of TCAS targets? More...
 Has XPMP2 control of TCAS targets? More...
 
+

@@ -193,7 +194,7 @@

Detailed Description

Implementation of serving TCAS target dataRef updates.

Updates the up to 63 slots of X-Plane's defined TCAS targets, which are in turn synced with the 19 "legacy" multiplayer slots, which in turn many other plugins (like TCAS implementations or map tools) read to learn about any multiplayer aircraft.
- Also serves shared dataRefs for publishing text information, which is not X-Plane standard but originally suggested by FSTramp. However, the post and file, in which he suggested this addition, is no longer available on forums.x-plane.org. Still, XPMP2 fullfills the earlier definition.

See also
X-Plane 11.50 Beta 8 introduced a new way of informing X-Plane of TCAS targets, see here a blog entry for details: https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/
+ Also serves shared dataRefs for publishing text information, which is not X-Plane standard but originally suggested by FSTramp. However, the post and file, in which he suggested this addition, is no longer available on forums.x-plane.org. Still, XPMP2 fullfills the earlier definition.

See also
X-Plane 11.50 Beta 8 introduced a new way of informing X-Plane of TCAS targets, see here a blog entry for details: https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/
Author
Birger Hoppe
Copyright
(c) 2020 Birger Hoppe
@@ -536,7 +537,7 @@

-

Has XPMP2 control of TCAS targets?

+

Has XPMP2 control of TCAS targets?

See also
XPMPMultiplayerEnable()

@@ -557,7 +558,7 @@

Release TCAS targets control.

-

Afterwards, XPMP2's aircraft will no longer appear on TCAS or on 3rd-party plugins relying on TCAS targets dataRefs.
+

Afterwards, XPMP2's aircraft will no longer appear on TCAS or on 3rd-party plugins relying on TCAS targets dataRefs.
Is called during XPMPMultiplayerCleanup() automatically.

@@ -590,7 +591,7 @@

XPMP2's aircraft will appear on TCAS and are available to 3rd-party plugins relying on TCAS tagrtes or multiplayer dataRefs.
+ If successful, XPMP2's aircraft will appear on TCAS and are available to 3rd-party plugins relying on TCAS tagrtes or multiplayer dataRefs.
Typically, a plugin calls this function just before the first aircraft are created. But it could also be bound to a menu item, for example.

Parameters
diff --git a/docs/html/AIMultiplayer_8h.html b/docs/html/AIMultiplayer_8h.html index 2a639705..ec986305 100644 --- a/docs/html/AIMultiplayer_8h.html +++ b/docs/html/AIMultiplayer_8h.html @@ -59,6 +59,7 @@ +
_callback(optional) You can provide a callback function, which is called directly by X-Plane when control of TCAS targets is not successful now but becomes available later.

Namespaces

 XPMP2
 Defined by FMOD.
 
+

diff --git a/docs/html/AIMultiplayer_8h_source.html b/docs/html/AIMultiplayer_8h_source.html index 06d678d0..136e6bb0 100644 --- a/docs/html/AIMultiplayer_8h_source.html +++ b/docs/html/AIMultiplayer_8h_source.html @@ -64,11 +64,11 @@
38 } // namespace XPMP2
39 
40 #endif
-
XPMP2
Definition: XPMPAircraft.h:41
-
XPMP2::AIMultiInformDREs
void AIMultiInformDREs()
Inform DRE and DRT of our shared dataRefs.
Definition: AIMultiplayer.cpp:828
-
XPMP2::AIMultiInit
void AIMultiInit()
Initialize the module.
Definition: AIMultiplayer.cpp:851
-
XPMP2::AIMultiCleanup
void AIMultiCleanup()
Grace cleanup.
Definition: AIMultiplayer.cpp:1026
-
XPMP2::AIMultiUpdate
void AIMultiUpdate()
Updates all TCAS target dataRefs, both standard X-Plane, as well as additional shared dataRefs for te...
Definition: AIMultiplayer.cpp:606
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
+
XPMP2::AIMultiInformDREs
void AIMultiInformDREs()
Inform DRE and DRT of our shared dataRefs.
Definition: AIMultiplayer.cpp:830
+
XPMP2::AIMultiInit
void AIMultiInit()
Initialize the module.
Definition: AIMultiplayer.cpp:853
+
XPMP2::AIMultiCleanup
void AIMultiCleanup()
Grace cleanup.
Definition: AIMultiplayer.cpp:1028
+
XPMP2::AIMultiUpdate
void AIMultiUpdate()
Updates all TCAS target dataRefs, both standard X-Plane, as well as additional shared dataRefs for te...
Definition: AIMultiplayer.cpp:608
diff --git a/docs/html/Aircraft_8cpp.html b/docs/html/Aircraft_8cpp.html index c4718243..21f96735 100644 --- a/docs/html/Aircraft_8cpp.html +++ b/docs/html/Aircraft_8cpp.html @@ -54,13 +54,14 @@
-

XPCAircraft represents an aircraft as managed by XPMP2. +

XPCAircraft represents an aircraft as managed by XPMP2. More...

#include "XPMP2.h"
+

Namespaces

 XPMP2
 Defined by FMOD.
 

@@ -133,8 +134,8 @@

 

Detailed Description

-

XPCAircraft represents an aircraft as managed by XPMP2.

-
Note
This class bases on and is compatible to the XPCAircraft wrapper class provided with the original libxplanemp. In XPMP2, however, this class is not a wrapper but the actual means of managing aircraft. Hence, it includes a lot more members.
+

XPCAircraft represents an aircraft as managed by XPMP2.

+
Note
This class bases on and is compatible to the XPCAircraft wrapper class provided with the original libxplanemp. In XPMP2, however, this class is not a wrapper but the actual means of managing aircraft. Hence, it includes a lot more members.
Author
Birger Hoppe
Copyright
The original XPCAircraft.h file in libxplanemp had no copyright note.
@@ -386,14 +387,14 @@

Add a user-defined dataRef to the list of dataRefs supported by every plane.

-

All planes created by XPMP2 define the same set of dataRefs. See XPMP2::DR_VALS for the definitions that come pre-defined with XPMP2. Here you can add more dataRefs that you want to set in your XPMP2::Aircraft::UpdatePosition() implementation.

Returns
The functions returns the array index you need to use in the XPMP2::Aircraft::v array to provide the actual value. Or 0 when an error occured.
+

All planes created by XPMP2 define the same set of dataRefs. See XPMP2::DR_VALS for the definitions that come pre-defined with XPMP2. Here you can add more dataRefs that you want to set in your XPMP2::Aircraft::UpdatePosition() implementation.

Returns
The functions returns the array index you need to use in the XPMP2::Aircraft::v array to provide the actual value. Or 0 when an error occured.
Note
There is a duplication check: Adding an already existing dataRef, no matter if XPMP2-predefined or by the plugin will return the already existing index.
Can only be called while no plane exists as it influence the size of important data arrays. Returns 0 if called while planes exist.
Can only be called from XP's main thread as XPLM SDK functions are called. Returns 0 if called from a worker thread.
-User-defined dataRefs are not transfered to the XPMP2 Remote Client for display on network-connected X-Plane instances.
+User-defined dataRefs are not transfered to the XPMP2 Remote Client for display on network-connected X-Plane instances.

diff --git a/docs/html/Aircraft_8h.html b/docs/html/Aircraft_8h.html index b4f97f35..26c81100 100644 --- a/docs/html/Aircraft_8h.html +++ b/docs/html/Aircraft_8h.html @@ -67,6 +67,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

diff --git a/docs/html/Aircraft_8h_source.html b/docs/html/Aircraft_8h_source.html index fe869fb6..b9dd698f 100644 --- a/docs/html/Aircraft_8h_source.html +++ b/docs/html/Aircraft_8h_source.html @@ -86,19 +86,19 @@
69 } // namespace XPMP2
70 
71 #endif
-
XPMPPlaneData_f
XPMPPlaneCallbackResult(* XPMPPlaneData_f)(XPMPPlaneID inPlane, XPMPPlaneDataType inDataType, void *ioData, void *inRefcon)
Callback function your plugin provides to return updated plane data.
Definition: XPMPMultiplayer.h:489
-
XPMPPlaneCallbackResult
XPMPPlaneCallbackResult
Definfes the different responses to asking for information.
Definition: XPMPMultiplayer.h:231
-
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:243
-
XPMPInfoTexts_t
Textual information of planes to be passed on via shared dataRefs to other plugins.
Definition: XPMPMultiplayer.h:199
-
XPMPPlanePosition_t
This data structure contains the basic position info for an aircraft.
Definition: XPMPMultiplayer.h:79
-
XPMPPlaneRadar_t
defines information about an aircraft visible to radar.
Definition: XPMPMultiplayer.h:189
-
XPMPPlaneSurfaces_t
External physical configuration of the plane.
Definition: XPMPMultiplayer.h:147
+
XPMPPlaneData_f
XPMPPlaneCallbackResult(* XPMPPlaneData_f)(XPMPPlaneID inPlane, XPMPPlaneDataType inDataType, void *ioData, void *inRefcon)
Callback function your plugin provides to return updated plane data.
Definition: XPMPMultiplayer.h:601
+
XPMPPlaneCallbackResult
XPMPPlaneCallbackResult
Definfes the different responses to asking for information.
Definition: XPMPMultiplayer.h:240
+
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:252
+
XPMPInfoTexts_t
Textual information of planes to be passed on via shared dataRefs to other plugins.
Definition: XPMPMultiplayer.h:208
+
XPMPPlanePosition_t
This data structure contains the basic position info for an aircraft.
Definition: XPMPMultiplayer.h:88
+
XPMPPlaneRadar_t
defines information about an aircraft visible to radar.
Definition: XPMPMultiplayer.h:198
+
XPMPPlaneSurfaces_t
External physical configuration of the plane.
Definition: XPMPMultiplayer.h:156
XPCAircraft
Legacy wrapper class as provided by original libxplanemp.
Definition: XPCAircraft.h:37
XPMP2::LegacyAircraft
This class helps creating aircraft via the legacy global functions. It provides standard implementati...
Definition: Aircraft.h:28
-
XPMP2
Definition: XPMPAircraft.h:41
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
XPMP2::mapAcTy
std::map< XPMPPlaneID, Aircraft * > mapAcTy
Map of all aircraft, key is tthe plane id.
Definition: Aircraft.h:57
-
XPMP2::AcCleanup
void AcCleanup()
Grace cleanup, esp. remove all aircraft.
Definition: Aircraft.cpp:1038
-
XPMP2::AcInit
void AcInit()
Initialize the module.
Definition: Aircraft.cpp:1008
+
XPMP2::AcCleanup
void AcCleanup()
Grace cleanup, esp. remove all aircraft.
Definition: Aircraft.cpp:1068
+
XPMP2::AcInit
void AcInit()
Initialize the module.
Definition: Aircraft.cpp:1038
diff --git a/docs/html/CSLCopy_8cpp.html b/docs/html/CSLCopy_8cpp.html index d6ab5743..5f88bf06 100644 --- a/docs/html/CSLCopy_8cpp.html +++ b/docs/html/CSLCopy_8cpp.html @@ -58,6 +58,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

@@ -79,11 +80,11 @@

Copy .obj file just before loading, to replace dataRefs and texture.

These routines make a copy of an .obj file just before it gets loaded by X-Plane. This way we can replace dataRefs and textures.

  1. xsb_aircraft.txt formats vary by now out in the wild. For example, X-CSL/X-IvAp used to defined texture on the OBJ8 line. X-Plane, especially for instancing, cannot replace textures on the fly. The solution is to copy the .obj file, replacing the up to two lines defining the texture to use, and then only have it loaded by X-Plane.
    2. -
  2. CSL-Models might not use correct dataRefs as supported by XPMP2. For example are the widely used Bluebell models known to have translated only a limited set of dataRefs from their World Traffic origin into the libxplanemp world. XPMP2 now supports a lot more dataRefs. Replacing dataRef names in those models unlocks a number of feature like rotating props/rotors, turning wheels, or reversers.
    3. +
  3. CSL-Models might not use correct dataRefs as supported by XPMP2. For example are the widely used Bluebell models known to have translated only a limited set of dataRefs from their World Traffic origin into the libxplanemp world. XPMP2 now supports a lot more dataRefs. Replacing dataRef names in those models unlocks a number of feature like rotating props/rotors, turning wheels, or reversers.
-
See also
https://twinfan.github.io/XPMP2/XSBAircraftFormat.html for the xsb_aircraft.txt format definition as supported by XPMP2.
+
See also
https://twinfan.github.io/XPMP2/XSBAircraftFormat.html for the xsb_aircraft.txt format definition as supported by XPMP2.
-https://twinfan.github.io/XPMP2/CSLdataRefs.html for a list of animation dataRefs supported by XPMP2. And beyond that you can add even more using the XPMPAddModelDataRef() function.
+https://twinfan.github.io/XPMP2/CSLdataRefs.html for a list of animation dataRefs supported by XPMP2. And beyond that you can add even more using the XPMPAddModelDataRef() function.
Author
Birger Hoppe
Copyright
(c) 2020 Birger Hoppe
diff --git a/docs/html/CSLModels_8cpp.html b/docs/html/CSLModels_8cpp.html index de61691e..fab95bb2 100644 --- a/docs/html/CSLModels_8cpp.html +++ b/docs/html/CSLModels_8cpp.html @@ -61,6 +61,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

diff --git a/docs/html/CSLModels_8h.html b/docs/html/CSLModels_8h.html index 7a8b2fe6..1db4cddd 100644 --- a/docs/html/CSLModels_8h.html +++ b/docs/html/CSLModels_8h.html @@ -74,6 +74,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
- + - + - + - + @@ -377,7 +377,7 @@

-

Handle A/C Animation dataRef messages, called by XPMP2 via callback.

+

Handle A/C Animation dataRef messages, called by XPMP2 via callback.

@@ -413,7 +413,7 @@

-

Handle A/C Details messages, called by XPMP2 via callback.

+

Handle A/C Details messages, called by XPMP2 via callback.

  1. If the aircraft does not exist create it
    1. Else update it's data
      2. @@ -455,7 +455,7 @@

      -

      Handle A/C Position Update message, called by XPMP2 via callback.

      +

      Handle A/C Position Update message, called by XPMP2 via callback.

      @@ -491,7 +491,7 @@

      -

      Handle A/C Removal message, called by XPMP2 via callback.

      +

      Handle A/C Removal message, called by XPMP2 via callback.

      diff --git a/docs/html/Client_8h_source.html b/docs/html/Client_8h_source.html index f10bf8aa..14e20ce0 100644 --- a/docs/html/Client_8h_source.html +++ b/docs/html/Client_8h_source.html @@ -147,7 +147,7 @@
      ClientTryGetAI
      void ClientTryGetAI()
      Try getting TCAS/AI control.
      Definition: Client.cpp:306
      ClientInit
      void ClientInit()
      Initializes the module.
      Definition: Client.cpp:581
      mapRemoteAcTy
      std::map< XPMPPlaneID, RemoteAC > mapRemoteAcTy
      Map of remote aircraft; key is the plane id as sent by the sending plugin (while the _modeS_id of the...
      Definition: Client.h:83
      -
      XPMPPlaneID
      unsigned XPMPPlaneID
      Unique ID for an aircraft created by a plugin.
      Definition: XPMPMultiplayer.h:243
      +
      XPMPPlaneID
      unsigned XPMPPlaneID
      Unique ID for an aircraft created by a plugin.
      Definition: XPMPMultiplayer.h:252
      RemoteAC
      Representation of a remote aircraft.
      Definition: Client.h:30
      RemoteAC::lon
      double lon
      longitude
      Definition: Client.h:46
      RemoteAC::diffTime
      std::chrono::duration< int, std::ratio< 1, 10000 > > diffTime
      time difference to previous historic position as passed in by the sender
      Definition: Client.h:48
      @@ -169,7 +169,7 @@
      RemoteAC::histTs
      std::chrono::time_point< std::chrono::steady_clock > histTs[2]
      Timestamps when these two positions were valid.
      Definition: Client.h:42
      RemoteAC::sShortId
      std::string sShortId
      CSL model's short id.
      Definition: Client.h:35
      RemoteAC::alt_ft
      double alt_ft
      altitude [ft]
      Definition: Client.h:47
      -
      XPMP2::Aircraft
      Actual representation of all aircraft in XPMP2.
      Definition: XPMPAircraft.h:147
      +
      XPMP2::Aircraft
      Actual representation of all aircraft in XPMP2.
      Definition: XPMPAircraft.h:181
      SenderAddrTy
      Uniquely identifies a sending plugin.
      Definition: Client.h:90
      SenderAddrTy::SenderAddrTy
      SenderAddrTy(XPLMPluginID _id, const std::uint32_t _from[4])
      Constructor just fills values.
      Definition: Client.h:95
      SenderAddrTy::from
      std::uint32_t from[4]
      numerical part of sender's IP address (only differentiating in rare cases of two plugins on different...
      Definition: Client.h:92
      diff --git a/docs/html/FMOD__Logo_8cpp.html b/docs/html/FMOD__Logo_8cpp.html new file mode 100644 index 00000000..51d82976 --- /dev/null +++ b/docs/html/FMOD__Logo_8cpp.html @@ -0,0 +1,112 @@ + + + + + + + +XPMP2: XPMP2-Sample/lib/fmod/logo/FMOD_Logo.cpp File Reference + + + + + + +
      +
      +

diff --git a/docs/html/CSLModels_8h_source.html b/docs/html/CSLModels_8h_source.html index c2f64ab2..29da3952 100644 --- a/docs/html/CSLModels_8h_source.html +++ b/docs/html/CSLModels_8h_source.html @@ -172,67 +172,69 @@
200  const char* GetWTC () const { return doc8643->wtc; }
201  char GetClassType () const { return doc8643->GetClassType(); }
202  char GetClassNumEng () const { return doc8643->GetClassNumEng(); }
-
203  char GetClassEngType () const { return doc8643->GetClassEngType(); }
-
204  bool HasRotor () const { return doc8643->HasRotor(); }
-
205 
-
207  float GetVertOfs () const { return vertOfs; }
-
208 
-
210  ObjLoadStateTy GetObjState () const;
-
212  bool IsObjInvalid () const { return GetObjState() == OLS_INVALID; }
-
213 
-
216  std::list<XPLMObjectRef> GetAllObjRefs ();
-
217 
-
219  void IncRefCnt () { ++refCnt; }
-
221  void DecRefCnt ();
-
223  unsigned GetRefCnt () const { return refCnt; }
-
224 
-
226  static float GarbageCollection (float inElapsedSinceLastCall,
-
227  float inElapsedTimeSinceLastFlightLoop,
-
228  int inCounter,
-
229  void * inRefcon);
-
230 
-
231 protected:
-
233  void Unload ();
-
235  float FetchVertOfsFromObjFile () const;
-
236 };
-
237 
-
239 typedef std::map<std::string,CSLModel> mapCSLModelTy;
-
240 
-
242 typedef std::multimap<unsigned long,std::pair<CSLModel*,const CSLModel::MatchCritTy*> > mmapCSLModelPTy;
-
243 
-
244 //
-
245 // MARK: Global Functions
-
246 //
-
247 
-
249 void CSLModelsInit ();
-
250 
-
252 void CSLModelsCleanup ();
-
253 
-
258 const char* CSLModelsLoad (const std::string& _path,
-
259  int _maxDepth = 5);
-
260 
-
264 CSLModel* CSLModelById (const std::string& _cslId,
-
265  mapCSLModelTy::iterator* _pOutIter = nullptr);
-
266 
-
270 CSLModel* CSLModelByKey(const std::string& _cslKey,
-
271  mapCSLModelTy::iterator* _pOutIter = nullptr);
-
272 
-
280 int CSLModelMatching (const std::string& _type,
-
281  const std::string& _airline,
-
282  const std::string& _livery,
-
283  CSLModel* &pModel);
-
284 
-
285 } // namespace XPMP2
-
286 
-
287 #endif
+
203  int GetNumEngines() const { return doc8643->GetNumEngines(); }
+
204  char GetClassEngType () const { return doc8643->GetClassEngType(); }
+
205  bool HasRotor () const { return doc8643->HasRotor(); }
+
206 
+
208  float GetVertOfs () const { return vertOfs; }
+
209 
+
211  ObjLoadStateTy GetObjState () const;
+
213  bool IsObjInvalid () const { return GetObjState() == OLS_INVALID; }
+
214 
+
217  std::list<XPLMObjectRef> GetAllObjRefs ();
+
218 
+
220  void IncRefCnt () { ++refCnt; }
+
222  void DecRefCnt ();
+
224  unsigned GetRefCnt () const { return refCnt; }
+
225 
+
227  static float GarbageCollection (float inElapsedSinceLastCall,
+
228  float inElapsedTimeSinceLastFlightLoop,
+
229  int inCounter,
+
230  void * inRefcon);
+
231 
+
232 protected:
+
234  void Unload ();
+
236  float FetchVertOfsFromObjFile () const;
+
237 };
+
238 
+
240 typedef std::map<std::string,CSLModel> mapCSLModelTy;
+
241 
+
243 typedef std::multimap<unsigned long,std::pair<CSLModel*,const CSLModel::MatchCritTy*> > mmapCSLModelPTy;
+
244 
+
245 //
+
246 // MARK: Global Functions
+
247 //
+
248 
+
250 void CSLModelsInit ();
+
251 
+
253 void CSLModelsCleanup ();
+
254 
+
259 const char* CSLModelsLoad (const std::string& _path,
+
260  int _maxDepth = 5);
+
261 
+
265 CSLModel* CSLModelById (const std::string& _cslId,
+
266  mapCSLModelTy::iterator* _pOutIter = nullptr);
+
267 
+
271 CSLModel* CSLModelByKey(const std::string& _cslKey,
+
272  mapCSLModelTy::iterator* _pOutIter = nullptr);
+
273 
+
281 int CSLModelMatching (const std::string& _type,
+
282  const std::string& _airline,
+
283  const std::string& _livery,
+
284  CSLModel* &pModel);
+
285 
+
286 } // namespace XPMP2
+
287 
+
288 #endif
XPMP2::CSLModel
Represetns a CSL model as it is saved on disk.
Definition: CSLModels.h:113
-
XPMP2::CSLModel::IsObjInvalid
bool IsObjInvalid() const
(Minimum) )State of the X-Plane object: Is it invalid?
Definition: CSLModels.h:212
+
XPMP2::CSLModel::IsObjInvalid
bool IsObjInvalid() const
(Minimum) )State of the X-Plane object: Is it invalid?
Definition: CSLModels.h:213
XPMP2::CSLModel::cslId
std::string cslId
full id: package name / shortId, expected to be unique
Definition: CSLModels.h:132
XPMP2::CSLModel::doc8643
const Doc8643 * doc8643
Proper Doc8643 entry for this model.
Definition: CSLModels.h:155
XPMP2::CSLModel::listObj
listCSLObjTy listObj
list of objects representing this model
Definition: CSLModels.h:140
+
XPMP2::CSLModel::GetNumEngines
int GetNumEngines() const
Definition: CSLModels.h:203
XPMP2::CSLModel::xsbAircraftLn
int xsbAircraftLn
Line number in the xsb_aircraft.txt file where the model definition starts.
Definition: CSLModels.h:149
XPMP2::CSLModel::refCnt
unsigned refCnt
Reference counter: Number of Aircraft actively using this model.
Definition: CSLModels.h:159
-
XPMP2::CSLModel::GetClassEngType
char GetClassEngType() const
Definition: CSLModels.h:203
+
XPMP2::CSLModel::GetClassEngType
char GetClassEngType() const
Definition: CSLModels.h:204
XPMP2::CSLModel::GetClassNumEng
char GetClassNumEng() const
Definition: CSLModels.h:202
XPMP2::CSLModel::shortId
std::string shortId
short id, just an arbitrary label read from xsb_aircraft.txt::OBJ8_AIRCRAFT
Definition: CSLModels.h:130
XPMP2::CSLModel::GetId
const std::string & GetId() const
full id: package name / shortId, expected to be unique
Definition: CSLModels.h:190
@@ -244,12 +246,12 @@
XPMP2::CSLModel::futVertOfs
std::future< float > futVertOfs
future for asynchronously reading vertOfs
Definition: CSLModels.h:163
XPMP2::CSLModel::vecMatchCrit
MatchCritVecTy vecMatchCrit
further match-relevant fields like airline and livery can be a list
Definition: CSLModels.h:138
XPMP2::CSLModel::icaoType
std::string icaoType
ICAO aircraft type this model represents: xsb_aircraft.txt::ICAO
Definition: CSLModels.h:153
-
XPMP2::CSLModel::FetchVertOfsFromObjFile
float FetchVertOfsFromObjFile() const
Read the obj files to fill CSLModel::vertOfs.
Definition: CSLModels.cpp:524
+
XPMP2::CSLModel::FetchVertOfsFromObjFile
float FetchVertOfsFromObjFile() const
Read the obj files to fill CSLModel::vertOfs.
Definition: CSLModels.cpp:523
XPMP2::CSLModel::GetLivery
const std::string & GetLivery() const
Livery code this model represents: xsb_aircraft.txt::LIVERY
Definition: CSLModels.h:194
XPMP2::CSLModel::GetObjState
ObjLoadStateTy GetObjState() const
(Minimum) )State of the X-Plane objects: Is it being loaded or available?
Definition: CSLModels.cpp:435
XPMP2::CSLModel::GetIcaoType
const std::string & GetIcaoType() const
ICAO aircraft type this model represents: xsb_aircraft.txt::ICAO
Definition: CSLModels.h:192
XPMP2::CSLModel::IsValid
bool IsValid() const
Minimum requirement for using this object is: id, type, path.
Definition: CSLModels.h:187
-
XPMP2::CSLModel::HasRotor
bool HasRotor() const
Definition: CSLModels.h:204
+
XPMP2::CSLModel::HasRotor
bool HasRotor() const
Definition: CSLModels.h:205
XPMP2::CSLModel::GetClassType
char GetClassType() const
Definition: CSLModels.h:201
XPMP2::CSLModel::modelName
std::string modelName
name, formed by last part of path plus id
Definition: CSLModels.h:134
XPMP2::CSLModel::CompModelName
void CompModelName()
Puts together the model name string from a path component and shortId
Definition: CSLModels.cpp:418
@@ -258,19 +260,19 @@
XPMP2::CSLModel::GetShortId
const std::string & GetShortId() const
short id, just an arbitrary label read from xsb_aircraft.txt::OBJ8_AIRCRAFT
Definition: CSLModels.h:189
XPMP2::CSLModel::GetRelatedGrp
int GetRelatedGrp() const
"related" group for this model (a group of alike plane models), or 0
Definition: CSLModels.h:195
XPMP2::CSLModel::related
int related
"related" group for this model (a group of alike plane models), or 0
Definition: CSLModels.h:157
-
XPMP2::CSLModel::GetVertOfs
float GetVertOfs() const
Vertical Offset to be applied to aircraft model.
Definition: CSLModels.h:207
-
XPMP2::CSLModel::Unload
void Unload()
Unload all objects.
Definition: CSLModels.cpp:516
+
XPMP2::CSLModel::GetVertOfs
float GetVertOfs() const
Vertical Offset to be applied to aircraft model.
Definition: CSLModels.h:208
+
XPMP2::CSLModel::Unload
void Unload()
Unload all objects.
Definition: CSLModels.cpp:515
XPMP2::CSLModel::GetWTC
const char * GetWTC() const
Wake turbulence category.
Definition: CSLModels.h:200
XPMP2::CSLModel::MatchCritVecTy
std::vector< MatchCritTy > MatchCritVecTy
Vector of match-relevant fields.
Definition: CSLModels.h:127
XPMP2::CSLModel::GetKeyString
std::string GetKeyString() const
compiles the string used as key in the CSL model map
Definition: CSLModels.cpp:429
XPMP2::CSLModel::vertOfs
float vertOfs
Vertical offset to be applied [m].
Definition: CSLModels.h:142
-
XPMP2::CSLModel::IncRefCnt
void IncRefCnt()
Increase the reference counter for Aircraft usage.
Definition: CSLModels.h:219
+
XPMP2::CSLModel::IncRefCnt
void IncRefCnt()
Increase the reference counter for Aircraft usage.
Definition: CSLModels.h:220
XPMP2::CSLModel::operator=
CSLModel & operator=(CSLModel &&o)=default
XPMP2::CSLModel::bVertOfsReadFromFile
bool bVertOfsReadFromFile
Shall we try reading vertOfs from the OBJ8 file if we need this a/c?
Definition: CSLModels.h:144
XPMP2::CSLModel::DecRefCnt
void DecRefCnt()
Decrease the reference counter for Aircraft usage.
Definition: CSLModels.cpp:484
XPMP2::CSLModel::refZeroTs
float refZeroTs
Time point when refCnt reached 0 (used in garbage collection, in terms of XP's total running time)
Definition: CSLModels.h:161
XPMP2::CSLModel::CSLModel
CSLModel(CSLModel &&o)=default
Generate standard move constructor.
-
XPMP2::CSLModel::GetRefCnt
unsigned GetRefCnt() const
Current reference counter.
Definition: CSLModels.h:223
+
XPMP2::CSLModel::GetRefCnt
unsigned GetRefCnt() const
Current reference counter.
Definition: CSLModels.h:224
XPMP2::CSLModel::xsbAircraftPath
std::string xsbAircraftPath
Path to the xsb_aircraft.txt file from where this model is loaded.
Definition: CSLModels.h:147
XPMP2::CSLModel::GetModelName
const std::string & GetModelName() const
name, formed by last part of path plus id (human readable, but not guaranteed to be unique)
Definition: CSLModels.h:191
XPMP2::CSLModel::AddMatchCriteria
void AddMatchCriteria(const std::string &_type, const MatchCritTy &_matchCrit, int lnNr)
Set the a/c type model and add other match criteria.
Definition: CSLModels.cpp:387
@@ -300,15 +302,15 @@
XPMP2::CSLObj::DetermineWhichObjToLoad
void DetermineWhichObjToLoad()
Determine which file to load and if we need a copied .obj file.
Definition: CSLModels.cpp:112
XPMP2::CSLObj::CopyAndReplace
bool CopyAndReplace()
Perform the copy-on-load functionality, replacing dataRefs and textures, expected to be called via st...
Definition: CSLCopy.cpp:73
XPMP2::CSLObj::texture
std::string texture
texture file if defined, to be used in the TEXTURE line of the .obj file
Definition: CSLModels.h:45
-
XPMP2
Definition: XPMPAircraft.h:41
-
XPMP2::CSLModelMatching
int CSLModelMatching(const std::string &_type, const std::string &_airline, const std::string &_livery, CSLModel *&pModel)
Find a matching model.
Definition: CSLModels.cpp:1359
-
XPMP2::CSLModelsCleanup
void CSLModelsCleanup()
Grace cleanup.
Definition: CSLModels.cpp:1062
-
XPMP2::mmapCSLModelPTy
std::multimap< unsigned long, std::pair< CSLModel *, const CSLModel::MatchCritTy * > > mmapCSLModelPTy
Multimap of references to CSLModels and match criteria for matching purposes.
Definition: CSLModels.h:242
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
+
XPMP2::CSLModelMatching
int CSLModelMatching(const std::string &_type, const std::string &_airline, const std::string &_livery, CSLModel *&pModel)
Find a matching model.
Definition: CSLModels.cpp:1358
+
XPMP2::CSLModelsCleanup
void CSLModelsCleanup()
Grace cleanup.
Definition: CSLModels.cpp:1061
+
XPMP2::mmapCSLModelPTy
std::multimap< unsigned long, std::pair< CSLModel *, const CSLModel::MatchCritTy * > > mmapCSLModelPTy
Multimap of references to CSLModels and match criteria for matching purposes.
Definition: CSLModels.h:243
XPMP2::pairOfStrTy
std::pair< std::string, std::string > pairOfStrTy
Definition: CSLModels.h:109
-
XPMP2::CSLModelById
CSLModel * CSLModelById(const std::string &_cslId, mapCSLModelTy::iterator *_pOutIter)
Find a model by unique id.
Definition: CSLModels.cpp:1107
+
XPMP2::CSLModelById
CSLModel * CSLModelById(const std::string &_cslId, mapCSLModelTy::iterator *_pOutIter)
Find a model by unique id.
Definition: CSLModels.cpp:1106
XPMP2::listCSLObjTy
std::list< CSLObj > listCSLObjTy
List of objects.
Definition: CSLModels.h:107
-
XPMP2::mapCSLModelTy
std::map< std::string, CSLModel > mapCSLModelTy
Map of CSLModels (owning the object), ordered by related group / type.
Definition: CSLModels.h:239
-
XPMP2::CSLModelsInit
void CSLModelsInit()
Initialization.
Definition: CSLModels.cpp:1043
+
XPMP2::mapCSLModelTy
std::map< std::string, CSLModel > mapCSLModelTy
Map of CSLModels (owning the object), ordered by related group / type.
Definition: CSLModels.h:240
+
XPMP2::CSLModelsInit
void CSLModelsInit()
Initialization.
Definition: CSLModels.cpp:1042
XPMP2::ObjLoadStateTy
ObjLoadStateTy
State of the X-Plane object: Is it being loaded or available?
Definition: CSLModels.h:30
XPMP2::OLS_COPYING
@ OLS_COPYING
creating a new .obj file copy, replacing dataRefs and textures
Definition: CSLModels.h:33
XPMP2::OLS_UNAVAIL
@ OLS_UNAVAIL
Not yet tried loading the CSL object.
Definition: CSLModels.h:32
@@ -316,17 +318,18 @@
XPMP2::OLS_LOADING
@ OLS_LOADING
async load underway
Definition: CSLModels.h:34
XPMP2::OLS_AVAILABLE
@ OLS_AVAILABLE
X-Plane object available in xpObj
Definition: CSLModels.h:35
XPMP2::mapCSLPackageTy
std::map< std::string, std::string > mapCSLPackageTy
Map of CSLPackages: Maps an id to the base path (path ends on forward slash)
Definition: CSLModels.h:27
-
XPMP2::CSLModelByKey
CSLModel * CSLModelByKey(const std::string &_cslKey, mapCSLModelTy::iterator *_pOutIter)
Find a model by (even more) unique key.
Definition: CSLModels.cpp:1131
-
XPMP2::CSLModelsLoad
const char * CSLModelsLoad(const std::string &_path, int _maxDepth)
Read the CSL Models found in the given path and below.
Definition: CSLModels.cpp:1078
+
XPMP2::CSLModelByKey
CSLModel * CSLModelByKey(const std::string &_cslKey, mapCSLModelTy::iterator *_pOutIter)
Find a model by (even more) unique key.
Definition: CSLModels.cpp:1130
+
XPMP2::CSLModelsLoad
const char * CSLModelsLoad(const std::string &_path, int _maxDepth)
Read the CSL Models found in the given path and below.
Definition: CSLModels.cpp:1077
XPMP2::CSLModel::MatchCritTy
Combines match-relevant fields (beside ICAO a/c type)
Definition: CSLModels.h:116
XPMP2::CSLModel::MatchCritTy::livery
std::string livery
Livery code this model represents: xsb_aircraft.txt::LIVERY
Definition: CSLModels.h:120
XPMP2::CSLModel::MatchCritTy::merge
bool merge(const MatchCritTy &o)
Decide which criteria is better and keep that.
Definition: CSLModels.cpp:321
XPMP2::CSLModel::MatchCritTy::icaoAirline
std::string icaoAirline
ICAO Airline code this model represents: xsb_aircraft.txt::AIRLINE
Definition: CSLModels.h:118
XPMP2::Doc8643
Represents a line in the Doc8643.txt file, of which we use only classification and WTC.
Definition: RelatedDoc8643.h:62
-
XPMP2::Doc8643::HasRotor
bool HasRotor() const
Definition: RelatedDoc8643.h:77
+
XPMP2::Doc8643::HasRotor
bool HasRotor() const
Definition: RelatedDoc8643.h:78
+
XPMP2::Doc8643::GetNumEngines
int GetNumEngines() const
Definition: RelatedDoc8643.h:76
XPMP2::Doc8643::wtc
char wtc[4]
Definition: RelatedDoc8643.h:65
XPMP2::Doc8643::GetClassNumEng
char GetClassNumEng() const
Definition: RelatedDoc8643.h:75
-
XPMP2::Doc8643::GetClassEngType
char GetClassEngType() const
Definition: RelatedDoc8643.h:76
+
XPMP2::Doc8643::GetClassEngType
char GetClassEngType() const
Definition: RelatedDoc8643.h:77
XPMP2::Doc8643::GetClassType
char GetClassType() const
Definition: RelatedDoc8643.h:74
diff --git a/docs/html/Client_8cpp.html b/docs/html/Client_8cpp.html index 037906ad..c4c2f925 100644 --- a/docs/html/Client_8cpp.html +++ b/docs/html/Client_8cpp.html @@ -95,16 +95,16 @@

 Called at the end of each flight loop processing: Release the data lock. More...
 
void ClientProcAcDetails (const std::uint32_t _from[4], size_t _msgLen, const XPMP2::RemoteMsgAcDetailTy &_msgAcDetails)
 Handle A/C Details messages, called by XPMP2 via callback. More...
 Handle A/C Details messages, called by XPMP2 via callback. More...
 
void ClientProcAcPosUpdate (const std::uint32_t _from[4], size_t _msgLen, const XPMP2::RemoteMsgAcPosUpdateTy &_msgAcPosUpdate)
 Handle A/C Position Update message, called by XPMP2 via callback. More...
 Handle A/C Position Update message, called by XPMP2 via callback. More...
 
void ClientProcAcAnim (const std::uint32_t _from[4], size_t _msgLen, const XPMP2::RemoteMsgAcAnimTy &_msgAcAnim)
 Handle A/C Animation dataRef messages, called by XPMP2 via callback. More...
 Handle A/C Animation dataRef messages, called by XPMP2 via callback. More...
 
void ClientProcAcRemove (const std::uint32_t _from[4], size_t _msgLen, const XPMP2::RemoteMsgAcRemoveTy &_msgAcRemove)
 Handle A/C Removal message, called by XPMP2 via callback. More...
 Handle A/C Removal message, called by XPMP2 via callback. More...
 
void ClientInit ()
 Initializes the module. More...
+ + + + + +
+
XPMP2 +
+
X-Plane multiplayer library 2 - using instancing
+
+ + + + + + + + + +
+
+Namespaces | +Functions | +Variables
+
+
FMOD_Logo.cpp File Reference
+
+
+ +

Compressed version of the FMOD logo with code to create a texture ID in X-Plane for display with Dear ImGui. +More...

+
#include "FMOD_Logo.h"
+#include <cassert>
+#include <GL/gl.h>
+#include <GL/glext.h>
+#include "XPLMGraphics.h"
+
+ + + +

+Namespaces

 
+ + + + + + + +

+Functions

uint8_t * FMODLogo::LoadRGBA (bool bBlack=true)
 Load the data of the FMOD logo, expanded into RGBA data. More...
 
bool FMODLogo::GetTexture (int &texId, bool bBlack=true)
 The one "public" function to return a texture id for the logo. More...
 
+ + + + + + + +

+Variables

constexpr size_t FMODLogo::RLE_SIZE = 5527
 number of array entries in the RLE array More...
 
const uint16_t FMODLogo::ALPHA_RLE [RLE_SIZE]
 Run-length encoded data of the Alpha value of each pixel in the FMOD logo. More...
 
+

Detailed Description

+

Compressed version of the FMOD logo with code to create a texture ID in X-Plane for display with Dear ImGui.

+
See also
FMOD attribution requirements
+
+FMOD Logo download
+

The FMOD logo is essential a single-color image, either black (RGB 0x06 0x08 0x0b) or white (0xff 0xff 0xff), with only the alpha value varying across the image. The below array ALPHA_RLE is a run-length encoded dump of these alpha values. The provided functions recreate the full RGBA data, so that it can be used with OpenGL functionality to be turned into a texture.

+

Usage
+

        #include "FMOD_Logo.inc"
+        ...
+        int logoId = 0;
+        if (FMODLogo::GetTexture(logoId)) {
+            ImGui::Image((void*)(intptr_t)logoId, ImVec2(FMODLogo::IMG_WIDTH, FMODLogo::IMG_HEIGHT));
+        }
+
Copyright
of the logo itself: Firelight Technologies Pty Ltd.
+
Author
of the code: Birger Hoppe
+
Copyright
(c) 2022 Birger Hoppe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/FMOD__Logo_8h.html b/docs/html/FMOD__Logo_8h.html new file mode 100644 index 00000000..8bfe60ab --- /dev/null +++ b/docs/html/FMOD__Logo_8h.html @@ -0,0 +1,113 @@ + + + + + + + +XPMP2: XPMP2-Sample/lib/fmod/logo/FMOD_Logo.h File Reference + + + + + + +
+
+ + + + + + +
+
XPMP2 +
+
X-Plane multiplayer library 2 - using instancing
+
+
+ + + + + + + +
+
+
+Namespaces | +Functions | +Variables
+
+
FMOD_Logo.h File Reference
+
+
+ +

Compressed version of the FMOD logo with code to create a texture ID in X-Plane for display with Dear ImGui. +More...

+
#include <cstdint>
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

 
+ + + + + + + +

+Functions

bool FMODLogo::GetTexture (int &texId, bool bBlack=true)
 The one "public" function to return a texture id for the logo. More...
 
uint8_t * FMODLogo::LoadRGBA (bool bBlack=true)
 Load the data of the FMOD logo, expanded into RGBA data. More...
 
+ + + + + + + + + + +

+Variables

constexpr int FMODLogo::IMG_WIDTH = 728
 Logo image width. More...
 
constexpr int FMODLogo::IMG_HEIGHT = 192
 Logo image height. More...
 
constexpr int FMODLogo::IMG_SIZE = IMG_WIDTH * IMG_HEIGHT
 Logo image size in number of pixels. More...
 
+

Detailed Description

+

Compressed version of the FMOD logo with code to create a texture ID in X-Plane for display with Dear ImGui.

+
See also
FMOD attribution requirements
+
+FMOD Logo download
+

The FMOD logo is essential a single-color image, either black (RGB 0x06 0x08 0x0b) or white (0xff 0xff 0xff), with only the alpha value varying across the image. The below array ALPHA_RLE is a run-length encoded dump of these alpha values. The provided functions recreate the full RGBA data, so that it can be used with OpenGL functionality to be turned into a texture.

+

Usage
+

        #include "FMOD_Logo.h"
+        ...
+        int logoId = 0;
+        if (FMODLogo::GetTexture(logoId)) {
+            ImGui::Image((void*)(intptr_t)logoId, ImVec2(FMODLogo::IMG_WIDTH, FMODLogo::IMG_HEIGHT));
+        }
+
Copyright
of the logo itself: Firelight Technologies Pty Ltd.
+
Author
of the code: Birger Hoppe
+
Copyright
(c) 2022 Birger Hoppe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/FMOD__Logo_8h_source.html b/docs/html/FMOD__Logo_8h_source.html new file mode 100644 index 00000000..0df2ac9f --- /dev/null +++ b/docs/html/FMOD__Logo_8h_source.html @@ -0,0 +1,79 @@ + + + + + + + +XPMP2: XPMP2-Sample/lib/fmod/logo/FMOD_Logo.h Source File + + + + + + +
+
+ + + + + + +
+
XPMP2 +
+
X-Plane multiplayer library 2 - using instancing
+
+
+ + + + + + + +
+
+
+
FMOD_Logo.h
+
+
+Go to the documentation of this file.
1 
+
43 #pragma once
+
44 
+
45 #include <cstdint>
+
46 
+
47 namespace FMODLogo {
+
48 
+
49 // Dimensions of the FMOD logo
+
50 constexpr int IMG_WIDTH = 728;
+
51 constexpr int IMG_HEIGHT = 192;
+
52 constexpr int IMG_SIZE = IMG_WIDTH * IMG_HEIGHT;
+
53 
+
60 bool GetTexture (int& texId, bool bBlack = true);
+
61 
+
70 uint8_t* LoadRGBA (bool bBlack = true);
+
71 
+
72 }; // namespace FMODLogo
+
FMODLogo
Definition: FMOD_Logo.cpp:63
+
FMODLogo::IMG_WIDTH
constexpr int IMG_WIDTH
Logo image width.
Definition: FMOD_Logo.h:50
+
FMODLogo::IMG_HEIGHT
constexpr int IMG_HEIGHT
Logo image height.
Definition: FMOD_Logo.h:51
+
FMODLogo::IMG_SIZE
constexpr int IMG_SIZE
Logo image size in number of pixels.
Definition: FMOD_Logo.h:52
+
FMODLogo::LoadRGBA
uint8_t * LoadRGBA(bool bBlack)
Load the data of the FMOD logo, expanded into RGBA data.
Definition: FMOD_Logo.cpp:419
+
FMODLogo::GetTexture
bool GetTexture(int &id, bool bBlack)
The one "public" function to return a texture id for the logo.
Definition: FMOD_Logo.cpp:459
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/Map_8cpp.html b/docs/html/Map_8cpp.html index 2b5d5ddf..d5cf6072 100644 --- a/docs/html/Map_8cpp.html +++ b/docs/html/Map_8cpp.html @@ -60,6 +60,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

@@ -231,7 +232,7 @@

XPMP2 creates a separate Map Layer named after the plugin for this purposes. By default, the map functionality is enabled including label writing.

+

XPMP2 creates a separate Map Layer named after the plugin for this purposes. By default, the map functionality is enabled including label writing.

diff --git a/docs/html/Map_8h.html b/docs/html/Map_8h.html index 54ecd2f1..6662941f 100644 --- a/docs/html/Map_8h.html +++ b/docs/html/Map_8h.html @@ -60,6 +60,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

diff --git a/docs/html/Map_8h_source.html b/docs/html/Map_8h_source.html index b5c90ab7..2f4488b8 100644 --- a/docs/html/Map_8h_source.html +++ b/docs/html/Map_8h_source.html @@ -63,7 +63,7 @@
36 }
37 
38 #endif
-
XPMP2
Definition: XPMPAircraft.h:41
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
XPMP2::MapInit
void MapInit()
Initialize the module.
Definition: Map.cpp:371
XPMP2::MapCleanup
void MapCleanup()
Grace cleanup.
Definition: Map.cpp:382
XPMP2::mapMapLayerIDTy
std::map< std::string, XPLMMapLayerID > mapMapLayerIDTy
A map holding our layer identifier, indexed by the map's name.
Definition: Map.h:27
diff --git a/docs/html/Network_8cpp.html b/docs/html/Network_8cpp.html index 578e3ea4..17ab2e92 100644 --- a/docs/html/Network_8cpp.html +++ b/docs/html/Network_8cpp.html @@ -62,6 +62,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

diff --git a/docs/html/Network_8h.html b/docs/html/Network_8h.html index 53656aee..b3fcd125 100644 --- a/docs/html/Network_8h.html +++ b/docs/html/Network_8h.html @@ -88,6 +88,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

diff --git a/docs/html/Network_8h_source.html b/docs/html/Network_8h_source.html index 27625cbf..e166a197 100644 --- a/docs/html/Network_8h_source.html +++ b/docs/html/Network_8h_source.html @@ -274,7 +274,7 @@
XPMP2::UDPReceiver::GetAddrHints
virtual void GetAddrHints(struct addrinfo &hints)
Sets flags to AI_PASSIVE, AF_INET, SOCK_DGRAM, IPPROTO_UDP.
Definition: Network.cpp:456
XPMP2::UDPReceiver::UDPReceiver
UDPReceiver(const std::string &_addr, int _port, size_t _bufSize=512, unsigned _timeOut_ms=0)
Constructor creates a socket and binds it to the given address.
Definition: Network.h:132
XPMP2::UDPReceiver::UDPReceiver
UDPReceiver()
Default constructor is not doing anything.
Definition: Network.h:130
-
XPMP2
Definition: XPMPAircraft.h:41
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
XPMP2::NetwGetLocalAddresses
const std::vector< InetAddrTy > & NetwGetLocalAddresses()
Return all local addresses (also cached locally)
Definition: Network.cpp:820
XPMP2::NetwIsLocalAddr
bool NetwIsLocalAddr(const InetAddrTy &addr)
Is given address a local one?
Definition: Network.cpp:899
XPMP2::INVALID_SOCKET
constexpr SOCKET INVALID_SOCKET
Definition: Network.h:46
diff --git a/docs/html/RelatedDoc8643_8cpp.html b/docs/html/RelatedDoc8643_8cpp.html index 0c4e07e2..51ed6f9d 100644 --- a/docs/html/RelatedDoc8643_8cpp.html +++ b/docs/html/RelatedDoc8643_8cpp.html @@ -60,6 +60,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

diff --git a/docs/html/RelatedDoc8643_8h.html b/docs/html/RelatedDoc8643_8h.html index f7cdd1c2..66906ff3 100644 --- a/docs/html/RelatedDoc8643_8h.html +++ b/docs/html/RelatedDoc8643_8h.html @@ -70,6 +70,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

@@ -109,7 +110,7 @@

Handling the related.txt file for creating groups of similar looking aircraft types, and Doc8643, the official list of ICAO aircraft type codes.

A related group is declared simply by a line of ICAO a/c type codes read from the file. Internally, the group is just identified by its line number in related.txt. So the group "44" might be "A306 A30B A310", the Airbus A300 series.

Doc8643 is a list of information maintained by the ICAO to list all registered aircraft types. Each type designator can appear multiple times in the dataset for slightly differing models, but the classification und the WTC will be the same in all those listing.
- XPMP2 is only interested in type designator, classification, and WTC.

Author
Birger Hoppe
+ XPMP2 is only interested in type designator, classification, and WTC.

Author
Birger Hoppe
Copyright
(c) 2020 Birger Hoppe
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
diff --git a/docs/html/RelatedDoc8643_8h_source.html b/docs/html/RelatedDoc8643_8h_source.html index 5b927b7e..cedf3c6a 100644 --- a/docs/html/RelatedDoc8643_8h_source.html +++ b/docs/html/RelatedDoc8643_8h_source.html @@ -80,45 +80,46 @@
73 
74  char GetClassType () const { return classification[0]; }
75  char GetClassNumEng () const { return classification[1]; }
-
76  char GetClassEngType () const { return classification[2]; }
-
77  bool HasRotor () const { return (classification[0] == 'H' ||
-
78  classification[0] == 'G'); }
-
79 
-
82  int GetWakeCat() const;
-
83 };
-
84 
-
86 typedef std::map<std::string, Doc8643> mapDoc8643Ty;
-
87 
-
89 const char* Doc8643Load (const std::string& _path);
-
90 
-
93 const Doc8643& Doc8643Get (const std::string& _type);
-
94 
-
96 bool Doc8643IsTypeValid (const std::string& _type);
-
97 
-
98 //
-
99 // MARK: Obj8DataRefs.txt
-
100 //
-
101 
-
103 struct Obj8DataRefs {
-
104  std::string s;
-
105  std::string r;
-
106 
-
108  Obj8DataRefs (std::string&& _s, std::string&& _r) :
-
109  s (std::move(_s)), r (std::move(_r)) {}
-
110 };
-
111 
-
113 typedef std::list<Obj8DataRefs> listObj8DataRefsTy;
-
114 
-
116 const char* Obj8DataRefsLoad (const std::string& _path);
-
117 
-
118 }
-
119 
-
120 #endif
-
XPMP2
Definition: XPMPAircraft.h:41
+
76  int GetNumEngines () const { return ('0' <= classification[1] && classification[1] <= '9') ? classification[1] - '0' : 0; }
+
77  char GetClassEngType () const { return classification[2]; }
+
78  bool HasRotor () const { return (classification[0] == 'H' ||
+
79  classification[0] == 'G'); }
+
80 
+
83  int GetWakeCat() const;
+
84 };
+
85 
+
87 typedef std::map<std::string, Doc8643> mapDoc8643Ty;
+
88 
+
90 const char* Doc8643Load (const std::string& _path);
+
91 
+
94 const Doc8643& Doc8643Get (const std::string& _type);
+
95 
+
97 bool Doc8643IsTypeValid (const std::string& _type);
+
98 
+
99 //
+
100 // MARK: Obj8DataRefs.txt
+
101 //
+
102 
+
104 struct Obj8DataRefs {
+
105  std::string s;
+
106  std::string r;
+
107 
+
109  Obj8DataRefs (std::string&& _s, std::string&& _r) :
+
110  s (std::move(_s)), r (std::move(_r)) {}
+
111 };
+
112 
+
114 typedef std::list<Obj8DataRefs> listObj8DataRefsTy;
+
115 
+
117 const char* Obj8DataRefsLoad (const std::string& _path);
+
118 
+
119 }
+
120 
+
121 #endif
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
XPMP2::Doc8643Get
const Doc8643 & Doc8643Get(const std::string &_type)
Return a reference to the matching Doc8643 object.
Definition: RelatedDoc8643.cpp:208
XPMP2::mapRelatedTy
std::map< std::string, int > mapRelatedTy
Map of group membership: ICAO a/c type maps to line in related.txt.
Definition: RelatedDoc8643.h:40
-
XPMP2::mapDoc8643Ty
std::map< std::string, Doc8643 > mapDoc8643Ty
Map of Doc8643 information, key is the (icao) type code.
Definition: RelatedDoc8643.h:86
-
XPMP2::listObj8DataRefsTy
std::list< Obj8DataRefs > listObj8DataRefsTy
a list of Obj8DataRefs definitions
Definition: RelatedDoc8643.h:113
+
XPMP2::mapDoc8643Ty
std::map< std::string, Doc8643 > mapDoc8643Ty
Map of Doc8643 information, key is the (icao) type code.
Definition: RelatedDoc8643.h:87
+
XPMP2::listObj8DataRefsTy
std::list< Obj8DataRefs > listObj8DataRefsTy
a list of Obj8DataRefs definitions
Definition: RelatedDoc8643.h:114
XPMP2::Doc8643Load
const char * Doc8643Load(const std::string &_path)
Load the content of the provided Doc8643.txt file.
Definition: RelatedDoc8643.cpp:144
XPMP2::RelatedGet
int RelatedGet(const std::string &_acType)
Find the related group for an ICAO a/c type, 0 if none.
Definition: RelatedDoc8643.cpp:108
XPMP2::Obj8DataRefsLoad
const char * Obj8DataRefsLoad(const std::string &_path)
Load the content of the provided Obj8DataRefs.txt file.
Definition: RelatedDoc8643.cpp:225
@@ -126,18 +127,19 @@
XPMP2::Doc8643IsTypeValid
bool Doc8643IsTypeValid(const std::string &_type)
Is the given aircraft type a valid ICAO type as per Doc8643?
Definition: RelatedDoc8643.cpp:215
XPMP2::Doc8643
Represents a line in the Doc8643.txt file, of which we use only classification and WTC.
Definition: RelatedDoc8643.h:62
XPMP2::Doc8643::Doc8643
Doc8643()
Definition: RelatedDoc8643.h:67
-
XPMP2::Doc8643::HasRotor
bool HasRotor() const
Definition: RelatedDoc8643.h:77
+
XPMP2::Doc8643::HasRotor
bool HasRotor() const
Definition: RelatedDoc8643.h:78
XPMP2::Doc8643::empty
bool empty() const
Is empty, doesn't contain anything?
Definition: RelatedDoc8643.h:72
+
XPMP2::Doc8643::GetNumEngines
int GetNumEngines() const
Definition: RelatedDoc8643.h:76
XPMP2::Doc8643::wtc
char wtc[4]
Definition: RelatedDoc8643.h:65
XPMP2::Doc8643::GetClassNumEng
char GetClassNumEng() const
Definition: RelatedDoc8643.h:75
XPMP2::Doc8643::GetWakeCat
int GetWakeCat() const
Returns the wake category as per XP12's wake system.
Definition: RelatedDoc8643.cpp:131
XPMP2::Doc8643::classification
char classification[4]
Definition: RelatedDoc8643.h:64
-
XPMP2::Doc8643::GetClassEngType
char GetClassEngType() const
Definition: RelatedDoc8643.h:76
+
XPMP2::Doc8643::GetClassEngType
char GetClassEngType() const
Definition: RelatedDoc8643.h:77
XPMP2::Doc8643::GetClassType
char GetClassType() const
Definition: RelatedDoc8643.h:74
-
XPMP2::Obj8DataRefs
A pair of strings, first one to search for, second one to replace it with.
Definition: RelatedDoc8643.h:103
-
XPMP2::Obj8DataRefs::Obj8DataRefs
Obj8DataRefs(std::string &&_s, std::string &&_r)
Constructor just loads the strings.
Definition: RelatedDoc8643.h:108
-
XPMP2::Obj8DataRefs::r
std::string r
if found replace it with this string
Definition: RelatedDoc8643.h:105
-
XPMP2::Obj8DataRefs::s
std::string s
search the .obj file for this string
Definition: RelatedDoc8643.h:104
+
XPMP2::Obj8DataRefs
A pair of strings, first one to search for, second one to replace it with.
Definition: RelatedDoc8643.h:104
+
XPMP2::Obj8DataRefs::Obj8DataRefs
Obj8DataRefs(std::string &&_s, std::string &&_r)
Constructor just loads the strings.
Definition: RelatedDoc8643.h:109
+
XPMP2::Obj8DataRefs::r
std::string r
if found replace it with this string
Definition: RelatedDoc8643.h:106
+
XPMP2::Obj8DataRefs::s
std::string s
search the .obj file for this string
Definition: RelatedDoc8643.h:105
diff --git a/docs/html/Remote_8cpp.html b/docs/html/Remote_8cpp.html index cc2ab410..67428672 100644 --- a/docs/html/Remote_8cpp.html +++ b/docs/html/Remote_8cpp.html @@ -70,6 +70,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
+

diff --git a/docs/html/Remote_8h.html b/docs/html/Remote_8h.html index 46b64826..ef145d5c 100644 --- a/docs/html/Remote_8h.html +++ b/docs/html/Remote_8h.html @@ -82,6 +82,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 

diff --git a/docs/html/Remote_8h_source.html b/docs/html/Remote_8h_source.html index 978add51..be1e0947 100644 --- a/docs/html/Remote_8h_source.html +++ b/docs/html/Remote_8h_source.html @@ -168,8 +168,8 @@
185 
186 }
187 #endif
-
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:243
-
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:147
+
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:252
+
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:181
XPMP2::CSLModel
Represetns a CSL model as it is saved on disk.
Definition: CSLModels.h:113
XPMP2::RmtDataAcAnimTy
Animation dataRef requires a special queue data type as each msg element is already of variable lengt...
Definition: Remote.h:106
XPMP2::RmtDataAcAnimTy::RmtDataAcAnimTy
RmtDataAcAnimTy(XPMPPlaneID _id)
Default constructor only sets message type and id, makes sure data is initialized.
Definition: Remote.h:116
@@ -195,7 +195,7 @@
XPMP2::RmtMsgBufTy::send
void send(UDPMulticast &_mc)
send the message (if there is any), then reset the buffer
Definition: Remote.cpp:465
XPMP2::RmtMsgBufTy::pMsg
void * pMsg
points to the actual message buffer of size glob.remoteBufSize
Definition: Remote.h:132
XPMP2::UDPMulticast
UDP Multicast, always binding to INADDR_ANY.
Definition: Network.h:145
-
XPMP2
Definition: XPMPAircraft.h:41
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
XPMP2::mapRmtAcCacheTy
std::map< XPMPPlaneID, RmtAcCacheTy > mapRmtAcCacheTy
Defines a map with the plane id as key and the aboce cache structure as payload.
Definition: Remote.h:63
XPMP2::RemoteAcClearAll
void RemoteAcClearAll()
Informs us that there are no more aircraft, clear our caches!
Definition: Remote.cpp:1312
XPMP2::RemoteAcEnqueueDone
void RemoteAcEnqueueDone()
Informs us that all a/c have been processed: All pending messages to be sent now.
Definition: Remote.cpp:1251
@@ -216,8 +216,8 @@
XPMP2::ptrRmtDataAcAnimTy
std::unique_ptr< RmtDataAcAnimTy > ptrRmtDataAcAnimTy
Smart pointer to XPMP2::RmtDataAcAnimTy.
Definition: Remote.h:122
XPMP2::RemoteInit
void RemoteInit()
Initialize the module.
Definition: Remote.cpp:1058
XPMP2::RmtDataAcPosUpdateTy
RmtDataEnqeueTy< RemoteAcPosUpdateTy, RMT_MSG_AC_POS_UPDATE > RmtDataAcPosUpdateTy
A/C Position Update queue type.
Definition: Remote.h:99
-
XPMP2::DR_VALS
DR_VALS
The dataRefs provided by XPMP2 to the CSL models.
Definition: XPMPAircraft.h:56
-
XPMP2::V_COUNT
@ V_COUNT
always last, number of dataRefs XPMP2 pre-defines
Definition: XPMPAircraft.h:106
+
XPMP2::DR_VALS
DR_VALS
The dataRefs provided by XPMP2 to the CSL models.
Definition: XPMPAircraft.h:90
+
XPMP2::V_COUNT
@ V_COUNT
always last, number of dataRefs XPMP2 pre-defines
Definition: XPMPAircraft.h:140
XPMP2::RmtDataAcDetailTy
RmtDataEnqeueTy< RemoteAcDetailTy, RMT_MSG_AC_DETAILED > RmtDataAcDetailTy
A/C Detail queue type.
Definition: Remote.h:98
XPMP2::RemoteAcAnimTy
A/C animation dataRef changes.
Definition: XPMPRemote.h:329
XPMP2::RemoteAcAnimTy::msgSize
size_t msgSize() const
current message size
Definition: XPMPRemote.h:347
diff --git a/docs/html/Sound_8cpp.html b/docs/html/Sound_8cpp.html new file mode 100644 index 00000000..43d52bb4 --- /dev/null +++ b/docs/html/Sound_8cpp.html @@ -0,0 +1,755 @@ + + + + + + + +XPMP2: src/Sound.cpp File Reference + + + + + + +
+
+ + + + + + +
+
XPMP2 +
+
X-Plane multiplayer library 2 - using instancing
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces | +Macros | +Typedefs | +Functions | +Variables
+
+
Sound.cpp File Reference
+
+
+ +

Sound for aircraft, based on the FMOD library. +More...

+
#include "XPMP2.h"
+#include "fmod_errors.h"
+
+ + + + + + + + + + + + + +

+Classes

struct  XPMP2::FMOD_10830_ADVANCEDSETTINGS
 FMOD 1.08.30 version of FMOD_ADVANCEDSETTINGS. More...
 
struct  XPMP2::SoundDefTy
 Definition of how sound is handled based on dataRef values (type) More...
 
class  XPMP2::FmodError
 Exception class to pass on error information. More...
 
class  XPMP2::SoundFile
 Represents a sound file. More...
 
+ + + + +

+Namespaces

 XPMP2
 Defined by FMOD.
 
+ + + + + + + + + + + + + + +

+Macros

#define FMOD_TEST(fmodCall)
 Log an error if fmodRes is not FMOD_OK More...
 
#define FMOD_CATCH   catch (const FmodError& e) { e.LogErr(); }
 Standard catch clause to handle FmodError exceptions by just logging them. More...
 
#define FMOD_LOG(fmodCall)
 Just log an error without raising an exception. More...
 
#define ADD_SND(s, f, l)   if (!XPMPSoundAdd(s,f,l)[0]) ++n;
 
#define ADD_CONE(s, f, l, cd, cp, cia, coa, cov)   if (!XPMPSoundAdd(s,f,l,cd,cp,cia,coa,cov)[0]) ++n;
 
+ + + + +

+Typedefs

typedef std::map< std::string, SoundFile > XPMP2::mapSoundTy
 Map of all sounds, indexed by a sound name (type) More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

FMOD_VECTOR XPMP2::HeadPitch2Vec (const float head, const float pitch)
 Convert heading/pitch to normalized x/y/z vector. More...
 
bool XPMP2::UseOldFmod ()
 Use pre-v2 FMOD version structures? More...
 
FMOD_RESULT F_CALLBACK XPMP2::SoundLogCB (FMOD_DEBUG_FLAGS flags, const char *file, int line, const char *func, const char *message)
 Callback function called by FMOD for logging purposes. More...
 
void XPMP2::SoundLogEnable (bool bEnable=true)
 Enables/disables FMOD logging. More...
 
FMOD_CHANNELGROUP * XPMP2::SoundGetMasterChn ()
 Get the FMOD system's master channel group, or nullptr More...
 
SoundFile * XPMP2::SoundGetSoundFile (FMOD_CHANNEL *pChn)
 Get pointer to Sound File that created the channel. More...
 
bool XPMP2::SoundIsChnValid (FMOD_CHANNEL *pChn)
 Is the channel still payling / is it valid? More...
 
template<class T_ADVSET >
void XPMP2::SoundSetFmodSettings (T_ADVSET &advSet)
 Helper functon to set FMOD settings. More...
 
const char * XPMP2::SoundEventTxt (Aircraft::SoundEventsTy e)
 Return a text for the values of Aircraft::SoundEventsTy. More...
 
bool XPMP2::SoundInit ()
 Initialize the sound module and load the sounds. More...
 
void XPMP2::SoundUpdatesDone ()
 Tell FMOD that all updates are done. More...
 
void XPMP2::SoundCleanup ()
 Graceful shoutdown. More...
 
bool XPMPSoundEnable (bool bEnable)
 Enable/Disable Sound. More...
 
bool XPMPSoundIsEnabled ()
 Is Sound enabled? More...
 
void XPMPSoundSetMasterVolume (float fVol)
 Set Master Volume. More...
 
void XPMPSoundMute (bool bMute)
 Mute all sounds (temporarily) More...
 
const char * XPMPSoundAdd (const char *sName, const char *filePath, bool bLoop, float coneDir, float conePitch, float coneInAngle, float coneOutAngle, float coneOutVol)
 Add a sound that can later be referenced from an XPMP2::Aircraft. More...
 
const char * XPMPSoundEnumerate (const char *prevName, const char **ppFilePath)
 Enumerate all sounds, including the internal ones. More...
 
+ + + + + + + + + + + + + +

+Variables

constexpr int XPMP2::EXP_COMP_SKIP_CYCLES = 10
 In how many cycles to skip expensive computations? More...
 
constexpr int XPMP2::FMOD_NUM_VIRT_CHANNELS = 1000
 Number of virtual channels during initialization. More...
 
constexpr float XPMP2::FMOD_3D_MAX_DIST = 10000.0f
 Value used for 3D max distance, which doesn't have much of a function for the inverse roll-off model used here. More...
 
constexpr float XPMP2::FMOD_LOW_PASS_GAIN = 0.2f
 Gain used when activating Low Pass filter. More...
 
+

Detailed Description

+

Sound for aircraft, based on the FMOD library.

+
Note
Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. Understand FMOD licensing and attribution requirements first!
+ Sound support is only included if built with CMake cache entry INCLUDE_FMOD_SOUND.
+
+
See also
FMOD Core API Guide https://fmod.com/docs/2.02/api/core-guide.html
+

FMOD's C interface is used exclusively (and not the C++ ABI). This is to ease handling of dynamic libaries between versions (XP11 is using FMOD 1.x while XP12 has upgraded to 2.x) and allows compiling with MingW.

+

Some functionality looks like immitating FMOD's SoundGroup, but 3D positioning was unstable when used via SoundGroup, and the cone functionality did not work at all, so this file handles all sound channels individually.

Note
If linking to the logging version of the FMOD API library (the one ending in L) and specifying a config item log_level of 0 = Debug (see XPMPIntPrefsFuncTy) while initializing sound, ie. typically during the first call to XPMPMultiplayerInit(), then FMOD logging output is added to X-Plane's Log.txt.
+
Author
Birger Hoppe
+
Copyright
(c) 2022 Birger Hoppe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

Class Documentation

+ +

◆ XPMP2::FMOD_10830_ADVANCEDSETTINGS

+ +
+
+ + + + +
struct XPMP2::FMOD_10830_ADVANCEDSETTINGS
+
+

FMOD 1.08.30 version of FMOD_ADVANCEDSETTINGS.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Class Members
+char ** +ASIOChannelList +
+int +ASIONumChannels +
+FMOD_SPEAKER * +ASIOSpeakerList +
+int +cbSize +
+unsigned int +commandQueueSize +
+unsigned int +defaultDecodeBufferSize +
+float +distanceFilterCenterFreq +
+int +DSPBufferPoolSize +
+unsigned int +geometryMaxFadeTime +
+float +HRTFFreq +
+float +HRTFMaxAngle +
+float +HRTFMinAngle +
+int +maxADPCMCodecs +
+int +maxAT9Codecs +
+int +maxFADPCMCodecs +
+int +maxMPEGCodecs +
+int +maxPCMCodecs +
+int +maxVorbisCodecs +
+int +maxXMACodecs +
+unsigned short +profilePort +
+unsigned int +randomSeed +
+FMOD_DSP_RESAMPLER +resamplerMethod +
+int +reverb3Dinstance +
+unsigned int +stackSizeMixer +
+unsigned int +stackSizeNonBlocking +
+unsigned int +stackSizeStream +
+float +vol0virtualvol +
+ +
+
+

Macro Definition Documentation

+ +

◆ ADD_CONE

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#define ADD_CONE( s,
 f,
 l,
 cd,
 cp,
 cia,
 coa,
 cov 
)   if (!XPMPSoundAdd(s,f,l,cd,cp,cia,coa,cov)[0]) ++n;
+
+ +
+
+ +

◆ ADD_SND

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
#define ADD_SND( s,
 f,
 l 
)   if (!XPMPSoundAdd(s,f,l)[0]) ++n;
+
+ +
+
+ +

◆ FMOD_CATCH

+ +
+
+ + + + +
#define FMOD_CATCH   catch (const FmodError& e) { e.LogErr(); }
+
+ +

Standard catch clause to handle FmodError exceptions by just logging them.

+ +
+
+ +

◆ FMOD_LOG

+ +
+
+ + + + + + + + +
#define FMOD_LOG( fmodCall)
+
+Value:
{ \
+
if ((XPMP2::gFmodRes = (fmodCall)) != FMOD_OK) \
+
XPMP2::FmodError(#fmodCall, XPMP2::gFmodRes, __LINE__, __func__).LogErr(); \
+
}
+
+

Just log an error without raising an exception.

+ +
+
+ +

◆ FMOD_TEST

+ +
+
+ + + + + + + + +
#define FMOD_TEST( fmodCall)
+
+Value:
{ \
+
if ((gFmodRes = (fmodCall)) != FMOD_OK) \
+
throw FmodError(#fmodCall, gFmodRes, __LINE__, __func__); \
+
}
+
+

Log an error if fmodRes is not FMOD_OK

+ +
+
+

Function Documentation

+ +

◆ XPMPSoundAdd()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
const char* XPMPSoundAdd (const char * sName,
const char * filePath,
bool bLoop,
float coneDir = NAN,
float conePitch = NAN,
float coneInAngle = NAN,
float coneOutAngle = NAN,
float coneOutVol = NAN 
)
+
+ +

Add a sound that can later be referenced from an XPMP2::Aircraft.

+

XPMP2 loads a number of default sounds from what X-Plane ships. This function allows to add your own. It will try to load the sound immediately.

Parameters
+ + + + + + + + + +
sNameA descriptive name, used as a key to refer to this sound later
filePathPath to the sound file; a relative path is relative to resourceDir as set by XPMPMultiplayerInit()
bLoopIs this sound to be played in a loop?
coneDir[opt] Which direction relative to plane's heading does the cone point to? (180 would be typical for jet engines)
conePitch[opt] Which pitch does the cone point to (up/down)? (0 would be typical, ie. level with the plane)
coneInAngle[opt] Inside cone angle. This is the angle spread within which the sound is unattenuated.
coneOutAngle[opt] Outside cone angle. This is the angle spread outside of which the sound is attenuated to its coneOutVol.
coneOutVol[opt] Cone outside volume.
+
+
+
Returns
Empty string in case of success, otherwise a human-readable error message.
+ +
+
+ +

◆ XPMPSoundEnable()

+ +
+
+ + + + + + + + +
bool XPMPSoundEnable (bool bEnable = true)
+
+ +

Enable/Disable Sound.

+

Enable or disable sound support. The default on startup is controlled by the configuration item sound / activate_sound, which in turn defaults to 1.

Returns
Is sound now available? (Could still be false even in case of activation if there was a problem during sound initialization)
+ +
+
+ +

◆ XPMPSoundEnumerate()

+ +
+
+ + + + + + + + + + + + + + + + + + +
const char* XPMPSoundEnumerate (const char * prevName,
const char ** ppFilePath = nullptr 
)
+
+ +

Enumerate all sounds, including the internal ones.

+
Parameters
+ + + +
prevNamenullptr or empty string to start from beginning, last returned name to continue with next sound
[out]ppFilePath(optional) Receives pointer to file path
+
+
+
Returns
Next sound's name.
+
Note
String pointers can change any frame. If you want to use the strings longer than immediately, make yourself a string copy.
+ +
+
+ +

◆ XPMPSoundIsEnabled()

+ +
+
+ + + + + + + +
bool XPMPSoundIsEnabled ()
+
+ +

Is Sound enabled?

+ +
+
+ +

◆ XPMPSoundMute()

+ +
+
+ + + + + + + + +
void XPMPSoundMute (bool bMute)
+
+ +

Mute all sounds (temporarily)

+
Parameters
+ + +
bMuteMute (true) or unmute (false)?
+
+
+ +
+
+ +

◆ XPMPSoundSetMasterVolume()

+ +
+
+ + + + + + + + +
void XPMPSoundSetMasterVolume (float fVol = 1.0f)
+
+ +

Set Master Volume.

+
Parameters
+ + +
fVolVolume level. 0 = silent, 1 = full. Negative level inverts the signal. Values larger than 1 amplify the signal.
+
+
+ +
+
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/Sound_8h.html b/docs/html/Sound_8h.html new file mode 100644 index 00000000..8e12962b --- /dev/null +++ b/docs/html/Sound_8h.html @@ -0,0 +1,94 @@ + + + + + + + +XPMP2: src/Sound.h File Reference + + + + + + +
+
+ + + + + + +
+
XPMP2 +
+
X-Plane multiplayer library 2 - using instancing
+
+
+ + + + + + + +
+
+
+Namespaces | +Functions
+
+
Sound.h File Reference
+
+
+ +

Sound for aircraft, based on the FMOD library. +More...

+ +

Go to the source code of this file.

+ + + + + +

+Namespaces

 XPMP2
 Defined by FMOD.
 
+ + + + + + + + + + +

+Functions

bool XPMP2::SoundInit ()
 Initialize the sound module and load the sounds. More...
 
void XPMP2::SoundUpdatesDone ()
 Tell FMOD that all updates are done. More...
 
void XPMP2::SoundCleanup ()
 Graceful shoutdown. More...
 
+

Detailed Description

+

Sound for aircraft, based on the FMOD library.

+
Note
Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. Understand FMOD licensing and attribution requirements first!
+ Sound support is only included if built with CMake cache entry INCLUDE_FMOD_SOUND.
+
+
Author
Birger Hoppe
+
Copyright
(c) 2022 Birger Hoppe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/Sound_8h_source.html b/docs/html/Sound_8h_source.html new file mode 100644 index 00000000..16e4b78e --- /dev/null +++ b/docs/html/Sound_8h_source.html @@ -0,0 +1,82 @@ + + + + + + + +XPMP2: src/Sound.h Source File + + + + + + +
+
+ + + + + + +
+
XPMP2 +
+
X-Plane multiplayer library 2 - using instancing
+
+
+ + + + + + + +
+
+
+
Sound.h
+
+
+Go to the documentation of this file.
1 
+
27 #pragma once
+
28 
+
29 // Only included if specified. Understand FMOD licensing and attribution first!
+
30 #ifdef INCLUDE_FMOD_SOUND
+
31 
+
32 namespace XPMP2 {
+
33 
+
34 
+
35 //
+
36 // MARK: Global Functions
+
37 //
+
38 
+
40 bool SoundInit ();
+
41 
+
43 void SoundUpdatesDone ();
+
44 
+
46 void SoundCleanup ();
+
47 
+
48 }
+
49 
+
50 #endif // INCLUDE_FMOD_SOUND
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
+
XPMP2::SoundInit
bool SoundInit()
Initialize the sound module and load the sounds.
Definition: Sound.cpp:739
+
XPMP2::SoundUpdatesDone
void SoundUpdatesDone()
Tell FMOD that all updates are done.
Definition: Sound.cpp:790
+
XPMP2::SoundCleanup
void SoundCleanup()
Graceful shoutdown.
Definition: Sound.cpp:832
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/Sound_8md.html b/docs/html/Sound_8md.html new file mode 100644 index 00000000..1c3a7937 --- /dev/null +++ b/docs/html/Sound_8md.html @@ -0,0 +1,52 @@ + + + + + + + +XPMP2: docs/Sound.md File Reference + + + + + + +
+
+ + + + + + +
+
XPMP2 +
+
X-Plane multiplayer library 2 - using instancing
+
+
+ + + + + + +
+
+
+
docs/Sound.md File Reference
+
+
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/Utilities_8cpp.html b/docs/html/Utilities_8cpp.html deleted file mode 100644 index a0fa93ab..00000000 --- a/docs/html/Utilities_8cpp.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - -XPMP2: src/Utilities.cpp File Reference - - - - - - -
-
- - - - - - -
-
XPMP2 -
-
X-Plane multiplayer library 2 - using instancing
-
-
- - - - - - - -
-
-
-Namespaces | -Macros | -Functions | -Variables
-
-
Utilities.cpp File Reference
-
-
- -

Miscellaneous utility functions, including logging. -More...

-
#include "XPMP2.h"
-
- - - -

-Namespaces

 XPMP2
 
- - - -

-Macros

#define S_ISDIR(m)   (((m) & _S_IFMT) == _S_IFDIR)
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Functions

int XPMP2::PrefsFuncIntDefault (const char *, const char *, int _default)
 Default config function just always returns the provided default value. More...
 
bool XPMP2::ExistsFile (const std::string &filename)
 Does a file path exist? More...
 
bool XPMP2::IsDir (const std::string &path)
 Is path a directory? More...
 
bool XPMP2::CreateDir (const std::string &path)
 Create directory if it does not exist. More...
 
bool XPMP2::CopyFileIfNewer (const std::string &source, const std::string &destDir)
 Copy file if source is newer or destination missing. More...
 
std::list< std::string > XPMP2::GetDirContents (const std::string &path)
 List of files in a directory (wrapper around XPLMGetDirectoryContents) More...
 
std::istream & XPMP2::safeGetline (std::istream &is, std::string &t)
 Read a line from a text file, no matter if ending on CRLF or LF. More...
 
std::string XPMP2::StripXPSysDir (const std::string &path)
 If a path starts with X-Plane's system directory it is stripped. More...
 
void XPMP2::RemoveExtension (std::string &path)
 Removes everything after the last dot, the dot including. More...
 
std::string & XPMP2::str_tolower (std::string &s)
 change a std::string to uppercase More...
 
std::vector< std::string > XPMP2::str_tokenize (const std::string s, const std::string tokens, bool bSkipEmpty=true)
 separates string into tokens More...
 
std::uint16_t XPMP2::PJWHash16 (const char *s)
 Produces a reproducible(!) hash value for strings. More...
 
float XPMP2::headDiff (float head1, float head2)
 (Shortest) difference between 2 angles: How much to turn to go from h1 to h2? More...
 
float XPMP2::GetMiscNetwTime ()
 Get synched network time from X-Plane (sim/network/misc/network_time_sec) as used in Log.txt. More...
 
const char * XPMP2::GetGraphicsDriverTxt ()
 Text string for current graphics driver in use. More...
 
bool XPMP2::CheckEverySoOften (float &_lastCheck, float _interval, float _now)
 Convenience function to check on something at most every x seconds. More...
 
const char * XPMP2::LogGetString (const char *szFile, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg, va_list args)
 Returns ptr to static buffer filled with formatted log string. More...
 
void XPMP2::LogMsg (const char *szFile, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg,...) XPMP2_FMTARGS(5)
 Log Text to log file. More...
 
- - - - - - -

-Variables

GlobVars XPMP2::glob
 The one and only global variable structure. More...
 
const char * XPMP2::LOG_LEVEL []
 
-

Detailed Description

-

Miscellaneous utility functions, including logging.

-
Author
Birger Hoppe
-
Copyright
(c) 2020 Birger Hoppe
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

Macro Definition Documentation

- -

◆ S_ISDIR

- -
-
- - - - - - - - -
#define S_ISDIR( m)   (((m) & _S_IFMT) == _S_IFDIR)
-
- -
-
-
- -
-Generated by   -doxygen - 1.8.18 -
- - diff --git a/docs/html/Utilities_8h.html b/docs/html/Utilities_8h.html deleted file mode 100644 index 6f281694..00000000 --- a/docs/html/Utilities_8h.html +++ /dev/null @@ -1,554 +0,0 @@ - - - - - - - -XPMP2: src/Utilities.h File Reference - - - - - - -
-
- - - - - - -
-
XPMP2 -
-
X-Plane multiplayer library 2 - using instancing
-
-
- - - - - - - -
-
-
-Namespaces | -Macros | -Enumerations | -Functions | -Variables
-
-
Utilities.h File Reference
-
-
- -

Miscellaneous utility functions, including logging. -More...

- -

Go to the source code of this file.

- - - - -

-Namespaces

 XPMP2
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Macros

#define ERR_ASSERT   "ASSERT FAILED: %s"
 
#define ERR_EXCEPTION   "EXCEPTION CAUGHT: %s"
 
#define PATH_DELIM_STD   '/'
 
#define WHITESPACE   " \t\f\v\r\n"
 
#define XPMP2_FMTARGS(FMT)
 To apply printf-style warnings to our functions. More...
 
#define LOG_MSG(lvl, ...)
 Log a message if lvl is greater or equal currently defined log level. More...
 
#define LOG_MATCHING(lvl, ...)
 Log a message about matching if logging of model matching is enabled. More...
 
#define THROW_ERROR(...)   throw XPMP2Error(__FILE__, __LINE__, __func__, __VA_ARGS__);
 Throws an exception using XPMP2Error. More...
 
#define LOG_ASSERT(cond)
 Throw in an assert-style (logging takes place in XPMP2Error constructor) More...
 
#define CATCH_AC(ac)
 Standard catch clauses for dealing with aircraft: logs message, sets aircraft invalid. More...
 
#define STRCPY_S(dest, src)   strncpy_s(dest,sizeof(dest),src,sizeof(dest)-1)
 Simpler access to strncpy_s if dest is a char array (not a pointer!) More...
 
#define STRCPY_ATMOST(dest, src)   strncpy_s(dest,sizeof(dest),strAtMost(src,sizeof(dest)-1).c_str(),sizeof(dest)-1)
 
#define SET_THREAD_NAME(sName)
 
- - - - -

-Enumerations

enum  XPMP2::logLevelTy {
-  XPMP2::logDEBUG = 0, -XPMP2::logINFO, -XPMP2::logWARN, -XPMP2::logERR, -
-  XPMP2::logFATAL, -XPMP2::logMSG -
- }
 Logging level. More...
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Functions

int XPMP2::PrefsFuncIntDefault (const char *, const char *, int _default)
 Default config function just always returns the provided default value. More...
 
float XPMP2::PrefsFuncFloatDefault (const char *, const char *, float _default)
 
bool XPMP2::ExistsFile (const std::string &filename)
 Does a file path exist? More...
 
bool XPMP2::IsDir (const std::string &path)
 Is path a directory? More...
 
bool XPMP2::CreateDir (const std::string &path)
 Create directory if it does not exist. More...
 
bool XPMP2::CopyFileIfNewer (const std::string &source, const std::string &destDir)
 Copy file if source is newer or destination missing. More...
 
std::list< std::string > XPMP2::GetDirContents (const std::string &path)
 List of files in a directory (wrapper around XPLMGetDirectoryContents) More...
 
std::istream & XPMP2::safeGetline (std::istream &is, std::string &t)
 Read a line from a text file, no matter if ending on CRLF or LF. More...
 
std::string XPMP2::StripXPSysDir (const std::string &path)
 If a path starts with X-Plane's system directory it is stripped. More...
 
void XPMP2::RemoveExtension (std::string &path)
 Removes everything after the last dot, the dot including. More...
 
std::string & XPMP2::str_tolower (std::string &s)
 change a std::string to uppercase More...
 
std::string & XPMP2::rtrim (std::string &s, const char *t=WHITESPACE)
 trimming of string (from right) More...
 
std::string & XPMP2::ltrim (std::string &s, const char *t=WHITESPACE)
 trimming of string (from left) More...
 
std::string & XPMP2::trim (std::string &s, const char *t=WHITESPACE)
 trimming of string (from both ends) More...
 
std::vector< std::string > XPMP2::str_tokenize (const std::string s, const std::string tokens, bool bSkipEmpty=true)
 separates string into tokens More...
 
template<class T >
T XPMP2::rad2deg (const T _rad)
 Convert radians to degrees, normalized to [0..360) More...
 
template<class T >
T XPMP2::deg2rad (const T _deg)
 Convert degree to radians. More...
 
template<class T >
T XPMP2::sqr (const T a)
 Square. More...
 
template<class T >
T XPMP2::dist (const T x1, const T y1, const T z1, const T x2, const T y2, const T z2)
 Pythagorean distance between two points in a 3-D world. More...
 
float XPMP2::atan2deg (float x, float y)
 atan2 converted to degrees: the angle between (0|0) and the given point More...
 
float XPMP2::angleLocCoord (float x1, float z1, float x2, float z2)
 Angle of line from point (x1|z1) to point (x2|z2) More...
 
float XPMP2::headDiff (float head1, float head2)
 (Shortest) difference between 2 angles: How much to turn to go from h1 to h2? More...
 
template<class numT >
numT XPMP2::headNormalize (numT _head)
 Normalize a heading value to [0..360), works for both float and double values. More...
 
float XPMP2::GetMiscNetwTime ()
 Get synched network time from X-Plane (sim/network/misc/network_time_sec) as used in Log.txt. More...
 
const char * XPMP2::GetGraphicsDriverTxt ()
 Text string for current graphics driver in use. More...
 
bool XPMP2::CheckEverySoOften (float &_lastCheck, float _interval, float _now)
 Convenience function to check on something at most every x seconds. More...
 
bool XPMP2::CheckEverySoOften (float &_lastCheck, float _interval)
 Convenience function to check on something at most every x seconds. More...
 
const char * XPMP2::LogGetString (const char *szFile, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg, va_list args)
 Returns ptr to static buffer filled with formatted log string. More...
 
void XPMP2::LogMsg (const char *szFile, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg,...) XPMP2_FMTARGS(5)
 Log Text to log file. More...
 
int XPMP2::strerror_s (char *buf, size_t bufsz, int errnum)
 
std::string XPMP2::TOPOSIX (const std::string &p)
 On Lin/Win there is no need for a conversion, but we do treat p now as std::string More...
 
std::string XPMP2::FROMPOSIX (const std::string &p)
 On Lin/Win there is no need for a conversion, but we do treat p now as std::string More...
 
- - - - - - - - - - - - -

-Variables

constexpr const char * XPMP2::RSRC_RELATED = "related.txt"
 
constexpr const char * XPMP2::RSRC_DOC8643 = "Doc8643.txt"
 
constexpr const char * XPMP2::RSRC_MAP_ICONS = "MapIcons.png"
 
constexpr const char * XPMP2::RSRC_OBJ8DATAREFS = "Obj8DataRefs.txt"
 
constexpr double XPMP2::PI = 3.1415926535897932384626433832795028841971693993751
 Pi. More...
 
-

Detailed Description

-

Miscellaneous utility functions, including logging.

-
Author
Birger Hoppe
-
Copyright
(c) 2020 Birger Hoppe
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

Macro Definition Documentation

- -

◆ CATCH_AC

- -
-
- - - - - - - - -
#define CATCH_AC( ac)
-
-Value:
catch (const std::exception& e) { \
-
LOG_MSG(logFATAL, ERR_EXCEPTION, e.what()); \
-
(ac).SetInvalid(); \
-
} \
-
catch (...) { \
-
LOG_MSG(logFATAL, ERR_EXCEPTION, "<unknown>"); \
-
(ac).SetInvalid(); \
-
}
-
-

Standard catch clauses for dealing with aircraft: logs message, sets aircraft invalid.

- -
-
- -

◆ ERR_ASSERT

- -
-
- - - - -
#define ERR_ASSERT   "ASSERT FAILED: %s"
-
- -
-
- -

◆ ERR_EXCEPTION

- -
-
- - - - -
#define ERR_EXCEPTION   "EXCEPTION CAUGHT: %s"
-
- -
-
- -

◆ LOG_ASSERT

- -
-
- - - - - - - - -
#define LOG_ASSERT( cond)
-
-Value:
if (!(cond)) { \
-
THROW_ERROR(ERR_ASSERT,#cond); \
-
}
-
-

Throw in an assert-style (logging takes place in XPMP2Error constructor)

-
Note
This conditional check always takes place, independend of any build or logging settings!
- -
-
- -

◆ LOG_MATCHING

- -
-
- - - - - - - - - - - - - - - - - - -
#define LOG_MATCHING( lvl,
 ... 
)
-
-Value:
{ \
-
if (glob.bLogMdlMatch && lvl >= glob.logLvl) \
-
{LogMsg(__FILE__, __LINE__, __func__, lvl, __VA_ARGS__);} \
-
}
-
-

Log a message about matching if logging of model matching is enabled.

-
Note
First parameter after lvl must be the message text, which can be a format string with its parameters following like in sprintf
- -
-
- -

◆ LOG_MSG

- -
-
- - - - - - - - - - - - - - - - - - -
#define LOG_MSG( lvl,
 ... 
)
-
-Value:
{ \
-
if (lvl >= glob.logLvl) \
-
{LogMsg(__FILE__, __LINE__, __func__, lvl, __VA_ARGS__);} \
-
}
-
-

Log a message if lvl is greater or equal currently defined log level.

-
Note
First parameter after lvl must be the message text, which can be a format string with its parameters following like in sprintf
- -
-
- -

◆ PATH_DELIM_STD

- -
-
- - - - -
#define PATH_DELIM_STD   '/'
-
- -
-
- -

◆ SET_THREAD_NAME

- -
-
- - - - - - - - -
#define SET_THREAD_NAME( sName)
-
- -
-
- -

◆ STRCPY_ATMOST

- -
-
- - - - - - - - - - - - - - - - - - -
#define STRCPY_ATMOST( dest,
 src 
)   strncpy_s(dest,sizeof(dest),strAtMost(src,sizeof(dest)-1).c_str(),sizeof(dest)-1)
-
- -
-
- -

◆ STRCPY_S

- -
-
- - - - - - - - - - - - - - - - - - -
#define STRCPY_S( dest,
 src 
)   strncpy_s(dest,sizeof(dest),src,sizeof(dest)-1)
-
- -

Simpler access to strncpy_s if dest is a char array (not a pointer!)

- -
-
- -

◆ THROW_ERROR

- -
-
- - - - - - - - -
#define THROW_ERROR( ...)   throw XPMP2Error(__FILE__, __LINE__, __func__, __VA_ARGS__);
-
- -

Throws an exception using XPMP2Error.

-
Note
First parameter after lvl must be the message text, which can be a format string with its parameters following like in sprintf
- -
-
- -

◆ WHITESPACE

- -
-
- - - - -
#define WHITESPACE   " \t\f\v\r\n"
-
- -
-
- -

◆ XPMP2_FMTARGS

- -
-
- - - - - - - - -
#define XPMP2_FMTARGS( FMT)
-
- -

To apply printf-style warnings to our functions.

-
See also
Taken from imgui.h's definition of IM_FMTARGS
- -
-
-
-
XPMP2::GlobVars::logLvl
logLevelTy logLvl
Logging level.
Definition: XPMP2.h:115
-
XPMP2::GlobVars::bLogMdlMatch
bool bLogMdlMatch
Debug model matching?
Definition: XPMP2.h:117
-
LogMsg
void LogMsg(const char *szMsg,...)
Log a message to X-Plane's Log.txt with sprintf-style parameters.
Definition: XPMP2-Sample.cpp:92
-
XPMP2::logFATAL
@ logFATAL
fatal is shortly before a crash
Definition: Utilities.h:218
-
ERR_EXCEPTION
#define ERR_EXCEPTION
Definition: Utilities.h:31
-
XPMP2::glob
GlobVars glob
The one and only global variable structure.
Definition: Utilities.cpp:29
-
ERR_ASSERT
#define ERR_ASSERT
Definition: Utilities.h:30
- -
-Generated by   -doxygen - 1.8.18 -
- - diff --git a/docs/html/Utilities_8h_source.html b/docs/html/Utilities_8h_source.html deleted file mode 100644 index 958b2631..00000000 --- a/docs/html/Utilities_8h_source.html +++ /dev/null @@ -1,398 +0,0 @@ - - - - - - - -XPMP2: src/Utilities.h Source File - - - - - - -
-
- - - - - - -
-
XPMP2 -
-
X-Plane multiplayer library 2 - using instancing
-
-
- - - - - - - -
-
-
-
Utilities.h
-
-
-Go to the documentation of this file.
1 
-
21 #ifndef _Utilities_h_
-
22 #define _Utilities_h_
-
23 
-
24 namespace XPMP2 {
-
25 
-
26 //
-
27 // MARK: General texts
-
28 //
-
29 
-
30 #define ERR_ASSERT "ASSERT FAILED: %s"
-
31 #define ERR_EXCEPTION "EXCEPTION CAUGHT: %s"
-
32 
-
33 // Required supplemental files
-
34 constexpr const char* RSRC_RELATED = "related.txt";
-
35 constexpr const char* RSRC_DOC8643 = "Doc8643.txt";
-
36 constexpr const char* RSRC_MAP_ICONS = "MapIcons.png";
-
37 constexpr const char* RSRC_OBJ8DATAREFS = "Obj8DataRefs.txt";
-
38 
-
39 //
-
40 // MARK: Default configuration callbacks
-
41 //
-
42 
-
43 int PrefsFuncIntDefault (const char *, const char *, int _default);
-
44 float PrefsFuncFloatDefault (const char *, const char *, float _default);
-
45 
-
46 //
-
47 // MARK: File access helpers
-
48 //
-
49 
-
50 #if IBM
-
51 #define PATH_DELIM_STD '\\'
-
52 #else
-
53 #define PATH_DELIM_STD '/'
-
54 #endif
-
55 
-
57 bool ExistsFile (const std::string& filename);
-
58 
-
60 bool IsDir (const std::string& path);
-
61 
-
64 bool CreateDir(const std::string& path);
-
65 
-
68 bool CopyFileIfNewer(const std::string& source, const std::string& destDir);
-
69 
-
71 std::list<std::string> GetDirContents (const std::string& path);
-
72 
-
74 std::istream& safeGetline(std::istream& is, std::string& t);
-
75 
-
77 std::string StripXPSysDir (const std::string& path);
-
78 
-
80 void RemoveExtension (std::string& path);
-
81 
-
82 //
-
83 // MARK: String helpers
-
84 //
-
85 
-
86 #define WHITESPACE " \t\f\v\r\n"
-
87 
-
89 std::string& str_tolower(std::string& s);
-
90 
-
93 inline std::string& rtrim(std::string& s, const char* t = WHITESPACE)
-
94 {
-
95  s.erase(s.find_last_not_of(t) + 1);
-
96  return s;
-
97 }
-
98 
-
101 inline std::string& ltrim(std::string& s, const char* t = WHITESPACE)
-
102 {
-
103  s.erase(0, s.find_first_not_of(t));
-
104  return s;
-
105 }
-
106 
-
109 inline std::string& trim(std::string& s, const char* t = WHITESPACE)
-
110 {
-
111  return ltrim(rtrim(s, t), t);
-
112 }
-
113 
-
115 std::vector<std::string> str_tokenize (const std::string s,
-
116  const std::string tokens,
-
117  bool bSkipEmpty = true);
-
118 
-
119 //
-
120 // MARK: Math helpers
-
121 //
-
122 
-
124 constexpr double PI = 3.1415926535897932384626433832795028841971693993751;
-
125 
-
127 template <class T>
-
128 inline T rad2deg (const T _rad)
-
129 { return (_rad < T(0) ? T(360) : T(0)) + _rad * T(180) / T(PI); }
-
130 
-
132 template <class T>
-
133 inline T deg2rad (const T _deg)
-
134 { return _deg * T(PI) / T(180); }
-
135 
-
137 template <class T>
-
138 inline T sqr (const T a) { return a*a; }
-
139 
-
141 template <class T>
-
142 inline T dist (const T x1, const T y1, const T z1,
-
143  const T x2, const T y2, const T z2)
-
144 {
-
145  return std::sqrt(sqr(x1-x2) + sqr(y1-y2) + sqr(z1-z2));
-
146 }
-
147 
-
149 inline float atan2deg (float x, float y)
-
150 { return rad2deg(atan2(x,y)); }
-
151 
-
159 inline float angleLocCoord (float x1, float z1, float x2, float z2)
-
160 { return rad2deg(atan2(z2-z1,x2-x1) + float(PI/2.0)); }
-
161 
-
163 float headDiff (float head1, float head2);
-
164 
-
166 template <class numT>
-
167 numT headNormalize (numT _head)
-
168 {
-
169  if (_head < numT(0))
-
170  _head += std::ceil(_head/-numT(360)) * numT(360);
-
171  else if (_head >= numT(360))
-
172  _head -= std::floor(_head/numT(360)) * numT(360);
-
173  return _head;
-
174 }
-
175 
-
176 //
-
177 // MARK: Misc
-
178 //
-
179 
-
181 float GetMiscNetwTime ();
-
182 
-
184 const char* GetGraphicsDriverTxt ();
-
185 
-
191 bool CheckEverySoOften (float& _lastCheck, float _interval, float _now);
-
192 
-
197 inline bool CheckEverySoOften (float& _lastCheck, float _interval)
-
198 { return CheckEverySoOften(_lastCheck, _interval, GetMiscNetwTime()); }
-
199 
-
200 //
-
201 // MARK: Logging Support
-
202 //
-
203 
-
206 #if defined(__clang__) || defined(__GNUC__)
-
207 #define XPMP2_FMTARGS(FMT) __attribute__((format(printf, FMT, FMT+1)))
-
208 #else
-
209 #define XPMP2_FMTARGS(FMT)
-
210 #endif
-
211 
-
213 enum logLevelTy {
-
214  logDEBUG = 0,
-
215  logINFO,
-
216  logWARN,
-
217  logERR,
-
218  logFATAL,
-
219  logMSG
-
220 };
-
221 
-
223 const char* LogGetString ( const char* szFile, int ln, const char* szFunc, logLevelTy lvl, const char* szMsg, va_list args );
-
224 
-
226 void LogMsg ( const char* szFile, int ln, const char* szFunc, logLevelTy lvl, const char* szMsg, ... ) XPMP2_FMTARGS(5);
-
227 
-
228 //
-
229 // MARK: Logging macros
-
230 //
-
231 
-
235 #define LOG_MSG(lvl,...) { \
-
236  if (lvl >= glob.logLvl) \
-
237  {LogMsg(__FILE__, __LINE__, __func__, lvl, __VA_ARGS__);} \
-
238 }
-
239 
-
243 #define LOG_MATCHING(lvl,...) { \
-
244  if (glob.bLogMdlMatch && lvl >= glob.logLvl) \
-
245  {LogMsg(__FILE__, __LINE__, __func__, lvl, __VA_ARGS__);} \
-
246 }
-
247 
-
251 #define THROW_ERROR(...) \
-
252 throw XPMP2Error(__FILE__, __LINE__, __func__, __VA_ARGS__);
-
253 
-
256 #define LOG_ASSERT(cond) \
-
257  if (!(cond)) { \
-
258  THROW_ERROR(ERR_ASSERT,#cond); \
-
259  }
-
260 
-
262 #define CATCH_AC(ac) \
-
263  catch (const std::exception& e) { \
-
264  LOG_MSG(logFATAL, ERR_EXCEPTION, e.what()); \
-
265  (ac).SetInvalid(); \
-
266  } \
-
267  catch (...) { \
-
268  LOG_MSG(logFATAL, ERR_EXCEPTION, "<unknown>"); \
-
269  (ac).SetInvalid(); \
-
270  }
-
271 
-
272 
-
273 //
-
274 // MARK: Compiler differences
-
275 //
-
276 
-
277 #if APL == 1 || LIN == 1
-
278 // not quite the same but close enough for our purposes
-
279 inline void strncpy_s(char * dest, size_t destsz, const char * src, size_t count)
-
280 {
-
281  strncpy(dest, src, std::min(destsz,count)); dest[destsz - 1] = 0;
-
282 }
-
283 
-
284 // these simulate the VC++ version, not the C standard versions!
-
285 inline struct tm *gmtime_s(struct tm * result, const time_t * time)
-
286 { return gmtime_r(time, result); }
-
287 inline struct tm *localtime_s(struct tm * result, const time_t * time)
-
288 { return localtime_r(time, result); }
-
289 
-
290 #endif
-
291 
-
293 #define STRCPY_S(dest,src) strncpy_s(dest,sizeof(dest),src,sizeof(dest)-1)
-
294 #define STRCPY_ATMOST(dest,src) strncpy_s(dest,sizeof(dest),strAtMost(src,sizeof(dest)-1).c_str(),sizeof(dest)-1)
-
295 
-
296 #if IBM != 1
-
297 // XCode/Linux don't provide the _s functions, not even with __STDC_WANT_LIB_EXT1__ 1
-
298 inline int strerror_s( char *buf, size_t bufsz, int errnum )
-
299 { return strerror_r(errnum, buf, bufsz); }
-
300 #endif
-
301 
-
302 // In case of Mac we need to prepare for HFS-to-Posix path conversion
-
303 #if APL
-
304 std::string TOPOSIX (const std::string& p);
-
307 std::string FROMPOSIX (const std::string& p);
-
308 #else
-
309 inline std::string TOPOSIX (const std::string& p) { return p; }
-
312 inline std::string FROMPOSIX (const std::string& p) { return p; }
-
313 #endif
-
314 
-
315 // MARK: Thread names
-
316 #ifdef DEBUG
-
317 // This might not work on older Windows version, which is why we don't publish it in release builds
-
318 #if IBM
-
319 #define SET_THREAD_NAME(sName) SetThreadDescription(GetCurrentThread(), L##sName)
-
320 #elif APL
-
321 #define SET_THREAD_NAME(sName) pthread_setname_np(sName)
-
322 #elif LIN
-
323 #define SET_THREAD_NAME(sName) pthread_setname_np(pthread_self(),sName)
-
324 #endif
-
325 #else
-
326 #define SET_THREAD_NAME(sName)
-
327 #endif
-
328 
-
329 } // namespace XPMP2
-
330 
-
331 #endif
-
-
XPMP2::rad2deg
T rad2deg(const T _rad)
Convert radians to degrees, normalized to [0..360)
Definition: Utilities.h:128
-
XPMP2::XPMP2Error::what
virtual const char * what() const noexcept
returns msg.c_str()
Definition: Utilities.cpp:527
-
XPMP2::logWARN
@ logWARN
warnings, i.e. unexpected, but uncritical events, maybe leading to unwanted display,...
Definition: Utilities.h:216
-
LOG_MSG
#define LOG_MSG(lvl,...)
Log a message if lvl is greater or equal currently defined log level.
Definition: Utilities.h:235
-
THROW_ERROR
#define THROW_ERROR(...)
Throws an exception using XPMP2Error.
Definition: Utilities.h:251
-
XPMP2::GlobVars::logAcronym
std::string logAcronym
Plugin acronym used in log output.
Definition: XPMP2.h:135
-
XPMP2::TOPOSIX
std::string TOPOSIX(const std::string &p)
On Lin/Win there is no need for a conversion, but we do treat p now as std::string
Definition: Utilities.h:310
-
XPMP2::LogGetString
const char * LogGetString(const char *szPath, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg, va_list args)
Returns ptr to static buffer filled with formatted log string.
Definition: Utilities.cpp:541
-
XPMP2::str_tolower
std::string & str_tolower(std::string &s)
change a std::string to uppercase
Definition: Utilities.cpp:397
-
XPMP2::GlobVars::logLvl
logLevelTy logLvl
Logging level.
Definition: XPMP2.h:115
-
XPMP_CFG_ITM_REPLDATAREFS
#define XPMP_CFG_ITM_REPLDATAREFS
Config key: Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to ...
Definition: XPMPMultiplayer.h:261
-
XPMP2::GlobVars::remoteCfg
RemoteCfgTy remoteCfg
Configuration: Are we to support remote connections?
Definition: XPMP2.h:195
-
XPMP2::dist
T dist(const T x1, const T y1, const T z1, const T x2, const T y2, const T z2)
Pythagorean distance between two points in a 3-D world.
Definition: Utilities.h:142
-
XPMP_CFG_ITM_CLAMPALL
#define XPMP_CFG_ITM_CLAMPALL
Config key: Ensure no plane sinks below ground, no matter of XPMP2::Aircraft::bClampToGround.
Definition: XPMPMultiplayer.h:263
-
XPMP2::RemoveExtension
void RemoveExtension(std::string &path)
Removes everything after the last dot, the dot including.
Definition: Utilities.cpp:286
-
XPMP2::GlobVars::bLogMdlMatch
bool bLogMdlMatch
Debug model matching?
Definition: XPMP2.h:117
-
XPMP_CFG_ITM_REPLTEXTURE
#define XPMP_CFG_ITM_REPLTEXTURE
Config key: Replace textures in OBJ8 files upon load if needed (specified on the OBJ8 line in xsb_air...
Definition: XPMPMultiplayer.h:262
-
XPMP2::deg2rad
T deg2rad(const T _deg)
Convert degree to radians.
Definition: Utilities.h:133
-
XPMP2::GlobVars::bHandleDupId
bool bHandleDupId
Handle duplicate XPMP2::Aircraft::modeS_id by overwriting with unique id.
Definition: XPMP2.h:121
-
XPMP2::REMOTE_CFG_CONDITIONALLY
@ REMOTE_CFG_CONDITIONALLY
config: on if in a netwoked/multiplayer setup
Definition: Remote.h:34
-
XPMP2::PI
constexpr double PI
Pi.
Definition: Utilities.h:124
-
XPMP2::logINFO
@ logINFO
regular info messages
Definition: Utilities.h:215
-
XPMP2::safeGetline
std::istream & safeGetline(std::istream &is, std::string &t)
Read a line from a text file, no matter if ending on CRLF or LF.
Definition: Utilities.cpp:255
-
XPMP2::ExistsFile
bool ExistsFile(const std::string &filename)
Does a file path exist?
Definition: Utilities.cpp:138
-
XPMP2::XPMP2Error::msg
std::string msg
additional text message
Definition: XPMPAircraft.h:515
-
XPMP2::RemoteSenderUpdateStatus
void RemoteSenderUpdateStatus()
Compares current vs. expected status and takes appropriate action.
Definition: Remote.cpp:770
-
XPMP2::RSRC_MAP_ICONS
constexpr const char * RSRC_MAP_ICONS
Definition: Utilities.h:36
-
XPMP2::GlobVars::bClampAll
bool bClampAll
Clamp all planes to the ground? Default is false as clamping is kinda expensive due to Y-Testing.
Definition: XPMP2.h:119
-
XPMP2::PrefsFuncFloatDefault
float PrefsFuncFloatDefault(const char *, const char *, float _default)
-
XPMP2::GlobVars::ReadVersions
void ReadVersions()
Read version numbers into verXplane/verXPLM.
Definition: Utilities.cpp:114
-
XPMP2::GlobVars::planeId
XPMPPlaneID planeId
Current plane ID counter.
Definition: XPMP2.h:226
-
XPMP2::rtrim
std::string & rtrim(std::string &s, const char *t=WHITESPACE)
trimming of string (from right)
Definition: Utilities.h:93
-
XPMP2::GlobVars::UsingModernGraphicsDriver
bool UsingModernGraphicsDriver() const
Using a modern graphics driver, ie. Vulkan/Metal?
Definition: XPMP2.h:240
-
XPMP2::LOG_LEVEL
const char * LOG_LEVEL[]
Definition: Utilities.cpp:536
-
XPMP2::logERR
@ logERR
errors mean, aircraft can potentially not be displayed
Definition: Utilities.h:217
-
XPMP2::CheckEverySoOften
bool CheckEverySoOften(float &_lastCheck, float _interval, float _now)
Convenience function to check on something at most every x seconds.
Definition: Utilities.cpp:497
-
XPMP2::GlobVars::NextPlaneId
XPMPPlaneID NextPlaneId()
Get the next unique artifical plane id.
Definition: Utilities.cpp:37
-
XPMP2::FROMPOSIX
std::string FROMPOSIX(const std::string &p)
On Lin/Win there is no need for a conversion, but we do treat p now as std::string
Definition: Utilities.h:312
-
XPMP2::trim
std::string & trim(std::string &s, const char *t=WHITESPACE)
trimming of string (from both ends)
Definition: Utilities.h:109
-
XPMP2::GlobVars::UpdateCfgVals
void UpdateCfgVals()
Update all settings, e.g. for logging level, by calling prefsFuncInt.
Definition: Utilities.cpp:61
-
XPMP2::str_tokenize
std::vector< std::string > str_tokenize(const std::string s, const std::string tokens, bool bSkipEmpty)
separates string into tokens
Definition: Utilities.cpp:404
-
S_ISDIR
#define S_ISDIR(m)
Definition: Utilities.cpp:133
-
XPMP2::PrefsFuncIntDefault
int PrefsFuncIntDefault(const char *, const char *, int _default)
Default config function just always returns the provided default value.
Definition: Utilities.cpp:55
-
XPMP2::GlobVars::verXPLM
int verXPLM
XPLM's SDK version number (XPLMGetVersions)
Definition: XPMP2.h:206
-
WHITESPACE
#define WHITESPACE
Definition: Utilities.h:86
-
XPMP_CFG_SEC_DEBUG
#define XPMP_CFG_SEC_DEBUG
Config section "debug".
Definition: XPMPMultiplayer.h:258
-
XPMP_CFG_ITM_SUPPORT_REMOTE
#define XPMP_CFG_ITM_SUPPORT_REMOTE
Config key: Support remote connections? <0 force off, 0 default: on if in a networked or multiplayer ...
Definition: XPMPMultiplayer.h:265
-
XPMP_CFG_SEC_MODELS
#define XPMP_CFG_SEC_MODELS
Config section "models".
Definition: XPMPMultiplayer.h:256
-
XPMP_CFG_ITM_HANDLE_DUP_ID
#define XPMP_CFG_ITM_HANDLE_DUP_ID
Config key: Boolean: If XPMP2::Aircraft::modeS_id already exists then assign a new unique one,...
Definition: XPMPMultiplayer.h:264
-
XPMP2::headDiff
float headDiff(float head1, float head2)
(Shortest) difference between 2 angles: How much to turn to go from h1 to h2?
Definition: Utilities.cpp:451
-
XPMP2::GlobVars::verXPlane
int verXPlane
X-Plane's version number (XPLMGetVersions)
Definition: XPMP2.h:204
-
XPMP2::IsDir
bool IsDir(const std::string &path)
Is path a directory?
Definition: Utilities.cpp:145
-
XPMP2::CreateDir
bool CreateDir(const std::string &path)
Create directory if it does not exist.
Definition: Utilities.cpp:154
-
XPMP2::GlobVars::bXPUsingModernGraphicsDriver
bool bXPUsingModernGraphicsDriver
Using a modern graphics driver, ie. Vulkan/Metal?
Definition: XPMP2.h:208
-
XPMP2::atan2deg
float atan2deg(float x, float y)
atan2 converted to degrees: the angle between (0|0) and the given point
Definition: Utilities.h:149
-
MIN_MODE_S_ID
constexpr XPMPPlaneID MIN_MODE_S_ID
Minimum allowed XPMPPlaneID / mode S id.
Definition: XPMPMultiplayer.h:246
-
XPMP_CFG_ITM_MODELMATCHING
#define XPMP_CFG_ITM_MODELMATCHING
Config key: Write information on model matching into Log.txt
Definition: XPMPMultiplayer.h:267
-
XPMP2::GlobVars::prefsFuncInt
int(* prefsFuncInt)(const char *, const char *, int)
Configuration callback for integer values.
Definition: XPMP2.h:138
-
XPMP2::REMOTE_CFG_ON
@ REMOTE_CFG_ON
config: force on
Definition: Remote.h:35
-
MAX_MODE_S_ID
constexpr XPMPPlaneID MAX_MODE_S_ID
Maximum allowed XPMPPlaneID / mode S id.
Definition: XPMPMultiplayer.h:248
-
XPMP2::angleLocCoord
float angleLocCoord(float x1, float z1, float x2, float z2)
Angle of line from point (x1|z1) to point (x2|z2)
Definition: Utilities.h:159
-
XPMP2::PJWHash16
std::uint16_t PJWHash16(const char *s)
Produces a reproducible(!) hash value for strings.
Definition: Utilities.cpp:430
-
XPMP2::logDEBUG
@ logDEBUG
Debug, highest level of detail.
Definition: Utilities.h:214
-
XPMP2::GlobVars::bXPNetworkedSetup
bool bXPNetworkedSetup
Is X-Plane configured for networked multi-computer or multiplayer setup?
Definition: XPMP2.h:210
-
XPMP2::REMOTE_CFG_OFF
@ REMOTE_CFG_OFF
config: force off
Definition: Remote.h:33
-
XPMP2_FMTARGS
#define XPMP2_FMTARGS(FMT)
To apply printf-style warnings to our functions.
Definition: Utilities.h:209
-
XPMP2.h
Header file covering all includes required for compiling XPMP2, basis for pre-compiled headers.
-
XPMP2::LogMsg
void LogMsg(const char *szPath, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg,...)
Log Text to log file.
Definition: Utilities.cpp:586
-
XPMP2::GlobVars::bObjReplDataRefs
bool bObjReplDataRefs
Replace dataRefs in .obj files on load? (defaults to OFF!)
Definition: XPMP2.h:124
-
XPMP2::logFATAL
@ logFATAL
fatal is shortly before a crash
Definition: Utilities.h:218
-
XPMP2::sqr
T sqr(const T a)
Square.
Definition: Utilities.h:138
-
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:243
-
XPMP2::GetDirContents
std::list< std::string > GetDirContents(const std::string &path)
List of files in a directory (wrapper around XPLMGetDirectoryContents)
Definition: Utilities.cpp:222
-
XPMP_CFG_ITM_LOGLEVEL
#define XPMP_CFG_ITM_LOGLEVEL
Config key: General level of logging into Log.txt (0 = Debug, 1 = Info, 2 = Warning,...
Definition: XPMPMultiplayer.h:266
-
XPMP2::glob
GlobVars glob
The one and only global variable structure.
Definition: Utilities.cpp:29
-
PATH_DELIM_STD
#define PATH_DELIM_STD
Definition: Utilities.h:53
-
XPMP2::StripXPSysDir
std::string StripXPSysDir(const std::string &path)
If a path starts with X-Plane's system directory it is stripped.
Definition: Utilities.cpp:268
-
XPMP2::logLevelTy
logLevelTy
Logging level.
Definition: Utilities.h:213
-
XPMP2::CopyFileIfNewer
bool CopyFileIfNewer(const std::string &source, const std::string &destDir)
Copy file if source is newer or destination missing.
Definition: Utilities.cpp:169
-
XPMP2::RSRC_OBJ8DATAREFS
constexpr const char * RSRC_OBJ8DATAREFS
Definition: Utilities.h:37
-
XPMP2::GlobVars::bObjReplTextures
bool bObjReplTextures
Replace textures in .obj files on load if needed?
Definition: XPMP2.h:126
-
XPMP2::RSRC_DOC8643
constexpr const char * RSRC_DOC8643
Definition: Utilities.h:35
-
XPMP_CFG_SEC_PLANES
#define XPMP_CFG_SEC_PLANES
Config section "planes".
Definition: XPMPMultiplayer.h:257
-
XPMP2::logMSG
@ logMSG
will always be output, no matter what has been configured, cannot be suppressed
Definition: Utilities.h:219
-
XPMP2
Definition: XPMPAircraft.h:39
-
XPMP2::strerror_s
int strerror_s(char *buf, size_t bufsz, int errnum)
Definition: Utilities.h:298
-
XPMP2::ltrim
std::string & ltrim(std::string &s, const char *t=WHITESPACE)
trimming of string (from left)
Definition: Utilities.h:101
-
XPMP2::GetGraphicsDriverTxt
const char * GetGraphicsDriverTxt()
Text string for current graphics driver in use.
Definition: Utilities.cpp:483
-
XPMP2::RSRC_RELATED
constexpr const char * RSRC_RELATED
Definition: Utilities.h:34
-
XPMP2::GetMiscNetwTime
float GetMiscNetwTime()
Get synched network time from X-Plane (sim/network/misc/network_time_sec) as used in Log....
Definition: Utilities.cpp:474
-
LOG_ASSERT
#define LOG_ASSERT(cond)
Throw in an assert-style (logging takes place in XPMP2Error constructor)
Definition: Utilities.h:256
-
XPMP2::GlobVars::mapAc
mapAcTy mapAc
Global map of all created planes.
Definition: XPMP2.h:163
-
XPMP2::headNormalize
numT headNormalize(numT _head)
Normalize a heading value to [0..360), works for both float and double values.
Definition: Utilities.h:167
-
XPMP2::XPMP2Error::XPMP2Error
XPMP2Error(const char *szFile, int ln, const char *szFunc, const char *szMsg,...)
Constructor puts together a formatted exception text.
Definition: Utilities.cpp:512
- -
-Generated by   -doxygen - 1.8.18 -
- - diff --git a/docs/html/XPCAircraft_8h.html b/docs/html/XPCAircraft_8h.html index fbfa6b3b..50d2bf7f 100644 --- a/docs/html/XPCAircraft_8h.html +++ b/docs/html/XPCAircraft_8h.html @@ -50,7 +50,7 @@
-

XPMP2::Aircraft / XPCAircraft represent an aircraft as managed by XPMP2. +

XPMP2::Aircraft / XPCAircraft represent an aircraft as managed by XPMP2. More...

#include "XPMPAircraft.h"
@@ -63,8 +63,8 @@

 

Detailed Description

-

XPMP2::Aircraft / XPCAircraft represent an aircraft as managed by XPMP2.

-
Deprecated:
XPCAircraft bases on and is compile-compatible to the XPCAircraft wrapper class provided with the original libxplanemp. In XPMP2, however, this class is not a wrapper but derived from XPMP2::Aircraft, which is the actual means of managing aircraft, Hence, it includes a lot more members.
+

XPMP2::Aircraft / XPCAircraft represent an aircraft as managed by XPMP2.

+
Deprecated:
XPCAircraft bases on and is compile-compatible to the XPCAircraft wrapper class provided with the original libxplanemp. In XPMP2, however, this class is not a wrapper but derived from XPMP2::Aircraft, which is the actual means of managing aircraft, Hence, it includes a lot more members.
New implementations should derive directly from XPMP2::Aircraft.
Author
Birger Hoppe
Copyright
The original XPCAircraft.h file in libxplanemp had no copyright note.
diff --git a/docs/html/XPCAircraft_8h_source.html b/docs/html/XPCAircraft_8h_source.html index 0ca3f360..5c7a0251 100644 --- a/docs/html/XPCAircraft_8h_source.html +++ b/docs/html/XPCAircraft_8h_source.html @@ -80,24 +80,24 @@
74 
75 #endif
XPMPAircraft.h
XPMP2::Aircraft represent an aircraft as managed by XPMP2.
-
XPMPPlaneCallbackResult
XPMPPlaneCallbackResult
Definfes the different responses to asking for information.
Definition: XPMPMultiplayer.h:231
-
xpmpData_Unavailable
@ xpmpData_Unavailable
Definition: XPMPMultiplayer.h:232
-
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:243
-
XPMPInfoTexts_t
Textual information of planes to be passed on via shared dataRefs to other plugins.
Definition: XPMPMultiplayer.h:199
-
XPMPPlanePosition_t
This data structure contains the basic position info for an aircraft.
Definition: XPMPMultiplayer.h:79
-
XPMPPlaneRadar_t
defines information about an aircraft visible to radar.
Definition: XPMPMultiplayer.h:189
-
XPMPPlaneSurfaces_t
External physical configuration of the plane.
Definition: XPMPMultiplayer.h:147
+
XPMPPlaneCallbackResult
XPMPPlaneCallbackResult
Definfes the different responses to asking for information.
Definition: XPMPMultiplayer.h:240
+
xpmpData_Unavailable
@ xpmpData_Unavailable
Definition: XPMPMultiplayer.h:241
+
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:252
+
XPMPInfoTexts_t
Textual information of planes to be passed on via shared dataRefs to other plugins.
Definition: XPMPMultiplayer.h:208
+
XPMPPlanePosition_t
This data structure contains the basic position info for an aircraft.
Definition: XPMPMultiplayer.h:88
+
XPMPPlaneRadar_t
defines information about an aircraft visible to radar.
Definition: XPMPMultiplayer.h:198
+
XPMPPlaneSurfaces_t
External physical configuration of the plane.
Definition: XPMPMultiplayer.h:156
XPCAircraft
Legacy wrapper class as provided by original libxplanemp.
Definition: XPCAircraft.h:37
-
XPCAircraft::UpdatePosition
virtual void UpdatePosition(float _elapsedSinceLastCall, int _flCounter)
Just calls all 4 previous Get... functions and copies the provided values into drawInfo and v
Definition: Aircraft.cpp:924
+
XPCAircraft::UpdatePosition
virtual void UpdatePosition(float _elapsedSinceLastCall, int _flCounter)
Just calls all 4 previous Get... functions and copies the provided values into drawInfo and v
Definition: Aircraft.cpp:954
XPCAircraft::acPos
XPMPPlanePosition_t acPos
Last position data. GetPlanePosition() passes a pointer to this member variable.
Definition: XPCAircraft.h:41
XPCAircraft::GetPlaneSurfaces
virtual XPMPPlaneCallbackResult GetPlaneSurfaces(XPMPPlaneSurfaces_t *outSurfaces)=0
Legacy: Called before rendering to query plane's current configuration, overwrite to provide your imp...
XPCAircraft::acSurfaces
XPMPPlaneSurfaces_t acSurfaces
Last surface data. GetPlaneSurfaces() passes a pointer to this member variable.
Definition: XPCAircraft.h:43
XPCAircraft::GetPlanePosition
virtual XPMPPlaneCallbackResult GetPlanePosition(XPMPPlanePosition_t *outPosition)=0
Legacy: Called before rendering to query plane's current position, overwrite to provide your implemen...
XPCAircraft::GetInfoTexts
virtual XPMPPlaneCallbackResult GetInfoTexts(XPMPInfoTexts_t *)
Legacy: Called before rendering to query plane's textual information, overwrite to provide your imple...
Definition: XPCAircraft.h:67
XPCAircraft::GetPlaneRadar
virtual XPMPPlaneCallbackResult GetPlaneRadar(XPMPPlaneRadar_t *outRadar)=0
Legacy: Called before rendering to query plane's current radar visibility, overwrite to provide your ...
-
XPCAircraft::XPCAircraft
XPCAircraft(const char *_icaoType, const char *_icaoAirline, const char *_livery, XPMPPlaneID _modeS_id=0, const char *_modelId=nullptr)
Legacy constructor creates a plane and puts it under control of XPlaneMP.
Definition: Aircraft.cpp:914
-
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:147
-
XPMP2
Definition: XPMPAircraft.h:41
+
XPCAircraft::XPCAircraft
XPCAircraft(const char *_icaoType, const char *_icaoAirline, const char *_livery, XPMPPlaneID _modeS_id=0, const char *_modelId=nullptr)
Legacy constructor creates a plane and puts it under control of XPlaneMP.
Definition: Aircraft.cpp:944
+
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:181
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
diff --git a/docs/html/XPMP2-Remote_8cpp.html b/docs/html/XPMP2-Remote_8cpp.html index ff4c297a..9ee30c38 100644 --- a/docs/html/XPMP2-Remote_8cpp.html +++ b/docs/html/XPMP2-Remote_8cpp.html @@ -52,7 +52,7 @@
-

XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network. +

XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network. More...

#include "XPMP2-Remote.h"
@@ -121,22 +121,22 @@
 

Detailed Description

-

XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network.

+

XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network.

This plugin is intended to be used in a multi-computer simulator setup, usually in the PCs used for external visuals.
The typical setup would be:

  • There is a multi-computer setup of one X-Plane Master PC, which also runs one or more XPMP2-based plugins like LiveTraffic, which create additional traffic, let's call them "traffic master".
    • -
  • Other PCs serve to compute additional external visuals. For them to be able to show the very same additional traffic they run XPMP2 Remote Client, which will display a copy of the traffic generated by the XPMP2-based plugin on the master.
    • +
  • Other PCs serve to compute additional external visuals. For them to be able to show the very same additional traffic they run XPMP2 Remote Client, which will display a copy of the traffic generated by the XPMP2-based plugin on the master.

Technically, this works as follows:

  • The "traffic masters" will first listen on the network if anyone is interested in their data.
    • -
  • The XPMP2 Remote Client will first send a "beacon of interest" message to the network.
    • +
  • The XPMP2 Remote Client will first send a "beacon of interest" message to the network.
  • This messages tells the master plugins to start feeding their data.
  • All communication is UDP multicast on the same multicast group that X-Plane uses, too: 239.255.1.1, but on a different port: 49788
  • This generic way allows for many different setups:
    • While the above might be typical, it is not of interest if the "traffic master" is running on the X-Plane Master or any other X-Plane instance in the network, for example to better balance the load.
    • It could even be an X-Plane PC not included in the External Visuals setup, like for example in a Networked Multiplayer setup.
      • -
    • Multiple XPMP2-based traffic masters can be active, and they can even run on different PCs. The one XPMP2 Remote Client per PC will still collect all traffic.
      • -
    • If several traffic masters run on different PCs, then all PCs, including the ones running one of the traffic masters, will need to run the XPMP2 Remote Client, so that they pick up the traffic generated on the other traffic masters.
      • +
    • Multiple XPMP2-based traffic masters can be active, and they can even run on different PCs. The one XPMP2 Remote Client per PC will still collect all traffic.
      • +
    • If several traffic masters run on different PCs, then all PCs, including the ones running one of the traffic masters, will need to run the XPMP2 Remote Client, so that they pick up the traffic generated on the other traffic masters.
@@ -224,7 +224,7 @@

-

This is a callback the XPMP2 calls regularly to learn about configuration settings. Only 3 are left, all of them integers.

+

This is a callback the XPMP2 calls regularly to learn about configuration settings. Only 3 are left, all of them integers.

diff --git a/docs/html/XPMP2-Remote_8h.html b/docs/html/XPMP2-Remote_8h.html index 47cc0dbe..5ce2b450 100644 --- a/docs/html/XPMP2-Remote_8h.html +++ b/docs/html/XPMP2-Remote_8h.html @@ -51,7 +51,7 @@
-

XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network. +

XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network. More...

#include <cassert>
#include <cstdio>
@@ -94,32 +94,32 @@  ID used in own log entries. More...
  constexpr const char * REMOTE_CLIENT_LOG2 = "RC" - Short ID used in XPMP2 log entries. More...
+ Short ID used in XPMP2 log entries. More...
  constexpr float REMOTE_CLIENT_VER = 1.20f - Version number for the XPMP2 Remote plugin. More...
+ Version number for the XPMP2 Remote plugin. More...
  XPMP2RCGlobals rcGlob  the one and only instance of XPMP2RCGlobals More...
 

Detailed Description

-

XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network.

+

XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network.

This plugin is intended to be used in a multi-computer simulator setup, usually in the PCs used for external visuals.
The typical setup would be:

  • There is a multi-computer setup of one X-Plane Master PC, which also runs one or more XPMP2-based plugins like LiveTraffic, which create additional traffic, let's call them "traffic master".
    • -
  • Other PCs serve to compute additional external visuals. For them to be able to show the very same additional traffic they run XPMP2 Remote Client, which will display a copy of the traffic generated by the XPMP2-based plugin on the master.
    • +
  • Other PCs serve to compute additional external visuals. For them to be able to show the very same additional traffic they run XPMP2 Remote Client, which will display a copy of the traffic generated by the XPMP2-based plugin on the master.

Technically, this works as follows:

  • The "traffic masters" will first listen on the network if anyone is interested in their data.
    • -
  • The XPMP2 Remote Client will first send a "beacon of interest" message to the network.
    • +
  • The XPMP2 Remote Client will first send a "beacon of interest" message to the network.
  • This messages tells the master plugins to start feeding their data.
  • All communication is UDP multicast on the same multicast group that X-Plane uses, too: 239.255.1.1, but on a different port: 49788
  • This generic way allows for many different setups:
    • While the above might be typical, it is not of interest if the "traffic master" is running on the X-Plane Master or any other X-Plane instance in the network, for example to better balance the load.
    • It could even be an X-Plane PC not included in the External Visuals setup, like for example in a Networked Multiplayer setup.
      • -
    • Multiple XPMP2-based traffic masters can be active, and they can even run on different PCs. The one XPMP2 Remote Client per PC will still collect all traffic.
      • -
    • If several traffic masters run on different PCs, then all PCs, including the ones running one of the traffic masters, will need to run the XPMP2 Remote Client, so that they pick up the traffic generated on the other traffic masters.
      • +
    • Multiple XPMP2-based traffic masters can be active, and they can even run on different PCs. The one XPMP2 Remote Client per PC will still collect all traffic.
      • +
    • If several traffic masters run on different PCs, then all PCs, including the ones running one of the traffic masters, will need to run the XPMP2 Remote Client, so that they pick up the traffic generated on the other traffic masters.
@@ -202,7 +202,7 @@

-

Short ID used in XPMP2 log entries.

+

Short ID used in XPMP2 log entries.

@@ -250,7 +250,7 @@

-

Version number for the XPMP2 Remote plugin.

+

Version number for the XPMP2 Remote plugin.

diff --git a/docs/html/XPMP2-Sample_8cpp.html b/docs/html/XPMP2-Sample_8cpp.html index ccd57519..4339e890 100644 --- a/docs/html/XPMP2-Sample_8cpp.html +++ b/docs/html/XPMP2-Sample_8cpp.html @@ -45,6 +45,7 @@
Classes | +Enumerations | Functions | Variables
@@ -52,7 +53,7 @@
-

Example plugin demonstrating XPMP2 techniques. +

Example plugin demonstrating XPMP2 techniques. More...

#include <cstdio>
#include <cstdarg>
@@ -79,12 +80,28 @@  Subclassing XPCAircraft to create our own class. More...
  + + + + +

+Enumerations

enum  MenuItemsTy {
+  MENU_PLANES = 0 +, MENU_VISIBLE +, MENU_FREEZE +, MENU_CYCLE_MDL +,
+  MENU_REMATCH_MDL +, MENU_AI +
+ }
 List of all menu item indexes. More...
 
+ @@ -122,7 +139,7 @@ - + @@ -165,6 +182,9 @@ Variables + + + @@ -212,8 +232,8 @@

Functions

void LogMsg (const char *szMsg,...)
 Log a message to X-Plane's Log.txt with sprintf-style parameters. More...
 
int CBIntPrefsFunc (const char *, [[maybe_unused]] const char *item, int defaultVal)
 This is a callback the XPMP2 calls regularly to learn about configuration settings. More...
 
void CBPlaneNotifier (XPMPPlaneID inPlaneID, XPMPPlaneNotification inNotification, void *)
 
 Handles requests for plane's informational texts. More...
 
XPMPPlaneCallbackResult CBPlaneData (XPMPPlaneID inPlane, XPMPPlaneDataType inDataType, void *ioData, void *)
 Callback function handed to XPMP2, will be called in every drawing frame to deliver plane position and configuration. More...
 Callback function handed to XPMP2, will be called in every drawing frame to deliver plane position and configuration. More...
 
bool ArePlanesCreated ()
 Is any plane object created? More...
std::string PLANE_MODEL [3][3]
 
bool gbFreeze = false
 Freeze all movements at the moment? More...
 
constexpr float PLANE_DIST_M = 200.0f
 Distance of our simulated planes to the user's plane's position? [m]. More...
 
 

Detailed Description

-

Example plugin demonstrating XPMP2 techniques.

-

This plugin creates 3 planes, one with each of the available ways of using the XPMP2 library. All planes move in a circle around a position 200m in front of the user's plane (even if the user plane moves).

+

Example plugin demonstrating XPMP2 techniques.

+

This plugin creates 3 planes, one with each of the available ways of using the XPMP2 library. All planes move in a circle around a position 200m in front of the user's plane (even if the user plane moves).

  1. Subclassing XPMP2::Aircraft, which is the recommended way. This plane flies highest, 100m above the user plane.
  2. Subclassing the legacy class XPCAircraft. This plane flies in the middle, 50m above the user plane.
    3. @@ -281,6 +301,37 @@

    ◆ +

+
+

Enumeration Type Documentation

+ +

◆ MenuItemsTy

+ +
+
+ + + + +
enum MenuItemsTy
+
+ +

List of all menu item indexes.

+ + + + + + + +
Enumerator
MENU_PLANES 

Menu Item "Toggle Planes".

+
MENU_VISIBLE 

Menu Item "Toggle Visibility".

+
MENU_FREEZE 

Menu Item "Freeze".

+
MENU_CYCLE_MDL 

Menu Item "Cycle Models".

+
MENU_REMATCH_MDL 

Menu Item "Rematch Models".

+
MENU_AI 

Menu Item "Toggle AI control".

+
+

Function Documentation

@@ -342,7 +393,8 @@

-

This is a callback the XPMP2 calls regularly to learn about configuration settings. Only 3 are left, all of them integers.

+ +

This is a callback the XPMP2 calls regularly to learn about configuration settings.

@@ -414,7 +466,7 @@

-

Callback function handed to XPMP2, will be called in every drawing frame to deliver plane position and configuration.

+

Callback function handed to XPMP2, will be called in every drawing frame to deliver plane position and configuration.

@@ -604,9 +656,6 @@

- - - +
@@ -615,11 +664,6 @@

-inline -

-
float GetTimeFragment

Returns a number between 0.0 and 1.0, increasing over the course of 10 seconds, then restarting.

@@ -631,9 +675,6 @@

- - - - + + + + - +
@@ -642,11 +683,6 @@

-inline -

-
float GetTimeUpDown

Returns a number between 0.0 and 1.0, going up and down over the course of 10 seconds.

@@ -1048,6 +1084,22 @@

Variable Documentation

+ +

◆ gbFreeze

+ +
+
+ + + + +
bool gbFreeze = false
+
+ +

Freeze all movements at the moment?

+ +
+

◆ gbMapLabels

@@ -1240,7 +1292,7 @@

{ "B06", "TXB", "" },

{ "A321", "", "" },
}
-

Initial type / airline / livery to be used to create our 3 planes

See also
https://www.icao.int/publications/DOC8643/Pages/Search.aspx for ICAO aircraft types
+

Initial type / airline / livery to be used to create our 3 planes

See also
https://www.icao.int/publications/DOC8643/Pages/Search.aspx for ICAO aircraft types
https://forums.x-plane.org/index.php?/files/file/37041-bluebell-obj8-csl-packages/ for the Bluebell package, which includes the models named here
diff --git a/docs/html/XPMP2_8h.html b/docs/html/XPMP2_8h.html index d18f042a..af502a05 100644 --- a/docs/html/XPMP2_8h.html +++ b/docs/html/XPMP2_8h.html @@ -55,7 +55,7 @@
-

Header file covering all includes required for compiling XPMP2, basis for pre-compiled headers. +

Header file covering all includes required for compiling XPMP2, basis for pre-compiled headers. More...

#include "XPMPMultiplayer.h"
#include "XPMPAircraft.h"
@@ -100,6 +100,7 @@ #include "Map.h"
#include "Network.h"
#include "Remote.h"
+#include "Sound.h"

Go to the source code of this file.

@@ -115,14 +116,13 @@ +

Namespaces

 XPMP2
 Defined by FMOD.
 
- -

Macros

#define UNKNOWN_PLUGIN_NAME   "(unknown)"
 
#define UPDATE_CYCLE_NUM
 
@@ -138,11 +138,11 @@ - +

Typedefs

Variables

constexpr float XPMP2::XPMP2_VER = XPMP2_VER_MAJOR + float(XPMP2_VER_MINOR) / 100.0f
 XPMP2 version number. More...
 XPMP2 version number. More...
 

Detailed Description

-

Header file covering all includes required for compiling XPMP2, basis for pre-compiled headers.

+

Header file covering all includes required for compiling XPMP2, basis for pre-compiled headers.

Author
Birger Hoppe
Copyright
(c) 2020 Birger Hoppe
@@ -162,20 +162,6 @@

-

-
- -

◆ UPDATE_CYCLE_NUM

- -
-
- - - - -
#define UPDATE_CYCLE_NUM
-
-
diff --git a/docs/html/XPMP2_8h_source.html b/docs/html/XPMP2_8h_source.html index 643b160e..e1171481 100644 --- a/docs/html/XPMP2_8h_source.html +++ b/docs/html/XPMP2_8h_source.html @@ -57,186 +57,191 @@
27 #include <ws2ipdef.h> // required for sockaddr_in6 (?)
28 #include <iphlpapi.h> // for GetAdaptersAddresses
29 #include <ws2tcpip.h>
-
30 #endif
-
31 
-
32 // XPlaneMP 2 - Public Header Files
-
33 #include "XPMPMultiplayer.h"
-
34 #include "XPMPAircraft.h"
-
35 #include "XPCAircraft.h"
-
36 #include "XPMPPlaneRenderer.h"
-
37 #include "XPMPRemote.h"
-
38 
-
39 // Standard C
-
40 #include <sys/stat.h>
-
41 #include <cmath>
-
42 #include <cstdarg>
-
43 #include <cassert>
-
44 
-
45 // Standard C++
-
46 #include <string>
-
47 #include <list>
-
48 #include <map>
-
49 #include <array>
-
50 #include <vector>
-
51 #include <queue>
-
52 #include <valarray>
-
53 #include <algorithm>
-
54 #include <numeric>
-
55 #include <fstream>
-
56 #include <future>
-
57 #include <thread>
-
58 #include <shared_mutex>
-
59 #include <regex>
-
60 #include <bitset>
-
61 
-
62 // X-Plane SDK
-
63 #include "XPLMUtilities.h"
-
64 #include "XPLMScenery.h"
-
65 #include "XPLMProcessing.h"
-
66 #include "XPLMGraphics.h"
-
67 #include "XPLMDataAccess.h"
-
68 #include "XPLMPlugin.h"
-
69 #include "XPLMDisplay.h"
-
70 #include "XPLMCamera.h"
-
71 #include "XPLMPlanes.h"
-
72 #include "XPLMMap.h"
-
73 
-
74 // XPlaneMP 2 - Internal Header Files
-
75 #include "Utilities.h"
-
76 #include "RelatedDoc8643.h"
-
77 #include "CSLModels.h"
-
78 #include "Aircraft.h"
-
79 #include "2D.h"
-
80 #include "AIMultiplayer.h"
-
81 #include "Map.h"
-
82 #include "Network.h"
-
83 #include "Remote.h"
-
84 
-
85 // On Windows, 'max' and 'min' are defined macros in conflict with C++ library. Let's undefine them!
-
86 #if IBM
-
87 #include <direct.h>
-
88 #undef max
-
89 #undef min
-
90 #endif
-
91 
+
30 // On Windows, 'max' and 'min' are defined macros in conflict with C++ library. Let's undefine them!
+
31 #include <direct.h>
+
32 #undef max
+
33 #undef min
+
34 #endif
+
35 
+
36 // XPlaneMP 2 - Public Header Files
+
37 #include "XPMPMultiplayer.h"
+
38 #include "XPMPAircraft.h"
+
39 #include "XPCAircraft.h"
+
40 #include "XPMPPlaneRenderer.h"
+
41 #include "XPMPRemote.h"
+
42 
+
43 // Standard C
+
44 #include <sys/stat.h>
+
45 #include <cmath>
+
46 #include <cstdarg>
+
47 #include <cassert>
+
48 
+
49 // Standard C++
+
50 #include <string>
+
51 #include <list>
+
52 #include <map>
+
53 #include <array>
+
54 #include <vector>
+
55 #include <queue>
+
56 #include <valarray>
+
57 #include <algorithm>
+
58 #include <numeric>
+
59 #include <fstream>
+
60 #include <future>
+
61 #include <thread>
+
62 #include <shared_mutex>
+
63 #include <regex>
+
64 #include <bitset>
+
65 
+
66 // X-Plane SDK
+
67 #include "XPLMUtilities.h"
+
68 #include "XPLMScenery.h"
+
69 #include "XPLMProcessing.h"
+
70 #include "XPLMGraphics.h"
+
71 #include "XPLMDataAccess.h"
+
72 #include "XPLMPlugin.h"
+
73 #include "XPLMDisplay.h"
+
74 #include "XPLMCamera.h"
+
75 #include "XPLMPlanes.h"
+
76 #include "XPLMMap.h"
+
77 
+
78 // XPlaneMP 2 - Internal Header Files
+
79 #include "Utilities.h"
+
80 #include "RelatedDoc8643.h"
+
81 #include "CSLModels.h"
+
82 #include "Aircraft.h"
+
83 #include "2D.h"
+
84 #include "AIMultiplayer.h"
+
85 #include "Map.h"
+
86 #include "Network.h"
+
87 #include "Remote.h"
+
88 #include "Sound.h"
+
89 
+
90 //
+
91 // MARK: Global Configurations and variables
92 //
-
93 // MARK: Global Configurations and variables
-
94 //
+
93 
+
94 #define UNKNOWN_PLUGIN_NAME "(unknown)"
95 
-
96 #define UNKNOWN_PLUGIN_NAME "(unknown)"
+
96 namespace XPMP2 {
97 
-
98 namespace XPMP2 {
-
99 
-
101 constexpr float XPMP2_VER = XPMP2_VER_MAJOR + float(XPMP2_VER_MINOR) / 100.0f;
-
102 
-
104 struct XPMPPlaneNotifierTy {
-
105  XPMPPlaneNotifier_f func = nullptr;
-
106  void* refcon = nullptr;
-
107 
-
108  XPMPPlaneNotifierTy (XPMPPlaneNotifier_f _func = nullptr, void* _refcon = nullptr) :
-
109  func(_func), refcon(_refcon) {}
-
110 
-
111  bool operator == (const XPMPPlaneNotifierTy& o)
-
112  { return func == o.func && refcon == o.refcon; }
-
113 };
+
99 constexpr float XPMP2_VER = XPMP2_VER_MAJOR + float(XPMP2_VER_MINOR) / 100.0f;
+
100 
+
102 struct XPMPPlaneNotifierTy {
+
103  XPMPPlaneNotifier_f func = nullptr;
+
104  void* refcon = nullptr;
+
105 
+
106  XPMPPlaneNotifierTy (XPMPPlaneNotifier_f _func = nullptr, void* _refcon = nullptr) :
+
107  func(_func), refcon(_refcon) {}
+
108 
+
109  bool operator == (const XPMPPlaneNotifierTy& o)
+
110  { return func == o.func && refcon == o.refcon; }
+
111 };
+
112 
+
113 typedef std::list<XPMPPlaneNotifierTy> listXPMPPlaneNotifierTy;
114 
-
115 typedef std::list<XPMPPlaneNotifierTy> listXPMPPlaneNotifierTy;
-
116 
-
118 void XPMPSendNotification (const Aircraft& plane, XPMPPlaneNotification _notification);
-
119 
-
121 struct GlobVars {
-
122 public:
-
123  // Settings:
-
125  logLevelTy logLvl = logINFO;
-
127  bool bLogMdlMatch= false;
-
129  bool bClampAll = false;
-
131  bool bHandleDupId= false;
-
132 
-
134  bool bObjReplDataRefs = false;
-
136  bool bObjReplTextures = true;
-
138  std::string pathObj8DataRefs;
-
140  listObj8DataRefsTy listObj8DataRefs;
-
141 
-
143  std::string pluginName = UNKNOWN_PLUGIN_NAME;
-
145  std::string logAcronym = UNKNOWN_PLUGIN_NAME;
-
146 
-
148  int (*prefsFuncInt)(const char *, const char *, int) = XPMP2::PrefsFuncIntDefault;
-
150  listXPMPPlaneNotifierTy listObservers;
-
151 
-
153  std::string pathDoc8643;
-
155  mapDoc8643Ty mapDoc8643;
-
157  std::string pathRelated;
-
159  mapRelatedTy mapRelated;
-
160 
-
162  mapCSLPackageTy mapCSLPkgs;
-
164  mapCSLModelTy mapCSLModels;
-
166  std::string defaultICAO = "A320";
-
168  std::string carIcaoType = "ZZZC";
-
170  std::string resourceDir;
-
171 
-
173  mapAcTy mapAc;
-
175  bool bDrawLabels = true;
-
177  float maxLabelDist = 5556.0f;
-
179  bool bLabelCutOffAtVisibility = true;
-
181  float labelFontScaling = 1.0f;
-
182 
-
184  bool bHasControlOfAIAircraft = false;
-
185 
-
187  bool bMapEnabled = true;
-
189  bool bMapLabels = true;
-
191  mapMapLayerIDTy mapMapLayers;
-
193  std::string pathMapIcons;
-
194 
-
197  std::string remoteMCGroup = "239.255.1.1";
-
199  int remotePort = 49788;
-
201  int remoteTTL = 8;
-
203  size_t remoteBufSize = 8192;
-
205  int remoteTxfFrequ = 5;
-
207  RemoteCfgTy remoteCfg = REMOTE_CFG_AUTO;
-
209  RemoteCfgTy remoteCfgFromIni= REMOTE_CFG_AUTO;
-
211  RemoteStatusTy remoteStatus = REMOTE_OFF;
-
213  bool RemoteIsListener() const { return remoteStatus == REMOTE_RECEIVING || remoteStatus == REMOTE_RECV_WAITING; }
-
215  bool RemoteIsSender() const { return remoteStatus == REMOTE_SENDING || remoteStatus == REMOTE_SEND_WAITING; }
-
216 
-
218  int verXPlane = -1;
-
220  int verXPLM = -1;
-
222  bool bXPUsingModernGraphicsDriver = false;
-
224  bool bXPNetworkedSetup = false;
-
226  XPLMPluginID pluginId = 0;
-
228  std::thread::id xpThread;
-
229 
-
230 #ifdef DEBUG
-
232  int xpCycleNum = 0;
-
233 #define UPDATE_CYCLE_NUM glob.xpCycleNum=XPLMGetCycleNumber();
-
234 #else
-
235 #define UPDATE_CYCLE_NUM
-
236 #endif
-
237 
-
238 protected:
-
240  XPMPPlaneID planeId = 0;
-
241 public:
-
243  XPMPPlaneID NextPlaneId ();
-
244 
-
245 public:
-
247  GlobVars (logLevelTy _logLvl = logINFO, bool _logMdlMatch = false) :
-
248  logLvl(_logLvl), bLogMdlMatch(_logMdlMatch) {}
-
250  void ReadConfigFile ();
-
252  void UpdateCfgVals ();
-
254  void ReadVersions ();
-
256  bool UsingModernGraphicsDriver() const { return bXPUsingModernGraphicsDriver; }
-
258  void ThisThreadIsXP()
-
259  { xpThread = std::this_thread::get_id(); pluginId = XPLMGetMyID(); }
-
261  bool IsXPThread() const { return std::this_thread::get_id() == xpThread; }
-
262 
-
263 };
-
264 
-
266 extern GlobVars glob;
-
267 
-
268 } // namespace XPMP2
-
269 
-
270 
-
271 
-
272 #endif
+
116 void XPMPSendNotification (const Aircraft& plane, XPMPPlaneNotification _notification);
+
117 
+
119 struct GlobVars {
+
120 public:
+
121  // Settings:
+
123  logLevelTy logLvl = logINFO;
+
125  bool bLogMdlMatch= false;
+
127  bool bClampAll = false;
+
129  bool bHandleDupId= false;
+
130 
+
132  bool bObjReplDataRefs = false;
+
134  bool bObjReplTextures = true;
+
136  std::string pathObj8DataRefs;
+
138  listObj8DataRefsTy listObj8DataRefs;
+
139 
+
141  std::string pluginName = UNKNOWN_PLUGIN_NAME;
+
143  std::string logAcronym = UNKNOWN_PLUGIN_NAME;
+
144 
+
146  int (*prefsFuncInt)(const char *, const char *, int) = XPMP2::PrefsFuncIntDefault;
+
148  listXPMPPlaneNotifierTy listObservers;
+
149 
+
151  std::string pathDoc8643;
+
153  mapDoc8643Ty mapDoc8643;
+
155  std::string pathRelated;
+
157  mapRelatedTy mapRelated;
+
158 
+
160  mapCSLPackageTy mapCSLPkgs;
+
162  mapCSLModelTy mapCSLModels;
+
164  std::string defaultICAO = "A320";
+
166  std::string carIcaoType = "ZZZC";
+
168  std::string resourceDir;
+
169 
+
171  mapAcTy mapAc;
+
173  bool bDrawLabels = true;
+
175  float maxLabelDist = 5556.0f;
+
177  bool bLabelCutOffAtVisibility = true;
+
179  float labelFontScaling = 1.0f;
+
180 
+
182  bool bHasControlOfAIAircraft = false;
+
183 
+
185  bool bMapEnabled = true;
+
187  bool bMapLabels = true;
+
189  mapMapLayerIDTy mapMapLayers;
+
191  std::string pathMapIcons;
+
192 
+
195  std::string remoteMCGroup = "239.255.1.1";
+
197  int remotePort = 49788;
+
199  int remoteTTL = 8;
+
201  size_t remoteBufSize = 8192;
+
203  int remoteTxfFrequ = 5;
+
205  RemoteCfgTy remoteCfg = REMOTE_CFG_AUTO;
+
207  RemoteCfgTy remoteCfgFromIni= REMOTE_CFG_AUTO;
+
209  RemoteStatusTy remoteStatus = REMOTE_OFF;
+
211  bool RemoteIsListener() const { return remoteStatus == REMOTE_RECEIVING || remoteStatus == REMOTE_RECV_WAITING; }
+
213  bool RemoteIsSender() const { return remoteStatus == REMOTE_SENDING || remoteStatus == REMOTE_SEND_WAITING; }
+
214 
+
216  bool bSoundOnStartup = true;
+
218  bool bSoundMuteOnPause = true;
+
220  bool bSoundAvail = false;
+
222  float sndMasterVol = 1.0f;
+
224  bool bSoundAutoMuted = false;
+
225 
+
227  int verXPlane = -1;
+
229  int verXPLM = -1;
+
231  bool bXPUsingModernGraphicsDriver = false;
+
233  bool bXPNetworkedSetup = false;
+
235  XPLMPluginID pluginId = 0;
+
237  std::thread::id xpThread;
+
238 
+
240  XPLMCameraPosition_t posCamera = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
+
242  XPLMCameraPosition_t prevCamera = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
+
244  float vCam_x = 0.0f, vCam_y = 0.0f, vCam_z = 0.0f;
+
246  float prevCamera_ts = 0.0f;
+
247 
+
249  int xpCycleNum = 0;
+
250 
+
251 protected:
+
253  XPMPPlaneID planeId = 0;
+
254 public:
+
256  XPMPPlaneID NextPlaneId ();
+
257 
+
258 public:
+
260  GlobVars (logLevelTy _logLvl = logINFO, bool _logMdlMatch = false) :
+
261  logLvl(_logLvl), bLogMdlMatch(_logMdlMatch) {}
+
263  void ReadConfigFile ();
+
265  void UpdateCfgVals ();
+
267  void ReadVersions ();
+
269  bool UsingModernGraphicsDriver() const { return bXPUsingModernGraphicsDriver; }
+
271  void ThisThreadIsXP()
+
272  { xpThread = std::this_thread::get_id(); pluginId = XPLMGetMyID(); }
+
274  bool IsXPThread() const { return std::this_thread::get_id() == xpThread; }
+
275 
+
277  void UpdateCameraPos ();
+
278 };
+
279 
+
281 extern GlobVars glob;
+
282 
+
283 } // namespace XPMP2
+
284 
+
285 
+
286 
+
287 #endif
2D.h
Definitions of 2-D routines, like drawing aircraft labels.
AIMultiplayer.h
Definitions for serving TCAS target dataRef updates.
Aircraft.h
Additional definitions beyond what public XPCAircraft defines.
@@ -245,20 +250,21 @@
Network.h
Low-level network communications, especially for TCP/UDP.
RelatedDoc8643.h
Handling the related.txt file for creating groups of similar looking aircraft types,...
Remote.h
Master/Client communication for aircraft synchronization on remote networked instances.
+
Sound.h
Sound for aircraft, based on the FMOD library.
XPCAircraft.h
XPMP2::Aircraft / XPCAircraft represent an aircraft as managed by XPMP2.
Utilities.h
Miscellaneous utility functions, including logging.
-
UNKNOWN_PLUGIN_NAME
#define UNKNOWN_PLUGIN_NAME
Definition: XPMP2.h:96
+
UNKNOWN_PLUGIN_NAME
#define UNKNOWN_PLUGIN_NAME
Definition: XPMP2.h:94
XPMPAircraft.h
XPMP2::Aircraft represent an aircraft as managed by XPMP2.
XPMPMultiplayer.h
Initialization and general control functions for XPMP2.
-
XPMPPlaneNotification
XPMPPlaneNotification
Events that trigger a notification callback.
Definition: XPMPMultiplayer.h:623
-
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:243
-
XPMPPlaneNotifier_f
void(* XPMPPlaneNotifier_f)(XPMPPlaneID inPlaneID, XPMPPlaneNotification inNotification, void *inRefcon)
Type of the callback function you provide, called when one of the events defined in XPMPPlaneNotifica...
Definition: XPMPMultiplayer.h:635
+
XPMPPlaneNotification
XPMPPlaneNotification
Events that trigger a notification callback.
Definition: XPMPMultiplayer.h:739
+
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:252
+
XPMPPlaneNotifier_f
void(* XPMPPlaneNotifier_f)(XPMPPlaneID inPlaneID, XPMPPlaneNotification inNotification, void *inRefcon)
Type of the callback function you provide, called when one of the events defined in XPMPPlaneNotifica...
Definition: XPMPMultiplayer.h:751
XPMPPlaneRenderer.h
Rendering functions.
XPMPRemote.h
Semi-public remote network functionality for master/client operations.
-
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:147
-
XPMP2
Definition: XPMPAircraft.h:41
-
XPMP2::logLevelTy
logLevelTy
Logging level.
Definition: Utilities.h:220
-
XPMP2::logINFO
@ logINFO
regular info messages
Definition: Utilities.h:222
+
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:181
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
+
XPMP2::logLevelTy
logLevelTy
Logging level.
Definition: Utilities.h:232
+
XPMP2::logINFO
@ logINFO
regular info messages
Definition: Utilities.h:234
XPMP2::mapAcTy
std::map< XPMPPlaneID, Aircraft * > mapAcTy
Map of all aircraft, key is tthe plane id.
Definition: Aircraft.h:57
XPMP2::glob
GlobVars glob
The one and only global variable structure.
Definition: Utilities.cpp:29
XPMP2::mapRelatedTy
std::map< std::string, int > mapRelatedTy
Map of group membership: ICAO a/c type maps to line in related.txt.
Definition: RelatedDoc8643.h:40
@@ -270,77 +276,90 @@
XPMP2::REMOTE_SEND_WAITING
@ REMOTE_SEND_WAITING
listening for a request to send data, but not actively sending data
Definition: XPMPRemote.h:437
XPMP2::REMOTE_SENDING
@ REMOTE_SENDING
actively sending aircraft data out to the network
Definition: XPMPRemote.h:438
XPMP2::REMOTE_RECEIVING
@ REMOTE_RECEIVING
actively receiving data
Definition: XPMPRemote.h:440
-
XPMP2::mapCSLModelTy
std::map< std::string, CSLModel > mapCSLModelTy
Map of CSLModels (owning the object), ordered by related group / type.
Definition: CSLModels.h:239
-
XPMP2::mapDoc8643Ty
std::map< std::string, Doc8643 > mapDoc8643Ty
Map of Doc8643 information, key is the (icao) type code.
Definition: RelatedDoc8643.h:86
-
XPMP2::listObj8DataRefsTy
std::list< Obj8DataRefs > listObj8DataRefsTy
a list of Obj8DataRefs definitions
Definition: RelatedDoc8643.h:113
-
XPMP2::listXPMPPlaneNotifierTy
std::list< XPMPPlaneNotifierTy > listXPMPPlaneNotifierTy
Definition: XPMP2.h:115
+
XPMP2::mapCSLModelTy
std::map< std::string, CSLModel > mapCSLModelTy
Map of CSLModels (owning the object), ordered by related group / type.
Definition: CSLModels.h:240
+
XPMP2::mapDoc8643Ty
std::map< std::string, Doc8643 > mapDoc8643Ty
Map of Doc8643 information, key is the (icao) type code.
Definition: RelatedDoc8643.h:87
+
XPMP2::listObj8DataRefsTy
std::list< Obj8DataRefs > listObj8DataRefsTy
a list of Obj8DataRefs definitions
Definition: RelatedDoc8643.h:114
+
XPMP2::listXPMPPlaneNotifierTy
std::list< XPMPPlaneNotifierTy > listXPMPPlaneNotifierTy
Definition: XPMP2.h:113
XPMP2::mapMapLayerIDTy
std::map< std::string, XPLMMapLayerID > mapMapLayerIDTy
A map holding our layer identifier, indexed by the map's name.
Definition: Map.h:27
-
XPMP2::XPMP2_VER
constexpr float XPMP2_VER
XPMP2 version number.
Definition: XPMP2.h:101
-
XPMP2::XPMPSendNotification
void XPMPSendNotification(const Aircraft &plane, XPMPPlaneNotification _notification)
Send a notification to all observers.
Definition: XPMPMultiplayer.cpp:560
+
XPMP2::XPMP2_VER
constexpr float XPMP2_VER
XPMP2 version number.
Definition: XPMP2.h:99
+
XPMP2::XPMPSendNotification
void XPMPSendNotification(const Aircraft &plane, XPMPPlaneNotification _notification)
Send a notification to all observers.
Definition: XPMPMultiplayer.cpp:572
XPMP2::mapCSLPackageTy
std::map< std::string, std::string > mapCSLPackageTy
Map of CSLPackages: Maps an id to the base path (path ends on forward slash)
Definition: CSLModels.h:27
XPMP2::PrefsFuncIntDefault
int PrefsFuncIntDefault(const char *, const char *, int _default)
Default config function just always returns the provided default value.
Definition: Utilities.cpp:161
-
XPMP2::GlobVars
All global config settings and variables are kept in one structure for convenient access and central ...
Definition: XPMP2.h:121
-
XPMP2::GlobVars::defaultICAO
std::string defaultICAO
Default ICAO aircraft type designator if no match can be found.
Definition: XPMP2.h:166
-
XPMP2::GlobVars::listObj8DataRefs
listObj8DataRefsTy listObj8DataRefs
List of dataRef replacement in .obj files.
Definition: XPMP2.h:140
-
XPMP2::GlobVars::pluginId
XPLMPluginID pluginId
This plugin's id.
Definition: XPMP2.h:226
-
XPMP2::GlobVars::bHasControlOfAIAircraft
bool bHasControlOfAIAircraft
Do we control X-Plane's AI/Multiplayer planes?
Definition: XPMP2.h:184
-
XPMP2::GlobVars::bXPUsingModernGraphicsDriver
bool bXPUsingModernGraphicsDriver
Using a modern graphics driver, ie. Vulkan/Metal?
Definition: XPMP2.h:222
-
XPMP2::GlobVars::listObservers
listXPMPPlaneNotifierTy listObservers
List of notifier functions registered for being notified of creation/destruction/model change.
Definition: XPMP2.h:150
-
XPMP2::GlobVars::pathRelated
std::string pathRelated
Path to related.txt file.
Definition: XPMP2.h:157
-
XPMP2::GlobVars::remoteStatus
RemoteStatusTy remoteStatus
Status of remote connections to networked clients.
Definition: XPMP2.h:211
-
XPMP2::GlobVars::mapMapLayers
mapMapLayerIDTy mapMapLayers
Map of map layer ids, i.e. for each map this is the id of the corresponding layer of ours.
Definition: XPMP2.h:191
-
XPMP2::GlobVars::bDrawLabels
bool bDrawLabels
Shall we draw aircraft labels?
Definition: XPMP2.h:175
-
XPMP2::GlobVars::pathMapIcons
std::string pathMapIcons
path to file containing plane icons for map display
Definition: XPMP2.h:193
-
XPMP2::GlobVars::mapAc
mapAcTy mapAc
Global map of all created planes.
Definition: XPMP2.h:173
-
XPMP2::GlobVars::remotePort
int remotePort
The port we use is different from the port the X-Plane BEACON uses, so we don't get into conflict.
Definition: XPMP2.h:199
-
XPMP2::GlobVars::bLabelCutOffAtVisibility
bool bLabelCutOffAtVisibility
Cut off labels at XP's reported visibility mit?
Definition: XPMP2.h:179
-
XPMP2::GlobVars::pluginName
std::string pluginName
Name of the plugin we are serving (used as map layer name or for folders)
Definition: XPMP2.h:143
-
XPMP2::GlobVars::pathObj8DataRefs
std::string pathObj8DataRefs
Path to the Obj8DataRefs.txt file.
Definition: XPMP2.h:138
-
XPMP2::GlobVars::xpThread
std::thread::id xpThread
id of X-Plane's thread (when it is OK to use XP API calls)
Definition: XPMP2.h:228
+
XPMP2::GlobVars
All global config settings and variables are kept in one structure for convenient access and central ...
Definition: XPMP2.h:119
+
XPMP2::GlobVars::defaultICAO
std::string defaultICAO
Default ICAO aircraft type designator if no match can be found.
Definition: XPMP2.h:164
+
XPMP2::GlobVars::listObj8DataRefs
listObj8DataRefsTy listObj8DataRefs
List of dataRef replacement in .obj files.
Definition: XPMP2.h:138
+
XPMP2::GlobVars::pluginId
XPLMPluginID pluginId
This plugin's id.
Definition: XPMP2.h:235
+
XPMP2::GlobVars::bHasControlOfAIAircraft
bool bHasControlOfAIAircraft
Do we control X-Plane's AI/Multiplayer planes?
Definition: XPMP2.h:182
+
XPMP2::GlobVars::vCam_z
float vCam_z
Definition: XPMP2.h:244
+
XPMP2::GlobVars::bSoundMuteOnPause
bool bSoundMuteOnPause
Config: Mute on Pause?
Definition: XPMP2.h:218
+
XPMP2::GlobVars::bXPUsingModernGraphicsDriver
bool bXPUsingModernGraphicsDriver
Using a modern graphics driver, ie. Vulkan/Metal?
Definition: XPMP2.h:231
+
XPMP2::GlobVars::listObservers
listXPMPPlaneNotifierTy listObservers
List of notifier functions registered for being notified of creation/destruction/model change.
Definition: XPMP2.h:148
+
XPMP2::GlobVars::pathRelated
std::string pathRelated
Path to related.txt file.
Definition: XPMP2.h:155
+
XPMP2::GlobVars::remoteStatus
RemoteStatusTy remoteStatus
Status of remote connections to networked clients.
Definition: XPMP2.h:209
+
XPMP2::GlobVars::posCamera
XPLMCameraPosition_t posCamera
Current camera location, updated every flight loop.
Definition: XPMP2.h:240
+
XPMP2::GlobVars::mapMapLayers
mapMapLayerIDTy mapMapLayers
Map of map layer ids, i.e. for each map this is the id of the corresponding layer of ours.
Definition: XPMP2.h:189
+
XPMP2::GlobVars::bDrawLabels
bool bDrawLabels
Shall we draw aircraft labels?
Definition: XPMP2.h:173
+
XPMP2::GlobVars::pathMapIcons
std::string pathMapIcons
path to file containing plane icons for map display
Definition: XPMP2.h:191
+
XPMP2::GlobVars::mapAc
mapAcTy mapAc
Global map of all created planes.
Definition: XPMP2.h:171
+
XPMP2::GlobVars::remotePort
int remotePort
The port we use is different from the port the X-Plane BEACON uses, so we don't get into conflict.
Definition: XPMP2.h:197
+
XPMP2::GlobVars::prevCamera_ts
float prevCamera_ts
When has prevCamera been updated last?
Definition: XPMP2.h:246
+
XPMP2::GlobVars::bLabelCutOffAtVisibility
bool bLabelCutOffAtVisibility
Cut off labels at XP's reported visibility mit?
Definition: XPMP2.h:177
+
XPMP2::GlobVars::pluginName
std::string pluginName
Name of the plugin we are serving (used as map layer name or for folders)
Definition: XPMP2.h:141
+
XPMP2::GlobVars::pathObj8DataRefs
std::string pathObj8DataRefs
Path to the Obj8DataRefs.txt file.
Definition: XPMP2.h:136
+
XPMP2::GlobVars::xpThread
std::thread::id xpThread
id of X-Plane's thread (when it is OK to use XP API calls)
Definition: XPMP2.h:237
XPMP2::GlobVars::UpdateCfgVals
void UpdateCfgVals()
Update all settings, e.g. for logging level, by calling prefsFuncInt.
Definition: Utilities.cpp:167
-
XPMP2::GlobVars::logAcronym
std::string logAcronym
Plugin acronym used in log output.
Definition: XPMP2.h:145
-
XPMP2::GlobVars::prefsFuncInt
int(* prefsFuncInt)(const char *, const char *, int)
Configuration callback for integer values.
Definition: XPMP2.h:148
-
XPMP2::GlobVars::verXPLM
int verXPLM
XPLM's SDK version number (XPLMGetVersions)
Definition: XPMP2.h:220
-
XPMP2::GlobVars::ThisThreadIsXP
void ThisThreadIsXP()
Set current thread as main xp Thread.
Definition: XPMP2.h:258
-
XPMP2::GlobVars::maxLabelDist
float maxLabelDist
Maximum distance for drawing labels? [m], defaults to 3nm.
Definition: XPMP2.h:177
-
XPMP2::GlobVars::carIcaoType
std::string carIcaoType
Ground vehicle type identifier (map decides icon based on this)
Definition: XPMP2.h:168
-
XPMP2::GlobVars::remoteBufSize
size_t remoteBufSize
Buffer size, ie. max message length we send over multicast.
Definition: XPMP2.h:203
-
XPMP2::GlobVars::ReadVersions
void ReadVersions()
Read version numbers into verXplane/verXPLM.
Definition: Utilities.cpp:251
-
XPMP2::GlobVars::resourceDir
std::string resourceDir
Resource directory, to store local definitions of vertical offsets (clamping)
Definition: XPMP2.h:170
-
XPMP2::GlobVars::bLogMdlMatch
bool bLogMdlMatch
Debug model matching?
Definition: XPMP2.h:127
-
XPMP2::GlobVars::RemoteIsSender
bool RemoteIsSender() const
Are we a sender?
Definition: XPMP2.h:215
+
XPMP2::GlobVars::logAcronym
std::string logAcronym
Plugin acronym used in log output.
Definition: XPMP2.h:143
+
XPMP2::GlobVars::prefsFuncInt
int(* prefsFuncInt)(const char *, const char *, int)
Configuration callback for integer values.
Definition: XPMP2.h:146
+
XPMP2::GlobVars::vCam_x
float vCam_x
Camera velocity.
Definition: XPMP2.h:244
+
XPMP2::GlobVars::sndMasterVol
float sndMasterVol
Sound master volume.
Definition: XPMP2.h:222
+
XPMP2::GlobVars::verXPLM
int verXPLM
XPLM's SDK version number (XPLMGetVersions)
Definition: XPMP2.h:229
+
XPMP2::GlobVars::ThisThreadIsXP
void ThisThreadIsXP()
Set current thread as main xp Thread.
Definition: XPMP2.h:271
+
XPMP2::GlobVars::maxLabelDist
float maxLabelDist
Maximum distance for drawing labels? [m], defaults to 3nm.
Definition: XPMP2.h:175
+
XPMP2::GlobVars::carIcaoType
std::string carIcaoType
Ground vehicle type identifier (map decides icon based on this)
Definition: XPMP2.h:166
+
XPMP2::GlobVars::remoteBufSize
size_t remoteBufSize
Buffer size, ie. max message length we send over multicast.
Definition: XPMP2.h:201
+
XPMP2::GlobVars::ReadVersions
void ReadVersions()
Read version numbers into verXplane/verXPLM.
Definition: Utilities.cpp:260
+
XPMP2::GlobVars::resourceDir
std::string resourceDir
Resource directory, to store local definitions of vertical offsets (clamping)
Definition: XPMP2.h:168
+
XPMP2::GlobVars::bLogMdlMatch
bool bLogMdlMatch
Debug model matching?
Definition: XPMP2.h:125
+
XPMP2::GlobVars::RemoteIsSender
bool RemoteIsSender() const
Are we a sender?
Definition: XPMP2.h:213
XPMP2::GlobVars::NextPlaneId
XPMPPlaneID NextPlaneId()
Get the next unique artifical plane id.
Definition: Utilities.cpp:37
-
XPMP2::GlobVars::mapCSLModels
mapCSLModelTy mapCSLModels
Global map of all CSL Models, indexed by related group, aircraft type, and model id.
Definition: XPMP2.h:164
-
XPMP2::GlobVars::verXPlane
int verXPlane
X-Plane's version number (XPLMGetVersions)
Definition: XPMP2.h:218
-
XPMP2::GlobVars::logLvl
logLevelTy logLvl
Logging level.
Definition: XPMP2.h:125
-
XPMP2::GlobVars::bObjReplDataRefs
bool bObjReplDataRefs
Replace dataRefs in .obj files on load? (defaults to OFF!)
Definition: XPMP2.h:134
-
XPMP2::GlobVars::bHandleDupId
bool bHandleDupId
Handle duplicate XPMP2::Aircraft::modeS_id by overwriting with unique id.
Definition: XPMP2.h:131
-
XPMP2::GlobVars::mapRelated
mapRelatedTy mapRelated
Content of related.txt file as a map of type codes to group id.
Definition: XPMP2.h:159
-
XPMP2::GlobVars::bMapLabels
bool bMapLabels
Do we show labels with the aircraft icons?
Definition: XPMP2.h:189
+
XPMP2::GlobVars::mapCSLModels
mapCSLModelTy mapCSLModels
Global map of all CSL Models, indexed by related group, aircraft type, and model id.
Definition: XPMP2.h:162
+
XPMP2::GlobVars::verXPlane
int verXPlane
X-Plane's version number (XPLMGetVersions)
Definition: XPMP2.h:227
+
XPMP2::GlobVars::logLvl
logLevelTy logLvl
Logging level.
Definition: XPMP2.h:123
+
XPMP2::GlobVars::bObjReplDataRefs
bool bObjReplDataRefs
Replace dataRefs in .obj files on load? (defaults to OFF!)
Definition: XPMP2.h:132
+
XPMP2::GlobVars::bHandleDupId
bool bHandleDupId
Handle duplicate XPMP2::Aircraft::modeS_id by overwriting with unique id.
Definition: XPMP2.h:129
+
XPMP2::GlobVars::mapRelated
mapRelatedTy mapRelated
Content of related.txt file as a map of type codes to group id.
Definition: XPMP2.h:157
+
XPMP2::GlobVars::bMapLabels
bool bMapLabels
Do we show labels with the aircraft icons?
Definition: XPMP2.h:187
XPMP2::GlobVars::ReadConfigFile
void ReadConfigFile()
Read from a generic XPMP2.prf or XPMP2.<logAcronym>.prf config file.
Definition: Utilities.cpp:63
-
XPMP2::GlobVars::bClampAll
bool bClampAll
Clamp all planes to the ground? Default is false as clamping is kinda expensive due to Y-Testing.
Definition: XPMP2.h:129
-
XPMP2::GlobVars::bXPNetworkedSetup
bool bXPNetworkedSetup
Is X-Plane configured for networked multi-computer or multiplayer setup?
Definition: XPMP2.h:224
-
XPMP2::GlobVars::RemoteIsListener
bool RemoteIsListener() const
Are we a listener?
Definition: XPMP2.h:213
-
XPMP2::GlobVars::labelFontScaling
float labelFontScaling
Label font scaling factor.
Definition: XPMP2.h:181
-
XPMP2::GlobVars::remoteMCGroup
std::string remoteMCGroup
The multicast group that we use, which is the same X-Plane is using itself for its BEACON.
Definition: XPMP2.h:197
-
XPMP2::GlobVars::remoteCfg
RemoteCfgTy remoteCfg
Configuration: Are we to support remote connections?
Definition: XPMP2.h:207
-
XPMP2::GlobVars::remoteTxfFrequ
int remoteTxfFrequ
Max transfer frequency per second.
Definition: XPMP2.h:205
-
XPMP2::GlobVars::mapDoc8643
mapDoc8643Ty mapDoc8643
Content of Doc8643.txt file.
Definition: XPMP2.h:155
-
XPMP2::GlobVars::remoteCfgFromIni
RemoteCfgTy remoteCfgFromIni
Configuration file entry: Are we to support remote connections?
Definition: XPMP2.h:209
-
XPMP2::GlobVars::UsingModernGraphicsDriver
bool UsingModernGraphicsDriver() const
Using a modern graphics driver, ie. Vulkan/Metal?
Definition: XPMP2.h:256
-
XPMP2::GlobVars::bMapEnabled
bool bMapEnabled
Do we feed X-Plane's maps with our aircraft positions?
Definition: XPMP2.h:187
-
XPMP2::GlobVars::IsXPThread
bool IsXPThread() const
Is this thread XP's main thread?
Definition: XPMP2.h:261
-
XPMP2::GlobVars::planeId
XPMPPlaneID planeId
Current plane ID counter.
Definition: XPMP2.h:240
-
XPMP2::GlobVars::GlobVars
GlobVars(logLevelTy _logLvl=logINFO, bool _logMdlMatch=false)
Constructor.
Definition: XPMP2.h:247
-
XPMP2::GlobVars::mapCSLPkgs
mapCSLPackageTy mapCSLPkgs
Global map of all CSL Packages, indexed by xsb_aircraft.txt::EXPORT_NAME
Definition: XPMP2.h:162
-
XPMP2::GlobVars::pathDoc8643
std::string pathDoc8643
Path to Doc8643.txt file.
Definition: XPMP2.h:153
-
XPMP2::GlobVars::bObjReplTextures
bool bObjReplTextures
Replace textures in .obj files on load if needed?
Definition: XPMP2.h:136
-
XPMP2::GlobVars::remoteTTL
int remoteTTL
Time-to-live, or mumber of hops for a multicast message.
Definition: XPMP2.h:201
-
XPMP2::XPMPPlaneNotifierTy
Stores the function and refcon pointer for plane creation/destrcution notifications.
Definition: XPMP2.h:104
-
XPMP2::XPMPPlaneNotifierTy::operator==
bool operator==(const XPMPPlaneNotifierTy &o)
Definition: XPMP2.h:111
-
XPMP2::XPMPPlaneNotifierTy::func
XPMPPlaneNotifier_f func
Definition: XPMP2.h:105
-
XPMP2::XPMPPlaneNotifierTy::XPMPPlaneNotifierTy
XPMPPlaneNotifierTy(XPMPPlaneNotifier_f _func=nullptr, void *_refcon=nullptr)
Definition: XPMP2.h:108
-
XPMP2::XPMPPlaneNotifierTy::refcon
void * refcon
Definition: XPMP2.h:106
+
XPMP2::GlobVars::bClampAll
bool bClampAll
Clamp all planes to the ground? Default is false as clamping is kinda expensive due to Y-Testing.
Definition: XPMP2.h:127
+
XPMP2::GlobVars::prevCamera
XPLMCameraPosition_t prevCamera
Previous camera location of about a second ago.
Definition: XPMP2.h:242
+
XPMP2::GlobVars::bXPNetworkedSetup
bool bXPNetworkedSetup
Is X-Plane configured for networked multi-computer or multiplayer setup?
Definition: XPMP2.h:233
+
XPMP2::GlobVars::RemoteIsListener
bool RemoteIsListener() const
Are we a listener?
Definition: XPMP2.h:211
+
XPMP2::GlobVars::labelFontScaling
float labelFontScaling
Label font scaling factor.
Definition: XPMP2.h:179
+
XPMP2::GlobVars::remoteMCGroup
std::string remoteMCGroup
The multicast group that we use, which is the same X-Plane is using itself for its BEACON.
Definition: XPMP2.h:195
+
XPMP2::GlobVars::remoteCfg
RemoteCfgTy remoteCfg
Configuration: Are we to support remote connections?
Definition: XPMP2.h:205
+
XPMP2::GlobVars::remoteTxfFrequ
int remoteTxfFrequ
Max transfer frequency per second.
Definition: XPMP2.h:203
+
XPMP2::GlobVars::UpdateCameraPos
void UpdateCameraPos()
Update the stored camera position and velocity values.
Definition: Utilities.cpp:275
+
XPMP2::GlobVars::mapDoc8643
mapDoc8643Ty mapDoc8643
Content of Doc8643.txt file.
Definition: XPMP2.h:153
+
XPMP2::GlobVars::vCam_y
float vCam_y
Definition: XPMP2.h:244
+
XPMP2::GlobVars::bSoundAutoMuted
bool bSoundAutoMuted
Is sound currently being auto-muted?
Definition: XPMP2.h:224
+
XPMP2::GlobVars::remoteCfgFromIni
RemoteCfgTy remoteCfgFromIni
Configuration file entry: Are we to support remote connections?
Definition: XPMP2.h:207
+
XPMP2::GlobVars::UsingModernGraphicsDriver
bool UsingModernGraphicsDriver() const
Using a modern graphics driver, ie. Vulkan/Metal?
Definition: XPMP2.h:269
+
XPMP2::GlobVars::xpCycleNum
int xpCycleNum
Current XP cycle number (see XPLMGetCycleNumber())
Definition: XPMP2.h:249
+
XPMP2::GlobVars::bSoundAvail
bool bSoundAvail
Is the sound system available?
Definition: XPMP2.h:220
+
XPMP2::GlobVars::bMapEnabled
bool bMapEnabled
Do we feed X-Plane's maps with our aircraft positions?
Definition: XPMP2.h:185
+
XPMP2::GlobVars::IsXPThread
bool IsXPThread() const
Is this thread XP's main thread?
Definition: XPMP2.h:274
+
XPMP2::GlobVars::planeId
XPMPPlaneID planeId
Current plane ID counter.
Definition: XPMP2.h:253
+
XPMP2::GlobVars::GlobVars
GlobVars(logLevelTy _logLvl=logINFO, bool _logMdlMatch=false)
Constructor.
Definition: XPMP2.h:260
+
XPMP2::GlobVars::mapCSLPkgs
mapCSLPackageTy mapCSLPkgs
Global map of all CSL Packages, indexed by xsb_aircraft.txt::EXPORT_NAME
Definition: XPMP2.h:160
+
XPMP2::GlobVars::bSoundOnStartup
bool bSoundOnStartup
Config: Start Sound on startup?
Definition: XPMP2.h:216
+
XPMP2::GlobVars::pathDoc8643
std::string pathDoc8643
Path to Doc8643.txt file.
Definition: XPMP2.h:151
+
XPMP2::GlobVars::bObjReplTextures
bool bObjReplTextures
Replace textures in .obj files on load if needed?
Definition: XPMP2.h:134
+
XPMP2::GlobVars::remoteTTL
int remoteTTL
Time-to-live, or mumber of hops for a multicast message.
Definition: XPMP2.h:199
+
XPMP2::XPMPPlaneNotifierTy
Stores the function and refcon pointer for plane creation/destrcution notifications.
Definition: XPMP2.h:102
+
XPMP2::XPMPPlaneNotifierTy::operator==
bool operator==(const XPMPPlaneNotifierTy &o)
Definition: XPMP2.h:109
+
XPMP2::XPMPPlaneNotifierTy::func
XPMPPlaneNotifier_f func
Definition: XPMP2.h:103
+
XPMP2::XPMPPlaneNotifierTy::XPMPPlaneNotifierTy
XPMPPlaneNotifierTy(XPMPPlaneNotifier_f _func=nullptr, void *_refcon=nullptr)
Definition: XPMP2.h:106
+
XPMP2::XPMPPlaneNotifierTy::refcon
void * refcon
Definition: XPMP2.h:104
diff --git a/docs/html/XPMPAircraft_8h.html b/docs/html/XPMPAircraft_8h.html index b67013fe..d0046384 100644 --- a/docs/html/XPMPAircraft_8h.html +++ b/docs/html/XPMPAircraft_8h.html @@ -54,7 +54,7 @@
-

XPMP2::Aircraft represent an aircraft as managed by XPMP2. +

XPMP2::Aircraft represent an aircraft as managed by XPMP2. More...

#include "XPMPMultiplayer.h"
#include "XPLMInstance.h"
@@ -78,18 +78,22 @@
 Any number of airline codes and/or liveries can be assigned to a model for matching purpose. More...
 
class  XPMP2::Aircraft
 Actual representation of all aircraft in XPMP2. More...
 Actual representation of all aircraft in XPMP2. More...
 
struct  XPMP2::Aircraft::wakeTy
 Wake dataRef support. More...
 
struct  XPMP2::Aircraft::SndChTy
 Operational values per sound channel, that is triggered by a standard sound event. More...
 
class  XPMP2::XPMP2Error
 XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft. More...
 XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft. More...
 
+

Namespaces

 XPMP2
 Defined by FMOD.
 
- +

@@ -150,7 +154,7 @@ , XPMP2::V_COUNT
}

 The dataRefs provided by XPMP2 to the CSL models. More...
 The dataRefs provided by XPMP2 to the CSL models. More...
 
- + @@ -173,14 +177,28 @@ + + +

@@ -165,7 +169,7 @@

Variables

constexpr float XPMP2::RPM_to_RADs = 0.10471975511966f
 Convert revolutions-per-minute (RPM) to radians per second (rad/s) by multiplying with PI/30. More...
 Defined by XPMP2 internally. More...
 
constexpr double XPMP2::M_per_FT = 0.3048
 Convert feet to meters, e.g. for altitude calculations. More...
constexpr int XPMP2::M_per_NM = 1852
 Convert nautical miles to meters. More...
 
constexpr double XPMP2::KT_per_M_per_S = 1.94384
 Convert m/s to knots. More...
 
constexpr float XPMP2::G_EARTH = 9.80665f
 standard gravitational acceleration [m/s²] More...
 

Detailed Description

-

XPMP2::Aircraft represent an aircraft as managed by XPMP2.

-

New implementations should derive directly from XPMP2::Aircraft.

Author
Birger Hoppe
-
Copyright
(c) 2020 Birger Hoppe
+

XPMP2::Aircraft represent an aircraft as managed by XPMP2.

+

New implementations should derive directly from XPMP2::Aircraft.

+

This is one of two main header files for using XPMP2. (The other is XPMPMultiplayer.h). XPMP2 is a library allowing an X-Plane plugin to have planes rendered in X-Plane's 3D world based on OBJ8 CSL models, which need to be installed separately. The plugin shall subclass XPMP2::Aircraft and override the abstract virtual function XPMP2::Aircraft::UpdatePosition() to provide updated position and attitude information. XPMP2 takes care of reading and initializaing CSL models, instanciating and updating the aircraft objects in X-Plane, display in a map layer, provisioning information via X-Plane's TCAS targets and AI/multiplayer (and more) dataRefs.

+
See also
For more developer's information see https://twinfan.github.io/XPMP2/
+
+Sample and "How to" available, see https://twinfan.github.io/XPMP2/HowTo.html
+
+For TCAS Override approach see https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/
+
+For a definition of ICAO aircraft type designators see https://www.icao.int/publications/DOC8643/Pages/Search.aspx
+
+For a list of ICAO airline/operator codes see https://en.wikipedia.org/wiki/List_of_airline_codes
+
Author
Birger Hoppe
+
Copyright
(c) 2020-2022 Birger Hoppe
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
@@ -214,6 +232,48 @@

+

◆ XPMP2::Aircraft::SndChTy

+ +
+
+ + + + +
struct XPMP2::Aircraft::SndChTy
+
+

Operational values per sound channel, that is triggered by a standard sound event.

+
+ + + + + + + + + + + + + +
Class Members
+bool +bAuto +Shall this sound event be handled automatically? (Set to false in your constructor or in Aircraft::SoundSetup() if you want to control that event type yourself)
+float +lastDRVal +last observed dataRef value to see if sound is to be triggered
+FMOD_CHANNEL * +pChn +channel playing the sound currently
+float +volAdj +Volume adjustment, fed from Aircraft::SoundGetName()
+

diff --git a/docs/html/XPMPAircraft_8h_source.html b/docs/html/XPMPAircraft_8h_source.html index 2bb2c941..b568dea7 100644 --- a/docs/html/XPMPAircraft_8h_source.html +++ b/docs/html/XPMPAircraft_8h_source.html @@ -48,692 +48,793 @@
Go to the documentation of this file.
1 
-
22 #ifndef _XPMPAircraft_h_
-
23 #define _XPMPAircraft_h_
-
24 
-
25 #include "XPMPMultiplayer.h"
-
26 #include "XPLMInstance.h"
-
27 #include "XPLMCamera.h"
-
28 #include "XPLMMap.h"
-
29 
-
30 #include <cstdint>
-
31 #include <cmath>
-
32 #include <stdexcept>
-
33 #include <string>
-
34 #include <vector>
-
35 #include <list>
-
36 
-
37 //
-
38 // MARK: XPMP2 New Definitions
-
39 //
-
40 
-
41 namespace XPMP2 {
-
42 
-
43 class CSLModel;
-
44 
-
46 constexpr float RPM_to_RADs = 0.10471975511966f;
-
48 constexpr double M_per_FT = 0.3048; // meter per 1 foot
-
50 constexpr int M_per_NM = 1852; // meter per one nautical mile
-
53 constexpr float G_EARTH = 9.80665f;
-
54 
-
56 enum DR_VALS : std::uint8_t {
-
57  V_CONTROLS_GEAR_RATIO = 0,
-
58  V_CONTROLS_NWS_RATIO,
-
59  V_CONTROLS_FLAP_RATIO,
-
60  V_CONTROLS_SPOILER_RATIO,
-
61  V_CONTROLS_SPEED_BRAKE_RATIO,
-
62  V_CONTROLS_SLAT_RATIO,
-
63  V_CONTROLS_WING_SWEEP_RATIO,
-
64  V_CONTROLS_THRUST_RATIO,
-
65  V_CONTROLS_YOKE_PITCH_RATIO,
-
66  V_CONTROLS_YOKE_HEADING_RATIO,
-
67  V_CONTROLS_YOKE_ROLL_RATIO,
-
68  V_CONTROLS_THRUST_REVERS,
-
69 
-
70  V_CONTROLS_TAXI_LITES_ON,
-
71  V_CONTROLS_LANDING_LITES_ON,
-
72  V_CONTROLS_BEACON_LITES_ON,
-
73  V_CONTROLS_STROBE_LITES_ON,
-
74  V_CONTROLS_NAV_LITES_ON,
-
75 
-
76  V_GEAR_NOSE_GEAR_DEFLECTION_MTR,
-
77  V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR,
-
78  V_GEAR_TIRE_ROTATION_ANGLE_DEG,
-
79  V_GEAR_TIRE_ROTATION_SPEED_RPM,
-
80  V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC,
-
81 
-
82  V_ENGINES_ENGINE_ROTATION_ANGLE_DEG,
-
83  V_ENGINES_ENGINE_ROTATION_SPEED_RPM,
-
84  V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC,
-
85  V_ENGINES_PROP_ROTATION_ANGLE_DEG,
-
86  V_ENGINES_PROP_ROTATION_SPEED_RPM,
-
87  V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC,
-
88  V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO,
-
89 
-
90  V_ENGINES_ENGINE_ROTATION_ANGLE_DEG1,
-
91  V_ENGINES_ENGINE_ROTATION_ANGLE_DEG2,
-
92  V_ENGINES_ENGINE_ROTATION_ANGLE_DEG3,
-
93  V_ENGINES_ENGINE_ROTATION_ANGLE_DEG4,
-
94  V_ENGINES_ENGINE_ROTATION_SPEED_RPM1,
-
95  V_ENGINES_ENGINE_ROTATION_SPEED_RPM2,
-
96  V_ENGINES_ENGINE_ROTATION_SPEED_RPM3,
-
97  V_ENGINES_ENGINE_ROTATION_SPEED_RPM4,
-
98  V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC1,
-
99  V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC2,
-
100  V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC3,
-
101  V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC4,
-
102 
+
51 #ifndef _XPMPAircraft_h_
+
52 #define _XPMPAircraft_h_
+
53 
+
54 #include "XPMPMultiplayer.h"
+
55 #include "XPLMInstance.h"
+
56 #include "XPLMCamera.h"
+
57 #include "XPLMMap.h"
+
58 
+
59 #include <cstdint>
+
60 #include <cmath>
+
61 #include <stdexcept>
+
62 #include <string>
+
63 #include <vector>
+
64 #include <list>
+
65 
+
66 //
+
67 // MARK: XPMP2 New Definitions
+
68 //
+
69 
+
70 struct FMOD_CHANNELGROUP;
+
71 struct FMOD_CHANNEL;
+
72 
+
73 namespace XPMP2 {
+
74 
+
75 class CSLModel;
+
76 
+
78 constexpr float RPM_to_RADs = 0.10471975511966f;
+
80 constexpr double M_per_FT = 0.3048; // meter per 1 foot
+
82 constexpr int M_per_NM = 1852; // meter per one nautical mile
+
84 constexpr double KT_per_M_per_S = 1.94384; // 1m/s = 1.94384kt
+
87 constexpr float G_EARTH = 9.80665f;
+
88 
+
90 enum DR_VALS : std::uint8_t {
+
91  V_CONTROLS_GEAR_RATIO = 0,
+
92  V_CONTROLS_NWS_RATIO,
+
93  V_CONTROLS_FLAP_RATIO,
+
94  V_CONTROLS_SPOILER_RATIO,
+
95  V_CONTROLS_SPEED_BRAKE_RATIO,
+
96  V_CONTROLS_SLAT_RATIO,
+
97  V_CONTROLS_WING_SWEEP_RATIO,
+
98  V_CONTROLS_THRUST_RATIO,
+
99  V_CONTROLS_YOKE_PITCH_RATIO,
+
100  V_CONTROLS_YOKE_HEADING_RATIO,
+
101  V_CONTROLS_YOKE_ROLL_RATIO,
+
102  V_CONTROLS_THRUST_REVERS,
103 
-
104  V_MISC_TOUCH_DOWN,
-
105 
-
106  V_COUNT
-
107 };
-
108 
-
114 struct CSLModelInfo_t {
-
116  std::string cslId;
-
118  std::string modelName;
-
120  std::string xsbAircraftPath;
-
122  int xsbAircraftLn = 0;
-
124  std::string icaoType;
-
126  std::string doc8643Classification;
-
128  std::string doc8643WTC;
-
129 
-
131  struct MatchCrit_t {
-
132  std::string icaoAirline;
-
133  std::string livery;
-
134  };
-
135  typedef std::vector<MatchCrit_t> vecMatchCrit_t;
-
136  // List of match criteria defined for the model, can be empty
-
137  vecMatchCrit_t vecMatchCrit;
-
138 
-
140  CSLModelInfo_t() {}
-
142  CSLModelInfo_t(const XPMP2::CSLModel& csl);
-
143 };
-
144 
-
147 class Aircraft {
-
148 
-
149 public:
-
150 
-
151 protected:
-
156  XPMPPlaneID modeS_id = 0;
-
157 
-
158 public:
-
161  std::string acIcaoType;
-
162  std::string acIcaoAirline;
-
163  std::string acLivery;
-
164 
-
169  XPLMDrawInfo_t drawInfo;
-
170 
-
172  bool bOnGrnd = false;
-
173 
-
181  std::vector<float> v;
+
104  V_CONTROLS_TAXI_LITES_ON,
+
105  V_CONTROLS_LANDING_LITES_ON,
+
106  V_CONTROLS_BEACON_LITES_ON,
+
107  V_CONTROLS_STROBE_LITES_ON,
+
108  V_CONTROLS_NAV_LITES_ON,
+
109 
+
110  V_GEAR_NOSE_GEAR_DEFLECTION_MTR,
+
111  V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR,
+
112  V_GEAR_TIRE_ROTATION_ANGLE_DEG,
+
113  V_GEAR_TIRE_ROTATION_SPEED_RPM,
+
114  V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC,
+
115 
+
116  V_ENGINES_ENGINE_ROTATION_ANGLE_DEG,
+
117  V_ENGINES_ENGINE_ROTATION_SPEED_RPM,
+
118  V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC,
+
119  V_ENGINES_PROP_ROTATION_ANGLE_DEG,
+
120  V_ENGINES_PROP_ROTATION_SPEED_RPM,
+
121  V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC,
+
122  V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO,
+
123 
+
124  V_ENGINES_ENGINE_ROTATION_ANGLE_DEG1,
+
125  V_ENGINES_ENGINE_ROTATION_ANGLE_DEG2,
+
126  V_ENGINES_ENGINE_ROTATION_ANGLE_DEG3,
+
127  V_ENGINES_ENGINE_ROTATION_ANGLE_DEG4,
+
128  V_ENGINES_ENGINE_ROTATION_SPEED_RPM1,
+
129  V_ENGINES_ENGINE_ROTATION_SPEED_RPM2,
+
130  V_ENGINES_ENGINE_ROTATION_SPEED_RPM3,
+
131  V_ENGINES_ENGINE_ROTATION_SPEED_RPM4,
+
132  V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC1,
+
133  V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC2,
+
134  V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC3,
+
135  V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC4,
+
136 
+
137 
+
138  V_MISC_TOUCH_DOWN,
+
139 
+
140  V_COUNT
+
141 };
+
142 
+
148 struct CSLModelInfo_t {
+
150  std::string cslId;
+
152  std::string modelName;
+
154  std::string xsbAircraftPath;
+
156  int xsbAircraftLn = 0;
+
158  std::string icaoType;
+
160  std::string doc8643Classification;
+
162  std::string doc8643WTC;
+
163 
+
165  struct MatchCrit_t {
+
166  std::string icaoAirline;
+
167  std::string livery;
+
168  };
+
169  typedef std::vector<MatchCrit_t> vecMatchCrit_t;
+
170  // List of match criteria defined for the model, can be empty
+
171  vecMatchCrit_t vecMatchCrit;
+
172 
+
174  CSLModelInfo_t() {}
+
176  CSLModelInfo_t(const XPMP2::CSLModel& csl);
+
177 };
+
178 
+
181 class Aircraft {
182 
-
184  std::string label;
-
185  float colLabel[4] = {1.0f,1.0f,0.0f,1.0f};
-
186  bool bDrawLabel = true;
-
187 
-
189  float vertOfsRatio = 1.0f;
-
190 
-
196  float gearDeflectRatio = 0.5f;
-
197 
-
203  bool bClampToGround = false;
+
183 public:
+
184 
+
185 protected:
+
190  XPMPPlaneID modeS_id = 0;
+
191 
+
192 public:
+
195  std::string acIcaoType;
+
196  std::string acIcaoAirline;
+
197  std::string acLivery;
+
198 
+
203  XPLMDrawInfo_t drawInfo;
204 
-
209  int aiPrio = 1;
-
210 
-
213  XPMPPlaneRadar_t acRadar;
-
214 
-
220  struct wakeTy {
-
221  float wingSpan_m = NAN;
-
222  float wingArea_m2 = NAN;
-
223  float mass_kg = NAN;
-
224 
-
225  void clear() { *this = wakeTy(); }
-
226  bool needsDefaults() const;
-
228  void applyDefaults(const std::string& _wtc, bool _bOverwriteAllFields = true);
-
230  void fillUpFrom(const wakeTy& o);
-
231  } wake;
-
232 
-
234  XPMPInfoTexts_t acInfoTexts;
-
235 
-
236 protected:
-
237  bool bValid = true;
-
238  bool bVisible = true;
-
239  bool bRender = true;
-
240 
-
241  XPMP2::CSLModel* pCSLMdl = nullptr;
-
242  int matchQuality = -1;
-
243  int acRelGrp = 0;
+
206  bool bOnGrnd = false;
+
207 
+
215  std::vector<float> v;
+
216 
+
218  std::string label;
+
219  float colLabel[4] = {1.0f,1.0f,0.0f,1.0f};
+
220  bool bDrawLabel = true;
+
221 
+
223  float vertOfsRatio = 1.0f;
+
224 
+
230  float gearDeflectRatio = 0.5f;
+
231 
+
237  bool bClampToGround = false;
+
238 
+
243  int aiPrio = 1;
244 
-
245  // this is data from about a second ago to calculate cartesian velocities
-
246  float prev_x = 0.0f, prev_y = 0.0f, prev_z = 0.0f;
-
247  float prev_ts = 0.0f;
+
247  XPMPPlaneRadar_t acRadar;
248 
-
250  float tsResetTouchDown = NAN;
-
251 
-
253  std::list<XPLMInstanceRef> listInst;
-
255  int tcasTargetIdx = -1;
-
256 
-
258  float camTimLstUpd = 0.0f;
-
260  float camDist = 0.0f;
-
262  float camBearing = 0.0f;
-
263 
-
265  XPLMProbeRef hProbe = nullptr;
+
254  struct wakeTy {
+
255  float wingSpan_m = NAN;
+
256  float wingArea_m2 = NAN;
+
257  float mass_kg = NAN;
+
258 
+
259  void clear() { *this = wakeTy(); }
+
260  bool needsDefaults() const;
+
262  void applyDefaults(const std::string& _wtc, bool _bOverwriteAllFields = true);
+
264  void fillUpFrom(const wakeTy& o);
+
265  } wake;
266 
-
267  // Data used for drawing icons in X-Plane's map
-
268  int mapIconRow = 0;
-
269  int mapIconCol = 0;
-
270  float mapX = 0.0f;
-
271  float mapY = 0.0f;
-
272  std::string mapLabel;
-
273 
-
274 private:
-
275  bool bDestroyInst = false;
-
276 public:
-
284  Aircraft (const std::string& _icaoType,
-
285  const std::string& _icaoAirline,
-
286  const std::string& _livery,
-
287  XPMPPlaneID _modeS_id = 0,
-
288  const std::string& _cslId = "");
-
290  Aircraft ();
-
292  virtual ~Aircraft();
-
293 
-
295  Aircraft (const Aircraft&) = delete;
-
297  Aircraft& operator=(const Aircraft&) = delete;
-
298 
-
307  void Create (const std::string& _icaoType,
-
308  const std::string& _icaoAirline,
-
309  const std::string& _livery,
-
310  XPMPPlaneID _modeS_id = 0,
-
311  const std::string& _cslId = "",
-
312  CSLModel* _pCSLModel = nullptr);
-
313 
-
315  XPMPPlaneID GetModeS_ID () const { return modeS_id; }
-
317  bool IsGroundVehicle() const;
-
321  bool IsRelatedTo (const std::string& _icaoType) const;
-
323  int GetTcasTargetIdx () const { return tcasTargetIdx; }
-
325  bool IsCurrentlyShownAsTcasTarget () const { return tcasTargetIdx >= 1; }
-
327  bool IsCurrentlyShownAsAI () const;
-
329  bool ShowAsAIPlane () const { return IsVisible() && acRadar.mode != xpmpTransponderMode_Standby; }
-
331  void ResetTcasTargetIdx () { tcasTargetIdx = -1; }
-
332 
-
335  virtual std::string GetFlightId() const;
+
268  XPMPInfoTexts_t acInfoTexts;
+
269 
+
270 protected:
+
271  bool bValid = true;
+
272  bool bVisible = true;
+
273  bool bRender = true;
+
274 
+
275  XPMP2::CSLModel* pCSLMdl = nullptr;
+
276  int matchQuality = -1;
+
277  int acRelGrp = 0;
+
278 
+
279  // this is data from about a second ago to calculate cartesian velocities
+
280  float prev_x = 0.0f, prev_y = 0.0f, prev_z = 0.0f;
+
281  float prev_ts = 0.0f;
+
282  float v_x = 0.0f, v_y = 0.0f, v_z = 0.0f;
+
283  float gs_kn = 0.0f;
+
284 
+
286  float tsResetTouchDown = NAN;
+
287 
+
289  std::list<XPLMInstanceRef> listInst;
+
291  int tcasTargetIdx = -1;
+
292 
+
294  float camTimLstUpd = 0.0f;
+
296  float camDist = 0.0f;
+
298  float camBearing = 0.0f;
+
299 
+
301  XPLMProbeRef hProbe = nullptr;
+
302 
+
303  // Data used for drawing icons in X-Plane's map
+
304  int mapIconRow = 0;
+
305  int mapIconCol = 0;
+
306  float mapX = 0.0f;
+
307  float mapY = 0.0f;
+
308  std::string mapLabel;
+
309 
+
310 #ifdef INCLUDE_FMOD_SOUND
+
311  // *** Sound support ***
+
312 public:
+
314  enum SoundEventsTy {
+
315  SND_ENG = 0,
+
316  SND_REVERSE_THRUST,
+
317  SND_TIRE,
+
318  SND_GEAR,
+
319  SND_FLAPS,
+
320  SND_NUM_EVENTS
+
321  };
+
323  typedef std::list<FMOD_CHANNEL*> ChnListTy;
+
324 
+
326  struct SndChTy {
+
327  bool bAuto = true;
+
328  FMOD_CHANNEL* pChn = nullptr;
+
329  float lastDRVal = NAN;
+
330  float volAdj = 1.0f;
+
331  };
+
332 
+
335  int sndMinDist = 50.0;
336 
-
342  int ChangeModel (const std::string& _icaoType,
-
343  const std::string& _icaoAirline,
-
344  const std::string& _livery);
-
345 
-
348  int ReMatchModel () { return ChangeModel(acIcaoType,acIcaoAirline,acLivery); }
+
337 protected:
+
339  SndChTy aSndCh[SND_NUM_EVENTS];
+
341  bool bChnLowPass = false;
+
343  bool bChnMuted = false;
+
345  ChnListTy chnList;
+
347  int skipCounter = 0;
+
348 #endif // INCLUDE_FMOD_SOUND
349 
-
354  bool AssignModel (const std::string& _cslId,
-
355  CSLModel* _pCSLModel = nullptr);
+
350 private:
+
351  bool bDestroyInst = false;
+
352 public:
+
353 
356 
-
358  XPMP2::CSLModel* GetModel () const { return pCSLMdl; }
-
360  const std::string& GetModelName () const;
-
362  CSLModelInfo_t GetModelInfo() const { return pCSLMdl ? CSLModelInfo_t(*pCSLMdl) : CSLModelInfo_t(); }
-
364  int GetMatchQuality () const { return matchQuality; }
-
366  float GetVertOfs () const;
-
367 
-
369  bool IsValid() const { return bValid; }
-
371  virtual void SetInvalid();
-
372 
-
374  virtual void SetVisible (bool _bVisible);
-
376  bool IsVisible () const { return bVisible && bValid; }
-
377 
-
379  virtual void SetRender (bool _bRender);
-
381  bool IsRendered () const { return bRender && IsVisible(); }
-
382 
-
384  bool IsInstanciated () const { return !listInst.empty(); }
-
385 
-
387  void SetDrawLabel (bool _b) { bDrawLabel = _b; }
-
389  bool ShallDrawLabel () const { return bDrawLabel; }
-
390 
-
392  float GetCameraDist () const { return camDist; }
-
394  float GetCameraBearing () const { return camBearing; }
-
395 
-
404  virtual void UpdatePosition (float _elapsedSinceLastCall, int _flCounter) = 0;
-
405 
-
407  bool IsOnGrnd () const { return bOnGrnd; }
-
411  void SetOnGrnd (bool on_grnd, float setTouchDownTime = NAN);
-
412 
-
413  // --- Getters and Setters for the values in `drawInfo` ---
-
414 
-
422  void SetLocation (double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime = NAN) {
-
423  SetLocation(lat, lon, alt_ft);
-
424  SetOnGrnd(on_grnd, setTouchDownTime);
-
425  }
-
426 
-
428  void SetLocation (double lat, double lon, double alt_ft);
-
429 
-
432  void GetLocation (double& lat, double& lon, double& alt_ft) const;
+
364  Aircraft (const std::string& _icaoType,
+
365  const std::string& _icaoAirline,
+
366  const std::string& _livery,
+
367  XPMPPlaneID _modeS_id = 0,
+
368  const std::string& _cslId = "");
+
370  Aircraft ();
+
372  virtual ~Aircraft();
+
373 
+
375  Aircraft (const Aircraft&) = delete;
+
377  Aircraft& operator=(const Aircraft&) = delete;
+
378 
+
387  void Create (const std::string& _icaoType,
+
388  const std::string& _icaoAirline,
+
389  const std::string& _livery,
+
390  XPMPPlaneID _modeS_id = 0,
+
391  const std::string& _cslId = "",
+
392  CSLModel* _pCSLModel = nullptr);
+
396 
+
398  XPMPPlaneID GetModeS_ID () const { return modeS_id; }
+
400  bool IsGroundVehicle() const;
+
404  bool IsRelatedTo (const std::string& _icaoType) const;
+
406  int GetTcasTargetIdx () const { return tcasTargetIdx; }
+
408  bool IsCurrentlyShownAsTcasTarget () const { return tcasTargetIdx >= 1; }
+
410  bool IsCurrentlyShownAsAI () const;
+
412  bool ShowAsAIPlane () const { return IsVisible() && acRadar.mode != xpmpTransponderMode_Standby; }
+
414  void ResetTcasTargetIdx () { tcasTargetIdx = -1; }
+
415 
+
418  virtual std::string GetFlightId() const;
+
419 
+
424 
+
430  int ChangeModel (const std::string& _icaoType,
+
431  const std::string& _icaoAirline,
+
432  const std::string& _livery);
433 
-
435  void SetLocalLoc (float _x, float _y, float _z) { drawInfo.x = _x; drawInfo.y = _y; drawInfo.z = _z; }
-
437  const XPLMDrawInfo_t& GetLocation () const { return drawInfo; }
-
438 
-
439  float GetPitch () const { return drawInfo.pitch; }
-
440  void SetPitch (float _deg) { drawInfo.pitch = _deg; }
-
441  float GetHeading () const { return drawInfo.heading; }
-
442  void SetHeading (float _deg) { drawInfo.heading = _deg; }
-
443  float GetRoll () const { return drawInfo.roll; }
-
444  void SetRoll (float _deg) { drawInfo.roll = _deg; }
-
445 
-
446  // --- Getters and Setters for the values in the `v` array ---
-
447  float GetGearRatio () const { return v[V_CONTROLS_GEAR_RATIO]; }
-
448  void SetGearRatio (float _f) { v[V_CONTROLS_GEAR_RATIO] = _f; }
-
449  float GetNoseWheelAngle () const { return v[V_CONTROLS_NWS_RATIO]; }
-
450  void SetNoseWheelAngle (float _f) { v[V_CONTROLS_NWS_RATIO] = _f; }
-
451  float GetFlapRatio () const { return v[V_CONTROLS_FLAP_RATIO]; }
-
452  void SetFlapRatio (float _f) { v[V_CONTROLS_FLAP_RATIO] = _f; }
-
453  float GetSpoilerRatio () const { return v[V_CONTROLS_SPOILER_RATIO]; }
-
454  void SetSpoilerRatio (float _f) { v[V_CONTROLS_SPOILER_RATIO] = _f; }
-
455  float GetSpeedbrakeRatio () const { return v[V_CONTROLS_SPEED_BRAKE_RATIO]; }
-
456  void SetSpeedbrakeRatio (float _f) { v[V_CONTROLS_SPEED_BRAKE_RATIO] = _f; }
-
457  float GetSlatRatio () const { return v[V_CONTROLS_SLAT_RATIO]; }
-
458  void SetSlatRatio (float _f) { v[V_CONTROLS_SLAT_RATIO] = _f; }
-
459  float GetWingSweepRatio () const { return v[V_CONTROLS_WING_SWEEP_RATIO]; }
-
460  void SetWingSweepRatio (float _f) { v[V_CONTROLS_WING_SWEEP_RATIO] = _f; }
-
461  float GetThrustRatio () const { return v[V_CONTROLS_THRUST_RATIO]; }
-
462  void SetThrustRatio (float _f) { v[V_CONTROLS_THRUST_RATIO] = _f; }
-
463  float GetYokePitchRatio () const { return v[V_CONTROLS_YOKE_PITCH_RATIO]; }
-
464  void SetYokePitchRatio (float _f) { v[V_CONTROLS_YOKE_PITCH_RATIO] = _f; }
-
465  float GetYokeHeadingRatio () const { return v[V_CONTROLS_YOKE_HEADING_RATIO]; }
-
466  void SetYokeHeadingRatio (float _f) { v[V_CONTROLS_YOKE_HEADING_RATIO] = _f; }
-
467  float GetYokeRollRatio () const { return v[V_CONTROLS_YOKE_ROLL_RATIO]; }
-
468  void SetYokeRollRatio (float _f) { v[V_CONTROLS_YOKE_ROLL_RATIO] = _f; }
-
469  float GetThrustReversRatio () const { return v[V_CONTROLS_THRUST_REVERS]; }
-
470  void SetThrustReversRatio (float _f){ v[V_CONTROLS_THRUST_REVERS] = _f; }
-
471 
-
472  bool GetLightsTaxi () const { return v[V_CONTROLS_TAXI_LITES_ON] > 0.5f; }
-
473  void SetLightsTaxi (bool _b) { v[V_CONTROLS_TAXI_LITES_ON] = float(_b); }
-
474  bool GetLightsLanding () const { return v[V_CONTROLS_LANDING_LITES_ON] > 0.5f; }
-
475  void SetLightsLanding (bool _b) { v[V_CONTROLS_LANDING_LITES_ON] = float(_b); }
-
476  bool GetLightsBeacon () const { return v[V_CONTROLS_BEACON_LITES_ON] > 0.5f; }
-
477  void SetLightsBeacon (bool _b) { v[V_CONTROLS_BEACON_LITES_ON] = float(_b); }
-
478  bool GetLightsStrobe () const { return v[V_CONTROLS_STROBE_LITES_ON] > 0.5f; }
-
479  void SetLightsStrobe (bool _b) { v[V_CONTROLS_STROBE_LITES_ON] = float(_b); }
-
480  bool GetLightsNav () const { return v[V_CONTROLS_NAV_LITES_ON] > 0.5f; }
-
481  void SetLightsNav (bool _b) { v[V_CONTROLS_NAV_LITES_ON] = float(_b); }
-
482 
-
483  float GetNoseGearDeflection () const { return v[V_GEAR_NOSE_GEAR_DEFLECTION_MTR]; }
-
484  void SetNoseGearDeflection (float _mtr) { v[V_GEAR_NOSE_GEAR_DEFLECTION_MTR] = _mtr; }
-
485  float GetTireDeflection () const { return v[V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR]; }
-
486  void SetTireDeflection (float _mtr) { v[V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR] = _mtr; }
-
487  float GetTireRotAngle () const { return v[V_GEAR_TIRE_ROTATION_ANGLE_DEG]; }
-
488  void SetTireRotAngle (float _deg) { v[V_GEAR_TIRE_ROTATION_ANGLE_DEG] = _deg; }
-
489  float GetTireRotRpm () const { return v[V_GEAR_TIRE_ROTATION_SPEED_RPM]; }
-
490  void SetTireRotRpm (float _rpm) { v[V_GEAR_TIRE_ROTATION_SPEED_RPM] = _rpm;
-
491  v[V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC] = _rpm * RPM_to_RADs; }
-
492  float GetTireRotRad () const { return v[V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC]; }
-
493  void SetTireRotRad (float _rad) { v[V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC] = _rad;
-
494  v[V_GEAR_TIRE_ROTATION_SPEED_RPM] = _rad / RPM_to_RADs; }
-
495 
-
496  float GetEngineRotAngle () const { return v[V_ENGINES_ENGINE_ROTATION_ANGLE_DEG]; }
-
497  void SetEngineRotAngle (float _deg);
-
498  float GetEngineRotRpm () const { return v[V_ENGINES_ENGINE_ROTATION_SPEED_RPM]; }
-
499  void SetEngineRotRpm (float _rpm);
-
500  float GetEngineRotRad () const { return v[V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC]; }
-
501  void SetEngineRotRad (float _rad);
-
502 
-
503  float GetEngineRotAngle (size_t idx) const
-
504  { return 1 <= idx && idx <= 4 ? v[V_ENGINES_ENGINE_ROTATION_ANGLE_DEG1+idx-1] : 0.0f; }
-
505  void SetEngineRotAngle (size_t idx, float _deg);
-
506  float GetEngineRotRpm (size_t idx) const
-
507  { return 1 <= idx && idx <= 4 ? v[V_ENGINES_ENGINE_ROTATION_SPEED_RPM1+idx-1] : 0.0f; }
-
508  void SetEngineRotRpm (size_t idx, float _rpm);
-
509  float GetEngineRotRad (size_t idx) const
-
510  { return 1 <= idx && idx <= 4 ? v[V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC+idx-1] : 0.0f; }
-
511  void SetEngineRotRad (size_t idx, float _rad);
-
512 
-
513  float GetPropRotAngle () const { return v[V_ENGINES_PROP_ROTATION_ANGLE_DEG]; }
-
514  void SetPropRotAngle (float _deg) { v[V_ENGINES_PROP_ROTATION_ANGLE_DEG] = _deg; }
-
515  float GetPropRotRpm () const { return v[V_ENGINES_PROP_ROTATION_SPEED_RPM]; }
-
516  void SetPropRotRpm (float _rpm) { v[V_ENGINES_PROP_ROTATION_SPEED_RPM] = _rpm;
-
517  v[V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC] = _rpm * RPM_to_RADs; }
-
518  float GetPropRotRad () const { return v[V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC]; }
-
519  void SetPropRotRad (float _rad) { v[V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC] = _rad;
-
520  v[V_ENGINES_PROP_ROTATION_SPEED_RPM] = _rad / RPM_to_RADs; }
+
436  int ReMatchModel () { return ChangeModel(acIcaoType,acIcaoAirline,acLivery); }
+
437 
+
442  bool AssignModel (const std::string& _cslId,
+
443  CSLModel* _pCSLModel = nullptr);
+
444 
+
446  XPMP2::CSLModel* GetModel () const { return pCSLMdl; }
+
448  const std::string& GetModelName () const;
+
450  CSLModelInfo_t GetModelInfo() const { return pCSLMdl ? CSLModelInfo_t(*pCSLMdl) : CSLModelInfo_t(); }
+
452  int GetMatchQuality () const { return matchQuality; }
+
453 
+
457 
+
459  float GetVertOfs () const;
+
460 
+
462  bool IsValid() const { return bValid; }
+
464  virtual void SetInvalid();
+
465 
+
467  virtual void SetVisible (bool _bVisible);
+
469  bool IsVisible () const { return bVisible && bValid; }
+
470 
+
472  virtual void SetRender (bool _bRender);
+
474  bool IsRendered () const { return bRender && IsVisible(); }
+
475 
+
477  bool IsInstanciated () const { return !listInst.empty(); }
+
478 
+
480  void SetDrawLabel (bool _b) { bDrawLabel = _b; }
+
482  bool ShallDrawLabel () const { return bDrawLabel; }
+
483 
+
485  float GetCameraDist () const { return camDist; }
+
487  float GetCameraBearing () const { return camBearing; }
+
488 
+
497  virtual void UpdatePosition (float _elapsedSinceLastCall, int _flCounter) = 0;
+
498 
+
500  bool IsOnGrnd () const { return bOnGrnd; }
+
504  void SetOnGrnd (bool on_grnd, float setTouchDownTime = NAN);
+
505 
+
509 
+
517  void SetLocation (double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime = NAN) {
+
518  SetLocation(lat, lon, alt_ft);
+
519  SetOnGrnd(on_grnd, setTouchDownTime);
+
520  }
521 
-
522  float GetReversDeployRatio () const { return v[V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO]; }
-
523  void SetReversDeployRatio (float _f){ v[V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO] = _f; }
-
524 
-
525  bool GetTouchDown () const { return v[V_MISC_TOUCH_DOWN] > 0.5f; }
-
526  void SetTouchDown (bool _b) { v[V_MISC_TOUCH_DOWN] = float(_b); }
-
527 
-
528  // Wake support as per X-Plane 12
-
529 
-
532  void WakeApplyDefaults(bool _bOverwriteAllFields = true);
+
523  void SetLocation (double lat, double lon, double alt_ft);
+
524 
+
527  void GetLocation (double& lat, double& lon, double& alt_ft) const;
+
528 
+
530  void SetLocalLoc (float _x, float _y, float _z) { drawInfo.x = _x; drawInfo.y = _y; drawInfo.z = _z; }
+
532  const XPLMDrawInfo_t& GetLocation () const { return drawInfo; }
533 
-
534  float GetWingSpan () const { return wake.wingSpan_m; }
-
535  void SetWingSpan (float _m) { wake.wingSpan_m = _m; }
-
536 
-
537  float GetWingArea() const { return wake.wingArea_m2; }
-
538  void SetWingArea (float _m2) { wake.wingArea_m2 = _m2; }
-
539 
-
540  int GetWakeCat() const;
-
541 
-
542  float GetMass() const { return wake.mass_kg; }
-
543  void SetMass(float _kg) { wake.mass_kg = _kg; }
-
544 
-
545  // Overridables:
-
546  virtual float GetAoA() const { return GetPitch(); }
-
547  virtual float GetLift() const { return GetMass() * G_EARTH; }
-
548 
-
549  // The following is implemented in Map.cpp:
-
551  void MapFindIcon ();
-
553  void MapPreparePos (XPLMMapProjectionID projection,
-
554  const float boundsLTRB[4]);
-
556  void MapDrawIcon (XPLMMapLayerID inLayer, float acSize);
-
558  void MapDrawLabel (XPLMMapLayerID inLayer, float yOfs);
-
559 
-
560 protected:
-
562  static float FlightLoopCB (float, float, int, void*);
-
564  void DoMove ();
-
566  void UpdateDistBearingCamera (const XPLMCameraPosition_t& posCam);
-
568  void ClampToGround ();
-
570  bool CreateInstances ();
-
572  void DestroyInstances ();
-
573 
-
576  virtual void ComputeMapLabel ();
-
577 
-
578  // The following functions are implemented in AIMultiplayer.cpp:
-
580  virtual void SetTcasTargetIdx (int _idx) { tcasTargetIdx = _idx; }
-
581  // These functions perform the TCAS target / multiplayer data updates
-
582  friend void AIMultiUpdate ();
-
583  friend size_t AIUpdateTCASTargets ();
-
584  friend size_t AIUpdateMultiplayerDataRefs ();
-
585 };
-
586 
-
588 Aircraft* AcFindByID (XPMPPlaneID _id);
-
589 
-
591 bool AcSetDefaultWakeData(const std::string& _wtc, const Aircraft::wakeTy& _wake);
-
592 
-
593 //
-
594 // MARK: XPMP2 Exception class
-
595 //
-
596 
-
598 class XPMP2Error : public std::logic_error {
-
599 protected:
-
600  std::string fileName;
-
601  int ln;
-
602  std::string funcName;
-
603  std::string msg;
-
604 public:
-
606  XPMP2Error (const char* szFile, int ln, const char* szFunc, const char* szMsg, ...);
-
607 public:
-
609  virtual const char* what() const noexcept;
-
610 
-
611 public:
-
612  // copy/move constructor/assignment as per default
-
613  XPMP2Error (const XPMP2Error& o) = default;
-
614  XPMP2Error (XPMP2Error&& o) = default;
-
615  XPMP2Error& operator = (const XPMP2Error& o) = default;
-
616  XPMP2Error& operator = (XPMP2Error&& o) = default;
-
617 };
-
618 
-
619 
-
620 
-
621 } // namespace XPMP2
+
534  float GetPitch () const { return drawInfo.pitch; }
+
535  void SetPitch (float _deg) { drawInfo.pitch = _deg; }
+
536  float GetHeading () const { return drawInfo.heading; }
+
537  void SetHeading (float _deg) { drawInfo.heading = _deg; }
+
538  float GetRoll () const { return drawInfo.roll; }
+
539  void SetRoll (float _deg) { drawInfo.roll = _deg; }
+
540 
+
541  float GetGS_kn() const { return gs_kn; }
+
542 
+
547 
+
548  float GetGearRatio () const { return v[V_CONTROLS_GEAR_RATIO]; }
+
549  void SetGearRatio (float _f) { v[V_CONTROLS_GEAR_RATIO] = _f; }
+
550  float GetNoseWheelAngle () const { return v[V_CONTROLS_NWS_RATIO]; }
+
551  void SetNoseWheelAngle (float _f) { v[V_CONTROLS_NWS_RATIO] = _f; }
+
552  float GetFlapRatio () const { return v[V_CONTROLS_FLAP_RATIO]; }
+
553  void SetFlapRatio (float _f) { v[V_CONTROLS_FLAP_RATIO] = _f; }
+
554  float GetSpoilerRatio () const { return v[V_CONTROLS_SPOILER_RATIO]; }
+
555  void SetSpoilerRatio (float _f) { v[V_CONTROLS_SPOILER_RATIO] = _f; }
+
556  float GetSpeedbrakeRatio () const { return v[V_CONTROLS_SPEED_BRAKE_RATIO]; }
+
557  void SetSpeedbrakeRatio (float _f) { v[V_CONTROLS_SPEED_BRAKE_RATIO] = _f; }
+
558  float GetSlatRatio () const { return v[V_CONTROLS_SLAT_RATIO]; }
+
559  void SetSlatRatio (float _f) { v[V_CONTROLS_SLAT_RATIO] = _f; }
+
560  float GetWingSweepRatio () const { return v[V_CONTROLS_WING_SWEEP_RATIO]; }
+
561  void SetWingSweepRatio (float _f) { v[V_CONTROLS_WING_SWEEP_RATIO] = _f; }
+
562  float GetThrustRatio () const { return v[V_CONTROLS_THRUST_RATIO]; }
+
563  void SetThrustRatio (float _f) { v[V_CONTROLS_THRUST_RATIO] = _f; }
+
564  float GetYokePitchRatio () const { return v[V_CONTROLS_YOKE_PITCH_RATIO]; }
+
565  void SetYokePitchRatio (float _f) { v[V_CONTROLS_YOKE_PITCH_RATIO] = _f; }
+
566  float GetYokeHeadingRatio () const { return v[V_CONTROLS_YOKE_HEADING_RATIO]; }
+
567  void SetYokeHeadingRatio (float _f) { v[V_CONTROLS_YOKE_HEADING_RATIO] = _f; }
+
568  float GetYokeRollRatio () const { return v[V_CONTROLS_YOKE_ROLL_RATIO]; }
+
569  void SetYokeRollRatio (float _f) { v[V_CONTROLS_YOKE_ROLL_RATIO] = _f; }
+
570  float GetThrustReversRatio () const { return v[V_CONTROLS_THRUST_REVERS]; }
+
571  void SetThrustReversRatio (float _f){ v[V_CONTROLS_THRUST_REVERS] = _f; }
+
572 
+
573  bool GetLightsTaxi () const { return v[V_CONTROLS_TAXI_LITES_ON] > 0.5f; }
+
574  void SetLightsTaxi (bool _b) { v[V_CONTROLS_TAXI_LITES_ON] = float(_b); }
+
575  bool GetLightsLanding () const { return v[V_CONTROLS_LANDING_LITES_ON] > 0.5f; }
+
576  void SetLightsLanding (bool _b) { v[V_CONTROLS_LANDING_LITES_ON] = float(_b); }
+
577  bool GetLightsBeacon () const { return v[V_CONTROLS_BEACON_LITES_ON] > 0.5f; }
+
578  void SetLightsBeacon (bool _b) { v[V_CONTROLS_BEACON_LITES_ON] = float(_b); }
+
579  bool GetLightsStrobe () const { return v[V_CONTROLS_STROBE_LITES_ON] > 0.5f; }
+
580  void SetLightsStrobe (bool _b) { v[V_CONTROLS_STROBE_LITES_ON] = float(_b); }
+
581  bool GetLightsNav () const { return v[V_CONTROLS_NAV_LITES_ON] > 0.5f; }
+
582  void SetLightsNav (bool _b) { v[V_CONTROLS_NAV_LITES_ON] = float(_b); }
+
583 
+
584  float GetNoseGearDeflection () const { return v[V_GEAR_NOSE_GEAR_DEFLECTION_MTR]; }
+
585  void SetNoseGearDeflection (float _mtr) { v[V_GEAR_NOSE_GEAR_DEFLECTION_MTR] = _mtr; }
+
586  float GetTireDeflection () const { return v[V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR]; }
+
587  void SetTireDeflection (float _mtr) { v[V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR] = _mtr; }
+
588  float GetTireRotAngle () const { return v[V_GEAR_TIRE_ROTATION_ANGLE_DEG]; }
+
589  void SetTireRotAngle (float _deg) { v[V_GEAR_TIRE_ROTATION_ANGLE_DEG] = _deg; }
+
590  float GetTireRotRpm () const { return v[V_GEAR_TIRE_ROTATION_SPEED_RPM]; }
+
591  void SetTireRotRpm (float _rpm) { v[V_GEAR_TIRE_ROTATION_SPEED_RPM] = _rpm;
+
592  v[V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC] = _rpm * RPM_to_RADs; }
+
593  float GetTireRotRad () const { return v[V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC]; }
+
594  void SetTireRotRad (float _rad) { v[V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC] = _rad;
+
595  v[V_GEAR_TIRE_ROTATION_SPEED_RPM] = _rad / RPM_to_RADs; }
+
596 
+
597  float GetEngineRotAngle () const { return v[V_ENGINES_ENGINE_ROTATION_ANGLE_DEG]; }
+
598  void SetEngineRotAngle (float _deg);
+
599  float GetEngineRotRpm () const { return v[V_ENGINES_ENGINE_ROTATION_SPEED_RPM]; }
+
600  void SetEngineRotRpm (float _rpm);
+
601  float GetEngineRotRad () const { return v[V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC]; }
+
602  void SetEngineRotRad (float _rad);
+
603 
+
604  float GetEngineRotAngle (size_t idx) const
+
605  { return 1 <= idx && idx <= 4 ? v[V_ENGINES_ENGINE_ROTATION_ANGLE_DEG1+idx-1] : 0.0f; }
+
606  void SetEngineRotAngle (size_t idx, float _deg);
+
607  float GetEngineRotRpm (size_t idx) const
+
608  { return 1 <= idx && idx <= 4 ? v[V_ENGINES_ENGINE_ROTATION_SPEED_RPM1+idx-1] : 0.0f; }
+
609  void SetEngineRotRpm (size_t idx, float _rpm);
+
610  float GetEngineRotRad (size_t idx) const
+
611  { return 1 <= idx && idx <= 4 ? v[V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC+idx-1] : 0.0f; }
+
612  void SetEngineRotRad (size_t idx, float _rad);
+
613 
+
614  float GetPropRotAngle () const { return v[V_ENGINES_PROP_ROTATION_ANGLE_DEG]; }
+
615  void SetPropRotAngle (float _deg) { v[V_ENGINES_PROP_ROTATION_ANGLE_DEG] = _deg; }
+
616  float GetPropRotRpm () const { return v[V_ENGINES_PROP_ROTATION_SPEED_RPM]; }
+
617  void SetPropRotRpm (float _rpm) { v[V_ENGINES_PROP_ROTATION_SPEED_RPM] = _rpm;
+
618  v[V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC] = _rpm * RPM_to_RADs; }
+
619  float GetPropRotRad () const { return v[V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC]; }
+
620  void SetPropRotRad (float _rad) { v[V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC] = _rad;
+
621  v[V_ENGINES_PROP_ROTATION_SPEED_RPM] = _rad / RPM_to_RADs; }
622 
-
623 #endif
+
623  float GetReversDeployRatio () const { return v[V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO]; }
+
624  void SetReversDeployRatio (float _f){ v[V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO] = _f; }
+
625 
+
626  bool GetTouchDown () const { return v[V_MISC_TOUCH_DOWN] > 0.5f; }
+
627  void SetTouchDown (bool _b) { v[V_MISC_TOUCH_DOWN] = float(_b); }
+
628 
+
635 
+
638  void WakeApplyDefaults(bool _bOverwriteAllFields = true);
+
639 
+
640  float GetWingSpan () const { return wake.wingSpan_m; }
+
641  void SetWingSpan (float _m) { wake.wingSpan_m = _m; }
+
642 
+
643  float GetWingArea() const { return wake.wingArea_m2; }
+
644  void SetWingArea (float _m2) { wake.wingArea_m2 = _m2; }
+
645 
+
646  int GetWakeCat() const;
+
647 
+
648  float GetMass() const { return wake.mass_kg; }
+
649  void SetMass(float _kg) { wake.mass_kg = _kg; }
+
650 
+
651  // Overridables:
+
652  virtual float GetAoA() const { return GetPitch(); }
+
653  virtual float GetLift() const { return GetMass() * G_EARTH; }
+
654 
+
659 
+
661  void MapFindIcon ();
+
663  void MapPreparePos (XPLMMapProjectionID projection,
+
664  const float boundsLTRB[4]);
+
666  void MapDrawIcon (XPLMMapLayerID inLayer, float acSize);
+
668  void MapDrawLabel (XPLMMapLayerID inLayer, float yOfs);
+
669 
+
670 #ifdef INCLUDE_FMOD_SOUND
+
675 
+
680  FMOD_CHANNEL* SoundPlay (const std::string& sndName, float vol = 1.0f);
+
681 
+
684  void SoundStop (FMOD_CHANNEL* pChn);
+
685 
+
689  void SoundVolume (FMOD_CHANNEL* pChn, float vol);
+
690 
+
692  void SoundMuteAll (bool bMute);
+
693 
+
702  virtual std::string SoundGetName (SoundEventsTy sndEvent, float& volAdj) const;
+
703 #endif
+
704 
+
705 protected:
+
706 
+
708 
+
710  static float FlightLoopCB (float, float, int, void*);
+
711 
+
714 
+
716  void DoMove ();
+
718  void UpdateDistBearingCamera (const XPLMCameraPosition_t& posCam);
+
720  void ClampToGround ();
+
722  bool CreateInstances ();
+
724  void DestroyInstances ();
+
725 
+
728  virtual void ComputeMapLabel ();
+
729 
+
730  // The following functions are implemented in AIMultiplayer.cpp:
+
732  virtual void SetTcasTargetIdx (int _idx) { tcasTargetIdx = _idx; }
+
733 
+
735 
+
736  // These functions perform the TCAS target / multiplayer data updates
+
737  friend void AIMultiUpdate ();
+
738  friend size_t AIUpdateTCASTargets ();
+
739  friend size_t AIUpdateMultiplayerDataRefs ();
+
740 
+
741 #ifdef INCLUDE_FMOD_SOUND
+
745 
+
747  virtual void SoundSetup ();
+
749  virtual void SoundUpdate ();
+
751  virtual void SoundRemoveAll ();
+
752 
+
754 #endif
+
755 };
+
756 
+
758 Aircraft* AcFindByID (XPMPPlaneID _id);
+
759 
+
761 bool AcSetDefaultWakeData(const std::string& _wtc, const Aircraft::wakeTy& _wake);
+
762 
+
763 //
+
764 // MARK: XPMP2 Exception class
+
765 //
+
766 
+
768 class XPMP2Error : public std::logic_error {
+
769 protected:
+
770  std::string fileName;
+
771  int ln;
+
772  std::string funcName;
+
773  std::string msg;
+
774 public:
+
776  XPMP2Error (const char* szFile, int ln, const char* szFunc, const char* szMsg, ...);
+
777 public:
+
779  virtual const char* what() const noexcept;
+
780 
+
781 public:
+
782  // copy/move constructor/assignment as per default
+
783  XPMP2Error (const XPMP2Error& o) = default;
+
784  XPMP2Error (XPMP2Error&& o) = default;
+
785  XPMP2Error& operator = (const XPMP2Error& o) = default;
+
786  XPMP2Error& operator = (XPMP2Error&& o) = default;
+
787 };
+
788 
+
789 
+
790 
+
791 } // namespace XPMP2
+
792 
+
793 #endif
XPMPMultiplayer.h
Initialization and general control functions for XPMP2.
-
XPMPPlaneRadar_t::mode
XPMPTransponderMode mode
current radar mode, if not xpmpTransponderMode_Standby then is plane considered for TCAS display
Definition: XPMPMultiplayer.h:192
-
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:243
-
xpmpTransponderMode_Standby
@ xpmpTransponderMode_Standby
transponder is in standby, not currently sending -> aircraft not visible on TCAS
Definition: XPMPMultiplayer.h:180
-
XPMPInfoTexts_t
Textual information of planes to be passed on via shared dataRefs to other plugins.
Definition: XPMPMultiplayer.h:199
-
XPMPPlaneRadar_t
defines information about an aircraft visible to radar.
Definition: XPMPMultiplayer.h:189
-
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:147
-
XPMP2::Aircraft::GetLightsBeacon
bool GetLightsBeacon() const
Beacon lights.
Definition: XPMPAircraft.h:476
+
XPMPPlaneRadar_t::mode
XPMPTransponderMode mode
current radar mode, if not xpmpTransponderMode_Standby then is plane considered for TCAS display
Definition: XPMPMultiplayer.h:201
+
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:252
+
xpmpTransponderMode_Standby
@ xpmpTransponderMode_Standby
transponder is in standby, not currently sending -> aircraft not visible on TCAS
Definition: XPMPMultiplayer.h:189
+
XPMPInfoTexts_t
Textual information of planes to be passed on via shared dataRefs to other plugins.
Definition: XPMPMultiplayer.h:208
+
XPMPPlaneRadar_t
defines information about an aircraft visible to radar.
Definition: XPMPMultiplayer.h:198
+
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:181
+
XPMP2::Aircraft::GetLightsBeacon
bool GetLightsBeacon() const
Beacon lights.
Definition: XPMPAircraft.h:577
XPMP2::Aircraft::UpdatePosition
virtual void UpdatePosition(float _elapsedSinceLastCall, int _flCounter)=0
Called right before updating the aircraft's placement in the world.
-
XPMP2::Aircraft::GetGearRatio
float GetGearRatio() const
Gear deploy ratio.
Definition: XPMPAircraft.h:447
-
XPMP2::Aircraft::SetLocalLoc
void SetLocalLoc(float _x, float _y, float _z)
Sets location in local world coordinates.
Definition: XPMPAircraft.h:435
-
XPMP2::Aircraft::GetThrustReversRatio
float GetThrustReversRatio() const
Thrust reversers ratio.
Definition: XPMPAircraft.h:469
-
XPMP2::Aircraft::label
std::string label
aircraft label shown in the 3D world next to the plane
Definition: XPMPAircraft.h:184
-
XPMP2::Aircraft::SetLightsNav
void SetLightsNav(bool _b)
Navigation lights.
Definition: XPMPAircraft.h:481
-
XPMP2::Aircraft::GetNoseWheelAngle
float GetNoseWheelAngle() const
Nose Wheel angle in degrees.
Definition: XPMPAircraft.h:449
-
XPMP2::Aircraft::IsRendered
bool IsRendered() const
Is this plane to be rendered?
Definition: XPMPAircraft.h:381
-
XPMP2::Aircraft::SetMass
void SetMass(float _kg)
Mass [kg].
Definition: XPMPAircraft.h:543
-
XPMP2::Aircraft::GetVertOfs
float GetVertOfs() const
Vertical offset, ie. the value that needs to be added to drawInfo.y to make the aircraft appear on th...
Definition: Aircraft.cpp:476
-
XPMP2::Aircraft::GetSpeedbrakeRatio
float GetSpeedbrakeRatio() const
Speedbrakes deploy ratio.
Definition: XPMPAircraft.h:455
-
XPMP2::Aircraft::acIcaoType
std::string acIcaoType
ICAO aircraft type designator of this plane.
Definition: XPMPAircraft.h:161
-
XPMP2::Aircraft::GetRoll
float GetRoll() const
roll [degree]
Definition: XPMPAircraft.h:443
-
XPMP2::Aircraft::GetModelInfo
CSLModelInfo_t GetModelInfo() const
return an information structure for the CSL model associated with the aircraft
Definition: XPMPAircraft.h:362
-
XPMP2::Aircraft::hProbe
XPLMProbeRef hProbe
Y Probe for terrain testing, needed in ground clamping.
Definition: XPMPAircraft.h:265
-
XPMP2::Aircraft::GetWakeCat
int GetWakeCat() const
Category between 0=light and 3=Super, derived from WTC.
Definition: Aircraft.cpp:486
-
XPMP2::Aircraft::SetSpoilerRatio
void SetSpoilerRatio(float _f)
Spoilers deploy ratio.
Definition: XPMPAircraft.h:454
+
XPMP2::Aircraft::aSndCh
SndChTy aSndCh[SND_NUM_EVENTS]
Operational values per sound channel, that is triggered by a standard sound event.
Definition: XPMPAircraft.h:339
+
XPMP2::Aircraft::GetGearRatio
float GetGearRatio() const
Gear deploy ratio.
Definition: XPMPAircraft.h:548
+
XPMP2::Aircraft::SetLocalLoc
void SetLocalLoc(float _x, float _y, float _z)
Sets location in local world coordinates.
Definition: XPMPAircraft.h:530
+
XPMP2::Aircraft::GetThrustReversRatio
float GetThrustReversRatio() const
Thrust reversers ratio.
Definition: XPMPAircraft.h:570
+
XPMP2::Aircraft::SndChTy::lastDRVal
float lastDRVal
last observed dataRef value to see if sound is to be triggered
Definition: XPMPAircraft.h:329
+
XPMP2::Aircraft::label
std::string label
aircraft label shown in the 3D world next to the plane
Definition: XPMPAircraft.h:218
+
XPMP2::Aircraft::SetLightsNav
void SetLightsNav(bool _b)
Navigation lights.
Definition: XPMPAircraft.h:582
+
XPMP2::Aircraft::GetNoseWheelAngle
float GetNoseWheelAngle() const
Nose Wheel angle in degrees.
Definition: XPMPAircraft.h:550
+
XPMP2::Aircraft::IsRendered
bool IsRendered() const
Is this plane to be rendered?
Definition: XPMPAircraft.h:474
+
XPMP2::Aircraft::SetMass
void SetMass(float _kg)
Mass [kg].
Definition: XPMPAircraft.h:649
+
XPMP2::Aircraft::GetVertOfs
float GetVertOfs() const
Vertical offset, ie. the value that needs to be added to drawInfo.y to make the aircraft appear on th...
Definition: Aircraft.cpp:490
+
XPMP2::Aircraft::GetSpeedbrakeRatio
float GetSpeedbrakeRatio() const
Speedbrakes deploy ratio.
Definition: XPMPAircraft.h:556
+
XPMP2::Aircraft::acIcaoType
std::string acIcaoType
ICAO aircraft type designator of this plane.
Definition: XPMPAircraft.h:195
+
XPMP2::Aircraft::GetRoll
float GetRoll() const
roll [degree]
Definition: XPMPAircraft.h:538
+
XPMP2::Aircraft::GetModelInfo
CSLModelInfo_t GetModelInfo() const
return an information structure for the CSL model associated with the aircraft
Definition: XPMPAircraft.h:450
+
XPMP2::Aircraft::hProbe
XPLMProbeRef hProbe
Y Probe for terrain testing, needed in ground clamping.
Definition: XPMPAircraft.h:301
+
XPMP2::Aircraft::GetWakeCat
int GetWakeCat() const
Category between 0=light and 3=Super, derived from WTC.
Definition: Aircraft.cpp:500
+
XPMP2::Aircraft::SetSpoilerRatio
void SetSpoilerRatio(float _f)
Spoilers deploy ratio.
Definition: XPMPAircraft.h:555
XPMP2::Aircraft::MapDrawLabel
void MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)
Actually draw the map label.
Definition: Map.cpp:151
-
XPMP2::Aircraft::IsCurrentlyShownAsTcasTarget
bool IsCurrentlyShownAsTcasTarget() const
Is this plane currently also being tracked as a TCAS target, ie. will appear on TCAS?
Definition: XPMPAircraft.h:325
+
XPMP2::Aircraft::IsCurrentlyShownAsTcasTarget
bool IsCurrentlyShownAsTcasTarget() const
Is this plane currently also being tracked as a TCAS target, ie. will appear on TCAS?
Definition: XPMPAircraft.h:408
XPMP2::Aircraft::IsCurrentlyShownAsAI
bool IsCurrentlyShownAsAI() const
Is this plane currently also being tracked by X-Plane's classic AI/multiplayer?
Definition: AIMultiplayer.cpp:217
-
XPMP2::Aircraft::SetRender
virtual void SetRender(bool _bRender)
Switch rendering of the CSL model on or off.
Definition: Aircraft.cpp:848
-
XPMP2::Aircraft::vertOfsRatio
float vertOfsRatio
How much of the vertical offset shall be applied? (This allows phasing out the vertical offset in hig...
Definition: XPMPAircraft.h:189
-
XPMP2::Aircraft::GetTcasTargetIdx
int GetTcasTargetIdx() const
return the current TCAS target index (into sim/cockpit2/tcas/targets), 1-based, -1 if not used
Definition: XPMPAircraft.h:323
-
XPMP2::Aircraft::aiPrio
int aiPrio
Priority for display in one of the limited number of TCAS target slots.
Definition: XPMPAircraft.h:209
-
XPMP2::Aircraft::GetModel
XPMP2::CSLModel * GetModel() const
return a pointer to the CSL model in use (Note: The CSLModel structure is not public....
Definition: XPMPAircraft.h:358
-
XPMP2::Aircraft::SetEngineRotRpm
void SetEngineRotRpm(float _rpm)
Engine rotation speed [rpm], also sets [rad/s] and engines 1..4.
Definition: Aircraft.cpp:739
-
XPMP2::Aircraft::GetEngineRotAngle
float GetEngineRotAngle() const
Engine rotation angle [degree].
Definition: XPMPAircraft.h:496
-
XPMP2::Aircraft::GetPropRotAngle
float GetPropRotAngle() const
Propellor rotation angle [degree].
Definition: XPMPAircraft.h:513
-
XPMP2::Aircraft::acIcaoAirline
std::string acIcaoAirline
ICAO Airline code of this plane.
Definition: XPMPAircraft.h:162
-
XPMP2::Aircraft::GetNoseGearDeflection
float GetNoseGearDeflection() const
Vertical nose gear deflection [meter].
Definition: XPMPAircraft.h:483
+
XPMP2::Aircraft::SetRender
virtual void SetRender(bool _bRender)
Switch rendering of the CSL model on or off.
Definition: Aircraft.cpp:878
+
XPMP2::Aircraft::vertOfsRatio
float vertOfsRatio
How much of the vertical offset shall be applied? (This allows phasing out the vertical offset in hig...
Definition: XPMPAircraft.h:223
+
XPMP2::Aircraft::GetTcasTargetIdx
int GetTcasTargetIdx() const
return the current TCAS target index (into sim/cockpit2/tcas/targets), 1-based, -1 if not used
Definition: XPMPAircraft.h:406
+
XPMP2::Aircraft::aiPrio
int aiPrio
Priority for display in one of the limited number of TCAS target slots.
Definition: XPMPAircraft.h:243
+
XPMP2::Aircraft::GetModel
XPMP2::CSLModel * GetModel() const
return a pointer to the CSL model in use (Note: The CSLModel structure is not public....
Definition: XPMPAircraft.h:446
+
XPMP2::Aircraft::SetEngineRotRpm
void SetEngineRotRpm(float _rpm)
Engine rotation speed [rpm], also sets [rad/s] and engines 1..4.
Definition: Aircraft.cpp:764
+
XPMP2::Aircraft::GetEngineRotAngle
float GetEngineRotAngle() const
Engine rotation angle [degree].
Definition: XPMPAircraft.h:597
+
XPMP2::Aircraft::GetPropRotAngle
float GetPropRotAngle() const
Propellor rotation angle [degree].
Definition: XPMPAircraft.h:614
+
XPMP2::Aircraft::acIcaoAirline
std::string acIcaoAirline
ICAO Airline code of this plane.
Definition: XPMPAircraft.h:196
+
XPMP2::Aircraft::GetNoseGearDeflection
float GetNoseGearDeflection() const
Vertical nose gear deflection [meter].
Definition: XPMPAircraft.h:584
XPMP2::Aircraft::ComputeMapLabel
virtual void ComputeMapLabel()
Put together the map label.
Definition: Map.cpp:165
-
XPMP2::Aircraft::SetVisible
virtual void SetVisible(bool _bVisible)
Make the plane (in)visible.
Definition: Aircraft.cpp:831
-
XPMP2::Aircraft::camDist
float camDist
Distance to camera in meters (updated internally regularly)
Definition: XPMPAircraft.h:260
-
XPMP2::Aircraft::GetFlightId
virtual std::string GetFlightId() const
Return a value for dataRef .../tcas/target/flight_id.
Definition: Aircraft.cpp:336
-
XPMP2::Aircraft::mapX
float mapX
temporary: map coordinates (NAN = not to be drawn)
Definition: XPMPAircraft.h:270
-
XPMP2::Aircraft::camBearing
float camBearing
Bearing from camera in degrees (updated internally regularly)
Definition: XPMPAircraft.h:262
+
XPMP2::Aircraft::SetVisible
virtual void SetVisible(bool _bVisible)
Make the plane (in)visible.
Definition: Aircraft.cpp:856
+
XPMP2::Aircraft::camDist
float camDist
Distance to camera in meters (updated internally regularly)
Definition: XPMPAircraft.h:296
+
XPMP2::Aircraft::GetFlightId
virtual std::string GetFlightId() const
Return a value for dataRef .../tcas/target/flight_id.
Definition: Aircraft.cpp:346
+
XPMP2::Aircraft::mapX
float mapX
temporary: map coordinates (NAN = not to be drawn)
Definition: XPMPAircraft.h:306
+
XPMP2::Aircraft::camBearing
float camBearing
Bearing from camera in degrees (updated internally regularly)
Definition: XPMPAircraft.h:298
XPMP2::Aircraft::wake
struct XPMP2::Aircraft::wakeTy wake
wake-support data
-
XPMP2::Aircraft::GetLightsLanding
bool GetLightsLanding() const
Landing lights.
Definition: XPMPAircraft.h:474
-
XPMP2::Aircraft::GetTireRotRpm
float GetTireRotRpm() const
Tire rotation speed [rpm].
Definition: XPMPAircraft.h:489
+
XPMP2::Aircraft::v_z
float v_z
Cartesian velocity in m/s per axis.
Definition: XPMPAircraft.h:282
+
XPMP2::Aircraft::GetLightsLanding
bool GetLightsLanding() const
Landing lights.
Definition: XPMPAircraft.h:575
+
XPMP2::Aircraft::GetTireRotRpm
float GetTireRotRpm() const
Tire rotation speed [rpm].
Definition: XPMPAircraft.h:590
XPMP2::Aircraft::Aircraft
Aircraft()
Default constructor creates an empty, invalid(!) and invisible shell; call XPMP2::Aircraft::Create() ...
Definition: Aircraft.cpp:204
-
XPMP2::Aircraft::GetLightsStrobe
bool GetLightsStrobe() const
Strobe lights.
Definition: XPMPAircraft.h:478
-
XPMP2::Aircraft::GetEngineRotAngle
float GetEngineRotAngle(size_t idx) const
< Engine rotation angle [degree] for engine idx (1..4)
Definition: XPMPAircraft.h:503
-
XPMP2::Aircraft::GetThrustRatio
float GetThrustRatio() const
Thrust ratio.
Definition: XPMPAircraft.h:461
-
XPMP2::Aircraft::SetGearRatio
void SetGearRatio(float _f)
Gear deploy ratio.
Definition: XPMPAircraft.h:448
-
XPMP2::Aircraft::GetSpoilerRatio
float GetSpoilerRatio() const
Spoilers deploy ratio.
Definition: XPMPAircraft.h:453
-
XPMP2::Aircraft::GetTouchDown
bool GetTouchDown() const
Moment of touch down.
Definition: XPMPAircraft.h:525
-
XPMP2::Aircraft::SetThrustReversRatio
void SetThrustReversRatio(float _f)
Thrust reversers ratio.
Definition: XPMPAircraft.h:470
-
XPMP2::Aircraft::GetTireRotAngle
float GetTireRotAngle() const
Tire rotation angle [degree].
Definition: XPMPAircraft.h:487
-
XPMP2::Aircraft::GetCameraBearing
float GetCameraBearing() const
Bearing from camera [°].
Definition: XPMPAircraft.h:394
-
XPMP2::Aircraft::SetLightsStrobe
void SetLightsStrobe(bool _b)
Strobe lights.
Definition: XPMPAircraft.h:479
-
XPMP2::Aircraft::SetTcasTargetIdx
virtual void SetTcasTargetIdx(int _idx)
Define the TCAS target index in use.
Definition: XPMPAircraft.h:580
-
XPMP2::Aircraft::GetLightsTaxi
bool GetLightsTaxi() const
Taxi lights.
Definition: XPMPAircraft.h:472
-
XPMP2::Aircraft::SetTireRotRpm
void SetTireRotRpm(float _rpm)
Definition: XPMPAircraft.h:490
-
XPMP2::Aircraft::bVisible
bool bVisible
Shall this plane be drawn at the moment and be visible to TCAS/interfaces?
Definition: XPMPAircraft.h:238
-
XPMP2::Aircraft::matchQuality
int matchQuality
quality of the match with the CSL model
Definition: XPMPAircraft.h:242
-
XPMP2::Aircraft::AIUpdateTCASTargets
friend size_t AIUpdateTCASTargets()
The modern way: Use TCAS override and update TCAS targets.
Definition: AIMultiplayer.cpp:343
-
XPMP2::Aircraft::SetNoseWheelAngle
void SetNoseWheelAngle(float _f)
Nose Wheel angle in degrees.
Definition: XPMPAircraft.h:450
-
XPMP2::Aircraft::GetModeS_ID
XPMPPlaneID GetModeS_ID() const
return the XPMP2 plane id
Definition: XPMPAircraft.h:315
-
XPMP2::Aircraft::SetSpeedbrakeRatio
void SetSpeedbrakeRatio(float _f)
Speedbrakes deploy ratio.
Definition: XPMPAircraft.h:456
-
XPMP2::Aircraft::AIMultiUpdate
friend void AIMultiUpdate()
Updates all TCAS target dataRefs, both standard X-Plane, as well as additional shared dataRefs for te...
Definition: AIMultiplayer.cpp:606
-
XPMP2::Aircraft::AssignModel
bool AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)
Assigns the given model.
Definition: Aircraft.cpp:409
-
XPMP2::Aircraft::DestroyInstances
void DestroyInstances()
Destroy all instances.
Definition: Aircraft.cpp:663
-
XPMP2::Aircraft::SetTireDeflection
void SetTireDeflection(float _mtr)
Vertical (main) gear deflection [meter].
Definition: XPMPAircraft.h:486
-
XPMP2::Aircraft::SetLightsLanding
void SetLightsLanding(bool _b)
Landing lights.
Definition: XPMPAircraft.h:475
-
XPMP2::Aircraft::listInst
std::list< XPLMInstanceRef > listInst
X-Plane instance handles for all objects making up the model.
Definition: XPMPAircraft.h:253
-
XPMP2::Aircraft::IsOnGrnd
bool IsOnGrnd() const
Is the aircraft on the ground?
Definition: XPMPAircraft.h:407
-
XPMP2::Aircraft::GetTireDeflection
float GetTireDeflection() const
Vertical (main) gear deflection [meter].
Definition: XPMPAircraft.h:485
-
XPMP2::Aircraft::SetYokeHeadingRatio
void SetYokeHeadingRatio(float _f)
Yoke heading ratio.
Definition: XPMPAircraft.h:466
-
XPMP2::Aircraft::IsRelatedTo
bool IsRelatedTo(const std::string &_icaoType) const
Is this object "related" to the given ICAO code? (named in the same line in related....
Definition: Aircraft.cpp:325
-
XPMP2::Aircraft::IsInstanciated
bool IsInstanciated() const
Are instances created for this aircraft?
Definition: XPMPAircraft.h:384
-
XPMP2::Aircraft::modeS_id
XPMPPlaneID modeS_id
A plane is uniquely identified by a 24bit number [0x01..0xFFFFFF].
Definition: XPMPAircraft.h:156
+
XPMP2::Aircraft::SoundGetName
virtual std::string SoundGetName(SoundEventsTy sndEvent, float &volAdj) const
Returns the name of the sound to play per event.
Definition: Sound.cpp:505
+
XPMP2::Aircraft::GetLightsStrobe
bool GetLightsStrobe() const
Strobe lights.
Definition: XPMPAircraft.h:579
+
XPMP2::Aircraft::bChnLowPass
bool bChnLowPass
Is Low Pass Filter currently being active?
Definition: XPMPAircraft.h:341
+
XPMP2::Aircraft::GetEngineRotAngle
float GetEngineRotAngle(size_t idx) const
< Engine rotation angle [degree] for engine idx (1..4)
Definition: XPMPAircraft.h:604
+
XPMP2::Aircraft::GetThrustRatio
float GetThrustRatio() const
Thrust ratio.
Definition: XPMPAircraft.h:562
+
XPMP2::Aircraft::SetGearRatio
void SetGearRatio(float _f)
Gear deploy ratio.
Definition: XPMPAircraft.h:549
+
XPMP2::Aircraft::GetSpoilerRatio
float GetSpoilerRatio() const
Spoilers deploy ratio.
Definition: XPMPAircraft.h:554
+
XPMP2::Aircraft::GetTouchDown
bool GetTouchDown() const
Moment of touch down.
Definition: XPMPAircraft.h:626
+
XPMP2::Aircraft::SetThrustReversRatio
void SetThrustReversRatio(float _f)
Thrust reversers ratio.
Definition: XPMPAircraft.h:571
+
XPMP2::Aircraft::GetTireRotAngle
float GetTireRotAngle() const
Tire rotation angle [degree].
Definition: XPMPAircraft.h:588
+
XPMP2::Aircraft::GetCameraBearing
float GetCameraBearing() const
Bearing from camera [°].
Definition: XPMPAircraft.h:487
+
XPMP2::Aircraft::SetLightsStrobe
void SetLightsStrobe(bool _b)
Strobe lights.
Definition: XPMPAircraft.h:580
+
XPMP2::Aircraft::SetTcasTargetIdx
virtual void SetTcasTargetIdx(int _idx)
Define the TCAS target index in use.
Definition: XPMPAircraft.h:732
+
XPMP2::Aircraft::GetLightsTaxi
bool GetLightsTaxi() const
Taxi lights.
Definition: XPMPAircraft.h:573
+
XPMP2::Aircraft::SoundEventsTy
SoundEventsTy
Types of sound supported directly by XPMP2.
Definition: XPMPAircraft.h:314
+
XPMP2::Aircraft::SND_FLAPS
@ SND_FLAPS
Flaps extending/retracting (once per event), bases on GetFlapRatio()
Definition: XPMPAircraft.h:319
+
XPMP2::Aircraft::SND_TIRE
@ SND_TIRE
Tires rolling on the ground (continuously while rolling on ground), bases on GetTireRotRpm()
Definition: XPMPAircraft.h:317
+
XPMP2::Aircraft::SND_GEAR
@ SND_GEAR
Gear extending/retracting (once per event), bases on GetGearRatio()
Definition: XPMPAircraft.h:318
+
XPMP2::Aircraft::SND_REVERSE_THRUST
@ SND_REVERSE_THRUST
Engine sound while reverse thrust (continuously while reversers deployed), bases on GetThrustReversRa...
Definition: XPMPAircraft.h:316
+
XPMP2::Aircraft::SND_ENG
@ SND_ENG
Engine sound (continuously while engine running), bases on GetThrustRatio()
Definition: XPMPAircraft.h:315
+
XPMP2::Aircraft::SND_NUM_EVENTS
@ SND_NUM_EVENTS
Number of events (always last in enum)
Definition: XPMPAircraft.h:320
+
XPMP2::Aircraft::SetTireRotRpm
void SetTireRotRpm(float _rpm)
Definition: XPMPAircraft.h:591
+
XPMP2::Aircraft::bVisible
bool bVisible
Shall this plane be drawn at the moment and be visible to TCAS/interfaces?
Definition: XPMPAircraft.h:272
+
XPMP2::Aircraft::SndChTy::pChn
FMOD_CHANNEL * pChn
channel playing the sound currently
Definition: XPMPAircraft.h:328
+
XPMP2::Aircraft::matchQuality
int matchQuality
quality of the match with the CSL model
Definition: XPMPAircraft.h:276
+
XPMP2::Aircraft::AIUpdateTCASTargets
friend size_t AIUpdateTCASTargets()
The modern way: Use TCAS override and update TCAS targets.
Definition: AIMultiplayer.cpp:345
+
XPMP2::Aircraft::SetNoseWheelAngle
void SetNoseWheelAngle(float _f)
Nose Wheel angle in degrees.
Definition: XPMPAircraft.h:551
+
XPMP2::Aircraft::GetModeS_ID
XPMPPlaneID GetModeS_ID() const
return the XPMP2 plane id
Definition: XPMPAircraft.h:398
+
XPMP2::Aircraft::SetSpeedbrakeRatio
void SetSpeedbrakeRatio(float _f)
Speedbrakes deploy ratio.
Definition: XPMPAircraft.h:557
+
XPMP2::Aircraft::SoundStop
void SoundStop(FMOD_CHANNEL *pChn)
Stop a continuously playing sound.
Definition: Sound.cpp:478
+
XPMP2::Aircraft::AIMultiUpdate
friend void AIMultiUpdate()
Updates all TCAS target dataRefs, both standard X-Plane, as well as additional shared dataRefs for te...
Definition: AIMultiplayer.cpp:608
+
XPMP2::Aircraft::AssignModel
bool AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)
Assigns the given model.
Definition: Aircraft.cpp:423
+
XPMP2::Aircraft::DestroyInstances
void DestroyInstances()
Destroy all instances.
Definition: Aircraft.cpp:688
+
XPMP2::Aircraft::SetTireDeflection
void SetTireDeflection(float _mtr)
Vertical (main) gear deflection [meter].
Definition: XPMPAircraft.h:587
+
XPMP2::Aircraft::SetLightsLanding
void SetLightsLanding(bool _b)
Landing lights.
Definition: XPMPAircraft.h:576
+
XPMP2::Aircraft::listInst
std::list< XPLMInstanceRef > listInst
X-Plane instance handles for all objects making up the model.
Definition: XPMPAircraft.h:289
+
XPMP2::Aircraft::IsOnGrnd
bool IsOnGrnd() const
Is the aircraft on the ground?
Definition: XPMPAircraft.h:500
+
XPMP2::Aircraft::GetGS_kn
float GetGS_kn() const
Rough estimate of a ground speed based on v_x/z
Definition: XPMPAircraft.h:541
+
XPMP2::Aircraft::GetTireDeflection
float GetTireDeflection() const
Vertical (main) gear deflection [meter].
Definition: XPMPAircraft.h:586
+
XPMP2::Aircraft::SetYokeHeadingRatio
void SetYokeHeadingRatio(float _f)
Yoke heading ratio.
Definition: XPMPAircraft.h:567
+
XPMP2::Aircraft::v_y
float v_y
Definition: XPMPAircraft.h:282
+
XPMP2::Aircraft::IsRelatedTo
bool IsRelatedTo(const std::string &_icaoType) const
Is this object "related" to the given ICAO code? (named in the same line in related....
Definition: Aircraft.cpp:335
+
XPMP2::Aircraft::IsInstanciated
bool IsInstanciated() const
Are instances created for this aircraft?
Definition: XPMPAircraft.h:477
+
XPMP2::Aircraft::modeS_id
XPMPPlaneID modeS_id
A plane is uniquely identified by a 24bit number [0x01..0xFFFFFF].
Definition: XPMPAircraft.h:190
XPMP2::Aircraft::MapPreparePos
void MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])
Prepare map coordinates.
Definition: Map.cpp:116
-
XPMP2::Aircraft::tcasTargetIdx
int tcasTargetIdx
Which sim/cockpit2/tcas/targets-index does this plane occupy? [1..63], -1 if none.
Definition: XPMPAircraft.h:255
-
XPMP2::Aircraft::SetPropRotRpm
void SetPropRotRpm(float _rpm)
Definition: XPMPAircraft.h:516
-
XPMP2::Aircraft::SetFlapRatio
void SetFlapRatio(float _f)
Flaps deploy ratio.
Definition: XPMPAircraft.h:452
-
XPMP2::Aircraft::ShowAsAIPlane
bool ShowAsAIPlane() const
Is this plane to be drawn on TCAS? (It will if transponder is not switched off)
Definition: XPMPAircraft.h:329
-
XPMP2::Aircraft::GetWingArea
float GetWingArea() const
Wing area [m²].
Definition: XPMPAircraft.h:537
-
XPMP2::Aircraft::GetTireRotRad
float GetTireRotRad() const
Tire rotation speed [rad/s].
Definition: XPMPAircraft.h:492
-
XPMP2::Aircraft::DoMove
void DoMove()
Internal: This puts the instance into XP's sky and makes it move.
Definition: Aircraft.cpp:569
-
XPMP2::Aircraft::gearDeflectRatio
float gearDeflectRatio
By how much of the gear deflection shall the plane's altitude be reduced?
Definition: XPMPAircraft.h:196
-
XPMP2::Aircraft::SetLightsBeacon
void SetLightsBeacon(bool _b)
Beacon lights.
Definition: XPMPAircraft.h:477
-
XPMP2::Aircraft::GetLift
virtual float GetLift() const
Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic inf...
Definition: XPMPAircraft.h:547
-
XPMP2::Aircraft::GetPropRotRpm
float GetPropRotRpm() const
Propellor rotation speed [rpm].
Definition: XPMPAircraft.h:515
+
XPMP2::Aircraft::tcasTargetIdx
int tcasTargetIdx
Which sim/cockpit2/tcas/targets-index does this plane occupy? [1..63], -1 if none.
Definition: XPMPAircraft.h:291
+
XPMP2::Aircraft::SetPropRotRpm
void SetPropRotRpm(float _rpm)
Definition: XPMPAircraft.h:617
+
XPMP2::Aircraft::SetFlapRatio
void SetFlapRatio(float _f)
Flaps deploy ratio.
Definition: XPMPAircraft.h:553
+
XPMP2::Aircraft::ShowAsAIPlane
bool ShowAsAIPlane() const
Is this plane to be drawn on TCAS? (It will if transponder is not switched off)
Definition: XPMPAircraft.h:412
+
XPMP2::Aircraft::GetWingArea
float GetWingArea() const
Wing area [m²].
Definition: XPMPAircraft.h:643
+
XPMP2::Aircraft::GetTireRotRad
float GetTireRotRad() const
Tire rotation speed [rad/s].
Definition: XPMPAircraft.h:593
+
XPMP2::Aircraft::DoMove
void DoMove()
Internal: This puts the instance into XP's sky and makes it move.
Definition: Aircraft.cpp:594
+
XPMP2::Aircraft::gearDeflectRatio
float gearDeflectRatio
By how much of the gear deflection shall the plane's altitude be reduced?
Definition: XPMPAircraft.h:230
+
XPMP2::Aircraft::SetLightsBeacon
void SetLightsBeacon(bool _b)
Beacon lights.
Definition: XPMPAircraft.h:578
+
XPMP2::Aircraft::GetLift
virtual float GetLift() const
Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic inf...
Definition: XPMPAircraft.h:653
+
XPMP2::Aircraft::GetPropRotRpm
float GetPropRotRpm() const
Propellor rotation speed [rpm].
Definition: XPMPAircraft.h:616
XPMP2::Aircraft::operator=
Aircraft & operator=(const Aircraft &)=delete
Aircraft must not be copied as they reference non-copyable resources like XP instances.
-
XPMP2::Aircraft::Create
void Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)
Creates a plane, only a valid operation if object was created using the default constructor.
Definition: Aircraft.cpp:237
-
XPMP2::Aircraft::SetPropRotAngle
void SetPropRotAngle(float _deg)
Propellor rotation angle [degree].
Definition: XPMPAircraft.h:514
-
XPMP2::Aircraft::SetSlatRatio
void SetSlatRatio(float _f)
Slats deploy ratio.
Definition: XPMPAircraft.h:458
-
XPMP2::Aircraft::SetLightsTaxi
void SetLightsTaxi(bool _b)
Taxi lights.
Definition: XPMPAircraft.h:473
-
XPMP2::Aircraft::IsGroundVehicle
bool IsGroundVehicle() const
Is this object a ground vehicle?
Definition: Aircraft.cpp:318
-
XPMP2::Aircraft::FlightLoopCB
static float FlightLoopCB(float, float, int, void *)
Internal: Flight loop callback function controlling update and movement of all planes.
Definition: Aircraft.cpp:492
-
XPMP2::Aircraft::drawInfo
XPLMDrawInfo_t drawInfo
Holds position (in local coordinates!) and orientation (pitch, heading roll) of the aircraft.
Definition: XPMPAircraft.h:169
-
XPMP2::Aircraft::GetYokePitchRatio
float GetYokePitchRatio() const
Yoke pitch ratio.
Definition: XPMPAircraft.h:463
-
XPMP2::Aircraft::SetOnGrnd
void SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)
Set if the aircraft is on the ground.
Definition: Aircraft.cpp:685
-
XPMP2::Aircraft::SetDrawLabel
void SetDrawLabel(bool _b)
Define if this aircraft's label is to be drawn (provided label drawing is enabled globally)
Definition: XPMPAircraft.h:387
-
XPMP2::Aircraft::ChangeModel
int ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)
(Potentially) changes the plane's model after doing a new match attempt
Definition: Aircraft.cpp:357
-
XPMP2::Aircraft::v
std::vector< float > v
actual dataRef values to be provided to the CSL model
Definition: XPMPAircraft.h:181
-
XPMP2::Aircraft::GetFlapRatio
float GetFlapRatio() const
Flaps deploy ratio.
Definition: XPMPAircraft.h:451
-
XPMP2::Aircraft::GetEngineRotRpm
float GetEngineRotRpm(size_t idx) const
< Engine rotation speed [rpm] for engine idx (1..4)
Definition: XPMPAircraft.h:506
-
XPMP2::Aircraft::GetEngineRotRad
float GetEngineRotRad(size_t idx) const
< Engine rotation speed [rad/s] for engine idx (1..4)
Definition: XPMPAircraft.h:509
-
XPMP2::Aircraft::acInfoTexts
XPMPInfoTexts_t acInfoTexts
Informational texts passed on via multiplayer shared dataRefs.
Definition: XPMPAircraft.h:234
-
XPMP2::Aircraft::GetMass
float GetMass() const
Mass [kg].
Definition: XPMPAircraft.h:542
-
XPMP2::Aircraft::CreateInstances
bool CreateInstances()
Create the instances required to represent the plane, return if successful.
Definition: Aircraft.cpp:626
-
XPMP2::Aircraft::prev_y
float prev_y
Definition: XPMPAircraft.h:246
-
XPMP2::Aircraft::bOnGrnd
bool bOnGrnd
Is the aircraft on the ground?
Definition: XPMPAircraft.h:172
-
XPMP2::Aircraft::SetLocation
void SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)
Converts world coordinates to local coordinates, writes to Aircraft::drawInfo.
Definition: XPMPAircraft.h:422
-
XPMP2::Aircraft::bDrawLabel
bool bDrawLabel
Shall this aircraft's label be drawn?
Definition: XPMPAircraft.h:186
-
XPMP2::Aircraft::GetModelName
const std::string & GetModelName() const
return the name of the CSL model in use
Definition: Aircraft.cpp:466
-
XPMP2::Aircraft::UpdateDistBearingCamera
void UpdateDistBearingCamera(const XPLMCameraPosition_t &posCam)
Internal: Update the plane's distance/bearing from the camera location.
Definition: Aircraft.cpp:615
-
XPMP2::Aircraft::GetYokeRollRatio
float GetYokeRollRatio() const
Yoke roll ratio.
Definition: XPMPAircraft.h:467
-
XPMP2::Aircraft::ClampToGround
void ClampToGround()
Clamp to ground: Make sure the plane is not below ground, corrects Aircraft::drawInfo if needed.
Definition: Aircraft.cpp:583
-
XPMP2::Aircraft::bClampToGround
bool bClampToGround
Shall this plane be clamped to ground (ie. never sink below ground)?
Definition: XPMPAircraft.h:203
-
XPMP2::Aircraft::SetHeading
void SetHeading(float _deg)
heading [degree]
Definition: XPMPAircraft.h:442
-
XPMP2::Aircraft::bRender
bool bRender
Shall the CSL model be drawn in 3D world? (if !bRender && bVivile then still visible on TCAS/interfac...
Definition: XPMPAircraft.h:239
-
XPMP2::Aircraft::SetWingArea
void SetWingArea(float _m2)
Wing area [m²].
Definition: XPMPAircraft.h:538
-
XPMP2::Aircraft::bValid
bool bValid
is this object valid? (Will be reset in case of exceptions)
Definition: XPMPAircraft.h:237
-
XPMP2::Aircraft::SetTouchDown
void SetTouchDown(bool _b)
Moment of touch down.
Definition: XPMPAircraft.h:526
-
XPMP2::Aircraft::SetWingSpan
void SetWingSpan(float _m)
Wing span [m].
Definition: XPMPAircraft.h:535
-
XPMP2::Aircraft::prev_x
float prev_x
Definition: XPMPAircraft.h:246
-
XPMP2::Aircraft::ShallDrawLabel
bool ShallDrawLabel() const
Shall this aircraft's label be drawn?
Definition: XPMPAircraft.h:389
-
XPMP2::Aircraft::SetNoseGearDeflection
void SetNoseGearDeflection(float _mtr)
Vertical nose gear deflection [meter].
Definition: XPMPAircraft.h:484
-
XPMP2::Aircraft::GetEngineRotRpm
float GetEngineRotRpm() const
Engine rotation speed [rpm].
Definition: XPMPAircraft.h:498
+
XPMP2::Aircraft::Create
void Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)
Creates a plane, only a valid operation if object was created using the default constructor.
Definition: Aircraft.cpp:242
+
XPMP2::Aircraft::SetPropRotAngle
void SetPropRotAngle(float _deg)
Propellor rotation angle [degree].
Definition: XPMPAircraft.h:615
+
XPMP2::Aircraft::SetSlatRatio
void SetSlatRatio(float _f)
Slats deploy ratio.
Definition: XPMPAircraft.h:559
+
XPMP2::Aircraft::SetLightsTaxi
void SetLightsTaxi(bool _b)
Taxi lights.
Definition: XPMPAircraft.h:574
+
XPMP2::Aircraft::IsGroundVehicle
bool IsGroundVehicle() const
Is this object a ground vehicle?
Definition: Aircraft.cpp:328
+
XPMP2::Aircraft::FlightLoopCB
static float FlightLoopCB(float, float, int, void *)
Internal: Flight loop callback function controlling update and movement of all planes.
Definition: Aircraft.cpp:506
+
XPMP2::Aircraft::drawInfo
XPLMDrawInfo_t drawInfo
Holds position (in local coordinates!) and orientation (pitch, heading roll) of the aircraft.
Definition: XPMPAircraft.h:203
+
XPMP2::Aircraft::GetYokePitchRatio
float GetYokePitchRatio() const
Yoke pitch ratio.
Definition: XPMPAircraft.h:564
+
XPMP2::Aircraft::SetOnGrnd
void SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)
Set if the aircraft is on the ground.
Definition: Aircraft.cpp:710
+
XPMP2::Aircraft::SetDrawLabel
void SetDrawLabel(bool _b)
Define if this aircraft's label is to be drawn (provided label drawing is enabled globally)
Definition: XPMPAircraft.h:480
+
XPMP2::Aircraft::ChangeModel
int ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)
(Potentially) changes the plane's model after doing a new match attempt
Definition: Aircraft.cpp:367
+
XPMP2::Aircraft::v
std::vector< float > v
actual dataRef values to be provided to the CSL model
Definition: XPMPAircraft.h:215
+
XPMP2::Aircraft::GetFlapRatio
float GetFlapRatio() const
Flaps deploy ratio.
Definition: XPMPAircraft.h:552
+
XPMP2::Aircraft::v_x
float v_x
Definition: XPMPAircraft.h:282
+
XPMP2::Aircraft::GetEngineRotRpm
float GetEngineRotRpm(size_t idx) const
< Engine rotation speed [rpm] for engine idx (1..4)
Definition: XPMPAircraft.h:607
+
XPMP2::Aircraft::GetEngineRotRad
float GetEngineRotRad(size_t idx) const
< Engine rotation speed [rad/s] for engine idx (1..4)
Definition: XPMPAircraft.h:610
+
XPMP2::Aircraft::acInfoTexts
XPMPInfoTexts_t acInfoTexts
Informational texts passed on via multiplayer shared dataRefs.
Definition: XPMPAircraft.h:268
+
XPMP2::Aircraft::GetMass
float GetMass() const
Mass [kg].
Definition: XPMPAircraft.h:648
+
XPMP2::Aircraft::CreateInstances
bool CreateInstances()
Create the instances required to represent the plane, return if successful.
Definition: Aircraft.cpp:651
+
XPMP2::Aircraft::prev_y
float prev_y
Definition: XPMPAircraft.h:280
+
XPMP2::Aircraft::bOnGrnd
bool bOnGrnd
Is the aircraft on the ground?
Definition: XPMPAircraft.h:206
+
XPMP2::Aircraft::SetLocation
void SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)
Converts world coordinates to local coordinates, writes to Aircraft::drawInfo.
Definition: XPMPAircraft.h:517
+
XPMP2::Aircraft::bDrawLabel
bool bDrawLabel
Shall this aircraft's label be drawn?
Definition: XPMPAircraft.h:220
+
XPMP2::Aircraft::GetModelName
const std::string & GetModelName() const
return the name of the CSL model in use
Definition: Aircraft.cpp:480
+
XPMP2::Aircraft::UpdateDistBearingCamera
void UpdateDistBearingCamera(const XPLMCameraPosition_t &posCam)
Internal: Update the plane's distance/bearing from the camera location.
Definition: Aircraft.cpp:640
+
XPMP2::Aircraft::GetYokeRollRatio
float GetYokeRollRatio() const
Yoke roll ratio.
Definition: XPMPAircraft.h:568
+
XPMP2::Aircraft::ClampToGround
void ClampToGround()
Clamp to ground: Make sure the plane is not below ground, corrects Aircraft::drawInfo if needed.
Definition: Aircraft.cpp:608
+
XPMP2::Aircraft::bClampToGround
bool bClampToGround
Shall this plane be clamped to ground (ie. never sink below ground)?
Definition: XPMPAircraft.h:237
+
XPMP2::Aircraft::SetHeading
void SetHeading(float _deg)
heading [degree]
Definition: XPMPAircraft.h:537
+
XPMP2::Aircraft::bRender
bool bRender
Shall the CSL model be drawn in 3D world? (if !bRender && bVivile then still visible on TCAS/interfac...
Definition: XPMPAircraft.h:273
+
XPMP2::Aircraft::SoundRemoveAll
virtual void SoundRemoveAll()
Remove all sound, e.g. during destruction.
Definition: Sound.cpp:719
+
XPMP2::Aircraft::SetWingArea
void SetWingArea(float _m2)
Wing area [m²].
Definition: XPMPAircraft.h:644
+
XPMP2::Aircraft::bValid
bool bValid
is this object valid? (Will be reset in case of exceptions)
Definition: XPMPAircraft.h:271
+
XPMP2::Aircraft::ChnListTy
std::list< FMOD_CHANNEL * > ChnListTy
List of FMOD channels, also beyond sounds created for SoundEvetsTy.
Definition: XPMPAircraft.h:323
+
XPMP2::Aircraft::SetTouchDown
void SetTouchDown(bool _b)
Moment of touch down.
Definition: XPMPAircraft.h:627
+
XPMP2::Aircraft::SetWingSpan
void SetWingSpan(float _m)
Wing span [m].
Definition: XPMPAircraft.h:641
+
XPMP2::Aircraft::prev_x
float prev_x
Definition: XPMPAircraft.h:280
+
XPMP2::Aircraft::ShallDrawLabel
bool ShallDrawLabel() const
Shall this aircraft's label be drawn?
Definition: XPMPAircraft.h:482
+
XPMP2::Aircraft::SetNoseGearDeflection
void SetNoseGearDeflection(float _mtr)
Vertical nose gear deflection [meter].
Definition: XPMPAircraft.h:585
+
XPMP2::Aircraft::GetEngineRotRpm
float GetEngineRotRpm() const
Engine rotation speed [rpm].
Definition: XPMPAircraft.h:599
XPMP2::Aircraft::MapFindIcon
void MapFindIcon()
Determine which map icon to use for this aircraft.
Definition: Map.cpp:72
-
XPMP2::Aircraft::camTimLstUpd
float camTimLstUpd
Timestamp of last update of camera dist/bearing.
Definition: XPMPAircraft.h:258
-
XPMP2::Aircraft::SetReversDeployRatio
void SetReversDeployRatio(float _f)
Thrust reversers deploy ratio.
Definition: XPMPAircraft.h:523
-
XPMP2::Aircraft::IsValid
bool IsValid() const
Is the a/c object valid?
Definition: XPMPAircraft.h:369
-
XPMP2::Aircraft::GetEngineRotRad
float GetEngineRotRad() const
Engine rotation speed [rad/s].
Definition: XPMPAircraft.h:500
-
XPMP2::Aircraft::SetYokePitchRatio
void SetYokePitchRatio(float _f)
Yoke pitch ratio.
Definition: XPMPAircraft.h:464
-
XPMP2::Aircraft::GetMatchQuality
int GetMatchQuality() const
quality of the match with the CSL model
Definition: XPMPAircraft.h:364
-
XPMP2::Aircraft::acRadar
XPMPPlaneRadar_t acRadar
Current radar status.
Definition: XPMPAircraft.h:213
-
XPMP2::Aircraft::GetWingSpan
float GetWingSpan() const
Wing span [m].
Definition: XPMPAircraft.h:534
-
XPMP2::Aircraft::acRelGrp
int acRelGrp
related group, ie. line in related.txt in which this a/c appears, if any
Definition: XPMPAircraft.h:243
-
XPMP2::Aircraft::SetPropRotRad
void SetPropRotRad(float _rad)
Definition: XPMPAircraft.h:519
+
XPMP2::Aircraft::camTimLstUpd
float camTimLstUpd
Timestamp of last update of camera dist/bearing.
Definition: XPMPAircraft.h:294
+
XPMP2::Aircraft::SetReversDeployRatio
void SetReversDeployRatio(float _f)
Thrust reversers deploy ratio.
Definition: XPMPAircraft.h:624
+
XPMP2::Aircraft::IsValid
bool IsValid() const
Is the a/c object valid?
Definition: XPMPAircraft.h:462
+
XPMP2::Aircraft::GetEngineRotRad
float GetEngineRotRad() const
Engine rotation speed [rad/s].
Definition: XPMPAircraft.h:601
+
XPMP2::Aircraft::SoundMuteAll
void SoundMuteAll(bool bMute)
Mute/Unmute all sounds of the airplane temporarily.
Definition: Sound.cpp:492
+
XPMP2::Aircraft::SetYokePitchRatio
void SetYokePitchRatio(float _f)
Yoke pitch ratio.
Definition: XPMPAircraft.h:565
+
XPMP2::Aircraft::GetMatchQuality
int GetMatchQuality() const
quality of the match with the CSL model
Definition: XPMPAircraft.h:452
+
XPMP2::Aircraft::acRadar
XPMPPlaneRadar_t acRadar
Current radar status.
Definition: XPMPAircraft.h:247
+
XPMP2::Aircraft::GetWingSpan
float GetWingSpan() const
Wing span [m].
Definition: XPMPAircraft.h:640
+
XPMP2::Aircraft::SndChTy::volAdj
float volAdj
Volume adjustment, fed from Aircraft::SoundGetName()
Definition: XPMPAircraft.h:330
+
XPMP2::Aircraft::acRelGrp
int acRelGrp
related group, ie. line in related.txt in which this a/c appears, if any
Definition: XPMPAircraft.h:277
+
XPMP2::Aircraft::SetPropRotRad
void SetPropRotRad(float _rad)
Definition: XPMPAircraft.h:620
+
XPMP2::Aircraft::gs_kn
float gs_kn
Definition: XPMPAircraft.h:283
XPMP2::Aircraft::~Aircraft
virtual ~Aircraft()
Destructor cleans up all resources acquired.
Definition: Aircraft.cpp:212
-
XPMP2::Aircraft::IsVisible
bool IsVisible() const
Is the plane visible?
Definition: XPMPAircraft.h:376
-
XPMP2::Aircraft::ResetTcasTargetIdx
void ResetTcasTargetIdx()
Reset TCAS target slot index to -1
Definition: XPMPAircraft.h:331
-
XPMP2::Aircraft::GetReversDeployRatio
float GetReversDeployRatio() const
Thrust reversers deploy ratio.
Definition: XPMPAircraft.h:522
-
XPMP2::Aircraft::GetLightsNav
bool GetLightsNav() const
Navigation lights.
Definition: XPMPAircraft.h:480
-
XPMP2::Aircraft::prev_ts
float prev_ts
last update of prev_x/y/z in XP's network time
Definition: XPMPAircraft.h:247
-
XPMP2::Aircraft::SetRoll
void SetRoll(float _deg)
roll [degree]
Definition: XPMPAircraft.h:444
-
XPMP2::Aircraft::GetWingSweepRatio
float GetWingSweepRatio() const
Wing sweep ratio.
Definition: XPMPAircraft.h:459
-
XPMP2::Aircraft::GetSlatRatio
float GetSlatRatio() const
Slats deploy ratio.
Definition: XPMPAircraft.h:457
-
XPMP2::Aircraft::mapLabel
std::string mapLabel
label for map drawing
Definition: XPMPAircraft.h:272
-
XPMP2::Aircraft::SetInvalid
virtual void SetInvalid()
Mark the plane invalid, e.g. after exceptions occured on the data.
Definition: Aircraft.cpp:811
-
XPMP2::Aircraft::SetWingSweepRatio
void SetWingSweepRatio(float _f)
Wing sweep ratio.
Definition: XPMPAircraft.h:460
-
XPMP2::Aircraft::GetHeading
float GetHeading() const
heading [degree]
Definition: XPMPAircraft.h:441
-
XPMP2::Aircraft::SetPitch
void SetPitch(float _deg)
pitch [degree]
Definition: XPMPAircraft.h:440
-
XPMP2::Aircraft::SetYokeRollRatio
void SetYokeRollRatio(float _f)
Yoke roll ratio.
Definition: XPMPAircraft.h:468
-
XPMP2::Aircraft::GetLocation
const XPLMDrawInfo_t & GetLocation() const
Gets all location info (including local coordinates)
Definition: XPMPAircraft.h:437
-
XPMP2::Aircraft::mapIconRow
int mapIconRow
map icon coordinates, row
Definition: XPMPAircraft.h:268
+
XPMP2::Aircraft::IsVisible
bool IsVisible() const
Is the plane visible?
Definition: XPMPAircraft.h:469
+
XPMP2::Aircraft::ResetTcasTargetIdx
void ResetTcasTargetIdx()
Reset TCAS target slot index to -1
Definition: XPMPAircraft.h:414
+
XPMP2::Aircraft::GetReversDeployRatio
float GetReversDeployRatio() const
Thrust reversers deploy ratio.
Definition: XPMPAircraft.h:623
+
XPMP2::Aircraft::GetLightsNav
bool GetLightsNav() const
Navigation lights.
Definition: XPMPAircraft.h:581
+
XPMP2::Aircraft::prev_ts
float prev_ts
last update of prev_x/y/z in XP's network time
Definition: XPMPAircraft.h:281
+
XPMP2::Aircraft::SetRoll
void SetRoll(float _deg)
roll [degree]
Definition: XPMPAircraft.h:539
+
XPMP2::Aircraft::GetWingSweepRatio
float GetWingSweepRatio() const
Wing sweep ratio.
Definition: XPMPAircraft.h:560
+
XPMP2::Aircraft::GetSlatRatio
float GetSlatRatio() const
Slats deploy ratio.
Definition: XPMPAircraft.h:558
+
XPMP2::Aircraft::mapLabel
std::string mapLabel
label for map drawing
Definition: XPMPAircraft.h:308
+
XPMP2::Aircraft::SetInvalid
virtual void SetInvalid()
Mark the plane invalid, e.g. after exceptions occured on the data.
Definition: Aircraft.cpp:836
+
XPMP2::Aircraft::SetWingSweepRatio
void SetWingSweepRatio(float _f)
Wing sweep ratio.
Definition: XPMPAircraft.h:561
+
XPMP2::Aircraft::SoundSetup
virtual void SoundSetup()
Sound-related initializations, called by Create() and ChangeModel()
Definition: Sound.cpp:557
+
XPMP2::Aircraft::GetHeading
float GetHeading() const
heading [degree]
Definition: XPMPAircraft.h:536
+
XPMP2::Aircraft::SetPitch
void SetPitch(float _deg)
pitch [degree]
Definition: XPMPAircraft.h:535
+
XPMP2::Aircraft::SetYokeRollRatio
void SetYokeRollRatio(float _f)
Yoke roll ratio.
Definition: XPMPAircraft.h:569
+
XPMP2::Aircraft::GetLocation
const XPLMDrawInfo_t & GetLocation() const
Gets all location info (including local coordinates)
Definition: XPMPAircraft.h:532
+
XPMP2::Aircraft::mapIconRow
int mapIconRow
map icon coordinates, row
Definition: XPMPAircraft.h:304
XPMP2::Aircraft::MapDrawIcon
void MapDrawIcon(XPLMMapLayerID inLayer, float acSize)
Actually draw the map icon.
Definition: Map.cpp:135
-
XPMP2::Aircraft::GetCameraDist
float GetCameraDist() const
Distance to camera [m].
Definition: XPMPAircraft.h:392
-
XPMP2::Aircraft::pCSLMdl
XPMP2::CSLModel * pCSLMdl
the CSL model in use
Definition: XPMPAircraft.h:241
-
XPMP2::Aircraft::WakeApplyDefaults
void WakeApplyDefaults(bool _bOverwriteAllFields=true)
Fill in default wake turbulence support data based on Doc8643 wake turbulence category.
Definition: Aircraft.cpp:458
-
XPMP2::Aircraft::SetTireRotAngle
void SetTireRotAngle(float _deg)
Tire rotation angle [degree].
Definition: XPMPAircraft.h:488
-
XPMP2::Aircraft::SetThrustRatio
void SetThrustRatio(float _f)
Thrust ratio.
Definition: XPMPAircraft.h:462
-
XPMP2::Aircraft::GetPropRotRad
float GetPropRotRad() const
Propellor rotation speed [rad/s].
Definition: XPMPAircraft.h:518
-
XPMP2::Aircraft::colLabel
float colLabel[4]
label base color (RGB)
Definition: XPMPAircraft.h:185
-
XPMP2::Aircraft::ReMatchModel
int ReMatchModel()
Finds a match again, using the existing parameters, eg. after more models have been loaded.
Definition: XPMPAircraft.h:348
-
XPMP2::Aircraft::mapIconCol
int mapIconCol
map icon coordinates, column
Definition: XPMPAircraft.h:269
-
XPMP2::Aircraft::SetEngineRotRad
void SetEngineRotRad(float _rad)
Engine rotation speed [rad/s], also sets [rpm] and engines 1..4.
Definition: Aircraft.cpp:754
+
XPMP2::Aircraft::GetCameraDist
float GetCameraDist() const
Distance to camera [m].
Definition: XPMPAircraft.h:485
+
XPMP2::Aircraft::pCSLMdl
XPMP2::CSLModel * pCSLMdl
the CSL model in use
Definition: XPMPAircraft.h:275
+
XPMP2::Aircraft::SoundPlay
FMOD_CHANNEL * SoundPlay(const std::string &sndName, float vol=1.0f)
Play a sound; a looping sound plays until explicitely stopped.
Definition: Sound.cpp:449
+
XPMP2::Aircraft::WakeApplyDefaults
void WakeApplyDefaults(bool _bOverwriteAllFields=true)
Fill in default wake turbulence support data based on Doc8643 wake turbulence category.
Definition: Aircraft.cpp:472
+
XPMP2::Aircraft::SetTireRotAngle
void SetTireRotAngle(float _deg)
Tire rotation angle [degree].
Definition: XPMPAircraft.h:589
+
XPMP2::Aircraft::SetThrustRatio
void SetThrustRatio(float _f)
Thrust ratio.
Definition: XPMPAircraft.h:563
+
XPMP2::Aircraft::skipCounter
int skipCounter
Counts how often we skipped expensive computations.
Definition: XPMPAircraft.h:347
+
XPMP2::Aircraft::GetPropRotRad
float GetPropRotRad() const
Propellor rotation speed [rad/s].
Definition: XPMPAircraft.h:619
+
XPMP2::Aircraft::colLabel
float colLabel[4]
label base color (RGB)
Definition: XPMPAircraft.h:219
+
XPMP2::Aircraft::sndMinDist
int sndMinDist
Minimum distance in [m] to play sound in full volume, the larger the 'louder' the aircraft.
Definition: XPMPAircraft.h:335
+
XPMP2::Aircraft::ReMatchModel
int ReMatchModel()
Finds a match again, using the existing parameters, eg. after more models have been loaded.
Definition: XPMPAircraft.h:436
+
XPMP2::Aircraft::SndChTy::bAuto
bool bAuto
Shall this sound event be handled automatically? (Set to false in your constructor or in Aircraft::So...
Definition: XPMPAircraft.h:327
+
XPMP2::Aircraft::mapIconCol
int mapIconCol
map icon coordinates, column
Definition: XPMPAircraft.h:305
+
XPMP2::Aircraft::SetEngineRotRad
void SetEngineRotRad(float _rad)
Engine rotation speed [rad/s], also sets [rpm] and engines 1..4.
Definition: Aircraft.cpp:779
XPMP2::Aircraft::Aircraft
Aircraft(const Aircraft &)=delete
Aircraft must not be copied as they reference non-copyable resources like XP instances.
-
XPMP2::Aircraft::GetAoA
virtual float GetAoA() const
Angle of Attach, returns pitch (but you can override in your class)
Definition: XPMPAircraft.h:546
+
XPMP2::Aircraft::GetAoA
virtual float GetAoA() const
Angle of Attach, returns pitch (but you can override in your class)
Definition: XPMPAircraft.h:652
+
XPMP2::Aircraft::SoundUpdate
virtual void SoundUpdate()
Update sound, like position and volume, called once per frame.
Definition: Sound.cpp:572
XPMP2::Aircraft::AIUpdateMultiplayerDataRefs
friend size_t AIUpdateMultiplayerDataRefs()
The old way: Update Multiplayer dataRefs directly.
Definition: AIMultiplayer.cpp:244
-
XPMP2::Aircraft::tsResetTouchDown
float tsResetTouchDown
Set by SetOnGrnd() with the timestamp when to reset SetTouchDown()
Definition: XPMPAircraft.h:250
-
XPMP2::Aircraft::acLivery
std::string acLivery
Livery code of this plane.
Definition: XPMPAircraft.h:163
-
XPMP2::Aircraft::GetPitch
float GetPitch() const
pitch [degree]
Definition: XPMPAircraft.h:439
-
XPMP2::Aircraft::GetYokeHeadingRatio
float GetYokeHeadingRatio() const
Yoke heading ratio.
Definition: XPMPAircraft.h:465
-
XPMP2::Aircraft::SetTireRotRad
void SetTireRotRad(float _rad)
Definition: XPMPAircraft.h:493
-
XPMP2::Aircraft::SetEngineRotAngle
void SetEngineRotAngle(float _deg)
Engine rotation angle [degree], also sets engines 1..4.
Definition: Aircraft.cpp:729
-
XPMP2::Aircraft::prev_z
float prev_z
Definition: XPMPAircraft.h:246
-
XPMP2::Aircraft::mapY
float mapY
temporary: map coordinates (NAN = not to be drawn)
Definition: XPMPAircraft.h:271
+
XPMP2::Aircraft::SoundVolume
void SoundVolume(FMOD_CHANNEL *pChn, float vol)
Sets the sound's volume (after applying master volume and Sound File's adjustments)
Definition: Sound.cpp:485
+
XPMP2::Aircraft::chnList
ChnListTy chnList
List of channels produced via calls to SoundPlay()
Definition: XPMPAircraft.h:345
+
XPMP2::Aircraft::tsResetTouchDown
float tsResetTouchDown
ground speed in [kn] based on above v_x/z
Definition: XPMPAircraft.h:286
+
XPMP2::Aircraft::acLivery
std::string acLivery
Livery code of this plane.
Definition: XPMPAircraft.h:197
+
XPMP2::Aircraft::GetPitch
float GetPitch() const
pitch [degree]
Definition: XPMPAircraft.h:534
+
XPMP2::Aircraft::GetYokeHeadingRatio
float GetYokeHeadingRatio() const
Yoke heading ratio.
Definition: XPMPAircraft.h:566
+
XPMP2::Aircraft::SetTireRotRad
void SetTireRotRad(float _rad)
Definition: XPMPAircraft.h:594
+
XPMP2::Aircraft::SetEngineRotAngle
void SetEngineRotAngle(float _deg)
Engine rotation angle [degree], also sets engines 1..4.
Definition: Aircraft.cpp:754
+
XPMP2::Aircraft::prev_z
float prev_z
Definition: XPMPAircraft.h:280
+
XPMP2::Aircraft::bChnMuted
bool bChnMuted
Is sound for this aircraft currently muted?
Definition: XPMPAircraft.h:343
+
XPMP2::Aircraft::mapY
float mapY
temporary: map coordinates (NAN = not to be drawn)
Definition: XPMPAircraft.h:307
+
XPMP2::Aircraft::SndChTy
Operational values per sound channel, that is triggered by a standard sound event.
Definition: XPMPAircraft.h:326
XPMP2::CSLModel
Represetns a CSL model as it is saved on disk.
Definition: CSLModels.h:113
-
XPMP2::XPMP2Error
XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an...
Definition: XPMPAircraft.h:598
-
XPMP2::XPMP2Error::fileName
std::string fileName
filename of the line of code where exception occurred
Definition: XPMPAircraft.h:600
-
XPMP2::XPMP2Error::what
virtual const char * what() const noexcept
returns msg.c_str()
Definition: Utilities.cpp:686
-
XPMP2::XPMP2Error::msg
std::string msg
additional text message
Definition: XPMPAircraft.h:603
-
XPMP2::XPMP2Error::XPMP2Error
XPMP2Error(const char *szFile, int ln, const char *szFunc, const char *szMsg,...)
Constructor puts together a formatted exception text.
Definition: Utilities.cpp:671
-
XPMP2::XPMP2Error::funcName
std::string funcName
function of the line of code where exception occurred
Definition: XPMPAircraft.h:602
-
XPMP2::XPMP2Error::ln
int ln
line number of the line of code where exception occurred
Definition: XPMPAircraft.h:601
-
XPMP2
Definition: XPMPAircraft.h:41
-
XPMP2::G_EARTH
constexpr float G_EARTH
standard gravitational acceleration [m/s²]
Definition: XPMPAircraft.h:53
-
XPMP2::AcFindByID
Aircraft * AcFindByID(XPMPPlaneID _id)
Find aircraft by its plane ID, can return nullptr.
Definition: Aircraft.cpp:1061
-
XPMP2::AcSetDefaultWakeData
bool AcSetDefaultWakeData(const std::string &_wtc, const Aircraft::wakeTy &_wake)
(Re)Define default wake turbulence values per WTC
Definition: Aircraft.cpp:1074
-
XPMP2::RPM_to_RADs
constexpr float RPM_to_RADs
Convert revolutions-per-minute (RPM) to radians per second (rad/s) by multiplying with PI/30.
Definition: XPMPAircraft.h:46
-
XPMP2::DR_VALS
DR_VALS
The dataRefs provided by XPMP2 to the CSL models.
Definition: XPMPAircraft.h:56
-
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC3
@ V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC3
libxplanemp/engines/engine_rotation_speed_rad_sec3
Definition: XPMPAircraft.h:100
-
XPMP2::V_CONTROLS_YOKE_HEADING_RATIO
@ V_CONTROLS_YOKE_HEADING_RATIO
libxplanemp/controls/yoke_heading_ratio and sim/cockpit2/tcas/targets/position/yolk_yaw
Definition: XPMPAircraft.h:66
-
XPMP2::V_CONTROLS_THRUST_RATIO
@ V_CONTROLS_THRUST_RATIO
libxplanemp/controls/thrust_ratio and sim/cockpit2/tcas/targets/position/throttle
Definition: XPMPAircraft.h:64
-
XPMP2::V_CONTROLS_WING_SWEEP_RATIO
@ V_CONTROLS_WING_SWEEP_RATIO
libxplanemp/controls/wing_sweep_ratio and sim/cockpit2/tcas/targets/position/wing_sweep
Definition: XPMPAircraft.h:63
-
XPMP2::V_CONTROLS_YOKE_PITCH_RATIO
@ V_CONTROLS_YOKE_PITCH_RATIO
libxplanemp/controls/yoke_pitch_ratio and sim/cockpit2/tcas/targets/position/yolk_pitch
Definition: XPMPAircraft.h:65
-
XPMP2::V_GEAR_TIRE_ROTATION_ANGLE_DEG
@ V_GEAR_TIRE_ROTATION_ANGLE_DEG
libxplanemp/gear/tire_rotation_angle_deg
Definition: XPMPAircraft.h:78
-
XPMP2::V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC
@ V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC
libxplanemp/engines/prop_rotation_speed_rad_sec
Definition: XPMPAircraft.h:87
-
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC1
@ V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC1
libxplanemp/engines/engine_rotation_speed_rad_sec1
Definition: XPMPAircraft.h:98
-
XPMP2::V_MISC_TOUCH_DOWN
@ V_MISC_TOUCH_DOWN
libxplanemp/misc/touch_down
Definition: XPMPAircraft.h:104
-
XPMP2::V_ENGINES_ENGINE_ROTATION_ANGLE_DEG3
@ V_ENGINES_ENGINE_ROTATION_ANGLE_DEG3
libxplanemp/engines/engine_rotation_angle_deg3
Definition: XPMPAircraft.h:92
-
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC2
@ V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC2
libxplanemp/engines/engine_rotation_speed_rad_sec2
Definition: XPMPAircraft.h:99
-
XPMP2::V_GEAR_NOSE_GEAR_DEFLECTION_MTR
@ V_GEAR_NOSE_GEAR_DEFLECTION_MTR
libxplanemp/gear/nose_gear_deflection_mtr
Definition: XPMPAircraft.h:76
-
XPMP2::V_COUNT
@ V_COUNT
always last, number of dataRefs XPMP2 pre-defines
Definition: XPMPAircraft.h:106
-
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC4
@ V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC4
libxplanemp/engines/engine_rotation_speed_rad_sec4
Definition: XPMPAircraft.h:101
-
XPMP2::V_ENGINES_PROP_ROTATION_ANGLE_DEG
@ V_ENGINES_PROP_ROTATION_ANGLE_DEG
libxplanemp/engines/prop_rotation_angle_deg
Definition: XPMPAircraft.h:85
-
XPMP2::V_CONTROLS_YOKE_ROLL_RATIO
@ V_CONTROLS_YOKE_ROLL_RATIO
libxplanemp/controls/yoke_roll_ratio and sim/cockpit2/tcas/targets/position/yolk_roll
Definition: XPMPAircraft.h:67
-
XPMP2::V_CONTROLS_SPOILER_RATIO
@ V_CONTROLS_SPOILER_RATIO
libxplanemp/controls/spoiler_ratio
Definition: XPMPAircraft.h:60
-
XPMP2::V_CONTROLS_TAXI_LITES_ON
@ V_CONTROLS_TAXI_LITES_ON
libxplanemp/controls/taxi_lites_on and sim/cockpit2/tcas/targets/position/lights
Definition: XPMPAircraft.h:70
-
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC
@ V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC
libxplanemp/engines/engine_rotation_speed_rad_sec
Definition: XPMPAircraft.h:84
-
XPMP2::V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR
@ V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR
libxplanemp/gear/tire_vertical_deflection_mtr
Definition: XPMPAircraft.h:77
-
XPMP2::V_CONTROLS_NWS_RATIO
@ V_CONTROLS_NWS_RATIO
libxplanemp/controls/nws_ratio, the nose wheel angle, actually in degrees
Definition: XPMPAircraft.h:58
-
XPMP2::V_ENGINES_ENGINE_ROTATION_ANGLE_DEG4
@ V_ENGINES_ENGINE_ROTATION_ANGLE_DEG4
libxplanemp/engines/engine_rotation_angle_deg4
Definition: XPMPAircraft.h:93
-
XPMP2::V_GEAR_TIRE_ROTATION_SPEED_RPM
@ V_GEAR_TIRE_ROTATION_SPEED_RPM
libxplanemp/gear/tire_rotation_speed_rpm
Definition: XPMPAircraft.h:79
-
XPMP2::V_ENGINES_ENGINE_ROTATION_ANGLE_DEG1
@ V_ENGINES_ENGINE_ROTATION_ANGLE_DEG1
libxplanemp/engines/engine_rotation_angle_deg1
Definition: XPMPAircraft.h:90
-
XPMP2::V_ENGINES_ENGINE_ROTATION_ANGLE_DEG
@ V_ENGINES_ENGINE_ROTATION_ANGLE_DEG
libxplanemp/engines/engine_rotation_angle_deg
Definition: XPMPAircraft.h:82
-
XPMP2::V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO
@ V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO
libxplanemp/engines/thrust_reverser_deploy_ratio
Definition: XPMPAircraft.h:88
-
XPMP2::V_CONTROLS_BEACON_LITES_ON
@ V_CONTROLS_BEACON_LITES_ON
libxplanemp/controls/beacon_lites_on and sim/cockpit2/tcas/targets/position/lights
Definition: XPMPAircraft.h:72
-
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RPM4
@ V_ENGINES_ENGINE_ROTATION_SPEED_RPM4
libxplanemp/engines/engine_rotation_speed_rpm4
Definition: XPMPAircraft.h:97
-
XPMP2::V_ENGINES_PROP_ROTATION_SPEED_RPM
@ V_ENGINES_PROP_ROTATION_SPEED_RPM
libxplanemp/engines/prop_rotation_speed_rpm
Definition: XPMPAircraft.h:86
-
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RPM2
@ V_ENGINES_ENGINE_ROTATION_SPEED_RPM2
libxplanemp/engines/engine_rotation_speed_rpm2
Definition: XPMPAircraft.h:95
-
XPMP2::V_CONTROLS_NAV_LITES_ON
@ V_CONTROLS_NAV_LITES_ON
libxplanemp/controls/nav_lites_on and sim/cockpit2/tcas/targets/position/lights
Definition: XPMPAircraft.h:74
-
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RPM
@ V_ENGINES_ENGINE_ROTATION_SPEED_RPM
libxplanemp/engines/engine_rotation_speed_rpm
Definition: XPMPAircraft.h:83
-
XPMP2::V_CONTROLS_SLAT_RATIO
@ V_CONTROLS_SLAT_RATIO
libxplanemp/controls/slat_ratio and sim/cockpit2/tcas/targets/position/slat_ratio
Definition: XPMPAircraft.h:62
-
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RPM3
@ V_ENGINES_ENGINE_ROTATION_SPEED_RPM3
libxplanemp/engines/engine_rotation_speed_rpm3
Definition: XPMPAircraft.h:96
-
XPMP2::V_CONTROLS_THRUST_REVERS
@ V_CONTROLS_THRUST_REVERS
libxplanemp/controls/thrust_revers
Definition: XPMPAircraft.h:68
-
XPMP2::V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC
@ V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC
libxplanemp/gear/tire_rotation_speed_rad_sec
Definition: XPMPAircraft.h:80
-
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RPM1
@ V_ENGINES_ENGINE_ROTATION_SPEED_RPM1
libxplanemp/engines/engine_rotation_speed_rpm1
Definition: XPMPAircraft.h:94
-
XPMP2::V_ENGINES_ENGINE_ROTATION_ANGLE_DEG2
@ V_ENGINES_ENGINE_ROTATION_ANGLE_DEG2
libxplanemp/engines/engine_rotation_angle_deg2
Definition: XPMPAircraft.h:91
-
XPMP2::V_CONTROLS_FLAP_RATIO
@ V_CONTROLS_FLAP_RATIO
libxplanemp/controls/flap_ratio and sim/cockpit2/tcas/targets/position/flap_ratio and ....
Definition: XPMPAircraft.h:59
-
XPMP2::V_CONTROLS_LANDING_LITES_ON
@ V_CONTROLS_LANDING_LITES_ON
libxplanemp/controls/landing_lites_on and sim/cockpit2/tcas/targets/position/lights
Definition: XPMPAircraft.h:71
-
XPMP2::V_CONTROLS_GEAR_RATIO
@ V_CONTROLS_GEAR_RATIO
libxplanemp/controls/gear_ratio and sim/cockpit2/tcas/targets/position/gear_deploy
Definition: XPMPAircraft.h:57
-
XPMP2::V_CONTROLS_STROBE_LITES_ON
@ V_CONTROLS_STROBE_LITES_ON
libxplanemp/controls/strobe_lites_on and sim/cockpit2/tcas/targets/position/lights
Definition: XPMPAircraft.h:73
-
XPMP2::V_CONTROLS_SPEED_BRAKE_RATIO
@ V_CONTROLS_SPEED_BRAKE_RATIO
libxplanemp/controls/speed_brake_ratio and sim/cockpit2/tcas/targets/position/speedbrake_ratio
Definition: XPMPAircraft.h:61
-
XPMP2::M_per_NM
constexpr int M_per_NM
Convert nautical miles to meters.
Definition: XPMPAircraft.h:50
-
XPMP2::M_per_FT
constexpr double M_per_FT
Convert feet to meters, e.g. for altitude calculations.
Definition: XPMPAircraft.h:48
-
XPMP2::Aircraft::wakeTy
Wake dataRef support.
Definition: XPMPAircraft.h:220
+
XPMP2::XPMP2Error
XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an...
Definition: XPMPAircraft.h:768
+
XPMP2::XPMP2Error::fileName
std::string fileName
filename of the line of code where exception occurred
Definition: XPMPAircraft.h:770
+
XPMP2::XPMP2Error::what
virtual const char * what() const noexcept
returns msg.c_str()
Definition: Utilities.cpp:728
+
XPMP2::XPMP2Error::msg
std::string msg
additional text message
Definition: XPMPAircraft.h:773
+
XPMP2::XPMP2Error::XPMP2Error
XPMP2Error(const char *szFile, int ln, const char *szFunc, const char *szMsg,...)
Constructor puts together a formatted exception text.
Definition: Utilities.cpp:713
+
XPMP2::XPMP2Error::funcName
std::string funcName
function of the line of code where exception occurred
Definition: XPMPAircraft.h:772
+
XPMP2::XPMP2Error::ln
int ln
line number of the line of code where exception occurred
Definition: XPMPAircraft.h:771
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
+
XPMP2::G_EARTH
constexpr float G_EARTH
standard gravitational acceleration [m/s²]
Definition: XPMPAircraft.h:87
+
XPMP2::KT_per_M_per_S
constexpr double KT_per_M_per_S
Convert m/s to knots.
Definition: XPMPAircraft.h:84
+
XPMP2::AcFindByID
Aircraft * AcFindByID(XPMPPlaneID _id)
Find aircraft by its plane ID, can return nullptr.
Definition: Aircraft.cpp:1091
+
XPMP2::AcSetDefaultWakeData
bool AcSetDefaultWakeData(const std::string &_wtc, const Aircraft::wakeTy &_wake)
(Re)Define default wake turbulence values per WTC
Definition: Aircraft.cpp:1104
+
XPMP2::RPM_to_RADs
constexpr float RPM_to_RADs
Defined by XPMP2 internally.
Definition: XPMPAircraft.h:78
+
XPMP2::DR_VALS
DR_VALS
The dataRefs provided by XPMP2 to the CSL models.
Definition: XPMPAircraft.h:90
+
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC3
@ V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC3
libxplanemp/engines/engine_rotation_speed_rad_sec3
Definition: XPMPAircraft.h:134
+
XPMP2::V_CONTROLS_YOKE_HEADING_RATIO
@ V_CONTROLS_YOKE_HEADING_RATIO
libxplanemp/controls/yoke_heading_ratio and sim/cockpit2/tcas/targets/position/yolk_yaw
Definition: XPMPAircraft.h:100
+
XPMP2::V_CONTROLS_THRUST_RATIO
@ V_CONTROLS_THRUST_RATIO
libxplanemp/controls/thrust_ratio and sim/cockpit2/tcas/targets/position/throttle
Definition: XPMPAircraft.h:98
+
XPMP2::V_CONTROLS_WING_SWEEP_RATIO
@ V_CONTROLS_WING_SWEEP_RATIO
libxplanemp/controls/wing_sweep_ratio and sim/cockpit2/tcas/targets/position/wing_sweep
Definition: XPMPAircraft.h:97
+
XPMP2::V_CONTROLS_YOKE_PITCH_RATIO
@ V_CONTROLS_YOKE_PITCH_RATIO
libxplanemp/controls/yoke_pitch_ratio and sim/cockpit2/tcas/targets/position/yolk_pitch
Definition: XPMPAircraft.h:99
+
XPMP2::V_GEAR_TIRE_ROTATION_ANGLE_DEG
@ V_GEAR_TIRE_ROTATION_ANGLE_DEG
libxplanemp/gear/tire_rotation_angle_deg
Definition: XPMPAircraft.h:112
+
XPMP2::V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC
@ V_ENGINES_PROP_ROTATION_SPEED_RAD_SEC
libxplanemp/engines/prop_rotation_speed_rad_sec
Definition: XPMPAircraft.h:121
+
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC1
@ V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC1
libxplanemp/engines/engine_rotation_speed_rad_sec1
Definition: XPMPAircraft.h:132
+
XPMP2::V_MISC_TOUCH_DOWN
@ V_MISC_TOUCH_DOWN
libxplanemp/misc/touch_down
Definition: XPMPAircraft.h:138
+
XPMP2::V_ENGINES_ENGINE_ROTATION_ANGLE_DEG3
@ V_ENGINES_ENGINE_ROTATION_ANGLE_DEG3
libxplanemp/engines/engine_rotation_angle_deg3
Definition: XPMPAircraft.h:126
+
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC2
@ V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC2
libxplanemp/engines/engine_rotation_speed_rad_sec2
Definition: XPMPAircraft.h:133
+
XPMP2::V_GEAR_NOSE_GEAR_DEFLECTION_MTR
@ V_GEAR_NOSE_GEAR_DEFLECTION_MTR
libxplanemp/gear/nose_gear_deflection_mtr
Definition: XPMPAircraft.h:110
+
XPMP2::V_COUNT
@ V_COUNT
always last, number of dataRefs XPMP2 pre-defines
Definition: XPMPAircraft.h:140
+
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC4
@ V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC4
libxplanemp/engines/engine_rotation_speed_rad_sec4
Definition: XPMPAircraft.h:135
+
XPMP2::V_ENGINES_PROP_ROTATION_ANGLE_DEG
@ V_ENGINES_PROP_ROTATION_ANGLE_DEG
libxplanemp/engines/prop_rotation_angle_deg
Definition: XPMPAircraft.h:119
+
XPMP2::V_CONTROLS_YOKE_ROLL_RATIO
@ V_CONTROLS_YOKE_ROLL_RATIO
libxplanemp/controls/yoke_roll_ratio and sim/cockpit2/tcas/targets/position/yolk_roll
Definition: XPMPAircraft.h:101
+
XPMP2::V_CONTROLS_SPOILER_RATIO
@ V_CONTROLS_SPOILER_RATIO
libxplanemp/controls/spoiler_ratio
Definition: XPMPAircraft.h:94
+
XPMP2::V_CONTROLS_TAXI_LITES_ON
@ V_CONTROLS_TAXI_LITES_ON
libxplanemp/controls/taxi_lites_on and sim/cockpit2/tcas/targets/position/lights
Definition: XPMPAircraft.h:104
+
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC
@ V_ENGINES_ENGINE_ROTATION_SPEED_RAD_SEC
libxplanemp/engines/engine_rotation_speed_rad_sec
Definition: XPMPAircraft.h:118
+
XPMP2::V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR
@ V_GEAR_TIRE_VERTICAL_DEFLECTION_MTR
libxplanemp/gear/tire_vertical_deflection_mtr
Definition: XPMPAircraft.h:111
+
XPMP2::V_CONTROLS_NWS_RATIO
@ V_CONTROLS_NWS_RATIO
libxplanemp/controls/nws_ratio, the nose wheel angle, actually in degrees
Definition: XPMPAircraft.h:92
+
XPMP2::V_ENGINES_ENGINE_ROTATION_ANGLE_DEG4
@ V_ENGINES_ENGINE_ROTATION_ANGLE_DEG4
libxplanemp/engines/engine_rotation_angle_deg4
Definition: XPMPAircraft.h:127
+
XPMP2::V_GEAR_TIRE_ROTATION_SPEED_RPM
@ V_GEAR_TIRE_ROTATION_SPEED_RPM
libxplanemp/gear/tire_rotation_speed_rpm
Definition: XPMPAircraft.h:113
+
XPMP2::V_ENGINES_ENGINE_ROTATION_ANGLE_DEG1
@ V_ENGINES_ENGINE_ROTATION_ANGLE_DEG1
libxplanemp/engines/engine_rotation_angle_deg1
Definition: XPMPAircraft.h:124
+
XPMP2::V_ENGINES_ENGINE_ROTATION_ANGLE_DEG
@ V_ENGINES_ENGINE_ROTATION_ANGLE_DEG
libxplanemp/engines/engine_rotation_angle_deg
Definition: XPMPAircraft.h:116
+
XPMP2::V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO
@ V_ENGINES_THRUST_REVERSER_DEPLOY_RATIO
libxplanemp/engines/thrust_reverser_deploy_ratio
Definition: XPMPAircraft.h:122
+
XPMP2::V_CONTROLS_BEACON_LITES_ON
@ V_CONTROLS_BEACON_LITES_ON
libxplanemp/controls/beacon_lites_on and sim/cockpit2/tcas/targets/position/lights
Definition: XPMPAircraft.h:106
+
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RPM4
@ V_ENGINES_ENGINE_ROTATION_SPEED_RPM4
libxplanemp/engines/engine_rotation_speed_rpm4
Definition: XPMPAircraft.h:131
+
XPMP2::V_ENGINES_PROP_ROTATION_SPEED_RPM
@ V_ENGINES_PROP_ROTATION_SPEED_RPM
libxplanemp/engines/prop_rotation_speed_rpm
Definition: XPMPAircraft.h:120
+
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RPM2
@ V_ENGINES_ENGINE_ROTATION_SPEED_RPM2
libxplanemp/engines/engine_rotation_speed_rpm2
Definition: XPMPAircraft.h:129
+
XPMP2::V_CONTROLS_NAV_LITES_ON
@ V_CONTROLS_NAV_LITES_ON
libxplanemp/controls/nav_lites_on and sim/cockpit2/tcas/targets/position/lights
Definition: XPMPAircraft.h:108
+
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RPM
@ V_ENGINES_ENGINE_ROTATION_SPEED_RPM
libxplanemp/engines/engine_rotation_speed_rpm
Definition: XPMPAircraft.h:117
+
XPMP2::V_CONTROLS_SLAT_RATIO
@ V_CONTROLS_SLAT_RATIO
libxplanemp/controls/slat_ratio and sim/cockpit2/tcas/targets/position/slat_ratio
Definition: XPMPAircraft.h:96
+
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RPM3
@ V_ENGINES_ENGINE_ROTATION_SPEED_RPM3
libxplanemp/engines/engine_rotation_speed_rpm3
Definition: XPMPAircraft.h:130
+
XPMP2::V_CONTROLS_THRUST_REVERS
@ V_CONTROLS_THRUST_REVERS
libxplanemp/controls/thrust_revers
Definition: XPMPAircraft.h:102
+
XPMP2::V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC
@ V_GEAR_TIRE_ROTATION_SPEED_RAD_SEC
libxplanemp/gear/tire_rotation_speed_rad_sec
Definition: XPMPAircraft.h:114
+
XPMP2::V_ENGINES_ENGINE_ROTATION_SPEED_RPM1
@ V_ENGINES_ENGINE_ROTATION_SPEED_RPM1
libxplanemp/engines/engine_rotation_speed_rpm1
Definition: XPMPAircraft.h:128
+
XPMP2::V_ENGINES_ENGINE_ROTATION_ANGLE_DEG2
@ V_ENGINES_ENGINE_ROTATION_ANGLE_DEG2
libxplanemp/engines/engine_rotation_angle_deg2
Definition: XPMPAircraft.h:125
+
XPMP2::V_CONTROLS_FLAP_RATIO
@ V_CONTROLS_FLAP_RATIO
libxplanemp/controls/flap_ratio and sim/cockpit2/tcas/targets/position/flap_ratio and ....
Definition: XPMPAircraft.h:93
+
XPMP2::V_CONTROLS_LANDING_LITES_ON
@ V_CONTROLS_LANDING_LITES_ON
libxplanemp/controls/landing_lites_on and sim/cockpit2/tcas/targets/position/lights
Definition: XPMPAircraft.h:105
+
XPMP2::V_CONTROLS_GEAR_RATIO
@ V_CONTROLS_GEAR_RATIO
libxplanemp/controls/gear_ratio and sim/cockpit2/tcas/targets/position/gear_deploy
Definition: XPMPAircraft.h:91
+
XPMP2::V_CONTROLS_STROBE_LITES_ON
@ V_CONTROLS_STROBE_LITES_ON
libxplanemp/controls/strobe_lites_on and sim/cockpit2/tcas/targets/position/lights
Definition: XPMPAircraft.h:107
+
XPMP2::V_CONTROLS_SPEED_BRAKE_RATIO
@ V_CONTROLS_SPEED_BRAKE_RATIO
libxplanemp/controls/speed_brake_ratio and sim/cockpit2/tcas/targets/position/speedbrake_ratio
Definition: XPMPAircraft.h:95
+
XPMP2::M_per_NM
constexpr int M_per_NM
Convert nautical miles to meters.
Definition: XPMPAircraft.h:82
+
XPMP2::M_per_FT
constexpr double M_per_FT
Convert feet to meters, e.g. for altitude calculations.
Definition: XPMPAircraft.h:80
+
XPMP2::Aircraft::wakeTy
Wake dataRef support.
Definition: XPMPAircraft.h:254
XPMP2::Aircraft::wakeTy::fillUpFrom
void fillUpFrom(const wakeTy &o)
Copies values only for non-NAN fields.
Definition: Aircraft.cpp:178
-
XPMP2::Aircraft::wakeTy::clear
void clear()
clear all values to defaults
Definition: XPMPAircraft.h:225
-
XPMP2::Aircraft::wakeTy::mass_kg
float mass_kg
actual mass of the aircraft creating the wake
Definition: XPMPAircraft.h:223
-
XPMP2::Aircraft::wakeTy::wingSpan_m
float wingSpan_m
wing span of the aircraft creating wake turbulence
Definition: XPMPAircraft.h:221
-
XPMP2::Aircraft::wakeTy::wingArea_m2
float wingArea_m2
wing area (total area of both wings combined) of the aircraft creating wake turbulence
Definition: XPMPAircraft.h:222
+
XPMP2::Aircraft::wakeTy::clear
void clear()
clear all values to defaults
Definition: XPMPAircraft.h:259
+
XPMP2::Aircraft::wakeTy::mass_kg
float mass_kg
actual mass of the aircraft creating the wake
Definition: XPMPAircraft.h:257
+
XPMP2::Aircraft::wakeTy::wingSpan_m
float wingSpan_m
wing span of the aircraft creating wake turbulence
Definition: XPMPAircraft.h:255
+
XPMP2::Aircraft::wakeTy::wingArea_m2
float wingArea_m2
wing area (total area of both wings combined) of the aircraft creating wake turbulence
Definition: XPMPAircraft.h:256
XPMP2::Aircraft::wakeTy::needsDefaults
bool needsDefaults() const
Definition: Aircraft.cpp:144
XPMP2::Aircraft::wakeTy::applyDefaults
void applyDefaults(const std::string &_wtc, bool _bOverwriteAllFields=true)
based on Doc8643 WTC fill with defaults
Definition: Aircraft.cpp:153
-
XPMP2::CSLModelInfo_t
Collates some information on the CSL model.
Definition: XPMPAircraft.h:114
-
XPMP2::CSLModelInfo_t::vecMatchCrit
vecMatchCrit_t vecMatchCrit
Definition: XPMPAircraft.h:137
-
XPMP2::CSLModelInfo_t::modelName
std::string modelName
name, formed by last part of path plus id
Definition: XPMPAircraft.h:118
-
XPMP2::CSLModelInfo_t::xsbAircraftLn
int xsbAircraftLn
Line number in the xsb_aircraft.txt file where the model definition starts.
Definition: XPMPAircraft.h:122
-
XPMP2::CSLModelInfo_t::icaoType
std::string icaoType
ICAO aircraft type this model represents: xsb_aircraft.txt::ICAO
Definition: XPMPAircraft.h:124
-
XPMP2::CSLModelInfo_t::cslId
std::string cslId
id, just an arbitrary label read from xsb_aircraft.txt::OBJ8_AIRCRAFT
Definition: XPMPAircraft.h:116
-
XPMP2::CSLModelInfo_t::doc8643WTC
std::string doc8643WTC
Doc8643 information: wake turbulence class, like M, L/M, L, H.
Definition: XPMPAircraft.h:128
-
XPMP2::CSLModelInfo_t::doc8643Classification
std::string doc8643Classification
Doc8643 information: Classification, like L1P, L4J, H1T.
Definition: XPMPAircraft.h:126
-
XPMP2::CSLModelInfo_t::xsbAircraftPath
std::string xsbAircraftPath
Path to the xsb_aircraft.txt file from where this model is loaded.
Definition: XPMPAircraft.h:120
-
XPMP2::CSLModelInfo_t::CSLModelInfo_t
CSLModelInfo_t()
Default constructor does nothing.
Definition: XPMPAircraft.h:140
-
XPMP2::CSLModelInfo_t::MatchCrit_t::livery
std::string livery
special livery (not often used)
Definition: XPMPAircraft.h:133
-
XPMP2::CSLModelInfo_t::MatchCrit_t::icaoAirline
std::string icaoAirline
ICAO airine/operator code.
Definition: XPMPAircraft.h:132
-
XPMP2::CSLModelInfo_t::vecMatchCrit_t
std::vector< MatchCrit_t > vecMatchCrit_t
Definition: XPMPAircraft.h:135
-
XPMP2::CSLModelInfo_t::MatchCrit_t
Any number of airline codes and/or liveries can be assigned to a model for matching purpose.
Definition: XPMPAircraft.h:131
+
XPMP2::CSLModelInfo_t
Collates some information on the CSL model.
Definition: XPMPAircraft.h:148
+
XPMP2::CSLModelInfo_t::vecMatchCrit
vecMatchCrit_t vecMatchCrit
Definition: XPMPAircraft.h:171
+
XPMP2::CSLModelInfo_t::modelName
std::string modelName
name, formed by last part of path plus id
Definition: XPMPAircraft.h:152
+
XPMP2::CSLModelInfo_t::xsbAircraftLn
int xsbAircraftLn
Line number in the xsb_aircraft.txt file where the model definition starts.
Definition: XPMPAircraft.h:156
+
XPMP2::CSLModelInfo_t::icaoType
std::string icaoType
ICAO aircraft type this model represents: xsb_aircraft.txt::ICAO
Definition: XPMPAircraft.h:158
+
XPMP2::CSLModelInfo_t::cslId
std::string cslId
id, just an arbitrary label read from xsb_aircraft.txt::OBJ8_AIRCRAFT
Definition: XPMPAircraft.h:150
+
XPMP2::CSLModelInfo_t::doc8643WTC
std::string doc8643WTC
Doc8643 information: wake turbulence class, like M, L/M, L, H.
Definition: XPMPAircraft.h:162
+
XPMP2::CSLModelInfo_t::doc8643Classification
std::string doc8643Classification
Doc8643 information: Classification, like L1P, L4J, H1T.
Definition: XPMPAircraft.h:160
+
XPMP2::CSLModelInfo_t::xsbAircraftPath
std::string xsbAircraftPath
Path to the xsb_aircraft.txt file from where this model is loaded.
Definition: XPMPAircraft.h:154
+
XPMP2::CSLModelInfo_t::CSLModelInfo_t
CSLModelInfo_t()
Default constructor does nothing.
Definition: XPMPAircraft.h:174
+
XPMP2::CSLModelInfo_t::MatchCrit_t::livery
std::string livery
special livery (not often used)
Definition: XPMPAircraft.h:167
+
XPMP2::CSLModelInfo_t::MatchCrit_t::icaoAirline
std::string icaoAirline
ICAO airine/operator code.
Definition: XPMPAircraft.h:166
+
XPMP2::CSLModelInfo_t::vecMatchCrit_t
std::vector< MatchCrit_t > vecMatchCrit_t
Definition: XPMPAircraft.h:169
+
XPMP2::CSLModelInfo_t::MatchCrit_t
Any number of airline codes and/or liveries can be assigned to a model for matching purpose.
Definition: XPMPAircraft.h:165
diff --git a/docs/html/XPMPMultiplayer_8cpp.html b/docs/html/XPMPMultiplayer_8cpp.html index dc74a914..a1229161 100644 --- a/docs/html/XPMPMultiplayer_8cpp.html +++ b/docs/html/XPMPMultiplayer_8cpp.html @@ -52,7 +52,7 @@
-

Initialization and general control functions for XPMP2. +

Initialization and general control functions for XPMP2. More...

#include "XPMP2.h"
#include <cstring>
@@ -60,6 +60,7 @@

Namespaces

 XPMP2
 Defined by FMOD.
 
- + - + @@ -183,7 +184,7 @@

@@ -83,10 +84,10 @@

 Validate all required files are available in the resource directory. More...
 
const char * XPMPMultiplayerInitLegacyData (const char *inCSLFolder, const char *inPluginName, const char *resourceDir, XPMPIntPrefsFuncTy inIntPrefsFunc, const char *inDefaultICAO, const char *inPluginLogAcronym)
 Deprecated legacy initialization of XPMP2. More...
 Deprecated legacy initialization of XPMP2. More...
 
const char * XPMPMultiplayerInit (const char *inPluginName, const char *resourceDir, XPMPIntPrefsFuncTy inIntPrefsFunc, const char *inDefaultICAO, const char *inPluginLogAcronym)
 Initializes the XPMP2 library. This shall be your first call to the library. More...
 Initializes the XPMP2 library. This shall be your first call to the library. More...
 
void XPMPSetPluginName (const char *inPluginName, const char *inPluginLogAcronym)
 Overrides the plugin's name to be used in Log output. More...
 

Detailed Description

-

Initialization and general control functions for XPMP2.

+

Initialization and general control functions for XPMP2.

Author
Birger Hoppe
Copyright
(c) 2020 Birger Hoppe
@@ -406,9 +407,9 @@

inICAOCodeICAO aircraft type designator, like 'A320', 'B738', 'C172' inAirlineICAO airline code, like 'BAW', 'DLH', can be an empty string inLiverySpecial livery designator, can be an empty string - inDataFuncCallback function called by XPMP2 to fetch updated data + inDataFuncCallback function called by XPMP2 to fetch updated data inRefconA refcon value passed back to you in all calls to the inDataFunc - inModeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given + inModeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given

@@ -479,9 +480,9 @@

inICAOCodeICAO aircraft type designator, like 'A320', 'B738', 'C172' inAirlineICAO airline code, like 'BAW', 'DLH', can be an empty string inLiverySpecial livery designator, can be an empty string - inDataFuncCallback function called by XPMP2 to fetch updated data + inDataFuncCallback function called by XPMP2 to fetch updated data inRefconA refcon value passed back to you in all calls to the inDataFunc - inModeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given + inModeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given @@ -639,7 +640,7 @@

Note
Index numbers may change if more models are loaded, don't rely on them. Model name is unique.
Deprecated:
Instead, use XPMPGetModelInfo2().
- This legacy function is defined with pointers to text arrays as return type. This is rather unsafe. XPMP2's internal maps and buffers may change if more models are loaded, hence pointers may become invalid. Don't rely on these pointers staying valid over an extended period of time.
+ This legacy function is defined with pointers to text arrays as return type. This is rather unsafe. XPMP2's internal maps and buffers may change if more models are loaded, hence pointers may become invalid. Don't rely on these pointers staying valid over an extended period of time.
Parameters
@@ -784,7 +785,7 @@

Unsupported, don't use.

-
Deprecated:
Not supported in XPMP2! In the legacy library this is actually more like an internal function, calling all callback functions for querying aircraft data (much like XPCAircraft::UpdatePosition() is now in XPMP2). I doubt that it was intended to be called from the outside in the first place.
+
Deprecated:
Not supported in XPMP2! In the legacy library this is actually more like an internal function, calling all callback functions for querying aircraft data (much like XPCAircraft::UpdatePosition() is now in XPMP2). I doubt that it was intended to be called from the outside in the first place.
Returns
Always xpmpData_Unavailable
@@ -1042,7 +1043,7 @@

Clean up the multiplayer library.

-

This shall be your last call to XPMP2. Call this latest from XPluginStop for proper and controlled cleanup of resources used by XPMP2.

+

This shall be your last call to XPMP2. Call this latest from XPluginStop for proper and controlled cleanup of resources used by XPMP2.

@@ -1090,12 +1091,12 @@

-

Initializes the XPMP2 library. This shall be your first call to the library.

+

Initializes the XPMP2 library. This shall be your first call to the library.

Note
Parameters changed compared to libxplanemp!
Parameters

inIndexNumber between 0 and `XPMPGetNumberOfInstalledModels()-1
- + @@ -1157,7 +1158,7 @@

-

Deprecated legacy initialization of XPMP2.

+

Deprecated legacy initialization of XPMP2.

Note
Parameters changed compared to libxplanemp!

Effectively calls, in this order, XPMPMultiplayerInit() and XPMPLoadCSLPackage().

See also
XPMPMultiplayerInit() and XPMPLoadCSLPackage() for details on the parameters.
@@ -1180,7 +1181,7 @@

Used to set the light textures for old OBJ7 models.

-
Note
Unsupported with XPMP2, will always return "OBJ7 format is no longer supported"
+
Note
Unsupported with XPMP2, will always return "OBJ7 format is no longer supported"
@@ -1286,7 +1287,7 @@

The original libxplanemp allowed to override rendering; no longer supported.

-
Deprecated:
Unsupported in XPMP2. The function is available to stay compile-time compatible, but it does nothing.
+
Deprecated:
Unsupported in XPMP2. The function is available to stay compile-time compatible, but it does nothing.
diff --git a/docs/html/XPMPMultiplayer_8h.html b/docs/html/XPMPMultiplayer_8h.html index fd5a7cdc..de127285 100644 --- a/docs/html/XPMPMultiplayer_8h.html +++ b/docs/html/XPMPMultiplayer_8h.html @@ -46,19 +46,18 @@
Classes | Namespaces | -Macros | Typedefs | Enumerations | -Functions | Variables
XPMPMultiplayer.h File Reference
-

Initialization and general control functions for XPMP2. +

Initialization and general control functions for XPMP2. More...

#include <string>
+#include <cmath>
#include "XPLMDefs.h"

Go to the source code of this file.

@@ -86,21 +85,31 @@

+
inPluginNameYour plugin's name, mainly used as map layer name and for logging
resourceDirThe directory where XPMP2 finds all required supplemental files (Doc8643.txt, MapIcons.png, related.txt, optionally Obj8DataRefs.txt)
resourceDirThe directory where XPMP2 finds all required supplemental files (Doc8643.txt, MapIcons.png, related.txt, optionally Obj8DataRefs.txt)
inIntPrefsFunc(optional) A pointer to a callback function providing integer config values. See XPMPIntPrefsFuncTy for details.
inDefaultICAO(optional) A fallback aircraft type if no type can be deduced otherwise for an aircraft.
inPluginLogAcronym(optional) A short text to be used in log output. If not given then inPluginName is used also for this purpose.

Namespaces

 XPMP2
 Defined by FMOD.
 
+ + + + + + + - + @@ -114,17 +123,44 @@ + + + + + + - + + + + + + + + + + + + + + + + + + + + + +

Macros

Configuration Sections

Config section is defined for legacy reasons only

+
#define XPMP_CFG_SEC_MODELS   "models"
 Config section "models". More...
 
#define XPMP_CFG_SEC_PLANES   "planes"
 Config section "planes". More...
 
#define XPMP_CFG_SEC_SOUND   "sound"
 Config section "sound". More...
 
#define XPMP_CFG_SEC_DEBUG   "debug"
 Config section "debug". More...
 
Configuration Items

Configuration Items are unique in itself even without considering the configuration section

+
#define XPMP_CFG_ITM_REPLDATAREFS   "replace_datarefs"
 Config key: Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!) More...
 Config key: Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!) More...
 
#define XPMP_CFG_ITM_REPLTEXTURE   "replace_texture"
 Config key: Replace textures in OBJ8 files upon load if needed (specified on the OBJ8 line in xsb_aircraft.txt), creating new OBJ8 files. More...
#define XPMP_CFG_ITM_SUPPORT_REMOTE   "support_remote"
 Config key: Support remote connections? <0 force off, 0 default: on if in a networked or multiplayer setup, >0 force on. More...
 
#define XPMP_CFG_ITM_ACTIVATE_SOUND   "activate_sound"
 Config key: Activate Sound upon initial startup? (No effect later) More...
 
#define XPMP_CFG_ITM_MUTE_ON_PAUSE   "mute_on_pause"
 Config key: Mute all sound temporarily while X-Plane is in a paused state? More...
 
#define XPMP_CFG_ITM_LOGLEVEL   "log_level"
 Config key: General level of logging into Log.txt (0 = Debug, 1 = Info, 2 = Warning, 3 = Error, 4 = Fatal) More...
 
#define XPMP_CFG_ITM_MODELMATCHING   "model_matching"
 Config key: Write information on model matching into Log.txt More...
 Config key: Write information on model matching and sound selection into Log.txt More...
 
Sound Macros
#define XP_SOUND_ELECTRIC   "Electric"
 
#define XP_SOUND_HIBYPASSJET   "HiBypassJet"
 
#define XP_SOUND_LOBYPASSJET   "LoBypassJet"
 
#define XP_SOUND_TURBOPROP   "Turboprop"
 
#define XP_SOUND_PROP_AIRPLANE   "PropAirplane"
 
#define XP_SOUND_PROP_HELI   "PropHeli"
 
#define XP_SOUND_REVERSE_THRUST   "ReverseThrust"
 
#define XP_SOUND_ROLL_RUNWAY   "RollRunway"
 
#define XP_SOUND_FLAP   "Flap"
 
#define XP_SOUND_GEAR   "Gear"
 
- + @@ -183,11 +219,12 @@

Typedefs

typedef unsigned int XPMPLightsPattern
 Light flash pattern (unused in XPMP2) More...
 Light flash pattern (unused in XPMP2) More...
 
typedef unsigned XPMPPlaneID
 Unique ID for an aircraft created by a plugin. More...
+ - + - + @@ -198,6 +235,28 @@ + + + + + + + + + + + + + + + + + + + + + @@ -205,8 +264,9 @@ - + + @@ -231,6 +291,7 @@ + @@ -270,12 +331,14 @@ + + @@ -307,22 +370,27 @@

Functions

Initialization
const char * XPMPMultiplayerInitLegacyData (const char *inCSLFolder, const char *inPluginName, const char *resourceDir, XPMPIntPrefsFuncTy inIntPrefsFunc=nullptr, const char *inDefaultICAO=nullptr, const char *inPluginLogAcronym=nullptr)
 Deprecated legacy initialization of XPMP2. More...
 Deprecated legacy initialization of XPMP2. More...
 
const char * XPMPMultiplayerInit (const char *inPluginName, const char *resourceDir, XPMPIntPrefsFuncTy inIntPrefsFunc=nullptr, const char *inDefaultICAO=nullptr, const char *inPluginLogAcronym=nullptr)
 Initializes the XPMP2 library. This shall be your first call to the library. More...
 Initializes the XPMP2 library. This shall be your first call to the library. More...
 
void XPMPSetPluginName (const char *inPluginName, const char *inPluginLogAcronym=nullptr)
 Overrides the plugin's name to be used in Log output. More...
const char * XPMPMultiplayerOBJ7SupportEnable (const char *inTexturePath)
 Used to set the light textures for old OBJ7 models. More...
 
Sound
Note
Only included if built with INCLUDE_FMOD_SOUND
+
bool XPMPSoundEnable (bool bEnable=true)
 Enable/Disable Sound. More...
 
bool XPMPSoundIsEnabled ()
 Is Sound enabled? More...
 
void XPMPSoundSetMasterVolume (float fVol=1.0f)
 Set Master Volume. More...
 
void XPMPSoundMute (bool bMute)
 Mute all sounds (temporarily) More...
 
const char * XPMPSoundAdd (const char *sName, const char *filePath, bool bLoop, float coneDir=NAN, float conePitch=NAN, float coneInAngle=NAN, float coneOutAngle=NAN, float coneOutVol=NAN)
 Add a sound that can later be referenced from an XPMP2::Aircraft. More...
 
const char * XPMPSoundEnumerate (const char *prevName, const char **ppFilePath=nullptr)
 Enumerate all sounds, including the internal ones. More...
 
AI / Multiplayer plane control
const char * XPMPMultiplayerEnable (void(*_callback)(void *)=nullptr, void *_refCon=nullptr)
 Tries to grab control of TCAS targets (formerly known as AI/multiplayer) from X-Plane. More...
 
 Release TCAS targets control. More...
 
bool XPMPHasControlOfAIAircraft ()
 Has XPMP2 control of TCAS targets? More...
 Has XPMP2 control of TCAS targets? More...
 
CSL Package Handling
const char * XPMPLoadCSLPackage (const char *inCSLFolder)
 Loads CSL packages from the given folder, searching up to 5 folder levels deep. More...
 
size_t XPMPAddModelDataRef (const std::string &dataRef)
 Add a user-defined dataRef to the list of dataRefs supported by every plane. More...
 
Plane Creation API
XPMPPlaneID XPMPCreatePlane (const char *inICAOCode, const char *inAirline, const char *inLivery, XPMPPlaneData_f inDataFunc, void *inRefcon, XPMPPlaneID inModeS_id=0)
 Creates a new plane. More...
 
void XPMPSetDefaultPlaneICAO (const char *_acIcaoType, const char *_carIcaoType=nullptr)
 Define default aircraft and ground vehicle ICAO types. More...
 
Plane Observation API
void XPMPRegisterPlaneNotifierFunc (XPMPPlaneNotifier_f inFunc, void *inRefcon)
 Registers a callback, which is called when one of the events defined in XPMPPlaneNotification happens. More...
 
void XPMPUnregisterPlaneNotifierFunc (XPMPPlaneNotifier_f inFunc, void *inRefcon)
 Unregisters a notification callback. Both function pointer and refcon must match what was registered. More...
 
Plane Rendering API
void XPMPSetPlaneRenderer (XPMPRenderPlanes_f inRenderer, void *inRef)
 The original libxplanemp allowed to override rendering; no longer supported. More...
 
 

Detailed Description

-

Initialization and general control functions for XPMP2.

+

Initialization and general control functions for XPMP2.

Note
This file bases on and should be largely compile-compatible to the header provided with the original libxplanemp.
Some functions are marked deprecated, reason is given with each function. They are only provided for backward compatibility.
-

This is one of two main header files for using XPMP2. (The other is XPMPAircraft.h). XPMP2 is a library allowing an X-Plane plugin to have planes rendered in X-Plane's 3D world based on OBJ8 CSL models, which need to be installed separately. The plugin shall subclass XPMP2::Aircraft:: and override the abstract virtual function XPMP2::Aircraft::UpdatePosition() to provide updated position and attitude information. XPMP2 takes care of reading and initializaing CSL models, instanciating and updating the aircraft objects in X-Plane, display in a map layer, provisioning information via X-Plane's TCAS targets and AI/multiplayer (and more) dataRefs.

+

This is one of two main header files for using XPMP2. (The other is XPMPAircraft.h). XPMP2 is a library allowing an X-Plane plugin to have planes rendered in X-Plane's 3D world based on OBJ8 CSL models, which need to be installed separately. The plugin shall subclass XPMP2::Aircraft and override the abstract virtual function XPMP2::Aircraft::UpdatePosition() to provide updated position and attitude information. XPMP2 takes care of reading and initializaing CSL models, instanciating and updating the aircraft objects in X-Plane, display in a map layer, provisioning information via X-Plane's TCAS targets and AI/multiplayer (and more) dataRefs.

See also
For more developer's information see https://twinfan.github.io/XPMP2/
+Sample and "How to" available, see https://twinfan.github.io/XPMP2/HowTo.html
+
For TCAS Override approach see https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/
For a definition of ICAO aircraft type designators see https://www.icao.int/publications/DOC8643/Pages/Search.aspx
For a list of ICAO airline/operator codes see https://en.wikipedia.org/wiki/List_of_airline_codes
+
Note
Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. Understand FMOD licensing and attribution requirements first!
+ Sound support is only included if built with CMake cache entry INCLUDE_FMOD_SOUND.
+
Author
Ben Supnik and Chris Serio
Copyright
Copyright (c) 2004, Ben Supnik and Chris Serio.
Author
Birger Hoppe
-
Copyright
(c) 2020 Birger Hoppe
+
Copyright
(c) 2020-2022 Birger Hoppe
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
@@ -399,7 +467,7 @@

multiIdx -OUT: set by XPMP2 to inform application about TCAS target index in use [1..63], with [1..19] also being available via classic multiplayer dataRefs, < 1 means 'none'. +OUT: set by XPMP2 to inform application about TCAS target index in use [1..63], with [1..19] also being available via classic multiplayer dataRefs, < 1 means 'none'. float @@ -653,7 +721,7 @@

&

Textual information of planes to be passed on via shared dataRefs to other plugins.

-

The texts are not used within XPMP2 in any way, just passed on to dataRefs

+

The texts are not used within XPMP2 in any way, just passed on to dataRefs

+light pattern (unused in XPMP2) +time offset to avoid lights across planes blink in sync (unused in XPMP2)
Class Members
@@ -744,7 +812,7 @@

flashPattern: 4

 -light pattern (unused in XPMP2)
unsigned int @@ -774,12 +842,168 @@

timeOffset: 16

 -time offset to avoid lights across planes blink in sync (unused in XPMP2)

Macro Definition Documentation

+ +

◆ XP_SOUND_ELECTRIC

+ +
+
+ + + + +
#define XP_SOUND_ELECTRIC   "Electric"
+
+ +
+
+ +

◆ XP_SOUND_FLAP

+ +
+
+ + + + +
#define XP_SOUND_FLAP   "Flap"
+
+ +
+
+ +

◆ XP_SOUND_GEAR

+ +
+
+ + + + +
#define XP_SOUND_GEAR   "Gear"
+
+ +
+
+ +

◆ XP_SOUND_HIBYPASSJET

+ +
+
+ + + + +
#define XP_SOUND_HIBYPASSJET   "HiBypassJet"
+
+ +
+
+ +

◆ XP_SOUND_LOBYPASSJET

+ +
+
+ + + + +
#define XP_SOUND_LOBYPASSJET   "LoBypassJet"
+
+ +
+
+ +

◆ XP_SOUND_PROP_AIRPLANE

+ +
+
+ + + + +
#define XP_SOUND_PROP_AIRPLANE   "PropAirplane"
+
+ +
+
+ +

◆ XP_SOUND_PROP_HELI

+ +
+
+ + + + +
#define XP_SOUND_PROP_HELI   "PropHeli"
+
+ +
+
+ +

◆ XP_SOUND_REVERSE_THRUST

+ +
+
+ + + + +
#define XP_SOUND_REVERSE_THRUST   "ReverseThrust"
+
+ +
+
+ +

◆ XP_SOUND_ROLL_RUNWAY

+ +
+
+ + + + +
#define XP_SOUND_ROLL_RUNWAY   "RollRunway"
+
+ +
+
+ +

◆ XP_SOUND_TURBOPROP

+ +
+
+ + + + +
#define XP_SOUND_TURBOPROP   "Turboprop"
+
+ +
+
+ +

◆ XPMP_CFG_ITM_ACTIVATE_SOUND

+ +
+
+ + + + +
#define XPMP_CFG_ITM_ACTIVATE_SOUND   "activate_sound"
+
+ +

Config key: Activate Sound upon initial startup? (No effect later)

+ +
+

◆ XPMP_CFG_ITM_CLAMPALL

@@ -840,7 +1064,23 @@

-

Config key: Write information on model matching into Log.txt

+

Config key: Write information on model matching and sound selection into Log.txt

+ +

+
+ +

◆ XPMP_CFG_ITM_MUTE_ON_PAUSE

+ +
+
+ + + + +
#define XPMP_CFG_ITM_MUTE_ON_PAUSE   "mute_on_pause"
+
+ +

Config key: Mute all sound temporarily while X-Plane is in a paused state?

@@ -856,7 +1096,7 @@

-

Config key: Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!)

+

Config key: Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!)

@@ -938,6 +1178,22 @@

+ + + +

◆ XPMP_CFG_SEC_SOUND

+ +
+
+ + + + +
#define XPMP_CFG_SEC_SOUND   "sound"
+
+ +

Config section "sound".

+

Typedef Documentation

@@ -954,23 +1210,25 @@

Definition for the type of configuration callback function.

-

The plugin using XPMP2 can provide such a callback function via XPMPMultiplayerInit(). It will be called max. every 2s to fetch each of the following configuration values:
+

The plugin using XPMP2 can provide such a callback function via XPMPMultiplayerInit(). It will be called max. every 2s to fetch each of the following configuration values:

section | key                 | type | default | description
------- | ------------------- | ---- | ------- | -------------------------------------------------------------------------
-models  | replace_datarefs    | int  |    0    | Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!)
+models  | replace_datarefs    | int  |    0    | Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!)
models  | replace_texture     | int  |    1    | Replace textures in OBJ8 files upon load if needed (specified on the OBJ8 line in xsb_aircraft.txt), creating new OBJ8 files
planes  | clamp_all_to_ground | int  |    1    | Ensure no plane sinks below ground, no matter of XPMP2::Aircraft::bClampToGround
planes  | handle_dup_id       | int  |    0    | Boolean: If XPMP2::Aircraft::modeS_id already exists then assign a new unique one, overwrites XPMP2::Aircraft::modeS_id
planes  | support_remote      | int  |    0    | 3-state integer: Support remote connections? <0 force off, 0 default: on if in a networked or multiplayer setup, >0 force on
+sound   | activate_sound      | int  |    1    | Activate Sound upon initial startup? (No effect later)
+sound   | mute_on_pause       | int  |    1    | Mute all sound temporarily while X-Plane is in a paused state?
debug   | log_level           | int  |    2    | General level of logging into Log.txt (0 = Debug, 1 = Info, 2 = Warning, 3 = Error, 4 = Fatal)
-debug   | model_matching      | int  |    0    | Write information on model matching into Log.txt
+debug   | model_matching      | int  |    0    | Write information on model matching and sound selection into Log.txt

Note
There is no immediate requirement to check the value of _section in your implementation. _key by itself is unique. Compare it with any of the XPMP_CFG_ITM_* values and return your value.
Parameters
- +
_sectionConfiguration section, ie. group of values, any of the XPMP_CFG_SEC_... values
_keyAny of the XPMP_CFG_ITM_* values to indicate which config value is to be returned.
_defaultA default provided by XPMP2. Have your callback return _default if you don't want to explicitely set a value or don't know the _key.
_defaultA default provided by XPMP2. Have your callback return _default if you don't want to explicitely set a value or don't know the _key.
@@ -990,7 +1248,7 @@

-

Light flash pattern (unused in XPMP2)

+

Light flash pattern (unused in XPMP2)

@@ -1008,11 +1266,11 @@

Note
This type is only used with deprecated concepts (direct use of callback functions.)
-

This functions is called by XPMP2 once per cycle per plane per data type. Your implementation returns the requested data, so that XPMP2 can move and update the associated aircraft instance.

Parameters
+

This functions is called by XPMP2 once per cycle per plane per data type. Your implementation returns the requested data, so that XPMP2 can move and update the associated aircraft instance.

Parameters
- +
inPlaneID of the plane, for which data is requested
inDataTypeThe type of data that is requested, see XPMPPlaneDataType
[out]ioDataA pointer to a structure XPMP2 provides, for you to fill the data into. For its type see XPMPPlaneDataType.
[out]ioDataA pointer to a structure XPMP2 provides, for you to fill the data into. For its type see XPMPPlaneDataType.
inRefconThe refcon value you provided when creating the plane
@@ -1033,7 +1291,7 @@

Unique ID for an aircraft created by a plugin.

-
Note
In XPMP2 this value is no longer a pointer to an internal memory address, but will directly be used as modeS_id in the new TCAS override approach.
+
Note
In XPMP2 this value is no longer a pointer to an internal memory address, but will directly be used as modeS_id in the new TCAS override approach.
@@ -1074,7 +1332,7 @@

The original libxplanemp allowed to override rendering; no longer supported.

-
Deprecated:
Unsupported in XPMP2. The type definition is available to stay compile-time compatible, but the callback will not be called.
+
Deprecated:
Unsupported in XPMP2. The type definition is available to stay compile-time compatible, but the callback will not be called.
@@ -1092,9 +1350,9 @@

Light flash patterns.

-
Note
Unused in XPMP2
+
Note
Unused in XPMP2
-Not changed to proper enum type as it is used in bitfields in xpmp_LightStatus, which causes misleading, non-suppressable warnings in gcc:
+Now changed to proper enum type as it is used in bitfields in XPMP2::xpmp_LightStatus, which causes misleading, non-suppressable warnings in gcc:
https://gcc.gnu.org/bugzilla/show_bug.cgi?id=51242
- + - +
Enumerator
xpmp_Lights_Pattern_Default 

Jets: one strobe flash, short beacon (-*—*—*—)

@@ -1142,7 +1400,7 @@

This enum defines the different categories of aircraft information we can query about.

-
Note
While these enums are defined in a way that they could be combined together, there is no place, which makes use of this possibility. Each value will be used individually only. Because of this, the definition has been changed in XPMP2 to an actual enum type for clarity.
+
Note
While these enums are defined in a way that they could be combined together, there is no place, which makes use of this possibility. Each value will be used individually only. Because of this, the definition has been changed in XPMP2 to an actual enum type for clarity.
This enum is only used with deprecated concepts (class XPCAircraft and direct use of callback functions.)
@@ -1195,7 +1453,7 @@

These enumerations define the way the transponder of a given plane is operating.

-
Note
Only information used by XPMP2 is "mode != xpmpTransponderMode_Standby", in which case the plane is considered for TCAS display.
+
Note
Only information used by XPMP2 is "mode != xpmpTransponderMode_Standby", in which case the plane is considered for TCAS display.

@@ -1229,14 +1487,14 @@

Add a user-defined dataRef to the list of dataRefs supported by every plane.

-

All planes created by XPMP2 define the same set of dataRefs. See XPMP2::DR_VALS for the definitions that come pre-defined with XPMP2. Here you can add more dataRefs that you want to set in your XPMP2::Aircraft::UpdatePosition() implementation.

Returns
The functions returns the array index you need to use in the XPMP2::Aircraft::v array to provide the actual value. Or 0 when an error occured.
+

All planes created by XPMP2 define the same set of dataRefs. See XPMP2::DR_VALS for the definitions that come pre-defined with XPMP2. Here you can add more dataRefs that you want to set in your XPMP2::Aircraft::UpdatePosition() implementation.

Returns
The functions returns the array index you need to use in the XPMP2::Aircraft::v array to provide the actual value. Or 0 when an error occured.
Note
There is a duplication check: Adding an already existing dataRef, no matter if XPMP2-predefined or by the plugin will return the already existing index.
Can only be called while no plane exists as it influence the size of important data arrays. Returns 0 if called while planes exist.
Can only be called from XP's main thread as XPLM SDK functions are called. Returns 0 if called from a worker thread.
-User-defined dataRefs are not transfered to the XPMP2 Remote Client for display on network-connected X-Plane instances.
+User-defined dataRefs are not transfered to the XPMP2 Remote Client for display on network-connected X-Plane instances. @@ -1370,9 +1628,9 @@

inICAOCode

- + - +
Enumerator
xpmpTransponderMode_Standby 

transponder is in standby, not currently sending -> aircraft not visible on TCAS

ICAO aircraft type designator, like 'A320', 'B738', 'C172'
inAirlineICAO airline code, like 'BAW', 'DLH', can be an empty string
inLiverySpecial livery designator, can be an empty string
inDataFuncCallback function called by XPMP2 to fetch updated data
inDataFuncCallback function called by XPMP2 to fetch updated data
inRefconA refcon value passed back to you in all calls to the inDataFunc
inModeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given
inModeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given
@@ -1443,9 +1701,9 @@

inICAOCode

ICAO aircraft type designator, like 'A320', 'B738', 'C172'
inAirlineICAO airline code, like 'BAW', 'DLH', can be an empty string
inLiverySpecial livery designator, can be an empty string
inDataFuncCallback function called by XPMP2 to fetch updated data
inDataFuncCallback function called by XPMP2 to fetch updated data
inRefconA refcon value passed back to you in all calls to the inDataFunc
inModeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given
inModeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given

@@ -1587,7 +1845,7 @@

XPMP2 creates a separate Map Layer named after the plugin for this purposes. By default, the map functionality is enabled including label writing.

+

XPMP2 creates a separate Map Layer named after the plugin for this purposes. By default, the map functionality is enabled including label writing.

@@ -1658,7 +1916,7 @@

Note
Index numbers may change if more models are loaded, don't rely on them. Model name is unique.
Deprecated:
Instead, use XPMPGetModelInfo2().
- This legacy function is defined with pointers to text arrays as return type. This is rather unsafe. XPMP2's internal maps and buffers may change if more models are loaded, hence pointers may become invalid. Don't rely on these pointers staying valid over an extended period of time.
+ This legacy function is defined with pointers to text arrays as return type. This is rather unsafe. XPMP2's internal maps and buffers may change if more models are loaded, hence pointers may become invalid. Don't rely on these pointers staying valid over an extended period of time.
Parameters
@@ -1803,7 +2061,7 @@

Unsupported, don't use.

-
Deprecated:
Not supported in XPMP2! In the legacy library this is actually more like an internal function, calling all callback functions for querying aircraft data (much like XPCAircraft::UpdatePosition() is now in XPMP2). I doubt that it was intended to be called from the outside in the first place.
+
Deprecated:
Not supported in XPMP2! In the legacy library this is actually more like an internal function, calling all callback functions for querying aircraft data (much like XPCAircraft::UpdatePosition() is now in XPMP2). I doubt that it was intended to be called from the outside in the first place.
Returns
Always xpmpData_Unavailable
@@ -1926,7 +2184,7 @@

-

Has XPMP2 control of TCAS targets?

+

Has XPMP2 control of TCAS targets?

See also
XPMPMultiplayerEnable()
@@ -2060,7 +2318,7 @@

Clean up the multiplayer library.

-

This shall be your last call to XPMP2. Call this latest from XPluginStop for proper and controlled cleanup of resources used by XPMP2.

+

This shall be your last call to XPMP2. Call this latest from XPluginStop for proper and controlled cleanup of resources used by XPMP2.

@@ -2080,7 +2338,7 @@

Release TCAS targets control.

-

Afterwards, XPMP2's aircraft will no longer appear on TCAS or on 3rd-party plugins relying on TCAS targets dataRefs.
+

Afterwards, XPMP2's aircraft will no longer appear on TCAS or on 3rd-party plugins relying on TCAS targets dataRefs.
Is called during XPMPMultiplayerCleanup() automatically.

@@ -2113,7 +2371,7 @@

XPMP2's aircraft will appear on TCAS and are available to 3rd-party plugins relying on TCAS tagrtes or multiplayer dataRefs.
+ If successful, XPMP2's aircraft will appear on TCAS and are available to 3rd-party plugins relying on TCAS tagrtes or multiplayer dataRefs.
Typically, a plugin calls this function just before the first aircraft are created. But it could also be bound to a menu item, for example.

Parameters

inIndexNumber between 0 and `XPMPGetNumberOfInstalledModels()-1
@@ -2170,12 +2428,12 @@

-

Initializes the XPMP2 library. This shall be your first call to the library.

+

Initializes the XPMP2 library. This shall be your first call to the library.

Note
Parameters changed compared to libxplanemp!
Parameters

_callback(optional) You can provide a callback function, which is called directly by X-Plane when control of TCAS targets is not successful now but becomes available later.
- + @@ -2237,7 +2495,7 @@

-

Deprecated legacy initialization of XPMP2.

+

Deprecated legacy initialization of XPMP2.

Note
Parameters changed compared to libxplanemp!

Effectively calls, in this order, XPMPMultiplayerInit() and XPMPLoadCSLPackage().

See also
XPMPMultiplayerInit() and XPMPLoadCSLPackage() for details on the parameters.
@@ -2260,7 +2518,7 @@

Used to set the light textures for old OBJ7 models.

-
Note
Unsupported with XPMP2, will always return "OBJ7 format is no longer supported"
+
Note
Unsupported with XPMP2, will always return "OBJ7 format is no longer supported"
@@ -2401,7 +2659,7 @@

The original libxplanemp allowed to override rendering; no longer supported.

-
Deprecated:
Unsupported in XPMP2. The function is available to stay compile-time compatible, but it does nothing.
+
Deprecated:
Unsupported in XPMP2. The function is available to stay compile-time compatible, but it does nothing.
@@ -2471,6 +2729,217 @@

+

◆ XPMPSoundAdd()

+ +
+
+

inPluginNameYour plugin's name, mainly used as map layer name and for logging
resourceDirThe directory where XPMP2 finds all required supplemental files (Doc8643.txt, MapIcons.png, related.txt, optionally Obj8DataRefs.txt)
resourceDirThe directory where XPMP2 finds all required supplemental files (Doc8643.txt, MapIcons.png, related.txt, optionally Obj8DataRefs.txt)
inIntPrefsFunc(optional) A pointer to a callback function providing integer config values. See XPMPIntPrefsFuncTy for details.
inDefaultICAO(optional) A fallback aircraft type if no type can be deduced otherwise for an aircraft.
inPluginLogAcronym(optional) A short text to be used in log output. If not given then inPluginName is used also for this purpose.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
const char* XPMPSoundAdd (const char * sName,
const char * filePath,
bool bLoop,
float coneDir = NAN,
float conePitch = NAN,
float coneInAngle = NAN,
float coneOutAngle = NAN,
float coneOutVol = NAN 
)
+
+ +

Add a sound that can later be referenced from an XPMP2::Aircraft.

+

XPMP2 loads a number of default sounds from what X-Plane ships. This function allows to add your own. It will try to load the sound immediately.

Parameters
+ + + + + + + + + +
sNameA descriptive name, used as a key to refer to this sound later
filePathPath to the sound file; a relative path is relative to resourceDir as set by XPMPMultiplayerInit()
bLoopIs this sound to be played in a loop?
coneDir[opt] Which direction relative to plane's heading does the cone point to? (180 would be typical for jet engines)
conePitch[opt] Which pitch does the cone point to (up/down)? (0 would be typical, ie. level with the plane)
coneInAngle[opt] Inside cone angle. This is the angle spread within which the sound is unattenuated.
coneOutAngle[opt] Outside cone angle. This is the angle spread outside of which the sound is attenuated to its coneOutVol.
coneOutVol[opt] Cone outside volume.
+
+
+
Returns
Empty string in case of success, otherwise a human-readable error message.
+ +
+ + +

◆ XPMPSoundEnable()

+ +
+
+ + + + + + + + +
bool XPMPSoundEnable (bool bEnable = true)
+
+ +

Enable/Disable Sound.

+

Enable or disable sound support. The default on startup is controlled by the configuration item sound / activate_sound, which in turn defaults to 1.

Returns
Is sound now available? (Could still be false even in case of activation if there was a problem during sound initialization)
+ +
+
+ +

◆ XPMPSoundEnumerate()

+ +
+
+ + + + + + + + + + + + + + + + + + +
const char* XPMPSoundEnumerate (const char * prevName,
const char ** ppFilePath = nullptr 
)
+
+ +

Enumerate all sounds, including the internal ones.

+
Parameters
+ + + +
prevNamenullptr or empty string to start from beginning, last returned name to continue with next sound
[out]ppFilePath(optional) Receives pointer to file path
+
+
+
Returns
Next sound's name.
+
Note
String pointers can change any frame. If you want to use the strings longer than immediately, make yourself a string copy.
+ +
+
+ +

◆ XPMPSoundIsEnabled()

+ +
+
+ + + + + + + +
bool XPMPSoundIsEnabled ()
+
+ +

Is Sound enabled?

+ +
+
+ +

◆ XPMPSoundMute()

+ +
+
+ + + + + + + + +
void XPMPSoundMute (bool bMute)
+
+ +

Mute all sounds (temporarily)

+
Parameters
+ + +
bMuteMute (true) or unmute (false)?
+
+
+ +
+
+ +

◆ XPMPSoundSetMasterVolume()

+ +
+
+ + + + + + + + +
void XPMPSoundSetMasterVolume (float fVol = 1.0f)
+
+ +

Set Master Volume.

+
Parameters
+ + +
fVolVolume level. 0 = silent, 1 = full. Negative level inverts the signal. Values larger than 1 amplify the signal.
+
+
+
diff --git a/docs/html/XPMPMultiplayer_8h_source.html b/docs/html/XPMPMultiplayer_8h_source.html index 51566a02..cc73cd79 100644 --- a/docs/html/XPMPMultiplayer_8h_source.html +++ b/docs/html/XPMPMultiplayer_8h_source.html @@ -48,507 +48,564 @@
Go to the documentation of this file.
1 
-
55 #ifndef _XPLMMultiplayer_h_
-
56 #define _XPLMMultiplayer_h_
-
57 
-
58 #include <string>
-
59 #include "XPLMDefs.h"
-
60 
-
61 #ifdef __cplusplus
-
62 extern "C" {
-
63 #endif
-
64 
-
65 // defined in XPMPAircraft
-
66 namespace XPMP2 { class Aircraft; }
-
67 
-
68 /************************************************************************************
-
69  * MARK: PLANE DATA TYPES
-
70  ************************************************************************************/
-
71 
-
79 struct XPMPPlanePosition_t {
-
80  long size = sizeof(XPMPPlanePosition_t);
-
81  double lat = 0.0;
-
82  double lon = 0.0;
-
83  double elevation = 0.0;
-
84  float pitch = 0.0f;
-
85  float roll = 0.0f;
-
86  float heading = 0.0f;
-
87  char label[32] = "";
-
88  float offsetScale = 1.0f;
-
89  bool clampToGround = false;
-
90  int aiPrio = 1;
-
91  float label_color[4] = {1.0f,1.0f,0.0f,1.0f};
-
92  int multiIdx = 0;
-
93 };
-
94 
-
95 
-
101 enum {
-
102  xpmp_Lights_Pattern_Default = 0,
-
103  xpmp_Lights_Pattern_EADS = 1,
-
104  xpmp_Lights_Pattern_GA = 2
-
105 };
-
106 typedef unsigned int XPMPLightsPattern;
-
107 
-
108 
-
109 #if __GNUC__
-
110 #pragma GCC diagnostic push
-
111 #pragma GCC diagnostic ignored "-Wpedantic" // because we don't want to change the anonymous structure following here as that would require code change in legacy plugins
-
112 #elif _MSC_VER
-
113 #pragma warning(push)
-
114 #pragma warning(disable: 4202 4201)
-
115 #endif
-
119 union xpmp_LightStatus {
-
120  unsigned int lightFlags = 0x150000;
-
121  struct {
-
122  unsigned int timeOffset : 16;
-
123 
-
124  unsigned int taxiLights : 1;
-
125  unsigned int landLights : 1;
-
126  unsigned int bcnLights : 1;
-
127  unsigned int strbLights : 1;
-
128  unsigned int navLights : 1;
-
129 
-
131  XPMPLightsPattern flashPattern : 4;
-
132  };
-
133 };
-
134 #if __GNUC__
-
135 #pragma GCC diagnostic pop
-
136 #elif _MSC_VER
-
137 #pragma warning(pop)
-
138 #endif
-
139 
-
140 
-
147 struct XPMPPlaneSurfaces_t {
-
148  long size = sizeof(XPMPPlaneSurfaces_t);
-
149  float gearPosition = 0.0f;
-
150  float flapRatio = 0.0f;
-
151  float spoilerRatio = 0.0f;
-
152  float speedBrakeRatio = 0.0f;
-
153  float slatRatio = 0.0f;
-
154  float wingSweep = 0.0f;
-
155  float thrust = 0.0f;
-
156  float yokePitch = 0.0f;
-
157  float yokeHeading = 0.0f;
-
158  float yokeRoll = 0.0f;
-
159 
-
160  xpmp_LightStatus lights;
-
161 
-
162  float tireDeflect = 0.0f;
-
163  float tireRotDegree = 0.0f;
-
164  float tireRotRpm = 0.0f;
-
165 
-
166  float engRotDegree = 0.0f;
-
167  float engRotRpm = 0.0f;
-
168  float propRotDegree = 0.0f;
-
169  float propRotRpm = 0.0f;
-
170  float reversRatio = 0.0f;
-
171 
-
172  bool touchDown = false;
-
173 };
-
174 
-
175 
-
179 enum XPMPTransponderMode {
-
180  xpmpTransponderMode_Standby,
-
181  xpmpTransponderMode_Mode3A,
-
182  xpmpTransponderMode_ModeC,
-
183  xpmpTransponderMode_ModeC_Low,
-
184  xpmpTransponderMode_ModeC_Ident
-
185 };
-
186 
-
187 
-
189 struct XPMPPlaneRadar_t {
-
190  long size = sizeof(XPMPPlaneRadar_t);
-
191  long code = 0;
-
192  XPMPTransponderMode mode = xpmpTransponderMode_ModeC;
-
193 };
-
194 
+
63 #ifndef _XPLMMultiplayer_h_
+
64 #define _XPLMMultiplayer_h_
+
65 
+
66 #include <string>
+
67 #include <cmath>
+
68 #include "XPLMDefs.h"
+
69 
+
70 #ifdef __cplusplus
+
71 extern "C" {
+
72 #endif
+
73 
+
74 // defined in XPMPAircraft
+
75 namespace XPMP2 { class Aircraft; }
+
76 
+
77 /************************************************************************************
+
78  * MARK: PLANE DATA TYPES
+
79  ************************************************************************************/
+
80 
+
88 struct XPMPPlanePosition_t {
+
89  long size = sizeof(XPMPPlanePosition_t);
+
90  double lat = 0.0;
+
91  double lon = 0.0;
+
92  double elevation = 0.0;
+
93  float pitch = 0.0f;
+
94  float roll = 0.0f;
+
95  float heading = 0.0f;
+
96  char label[32] = "";
+
97  float offsetScale = 1.0f;
+
98  bool clampToGround = false;
+
99  int aiPrio = 1;
+
100  float label_color[4] = {1.0f,1.0f,0.0f,1.0f};
+
101  int multiIdx = 0;
+
102 };
+
103 
+
104 
+
110 enum {
+
111  xpmp_Lights_Pattern_Default = 0,
+
112  xpmp_Lights_Pattern_EADS = 1,
+
113  xpmp_Lights_Pattern_GA = 2
+
114 };
+
115 typedef unsigned int XPMPLightsPattern;
+
116 
+
117 
+
118 #if __GNUC__
+
119 #pragma GCC diagnostic push
+
120 #pragma GCC diagnostic ignored "-Wpedantic" // because we don't want to change the anonymous structure following here as that would require code change in legacy plugins
+
121 #elif _MSC_VER
+
122 #pragma warning(push)
+
123 #pragma warning(disable: 4202 4201)
+
124 #endif
+
128 union xpmp_LightStatus {
+
129  unsigned int lightFlags = 0x150000;
+
130  struct {
+
131  unsigned int timeOffset : 16;
+
132 
+
133  unsigned int taxiLights : 1;
+
134  unsigned int landLights : 1;
+
135  unsigned int bcnLights : 1;
+
136  unsigned int strbLights : 1;
+
137  unsigned int navLights : 1;
+
138 
+
140  XPMPLightsPattern flashPattern : 4;
+
141  };
+
142 };
+
143 #if __GNUC__
+
144 #pragma GCC diagnostic pop
+
145 #elif _MSC_VER
+
146 #pragma warning(pop)
+
147 #endif
+
148 
+
149 
+
156 struct XPMPPlaneSurfaces_t {
+
157  long size = sizeof(XPMPPlaneSurfaces_t);
+
158  float gearPosition = 0.0f;
+
159  float flapRatio = 0.0f;
+
160  float spoilerRatio = 0.0f;
+
161  float speedBrakeRatio = 0.0f;
+
162  float slatRatio = 0.0f;
+
163  float wingSweep = 0.0f;
+
164  float thrust = 0.0f;
+
165  float yokePitch = 0.0f;
+
166  float yokeHeading = 0.0f;
+
167  float yokeRoll = 0.0f;
+
168 
+
169  xpmp_LightStatus lights;
+
170 
+
171  float tireDeflect = 0.0f;
+
172  float tireRotDegree = 0.0f;
+
173  float tireRotRpm = 0.0f;
+
174 
+
175  float engRotDegree = 0.0f;
+
176  float engRotRpm = 0.0f;
+
177  float propRotDegree = 0.0f;
+
178  float propRotRpm = 0.0f;
+
179  float reversRatio = 0.0f;
+
180 
+
181  bool touchDown = false;
+
182 };
+
183 
+
184 
+
188 enum XPMPTransponderMode {
+
189  xpmpTransponderMode_Standby,
+
190  xpmpTransponderMode_Mode3A,
+
191  xpmpTransponderMode_ModeC,
+
192  xpmpTransponderMode_ModeC_Low,
+
193  xpmpTransponderMode_ModeC_Ident
+
194 };
195 
-
199 struct XPMPInfoTexts_t {
-
200  long size = sizeof(XPMPInfoTexts_t);
-
201  char tailNum[10] = {0};
-
202  char icaoAcType[5] = {0};
-
203  char manufacturer[40] = {0};
-
204  char model[40] = {0};
-
205  char icaoAirline[4] = {0};
-
206  char airline[40] = {0};
-
207  char flightNum [10] = {0};
-
208  char aptFrom [5] = {0};
-
209  char aptTo [5] = {0};
-
210 };
-
211 
-
212 
-
220 enum XPMPPlaneDataType {
-
221  xpmpDataType_Position = 1L << 1,
-
222  xpmpDataType_Surfaces = 1L << 2,
-
223  xpmpDataType_Radar = 1L << 3,
-
224  xpmpDataType_InfoTexts = 1L << 4,
-
225 };
-
226 
-
227 
-
231 enum XPMPPlaneCallbackResult {
-
232  xpmpData_Unavailable = 0, /* The information has never been specified. */
-
233  xpmpData_Unchanged = 1, /* The information from the last time the plug-in was asked. */
-
234  xpmpData_NewData = 2 /* The information has changed this sim cycle. */
-
235 };
+
196 
+
198 struct XPMPPlaneRadar_t {
+
199  long size = sizeof(XPMPPlaneRadar_t);
+
200  long code = 0;
+
201  XPMPTransponderMode mode = xpmpTransponderMode_ModeC;
+
202 };
+
203 
+
204 
+
208 struct XPMPInfoTexts_t {
+
209  long size = sizeof(XPMPInfoTexts_t);
+
210  char tailNum[10] = {0};
+
211  char icaoAcType[5] = {0};
+
212  char manufacturer[40] = {0};
+
213  char model[40] = {0};
+
214  char icaoAirline[4] = {0};
+
215  char airline[40] = {0};
+
216  char flightNum [10] = {0};
+
217  char aptFrom [5] = {0};
+
218  char aptTo [5] = {0};
+
219 };
+
220 
+
221 
+
229 enum XPMPPlaneDataType {
+
230  xpmpDataType_Position = 1L << 1,
+
231  xpmpDataType_Surfaces = 1L << 2,
+
232  xpmpDataType_Radar = 1L << 3,
+
233  xpmpDataType_InfoTexts = 1L << 4,
+
234 };
+
235 
236 
-
237 
-
243 typedef unsigned XPMPPlaneID;
-
244 
-
246 constexpr XPMPPlaneID MIN_MODE_S_ID = 0x00000001;
-
248 constexpr XPMPPlaneID MAX_MODE_S_ID = 0x00FFFFFF;
-
249 
-
250 
-
251 /************************************************************************************
-
252 * MARK: INITIALIZATION
-
253 ************************************************************************************/
-
254 
-
255 // Config section is defined for legacy reasons only
-
256 #define XPMP_CFG_SEC_MODELS "models"
-
257 #define XPMP_CFG_SEC_PLANES "planes"
-
258 #define XPMP_CFG_SEC_DEBUG "debug"
+
240 enum XPMPPlaneCallbackResult {
+
241  xpmpData_Unavailable = 0, /* The information has never been specified. */
+
242  xpmpData_Unchanged = 1, /* The information from the last time the plug-in was asked. */
+
243  xpmpData_NewData = 2 /* The information has changed this sim cycle. */
+
244 };
+
245 
+
246 
+
252 typedef unsigned XPMPPlaneID;
+
253 
+
255 constexpr XPMPPlaneID MIN_MODE_S_ID = 0x00000001;
+
257 constexpr XPMPPlaneID MAX_MODE_S_ID = 0x00FFFFFF;
+
258 
259 
-
260 // Config key definitions
-
261 #define XPMP_CFG_ITM_REPLDATAREFS "replace_datarefs"
-
262 #define XPMP_CFG_ITM_REPLTEXTURE "replace_texture"
-
263 #define XPMP_CFG_ITM_CLAMPALL "clamp_all_to_ground"
-
264 #define XPMP_CFG_ITM_HANDLE_DUP_ID "handle_dup_id"
-
265 #define XPMP_CFG_ITM_SUPPORT_REMOTE "support_remote"
-
266 #define XPMP_CFG_ITM_LOGLEVEL "log_level"
-
267 #define XPMP_CFG_ITM_MODELMATCHING "model_matching"
-
268 
-
288 typedef int (*XPMPIntPrefsFuncTy)(const char* _section, const char* _key, int _default);
-
289 
-
295 [[deprecated("Use XPMPMultiplayerInit and XPMPLoadCSLPackages")]]
-
296 const char * XPMPMultiplayerInitLegacyData(const char* inCSLFolder,
-
297  const char* inPluginName,
-
298  const char* resourceDir,
-
299  XPMPIntPrefsFuncTy inIntPrefsFunc = nullptr,
-
300  const char* inDefaultICAO = nullptr,
-
301  const char* inPluginLogAcronym = nullptr);
-
302 
-
311 const char * XPMPMultiplayerInit(const char* inPluginName,
-
312  const char* resourceDir,
-
313  XPMPIntPrefsFuncTy inIntPrefsFunc = nullptr,
-
314  const char* inDefaultICAO = nullptr,
-
315  const char* inPluginLogAcronym = nullptr);
-
316 
-
323 void XPMPSetPluginName (const char* inPluginName,
-
324  const char* inPluginLogAcronym = nullptr);
+
260 /************************************************************************************
+
261 * MARK: INITIALIZATION
+
262 ************************************************************************************/
+
263 
+
267 #define XPMP_CFG_SEC_MODELS "models"
+
268 #define XPMP_CFG_SEC_PLANES "planes"
+
269 #define XPMP_CFG_SEC_SOUND "sound"
+
270 #define XPMP_CFG_SEC_DEBUG "debug"
+
272 
+
276 #define XPMP_CFG_ITM_REPLDATAREFS "replace_datarefs"
+
277 #define XPMP_CFG_ITM_REPLTEXTURE "replace_texture"
+
278 #define XPMP_CFG_ITM_CLAMPALL "clamp_all_to_ground"
+
279 #define XPMP_CFG_ITM_HANDLE_DUP_ID "handle_dup_id"
+
280 #define XPMP_CFG_ITM_SUPPORT_REMOTE "support_remote"
+
281 #define XPMP_CFG_ITM_ACTIVATE_SOUND "activate_sound"
+
282 #define XPMP_CFG_ITM_MUTE_ON_PAUSE "mute_on_pause"
+
283 #define XPMP_CFG_ITM_LOGLEVEL "log_level"
+
284 #define XPMP_CFG_ITM_MODELMATCHING "model_matching"
+
286 
+
308 typedef int (*XPMPIntPrefsFuncTy)(const char* _section, const char* _key, int _default);
+
309 
+
312 
+
318 [[deprecated("Use XPMPMultiplayerInit and XPMPLoadCSLPackages")]]
+
319 const char * XPMPMultiplayerInitLegacyData(const char* inCSLFolder,
+
320  const char* inPluginName,
+
321  const char* resourceDir,
+
322  XPMPIntPrefsFuncTy inIntPrefsFunc = nullptr,
+
323  const char* inDefaultICAO = nullptr,
+
324  const char* inPluginLogAcronym = nullptr);
325 
-
326 
-
331 void XPMPMultiplayerCleanup();
-
332 
-
333 
-
336 [[deprecated("Unsupported feature, will alsways return 'OBJ7 format is no longer supported'")]]
-
337 const char * XPMPMultiplayerOBJ7SupportEnable(const char * inTexturePath);
-
338 
+
334 const char * XPMPMultiplayerInit(const char* inPluginName,
+
335  const char* resourceDir,
+
336  XPMPIntPrefsFuncTy inIntPrefsFunc = nullptr,
+
337  const char* inDefaultICAO = nullptr,
+
338  const char* inPluginLogAcronym = nullptr);
339 
-
340 /************************************************************************************
-
341 * MARK: AI / Multiplayer plane control
-
342 ************************************************************************************/
-
343 
-
344 
-
365 const char * XPMPMultiplayerEnable(void (*_callback)(void*) = nullptr,
-
366  void* _refCon = nullptr);
+
346 void XPMPSetPluginName (const char* inPluginName,
+
347  const char* inPluginLogAcronym = nullptr);
+
348 
+
349 
+
354 void XPMPMultiplayerCleanup();
+
355 
+
356 
+
359 [[deprecated("Unsupported feature, will always return 'OBJ7 format is no longer supported'")]]
+
360 const char * XPMPMultiplayerOBJ7SupportEnable(const char * inTexturePath);
+
361 
+
363 
+
364 /************************************************************************************
+
365 * MARK: Sound
+
366 ************************************************************************************/
367 
-
368 
-
373 void XPMPMultiplayerDisable();
+
368 // Only included if specified. Understand FMOD licensing and attribution first!
+
369 #ifdef INCLUDE_FMOD_SOUND
+
370 
374 
-
375 
-
378 bool XPMPHasControlOfAIAircraft();
-
379 
-
380 /************************************************************************************
-
381 * MARK: CSL Package Handling
-
382 ************************************************************************************/
-
383 
-
402 const char * XPMPLoadCSLPackage(const char * inCSLFolder);
-
403 
-
404 
-
406 [[deprecated("No longer needed, does not do anything.")]]
-
407 void XPMPLoadPlanesIfNecessary();
-
408 
-
409 
-
411 int XPMPGetNumberOfInstalledModels();
-
412 
+
381 bool XPMPSoundEnable (bool bEnable = true);
+
382 
+
384 bool XPMPSoundIsEnabled ();
+
385 
+
388 void XPMPSoundSetMasterVolume (float fVol = 1.0f);
+
389 
+
392 void XPMPSoundMute (bool bMute);
+
393 
+
407 const char* XPMPSoundAdd (const char* sName,
+
408  const char* filePath,
+
409  bool bLoop,
+
410  float coneDir = NAN, float conePitch = NAN,
+
411  float coneInAngle = NAN, float coneOutAngle = NAN,
+
412  float coneOutVol = NAN);
413 
-
427 [[deprecated("Unsafe, use XPMPGetModelInfo2() instead.")]]
-
428 void XPMPGetModelInfo(int inIndex, const char **outModelName, const char **outIcao, const char **outAirline, const char **outLivery);
-
429 
-
438 void XPMPGetModelInfo2(int inIndex, std::string& outModelName, std::string& outIcao, std::string& outAirline, std::string& outLivery);
-
439 
+
420 const char* XPMPSoundEnumerate (const char* prevName, const char** ppFilePath = nullptr);
+
421 
+
423 
+
426 
+
427 // Standard sounds loaded by XPMP2 from XP's `Resource/sounds` folders
+
428 #define XP_SOUND_ELECTRIC "Electric"
+
429 #define XP_SOUND_HIBYPASSJET "HiBypassJet"
+
430 #define XP_SOUND_LOBYPASSJET "LoBypassJet"
+
431 #define XP_SOUND_TURBOPROP "Turboprop"
+
432 #define XP_SOUND_PROP_AIRPLANE "PropAirplane"
+
433 #define XP_SOUND_PROP_HELI "PropHeli"
+
434 #define XP_SOUND_REVERSE_THRUST "ReverseThrust"
+
435 #define XP_SOUND_ROLL_RUNWAY "RollRunway"
+
436 #define XP_SOUND_FLAP "Flap"
+
437 #define XP_SOUND_GEAR "Gear"
+
438 
440 
-
446 int XPMPModelMatchQuality(const char * inICAO,
-
447  const char * inAirline,
-
448  const char * inLivery);
+
441 #endif // INCLUDE_FMOD_SOUND
+
442 
+
443 /************************************************************************************
+
444 * MARK: AI / Multiplayer plane control
+
445 ************************************************************************************/
+
446 
449 
-
450 
-
452 bool XPMPIsICAOValid(const char * inICAO);
-
453 
-
471 size_t XPMPAddModelDataRef (const std::string& dataRef);
+
470 const char * XPMPMultiplayerEnable(void (*_callback)(void*) = nullptr,
+
471  void* _refCon = nullptr);
472 
-
473 /************************************************************************************
-
474  * MARK: PLANE CREATION API
-
475  ************************************************************************************/
-
476 
-
477 
-
489 typedef XPMPPlaneCallbackResult (* XPMPPlaneData_f)(XPMPPlaneID inPlane,
-
490  XPMPPlaneDataType inDataType,
-
491  void * ioData,
-
492  void * inRefcon);
+
473 
+
478 void XPMPMultiplayerDisable();
+
479 
+
480 
+
483 bool XPMPHasControlOfAIAircraft();
+
484 
+
486 
+
487 /************************************************************************************
+
488 * MARK: CSL Package Handling
+
489 ************************************************************************************/
+
490 
493 
-
494 
-
505 [[deprecated("Subclass XPMP2::Aircraft instead")]]
-
506 XPMPPlaneID XPMPCreatePlane(const char * inICAOCode,
-
507  const char * inAirline,
-
508  const char * inLivery,
-
509  XPMPPlaneData_f inDataFunc,
-
510  void * inRefcon,
-
511  XPMPPlaneID inModeS_id = 0);
-
512 
-
522 [[deprecated("Subclass XPMP2::Aircraft instead")]]
-
523 XPMPPlaneID XPMPCreatePlaneWithModelName(const char * inModelName,
-
524  const char * inICAOCode,
-
525  const char * inAirline,
-
526  const char * inLivery,
-
527  XPMPPlaneData_f inDataFunc,
-
528  void * inRefcon,
-
529  XPMPPlaneID inModeS_id = 0);
-
530 
-
533 [[deprecated("Delete subclassed XPMP2::Aircraft object instead")]]
-
534 void XPMPDestroyPlane(XPMPPlaneID _id);
-
535 
-
536 
-
538 void XPMPSetPlaneVisibility(XPMPPlaneID _id, bool _bVisible);
+
512 const char * XPMPLoadCSLPackage(const char * inCSLFolder);
+
513 
+
514 
+
516 [[deprecated("No longer needed, does not do anything.")]]
+
517 void XPMPLoadPlanesIfNecessary();
+
518 
+
519 
+
521 int XPMPGetNumberOfInstalledModels();
+
522 
+
523 
+
537 [[deprecated("Unsafe, use XPMPGetModelInfo2() instead.")]]
+
538 void XPMPGetModelInfo(int inIndex, const char **outModelName, const char **outIcao, const char **outAirline, const char **outLivery);
539 
-
540 
-
549 int XPMPChangePlaneModel(XPMPPlaneID inPlaneID,
-
550  const char * inICAOCode,
-
551  const char * inAirline,
-
552  const char * inLivery);
-
553 
-
554 
-
566 int XPMPGetPlaneModelName(XPMPPlaneID inPlaneID,
-
567  char * outTxtBuf,
-
568  int outTxtBufSize);
-
569 
-
570 
-
576 [[deprecated("Unsafe pointer operations")]]
-
577 void XPMPGetPlaneICAOAndLivery(XPMPPlaneID inPlane,
-
578  char * outICAOCode, // Can be NULL
-
579  char * outLivery); // Can be NULL
-
580 
-
581 
-
589 [[deprecated("Unsupported")]]
-
590 XPMPPlaneCallbackResult XPMPGetPlaneData(XPMPPlaneID inPlane,
-
591  XPMPPlaneDataType inDataType,
-
592  void * outData);
-
593 
-
594 
-
596 int XPMPGetPlaneModelQuality(XPMPPlaneID inPlane);
-
597 
-
598 
-
600 long XPMPCountPlanes(void);
-
601 
-
602 
-
604 XPMPPlaneID XPMPGetNthPlane(long index);
+
548 void XPMPGetModelInfo2(int inIndex, std::string& outModelName, std::string& outIcao, std::string& outAirline, std::string& outLivery);
+
549 
+
550 
+
556 int XPMPModelMatchQuality(const char * inICAO,
+
557  const char * inAirline,
+
558  const char * inLivery);
+
559 
+
560 
+
562 bool XPMPIsICAOValid(const char * inICAO);
+
563 
+
581 size_t XPMPAddModelDataRef (const std::string& dataRef);
+
582 
+
584 
+
585 /************************************************************************************
+
586  * MARK: PLANE CREATION API
+
587  ************************************************************************************/
+
588 
+
589 
+
601 typedef XPMPPlaneCallbackResult (* XPMPPlaneData_f)(XPMPPlaneID inPlane,
+
602  XPMPPlaneDataType inDataType,
+
603  void * ioData,
+
604  void * inRefcon);
605 
-
606 
-
608 XPMP2::Aircraft* XPMPGetAircraft (XPMPPlaneID _id);
-
609 
-
610 
-
614 void XPMPSetDefaultPlaneICAO(const char* _acIcaoType,
-
615  const char* _carIcaoType = nullptr);
-
616 
-
617 /************************************************************************************
-
618  * MARK: PLANE OBSERVATION API
-
619  ************************************************************************************/
-
620 
-
621 
-
623 enum XPMPPlaneNotification {
-
624  xpmp_PlaneNotification_Created = 1,
-
625  xpmp_PlaneNotification_ModelChanged = 2,
-
626  xpmp_PlaneNotification_Destroyed = 3,
-
627 };
-
628 
-
629 
-
635 typedef void (*XPMPPlaneNotifier_f)(XPMPPlaneID inPlaneID,
-
636  XPMPPlaneNotification inNotification,
-
637  void * inRefcon);
-
638 
-
639 
-
644 void XPMPRegisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc,
-
645  void * inRefcon);
-
646 
-
647 
-
652 void XPMPUnregisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc,
-
653  void * inRefcon);
+
608 
+
619 [[deprecated("Subclass XPMP2::Aircraft instead")]]
+
620 XPMPPlaneID XPMPCreatePlane(const char * inICAOCode,
+
621  const char * inAirline,
+
622  const char * inLivery,
+
623  XPMPPlaneData_f inDataFunc,
+
624  void * inRefcon,
+
625  XPMPPlaneID inModeS_id = 0);
+
626 
+
636 [[deprecated("Subclass XPMP2::Aircraft instead")]]
+
637 XPMPPlaneID XPMPCreatePlaneWithModelName(const char * inModelName,
+
638  const char * inICAOCode,
+
639  const char * inAirline,
+
640  const char * inLivery,
+
641  XPMPPlaneData_f inDataFunc,
+
642  void * inRefcon,
+
643  XPMPPlaneID inModeS_id = 0);
+
644 
+
647 [[deprecated("Delete subclassed XPMP2::Aircraft object instead")]]
+
648 void XPMPDestroyPlane(XPMPPlaneID _id);
+
649 
+
650 
+
652 void XPMPSetPlaneVisibility(XPMPPlaneID _id, bool _bVisible);
+
653 
654 
-
655 /************************************************************************************
-
656  * MARK: PLANE RENDERING API (unsued in XPMP2)
-
657  ************************************************************************************/
-
658 
-
662 [[deprecated("Unsupported, will not be called")]]
-
663 typedef void (* XPMPRenderPlanes_f)(
-
664  int inIsBlend,
-
665  void * inRef);
-
666 
+
663 int XPMPChangePlaneModel(XPMPPlaneID inPlaneID,
+
664  const char * inICAOCode,
+
665  const char * inAirline,
+
666  const char * inLivery);
667 
-
671 [[deprecated("Unsupported, doesn't do anything")]]
-
672 void XPMPSetPlaneRenderer(XPMPRenderPlanes_f inRenderer,
-
673  void * inRef);
-
674 
-
675 
-
678 [[deprecated("Unsupported, doesn't do anything")]]
-
679 void XPMPDumpOneCycle(void);
-
680 
-
681 
-
683 void XPMPEnableAircraftLabels (bool _enable = true);
+
668 
+
680 int XPMPGetPlaneModelName(XPMPPlaneID inPlaneID,
+
681  char * outTxtBuf,
+
682  int outTxtBufSize);
+
683 
684 
-
685 
-
688 void XPMPDisableAircraftLabels();
-
689 
-
690 
-
692 bool XPMPDrawingAircraftLabels();
-
693 
+
690 [[deprecated("Unsafe pointer operations")]]
+
691 void XPMPGetPlaneICAOAndLivery(XPMPPlaneID inPlane,
+
692  char * outICAOCode, // Can be NULL
+
693  char * outLivery); // Can be NULL
694 
-
698 void XPMPSetAircraftLabelDist (float _dist_nm, bool _bCutOffAtVisibility = true);
-
699 
-
700 //
-
701 // MARK: MAP
-
702 // Enable or disable the drawing of icons on maps
-
703 //
-
704 
-
710 void XPMPEnableMap (bool _bEnable, bool _bLabels = true);
+
695 
+
703 [[deprecated("Unsupported")]]
+
704 XPMPPlaneCallbackResult XPMPGetPlaneData(XPMPPlaneID inPlane,
+
705  XPMPPlaneDataType inDataType,
+
706  void * outData);
+
707 
+
708 
+
710 int XPMPGetPlaneModelQuality(XPMPPlaneID inPlane);
711 
-
712 #ifdef __cplusplus
-
713 }
-
714 #endif
+
712 
+
714 long XPMPCountPlanes(void);
715 
716 
-
717 #endif
-
XPMPIntPrefsFuncTy
int(* XPMPIntPrefsFuncTy)(const char *_section, const char *_key, int _default)
Definition for the type of configuration callback function.
Definition: XPMPMultiplayer.h:288
-
XPMPSetAircraftLabelDist
void XPMPSetAircraftLabelDist(float _dist_nm, bool _bCutOffAtVisibility=true)
Definition: 2D.cpp:287
-
XPMPPlanePosition_t::clampToGround
bool clampToGround
enables ground-clamping for this aircraft (can be expensive, see XPMP2::Aircraft::bClampToGround)
Definition: XPMPMultiplayer.h:89
-
xpmp_Lights_Pattern_GA
@ xpmp_Lights_Pattern_GA
GA: one strobe flash, long beacon (-*-----—*—)
Definition: XPMPMultiplayer.h:104
-
xpmp_Lights_Pattern_EADS
@ xpmp_Lights_Pattern_EADS
Airbus+EADS: strobe flashes twice (-*-*--—*-*–), short beacon.
Definition: XPMPMultiplayer.h:103
-
xpmp_Lights_Pattern_Default
@ xpmp_Lights_Pattern_Default
Jets: one strobe flash, short beacon (-*—*—*—)
Definition: XPMPMultiplayer.h:102
-
XPMPPlanePosition_t::elevation
double elevation
current altitude of aircraft [ft above MSL]
Definition: XPMPMultiplayer.h:83
-
XPMPMultiplayerEnable
const char * XPMPMultiplayerEnable(void(*_callback)(void *)=nullptr, void *_refCon=nullptr)
Tries to grab control of TCAS targets (formerly known as AI/multiplayer) from X-Plane.
Definition: AIMultiplayer.cpp:1067
-
XPMPPlaneRadar_t::mode
XPMPTransponderMode mode
current radar mode, if not xpmpTransponderMode_Standby then is plane considered for TCAS display
Definition: XPMPMultiplayer.h:192
-
XPMPCountPlanes
long XPMPCountPlanes(void)
Returns the number of planes in existence.
Definition: XPMPMultiplayer.cpp:475
-
XPMPPlanePosition_t::lat
double lat
current position of aircraft (latitude)
Definition: XPMPMultiplayer.h:81
-
XPMPPlanePosition_t::pitch
float pitch
pitch [degrees, psitive up]
Definition: XPMPMultiplayer.h:84
-
XPMPGetPlaneModelName
int XPMPGetPlaneModelName(XPMPPlaneID inPlaneID, char *outTxtBuf, int outTxtBufSize)
Return the name of the model, with which the given plane is rendered.
Definition: XPMPMultiplayer.cpp:425
-
XPMPPlaneSurfaces_t::engRotRpm
float engRotRpm
engine rotation speed (rpm)
Definition: XPMPMultiplayer.h:167
-
XPMPGetPlaneData
XPMPPlaneCallbackResult XPMPGetPlaneData(XPMPPlaneID inPlane, XPMPPlaneDataType inDataType, void *outData)
Unsupported, don't use.
Definition: XPMPMultiplayer.cpp:456
-
XPMPInfoTexts_t::tailNum
char tailNum[10]
registration, tail number
Definition: XPMPMultiplayer.h:201
-
XPMPPlaneSurfaces_t::yokePitch
float yokePitch
yoke pitch ratio [0..1]
Definition: XPMPMultiplayer.h:156
-
XPMPPlaneDataType
XPMPPlaneDataType
This enum defines the different categories of aircraft information we can query about.
Definition: XPMPMultiplayer.h:220
-
xpmpDataType_Surfaces
@ xpmpDataType_Surfaces
physical appearance in XPMPPlaneSurfaces_t
Definition: XPMPMultiplayer.h:222
-
xpmpDataType_Radar
@ xpmpDataType_Radar
radar information in XPMPPlaneRadar_t
Definition: XPMPMultiplayer.h:223
-
xpmpDataType_InfoTexts
@ xpmpDataType_InfoTexts
informational texts in XPMPInfoTexts_t
Definition: XPMPMultiplayer.h:224
-
xpmpDataType_Position
@ xpmpDataType_Position
position data in XPMPPlanePosition_t
Definition: XPMPMultiplayer.h:221
-
XPMPPlaneSurfaces_t::gearPosition
float gearPosition
gear position [0..1]
Definition: XPMPMultiplayer.h:149
-
XPMPIsICAOValid
bool XPMPIsICAOValid(const char *inICAO)
Is inICAO a valid ICAO aircraft type designator?
Definition: XPMPMultiplayer.cpp:330
-
XPMPRegisterPlaneNotifierFunc
void XPMPRegisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc, void *inRefcon)
Registers a callback, which is called when one of the events defined in XPMPPlaneNotification happens...
Definition: XPMPMultiplayer.cpp:525
+
718 XPMPPlaneID XPMPGetNthPlane(long index);
+
719 
+
720 
+
722 XPMP2::Aircraft* XPMPGetAircraft (XPMPPlaneID _id);
+
723 
+
724 
+
728 void XPMPSetDefaultPlaneICAO(const char* _acIcaoType,
+
729  const char* _carIcaoType = nullptr);
+
730 
+
732 
+
733 /************************************************************************************
+
734  * MARK: PLANE OBSERVATION API
+
735  ************************************************************************************/
+
736 
+
737 
+
739 enum XPMPPlaneNotification {
+
740  xpmp_PlaneNotification_Created = 1,
+
741  xpmp_PlaneNotification_ModelChanged = 2,
+
742  xpmp_PlaneNotification_Destroyed = 3,
+
743 };
+
744 
+
745 
+
751 typedef void (*XPMPPlaneNotifier_f)(XPMPPlaneID inPlaneID,
+
752  XPMPPlaneNotification inNotification,
+
753  void * inRefcon);
+
754 
+
757 
+
762 void XPMPRegisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc,
+
763  void * inRefcon);
+
764 
+
765 
+
770 void XPMPUnregisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc,
+
771  void * inRefcon);
+
772 
+
774 
+
775 /************************************************************************************
+
776  * MARK: PLANE RENDERING API (unsued in XPMP2)
+
777  ************************************************************************************/
+
778 
+
782 [[deprecated("Unsupported, will not be called")]]
+
783 typedef void (* XPMPRenderPlanes_f)(
+
784  int inIsBlend,
+
785  void * inRef);
+
786 
+
789 
+
793 [[deprecated("Unsupported, doesn't do anything")]]
+
794 void XPMPSetPlaneRenderer(XPMPRenderPlanes_f inRenderer,
+
795  void * inRef);
+
796 
+
797 
+
800 [[deprecated("Unsupported, doesn't do anything")]]
+
801 void XPMPDumpOneCycle(void);
+
802 
+
803 
+
805 void XPMPEnableAircraftLabels (bool _enable = true);
+
806 
+
807 
+
810 void XPMPDisableAircraftLabels();
+
811 
+
812 
+
814 bool XPMPDrawingAircraftLabels();
+
815 
+
816 
+
820 void XPMPSetAircraftLabelDist (float _dist_nm, bool _bCutOffAtVisibility = true);
+
821 
+
822 //
+
823 // MARK: MAP
+
824 // Enable or disable the drawing of icons on maps
+
825 //
+
826 
+
832 void XPMPEnableMap (bool _bEnable, bool _bLabels = true);
+
833 
+
835 
+
836 #ifdef __cplusplus
+
837 }
+
838 #endif
+
839 
+
840 
+
841 #endif
+
XPMPIntPrefsFuncTy
int(* XPMPIntPrefsFuncTy)(const char *_section, const char *_key, int _default)
Definition for the type of configuration callback function.
Definition: XPMPMultiplayer.h:308
+
XPMPSetAircraftLabelDist
void XPMPSetAircraftLabelDist(float _dist_nm, bool _bCutOffAtVisibility=true)
Definition: 2D.cpp:286
+
XPMPPlanePosition_t::clampToGround
bool clampToGround
enables ground-clamping for this aircraft (can be expensive, see XPMP2::Aircraft::bClampToGround)
Definition: XPMPMultiplayer.h:98
+
xpmp_Lights_Pattern_GA
@ xpmp_Lights_Pattern_GA
GA: one strobe flash, long beacon (-*-----—*—)
Definition: XPMPMultiplayer.h:113
+
xpmp_Lights_Pattern_EADS
@ xpmp_Lights_Pattern_EADS
Airbus+EADS: strobe flashes twice (-*-*--—*-*–), short beacon.
Definition: XPMPMultiplayer.h:112
+
xpmp_Lights_Pattern_Default
@ xpmp_Lights_Pattern_Default
Jets: one strobe flash, short beacon (-*—*—*—)
Definition: XPMPMultiplayer.h:111
+
XPMPPlanePosition_t::elevation
double elevation
current altitude of aircraft [ft above MSL]
Definition: XPMPMultiplayer.h:92
+
XPMPMultiplayerEnable
const char * XPMPMultiplayerEnable(void(*_callback)(void *)=nullptr, void *_refCon=nullptr)
Tries to grab control of TCAS targets (formerly known as AI/multiplayer) from X-Plane.
Definition: AIMultiplayer.cpp:1069
+
XPMPPlaneRadar_t::mode
XPMPTransponderMode mode
current radar mode, if not xpmpTransponderMode_Standby then is plane considered for TCAS display
Definition: XPMPMultiplayer.h:201
+
XPMPCountPlanes
long XPMPCountPlanes(void)
Returns the number of planes in existence.
Definition: XPMPMultiplayer.cpp:487
+
XPMPPlanePosition_t::lat
double lat
current position of aircraft (latitude)
Definition: XPMPMultiplayer.h:90
+
XPMPPlanePosition_t::pitch
float pitch
pitch [degrees, psitive up]
Definition: XPMPMultiplayer.h:93
+
XPMPGetPlaneModelName
int XPMPGetPlaneModelName(XPMPPlaneID inPlaneID, char *outTxtBuf, int outTxtBufSize)
Return the name of the model, with which the given plane is rendered.
Definition: XPMPMultiplayer.cpp:437
+
XPMPPlaneSurfaces_t::engRotRpm
float engRotRpm
engine rotation speed (rpm)
Definition: XPMPMultiplayer.h:176
+
XPMPGetPlaneData
XPMPPlaneCallbackResult XPMPGetPlaneData(XPMPPlaneID inPlane, XPMPPlaneDataType inDataType, void *outData)
Unsupported, don't use.
Definition: XPMPMultiplayer.cpp:468
+
XPMPInfoTexts_t::tailNum
char tailNum[10]
registration, tail number
Definition: XPMPMultiplayer.h:210
+
XPMPPlaneSurfaces_t::yokePitch
float yokePitch
yoke pitch ratio [0..1]
Definition: XPMPMultiplayer.h:165
+
XPMPPlaneDataType
XPMPPlaneDataType
This enum defines the different categories of aircraft information we can query about.
Definition: XPMPMultiplayer.h:229
+
xpmpDataType_Surfaces
@ xpmpDataType_Surfaces
physical appearance in XPMPPlaneSurfaces_t
Definition: XPMPMultiplayer.h:231
+
xpmpDataType_Radar
@ xpmpDataType_Radar
radar information in XPMPPlaneRadar_t
Definition: XPMPMultiplayer.h:232
+
xpmpDataType_InfoTexts
@ xpmpDataType_InfoTexts
informational texts in XPMPInfoTexts_t
Definition: XPMPMultiplayer.h:233
+
xpmpDataType_Position
@ xpmpDataType_Position
position data in XPMPPlanePosition_t
Definition: XPMPMultiplayer.h:230
+
XPMPPlaneSurfaces_t::gearPosition
float gearPosition
gear position [0..1]
Definition: XPMPMultiplayer.h:158
+
XPMPIsICAOValid
bool XPMPIsICAOValid(const char *inICAO)
Is inICAO a valid ICAO aircraft type designator?
Definition: XPMPMultiplayer.cpp:342
+
XPMPSoundSetMasterVolume
void XPMPSoundSetMasterVolume(float fVol=1.0f)
Set Master Volume.
Definition: Sound.cpp:874
+
XPMPRegisterPlaneNotifierFunc
void XPMPRegisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc, void *inRefcon)
Registers a callback, which is called when one of the events defined in XPMPPlaneNotification happens...
Definition: XPMPMultiplayer.cpp:537
XPMPMultiplayerInit
const char * XPMPMultiplayerInit(const char *inPluginName, const char *resourceDir, XPMPIntPrefsFuncTy inIntPrefsFunc=nullptr, const char *inDefaultICAO=nullptr, const char *inPluginLogAcronym=nullptr)
Initializes the XPMP2 library. This shall be your first call to the library.
Definition: XPMPMultiplayer.cpp:126
-
XPMPPlanePosition_t::label
char label[32]
label to show with the aircraft
Definition: XPMPMultiplayer.h:87
-
MIN_MODE_S_ID
constexpr XPMPPlaneID MIN_MODE_S_ID
Minimum allowed XPMPPlaneID / mode S id.
Definition: XPMPMultiplayer.h:246
-
XPMPPlaneSurfaces_t::touchDown
bool touchDown
just now is moment of touch down?
Definition: XPMPMultiplayer.h:172
-
XPMPRenderPlanes_f
void(* XPMPRenderPlanes_f)(int inIsBlend, void *inRef)
The original libxplanemp allowed to override rendering; no longer supported.
Definition: XPMPMultiplayer.h:663
-
XPMPModelMatchQuality
int XPMPModelMatchQuality(const char *inICAO, const char *inAirline, const char *inLivery)
Tests model match quality based on the given parameters.
Definition: XPMPMultiplayer.cpp:318
-
XPMPGetPlaneICAOAndLivery
void XPMPGetPlaneICAOAndLivery(XPMPPlaneID inPlane, char *outICAOCode, char *outLivery)
Returns ICAO aircraft type designator and livery of the given plane.
Definition: XPMPMultiplayer.cpp:443
-
XPMPInfoTexts_t::aptFrom
char aptFrom[5]
Origin airport (ICAO)
Definition: XPMPMultiplayer.h:208
-
XPMPPlaneRadar_t::code
long code
current radar code, published via dataRef sim/cockpit2/tcas/targets/modeC_code
Definition: XPMPMultiplayer.h:191
-
XPMPPlaneSurfaces_t::tireRotRpm
float tireRotRpm
tire rotation speed (rpm)
Definition: XPMPMultiplayer.h:164
-
XPMPPlanePosition_t::heading
float heading
heading [degrees]
Definition: XPMPMultiplayer.h:86
-
XPMPPlaneSurfaces_t::yokeRoll
float yokeRoll
yoke roll ratio [0..1]
Definition: XPMPMultiplayer.h:158
-
XPMPInfoTexts_t::airline
char airline[40]
airline, human readable
Definition: XPMPMultiplayer.h:206
-
XPMPPlaneRadar_t::size
long size
structure size
Definition: XPMPMultiplayer.h:190
-
XPMPPlaneSurfaces_t::flapRatio
float flapRatio
flap extension ratio [0..1]
Definition: XPMPMultiplayer.h:150
-
MAX_MODE_S_ID
constexpr XPMPPlaneID MAX_MODE_S_ID
Maximum allowed XPMPPlaneID / mode S id.
Definition: XPMPMultiplayer.h:248
-
XPMPGetNthPlane
XPMPPlaneID XPMPGetNthPlane(long index)
Returns the plane ID of the Nth plane.
Definition: XPMPMultiplayer.cpp:481
-
XPMPInfoTexts_t::flightNum
char flightNum[10]
flight number
Definition: XPMPMultiplayer.h:207
-
XPMPInfoTexts_t::manufacturer
char manufacturer[40]
a/c manufacturer, human readable
Definition: XPMPMultiplayer.h:203
-
XPMPPlanePosition_t::label_color
float label_color[4]
label base color (RGB), defaults to yellow
Definition: XPMPMultiplayer.h:91
-
XPMPPlanePosition_t::aiPrio
int aiPrio
Priority for AI/TCAS consideration, the lower the earlier.
Definition: XPMPMultiplayer.h:90
-
XPMPUnregisterPlaneNotifierFunc
void XPMPUnregisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc, void *inRefcon)
Unregisters a notification callback. Both function pointer and refcon must match what was registered.
Definition: XPMPMultiplayer.cpp:545
-
XPMPInfoTexts_t::model
char model[40]
a/c model, human readable
Definition: XPMPMultiplayer.h:204
-
XPMPPlaneSurfaces_t::lights
xpmp_LightStatus lights
status of lights
Definition: XPMPMultiplayer.h:160
-
XPMPPlaneSurfaces_t::engRotDegree
float engRotDegree
engine rotation angle (degrees 0..360)
Definition: XPMPMultiplayer.h:166
-
XPMPPlaneSurfaces_t::reversRatio
float reversRatio
thrust reversers ratio
Definition: XPMPMultiplayer.h:170
-
XPMPPlaneData_f
XPMPPlaneCallbackResult(* XPMPPlaneData_f)(XPMPPlaneID inPlane, XPMPPlaneDataType inDataType, void *ioData, void *inRefcon)
Callback function your plugin provides to return updated plane data.
Definition: XPMPMultiplayer.h:489
-
XPMPDisableAircraftLabels
void XPMPDisableAircraftLabels()
Disable drawing of labels with the aircraft.
Definition: 2D.cpp:276
+
XPMPPlanePosition_t::label
char label[32]
label to show with the aircraft
Definition: XPMPMultiplayer.h:96
+
MIN_MODE_S_ID
constexpr XPMPPlaneID MIN_MODE_S_ID
Minimum allowed XPMPPlaneID / mode S id.
Definition: XPMPMultiplayer.h:255
+
XPMPSoundAdd
const char * XPMPSoundAdd(const char *sName, const char *filePath, bool bLoop, float coneDir=NAN, float conePitch=NAN, float coneInAngle=NAN, float coneOutAngle=NAN, float coneOutVol=NAN)
Add a sound that can later be referenced from an XPMP2::Aircraft.
Definition: Sound.cpp:892
+
XPMPPlaneSurfaces_t::touchDown
bool touchDown
just now is moment of touch down?
Definition: XPMPMultiplayer.h:181
+
XPMPRenderPlanes_f
void(* XPMPRenderPlanes_f)(int inIsBlend, void *inRef)
The original libxplanemp allowed to override rendering; no longer supported.
Definition: XPMPMultiplayer.h:783
+
XPMPModelMatchQuality
int XPMPModelMatchQuality(const char *inICAO, const char *inAirline, const char *inLivery)
Tests model match quality based on the given parameters.
Definition: XPMPMultiplayer.cpp:330
+
XPMPGetPlaneICAOAndLivery
void XPMPGetPlaneICAOAndLivery(XPMPPlaneID inPlane, char *outICAOCode, char *outLivery)
Returns ICAO aircraft type designator and livery of the given plane.
Definition: XPMPMultiplayer.cpp:455
+
XPMPInfoTexts_t::aptFrom
char aptFrom[5]
Origin airport (ICAO)
Definition: XPMPMultiplayer.h:217
+
XPMPPlaneRadar_t::code
long code
current radar code, published via dataRef sim/cockpit2/tcas/targets/modeC_code
Definition: XPMPMultiplayer.h:200
+
XPMPPlaneSurfaces_t::tireRotRpm
float tireRotRpm
tire rotation speed (rpm)
Definition: XPMPMultiplayer.h:173
+
XPMPPlanePosition_t::heading
float heading
heading [degrees]
Definition: XPMPMultiplayer.h:95
+
XPMPPlaneSurfaces_t::yokeRoll
float yokeRoll
yoke roll ratio [0..1]
Definition: XPMPMultiplayer.h:167
+
XPMPInfoTexts_t::airline
char airline[40]
airline, human readable
Definition: XPMPMultiplayer.h:215
+
XPMPPlaneRadar_t::size
long size
structure size
Definition: XPMPMultiplayer.h:199
+
XPMPPlaneSurfaces_t::flapRatio
float flapRatio
flap extension ratio [0..1]
Definition: XPMPMultiplayer.h:159
+
MAX_MODE_S_ID
constexpr XPMPPlaneID MAX_MODE_S_ID
Maximum allowed XPMPPlaneID / mode S id.
Definition: XPMPMultiplayer.h:257
+
XPMPSoundMute
void XPMPSoundMute(bool bMute)
Mute all sounds (temporarily)
Definition: Sound.cpp:883
+
XPMPGetNthPlane
XPMPPlaneID XPMPGetNthPlane(long index)
Returns the plane ID of the Nth plane.
Definition: XPMPMultiplayer.cpp:493
+
XPMPInfoTexts_t::flightNum
char flightNum[10]
flight number
Definition: XPMPMultiplayer.h:216
+
XPMPInfoTexts_t::manufacturer
char manufacturer[40]
a/c manufacturer, human readable
Definition: XPMPMultiplayer.h:212
+
XPMPPlanePosition_t::label_color
float label_color[4]
label base color (RGB), defaults to yellow
Definition: XPMPMultiplayer.h:100
+
XPMPPlanePosition_t::aiPrio
int aiPrio
Priority for AI/TCAS consideration, the lower the earlier.
Definition: XPMPMultiplayer.h:99
+
XPMPUnregisterPlaneNotifierFunc
void XPMPUnregisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc, void *inRefcon)
Unregisters a notification callback. Both function pointer and refcon must match what was registered.
Definition: XPMPMultiplayer.cpp:557
+
XPMPInfoTexts_t::model
char model[40]
a/c model, human readable
Definition: XPMPMultiplayer.h:213
+
XPMPPlaneSurfaces_t::lights
xpmp_LightStatus lights
status of lights
Definition: XPMPMultiplayer.h:169
+
XPMPPlaneSurfaces_t::engRotDegree
float engRotDegree
engine rotation angle (degrees 0..360)
Definition: XPMPMultiplayer.h:175
+
XPMPPlaneSurfaces_t::reversRatio
float reversRatio
thrust reversers ratio
Definition: XPMPMultiplayer.h:179
+
XPMPSoundEnumerate
const char * XPMPSoundEnumerate(const char *prevName, const char **ppFilePath=nullptr)
Enumerate all sounds, including the internal ones.
Definition: Sound.cpp:925
+
XPMPPlaneData_f
XPMPPlaneCallbackResult(* XPMPPlaneData_f)(XPMPPlaneID inPlane, XPMPPlaneDataType inDataType, void *ioData, void *inRefcon)
Callback function your plugin provides to return updated plane data.
Definition: XPMPMultiplayer.h:601
+
XPMPDisableAircraftLabels
void XPMPDisableAircraftLabels()
Disable drawing of labels with the aircraft.
Definition: 2D.cpp:275
XPMPEnableMap
void XPMPEnableMap(bool _bEnable, bool _bLabels=true)
Enable or disable the drawing of aircraft icons on X-Plane's map.
Definition: Map.cpp:397
-
XPMPPlanePosition_t::offsetScale
float offsetScale
how much of the surface contact correction offset should be applied [0..1]
Definition: XPMPMultiplayer.h:88
-
XPMPHasControlOfAIAircraft
bool XPMPHasControlOfAIAircraft()
Has XPMP2 control of TCAS targets?
Definition: AIMultiplayer.cpp:1178
-
XPMPChangePlaneModel
int XPMPChangePlaneModel(XPMPPlaneID inPlaneID, const char *inICAOCode, const char *inAirline, const char *inLivery)
Perform model matching again and change the CSL model to the resulting match.
Definition: XPMPMultiplayer.cpp:410
-
XPMPPlaneCallbackResult
XPMPPlaneCallbackResult
Definfes the different responses to asking for information.
Definition: XPMPMultiplayer.h:231
-
xpmpData_Unchanged
@ xpmpData_Unchanged
Definition: XPMPMultiplayer.h:233
-
xpmpData_Unavailable
@ xpmpData_Unavailable
Definition: XPMPMultiplayer.h:232
-
xpmpData_NewData
@ xpmpData_NewData
Definition: XPMPMultiplayer.h:234
-
XPMPCreatePlane
XPMPPlaneID XPMPCreatePlane(const char *inICAOCode, const char *inAirline, const char *inLivery, XPMPPlaneData_f inDataFunc, void *inRefcon, XPMPPlaneID inModeS_id=0)
Creates a new plane.
Definition: XPMPMultiplayer.cpp:341
-
XPMPInfoTexts_t::icaoAcType
char icaoAcType[5]
ICAO aircraft type designator, 3-4 chars.
Definition: XPMPMultiplayer.h:202
-
XPMPPlaneNotification
XPMPPlaneNotification
Events that trigger a notification callback.
Definition: XPMPMultiplayer.h:623
-
xpmp_PlaneNotification_Destroyed
@ xpmp_PlaneNotification_Destroyed
a plane is about to be destroyed
Definition: XPMPMultiplayer.h:626
-
xpmp_PlaneNotification_ModelChanged
@ xpmp_PlaneNotification_ModelChanged
a plane's model changed
Definition: XPMPMultiplayer.h:625
-
xpmp_PlaneNotification_Created
@ xpmp_PlaneNotification_Created
a plane was just created
Definition: XPMPMultiplayer.h:624
-
XPMPLightsPattern
unsigned int XPMPLightsPattern
Light flash pattern (unused in XPMP2)
Definition: XPMPMultiplayer.h:106
-
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:243
+
XPMPPlanePosition_t::offsetScale
float offsetScale
how much of the surface contact correction offset should be applied [0..1]
Definition: XPMPMultiplayer.h:97
+
XPMPHasControlOfAIAircraft
bool XPMPHasControlOfAIAircraft()
Has XPMP2 control of TCAS targets?
Definition: AIMultiplayer.cpp:1180
+
XPMPChangePlaneModel
int XPMPChangePlaneModel(XPMPPlaneID inPlaneID, const char *inICAOCode, const char *inAirline, const char *inLivery)
Perform model matching again and change the CSL model to the resulting match.
Definition: XPMPMultiplayer.cpp:422
+
XPMPPlaneCallbackResult
XPMPPlaneCallbackResult
Definfes the different responses to asking for information.
Definition: XPMPMultiplayer.h:240
+
xpmpData_Unchanged
@ xpmpData_Unchanged
Definition: XPMPMultiplayer.h:242
+
xpmpData_Unavailable
@ xpmpData_Unavailable
Definition: XPMPMultiplayer.h:241
+
xpmpData_NewData
@ xpmpData_NewData
Definition: XPMPMultiplayer.h:243
+
XPMPCreatePlane
XPMPPlaneID XPMPCreatePlane(const char *inICAOCode, const char *inAirline, const char *inLivery, XPMPPlaneData_f inDataFunc, void *inRefcon, XPMPPlaneID inModeS_id=0)
Creates a new plane.
Definition: XPMPMultiplayer.cpp:353
+
XPMPInfoTexts_t::icaoAcType
char icaoAcType[5]
ICAO aircraft type designator, 3-4 chars.
Definition: XPMPMultiplayer.h:211
+
XPMPPlaneNotification
XPMPPlaneNotification
Events that trigger a notification callback.
Definition: XPMPMultiplayer.h:739
+
xpmp_PlaneNotification_Destroyed
@ xpmp_PlaneNotification_Destroyed
a plane is about to be destroyed
Definition: XPMPMultiplayer.h:742
+
xpmp_PlaneNotification_ModelChanged
@ xpmp_PlaneNotification_ModelChanged
a plane's model changed
Definition: XPMPMultiplayer.h:741
+
xpmp_PlaneNotification_Created
@ xpmp_PlaneNotification_Created
a plane was just created
Definition: XPMPMultiplayer.h:740
+
XPMPLightsPattern
unsigned int XPMPLightsPattern
Light flash pattern (unused in XPMP2)
Definition: XPMPMultiplayer.h:115
+
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:252
XPMPMultiplayerInitLegacyData
const char * XPMPMultiplayerInitLegacyData(const char *inCSLFolder, const char *inPluginName, const char *resourceDir, XPMPIntPrefsFuncTy inIntPrefsFunc=nullptr, const char *inDefaultICAO=nullptr, const char *inPluginLogAcronym=nullptr)
Deprecated legacy initialization of XPMP2.
Definition: XPMPMultiplayer.cpp:102
-
XPMPInfoTexts_t::size
long size
structure size
Definition: XPMPMultiplayer.h:200
-
XPMPPlanePosition_t::size
long size
size of structure
Definition: XPMPMultiplayer.h:80
-
XPMPMultiplayerOBJ7SupportEnable
const char * XPMPMultiplayerOBJ7SupportEnable(const char *inTexturePath)
Used to set the light textures for old OBJ7 models.
Definition: XPMPMultiplayer.cpp:222
-
XPMPLoadCSLPackage
const char * XPMPLoadCSLPackage(const char *inCSLFolder)
Loads CSL packages from the given folder, searching up to 5 folder levels deep.
Definition: XPMPMultiplayer.cpp:232
-
XPMPPlaneSurfaces_t::spoilerRatio
float spoilerRatio
spoiler extension ratio [0..1]
Definition: XPMPMultiplayer.h:151
-
XPMPPlaneSurfaces_t::yokeHeading
float yokeHeading
yoke heading ratio [0..1]
Definition: XPMPMultiplayer.h:157
-
XPMPDestroyPlane
void XPMPDestroyPlane(XPMPPlaneID _id)
[Deprecated] Removes a plane previously created with XPMPCreatePlane()
Definition: XPMPMultiplayer.cpp:394
-
XPMPSetPlaneVisibility
void XPMPSetPlaneVisibility(XPMPPlaneID _id, bool _bVisible)
Show/Hide the aircraft temporarily without destroying the object.
Definition: XPMPMultiplayer.cpp:402
-
XPMPSetDefaultPlaneICAO
void XPMPSetDefaultPlaneICAO(const char *_acIcaoType, const char *_carIcaoType=nullptr)
Define default aircraft and ground vehicle ICAO types.
Definition: XPMPMultiplayer.cpp:499
-
xpmp_LightStatus::lightFlags
unsigned int lightFlags
this defaults to taxi | beacon | nav lights on
Definition: XPMPMultiplayer.h:120
-
XPMPPlaneSurfaces_t::wingSweep
float wingSweep
wing sweep ratio [0..1]
Definition: XPMPMultiplayer.h:154
-
XPMPPlaneSurfaces_t::propRotDegree
float propRotDegree
prop rotation angle (degrees 0..360)
Definition: XPMPMultiplayer.h:168
-
XPMPGetAircraft
XPMP2::Aircraft * XPMPGetAircraft(XPMPPlaneID _id)
Returns the underlying aircraft object, or nullptr if _id is invalid.
Definition: XPMPMultiplayer.cpp:492
-
XPMPPlaneSurfaces_t::propRotRpm
float propRotRpm
prop rotation speed (rpm)
Definition: XPMPMultiplayer.h:169
-
XPMPInfoTexts_t::icaoAirline
char icaoAirline[4]
ICAO airline code.
Definition: XPMPMultiplayer.h:205
-
XPMPCreatePlaneWithModelName
XPMPPlaneID XPMPCreatePlaneWithModelName(const char *inModelName, const char *inICAOCode, const char *inAirline, const char *inLivery, XPMPPlaneData_f inDataFunc, void *inRefcon, XPMPPlaneID inModeS_id=0)
Creates a new plane, providing a specific CSL model name.
Definition: XPMPMultiplayer.cpp:359
-
XPMPGetModelInfo2
void XPMPGetModelInfo2(int inIndex, std::string &outModelName, std::string &outIcao, std::string &outAirline, std::string &outLivery)
Fetch information about a CSL model identified by an index.
Definition: XPMPMultiplayer.cpp:286
-
XPMPPlanePosition_t::lon
double lon
current position of aircraft (longitude)
Definition: XPMPMultiplayer.h:82
-
XPMPPlaneSurfaces_t::tireDeflect
float tireDeflect
tire deflection (meters)
Definition: XPMPMultiplayer.h:162
-
XPMPPlaneSurfaces_t::thrust
float thrust
thrust ratio [0..1]
Definition: XPMPMultiplayer.h:155
-
XPMPSetPluginName
void XPMPSetPluginName(const char *inPluginName, const char *inPluginLogAcronym=nullptr)
Overrides the plugin's name to be used in Log output.
Definition: XPMPMultiplayer.cpp:196
-
XPMPTransponderMode
XPMPTransponderMode
These enumerations define the way the transponder of a given plane is operating.
Definition: XPMPMultiplayer.h:179
-
xpmpTransponderMode_ModeC
@ xpmpTransponderMode_ModeC
transponder is on
Definition: XPMPMultiplayer.h:182
-
xpmpTransponderMode_Mode3A
@ xpmpTransponderMode_Mode3A
transponder is on
Definition: XPMPMultiplayer.h:181
-
xpmpTransponderMode_ModeC_Ident
@ xpmpTransponderMode_ModeC_Ident
transponder is on
Definition: XPMPMultiplayer.h:184
-
xpmpTransponderMode_ModeC_Low
@ xpmpTransponderMode_ModeC_Low
transponder is on
Definition: XPMPMultiplayer.h:183
-
xpmpTransponderMode_Standby
@ xpmpTransponderMode_Standby
transponder is in standby, not currently sending -> aircraft not visible on TCAS
Definition: XPMPMultiplayer.h:180
-
XPMPPlaneSurfaces_t::speedBrakeRatio
float speedBrakeRatio
speed brake extension ratio [0..1]
Definition: XPMPMultiplayer.h:152
-
XPMPMultiplayerCleanup
void XPMPMultiplayerCleanup()
Clean up the multiplayer library.
Definition: XPMPMultiplayer.cpp:205
-
XPMPPlanePosition_t::multiIdx
int multiIdx
OUT: set by XPMP2 to inform application about TCAS target index in use [1..63], with [1....
Definition: XPMPMultiplayer.h:92
-
XPMPPlaneNotifier_f
void(* XPMPPlaneNotifier_f)(XPMPPlaneID inPlaneID, XPMPPlaneNotification inNotification, void *inRefcon)
Type of the callback function you provide, called when one of the events defined in XPMPPlaneNotifica...
Definition: XPMPMultiplayer.h:635
-
XPMPDumpOneCycle
void XPMPDumpOneCycle(void)
Legacy debug-support function, no longer supported.
Definition: XPMPMultiplayer.cpp:581
-
XPMPPlanePosition_t::roll
float roll
roll [degrees, positive right]
Definition: XPMPMultiplayer.h:85
-
XPMPPlaneSurfaces_t::tireRotDegree
float tireRotDegree
tire rotation angle (degrees 0..360)
Definition: XPMPMultiplayer.h:163
-
XPMPGetNumberOfInstalledModels
int XPMPGetNumberOfInstalledModels()
Returns the number of loaded CSL models.
Definition: XPMPMultiplayer.cpp:248
-
XPMPMultiplayerDisable
void XPMPMultiplayerDisable()
Release TCAS targets control.
Definition: AIMultiplayer.cpp:1149
-
XPMPGetModelInfo
void XPMPGetModelInfo(int inIndex, const char **outModelName, const char **outIcao, const char **outAirline, const char **outLivery)
Fetch information about a CSL model identified by an index.
Definition: XPMPMultiplayer.cpp:254
-
XPMPDrawingAircraftLabels
bool XPMPDrawingAircraftLabels()
Returns if labels are currently configured to be drawn.
Definition: 2D.cpp:281
-
XPMPAddModelDataRef
size_t XPMPAddModelDataRef(const std::string &dataRef)
Add a user-defined dataRef to the list of dataRefs supported by every plane.
Definition: Aircraft.cpp:1095
-
XPMPPlaneSurfaces_t::slatRatio
float slatRatio
slats extension ratio [0..1]
Definition: XPMPMultiplayer.h:153
-
XPMPGetPlaneModelQuality
int XPMPGetPlaneModelQuality(XPMPPlaneID inPlane)
Returns the match quality of the currently used model, or -1 if inPlane is invalid.
Definition: XPMPMultiplayer.cpp:465
-
XPMPSetPlaneRenderer
void XPMPSetPlaneRenderer(XPMPRenderPlanes_f inRenderer, void *inRef)
The original libxplanemp allowed to override rendering; no longer supported.
Definition: XPMPMultiplayer.cpp:576
-
XPMPPlaneSurfaces_t::size
long size
structure size
Definition: XPMPMultiplayer.h:148
-
XPMPLoadPlanesIfNecessary
void XPMPLoadPlanesIfNecessary()
Legacy function only provided for backwards compatibility. Does not actually do anything.
Definition: XPMPMultiplayer.cpp:244
-
XPMPInfoTexts_t::aptTo
char aptTo[5]
Destination airport (ICAO)
Definition: XPMPMultiplayer.h:209
-
XPMPEnableAircraftLabels
void XPMPEnableAircraftLabels(bool _enable=true)
Enable or disable drawing of labels with the aircraft.
Definition: 2D.cpp:261
-
XPMPInfoTexts_t
Textual information of planes to be passed on via shared dataRefs to other plugins.
Definition: XPMPMultiplayer.h:199
-
XPMPPlanePosition_t
This data structure contains the basic position info for an aircraft.
Definition: XPMPMultiplayer.h:79
-
XPMPPlaneRadar_t
defines information about an aircraft visible to radar.
Definition: XPMPMultiplayer.h:189
-
XPMPPlaneSurfaces_t
External physical configuration of the plane.
Definition: XPMPMultiplayer.h:147
-
xpmp_LightStatus
Defines, which lights of the aircraft are on.
Definition: XPMPMultiplayer.h:119
-
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:147
-
XPMP2
Definition: XPMPAircraft.h:41
+
XPMPSoundIsEnabled
bool XPMPSoundIsEnabled()
Is Sound enabled?
Definition: Sound.cpp:868
+
XPMPInfoTexts_t::size
long size
structure size
Definition: XPMPMultiplayer.h:209
+
XPMPPlanePosition_t::size
long size
size of structure
Definition: XPMPMultiplayer.h:89
+
XPMPMultiplayerOBJ7SupportEnable
const char * XPMPMultiplayerOBJ7SupportEnable(const char *inTexturePath)
Used to set the light textures for old OBJ7 models.
Definition: XPMPMultiplayer.cpp:234
+
XPMPLoadCSLPackage
const char * XPMPLoadCSLPackage(const char *inCSLFolder)
Loads CSL packages from the given folder, searching up to 5 folder levels deep.
Definition: XPMPMultiplayer.cpp:244
+
XPMPPlaneSurfaces_t::spoilerRatio
float spoilerRatio
spoiler extension ratio [0..1]
Definition: XPMPMultiplayer.h:160
+
XPMPPlaneSurfaces_t::yokeHeading
float yokeHeading
yoke heading ratio [0..1]
Definition: XPMPMultiplayer.h:166
+
XPMPDestroyPlane
void XPMPDestroyPlane(XPMPPlaneID _id)
[Deprecated] Removes a plane previously created with XPMPCreatePlane()
Definition: XPMPMultiplayer.cpp:406
+
XPMPSetPlaneVisibility
void XPMPSetPlaneVisibility(XPMPPlaneID _id, bool _bVisible)
Show/Hide the aircraft temporarily without destroying the object.
Definition: XPMPMultiplayer.cpp:414
+
XPMPSetDefaultPlaneICAO
void XPMPSetDefaultPlaneICAO(const char *_acIcaoType, const char *_carIcaoType=nullptr)
Define default aircraft and ground vehicle ICAO types.
Definition: XPMPMultiplayer.cpp:511
+
xpmp_LightStatus::lightFlags
unsigned int lightFlags
this defaults to taxi | beacon | nav lights on
Definition: XPMPMultiplayer.h:129
+
XPMPPlaneSurfaces_t::wingSweep
float wingSweep
wing sweep ratio [0..1]
Definition: XPMPMultiplayer.h:163
+
XPMPPlaneSurfaces_t::propRotDegree
float propRotDegree
prop rotation angle (degrees 0..360)
Definition: XPMPMultiplayer.h:177
+
XPMPGetAircraft
XPMP2::Aircraft * XPMPGetAircraft(XPMPPlaneID _id)
Returns the underlying aircraft object, or nullptr if _id is invalid.
Definition: XPMPMultiplayer.cpp:504
+
XPMPPlaneSurfaces_t::propRotRpm
float propRotRpm
prop rotation speed (rpm)
Definition: XPMPMultiplayer.h:178
+
XPMPInfoTexts_t::icaoAirline
char icaoAirline[4]
ICAO airline code.
Definition: XPMPMultiplayer.h:214
+
XPMPCreatePlaneWithModelName
XPMPPlaneID XPMPCreatePlaneWithModelName(const char *inModelName, const char *inICAOCode, const char *inAirline, const char *inLivery, XPMPPlaneData_f inDataFunc, void *inRefcon, XPMPPlaneID inModeS_id=0)
Creates a new plane, providing a specific CSL model name.
Definition: XPMPMultiplayer.cpp:371
+
XPMPGetModelInfo2
void XPMPGetModelInfo2(int inIndex, std::string &outModelName, std::string &outIcao, std::string &outAirline, std::string &outLivery)
Fetch information about a CSL model identified by an index.
Definition: XPMPMultiplayer.cpp:298
+
XPMPPlanePosition_t::lon
double lon
current position of aircraft (longitude)
Definition: XPMPMultiplayer.h:91
+
XPMPPlaneSurfaces_t::tireDeflect
float tireDeflect
tire deflection (meters)
Definition: XPMPMultiplayer.h:171
+
XPMPPlaneSurfaces_t::thrust
float thrust
thrust ratio [0..1]
Definition: XPMPMultiplayer.h:164
+
XPMPSetPluginName
void XPMPSetPluginName(const char *inPluginName, const char *inPluginLogAcronym=nullptr)
Overrides the plugin's name to be used in Log output.
Definition: XPMPMultiplayer.cpp:205
+
XPMPTransponderMode
XPMPTransponderMode
These enumerations define the way the transponder of a given plane is operating.
Definition: XPMPMultiplayer.h:188
+
xpmpTransponderMode_ModeC
@ xpmpTransponderMode_ModeC
transponder is on
Definition: XPMPMultiplayer.h:191
+
xpmpTransponderMode_Mode3A
@ xpmpTransponderMode_Mode3A
transponder is on
Definition: XPMPMultiplayer.h:190
+
xpmpTransponderMode_ModeC_Ident
@ xpmpTransponderMode_ModeC_Ident
transponder is on
Definition: XPMPMultiplayer.h:193
+
xpmpTransponderMode_ModeC_Low
@ xpmpTransponderMode_ModeC_Low
transponder is on
Definition: XPMPMultiplayer.h:192
+
xpmpTransponderMode_Standby
@ xpmpTransponderMode_Standby
transponder is in standby, not currently sending -> aircraft not visible on TCAS
Definition: XPMPMultiplayer.h:189
+
XPMPPlaneSurfaces_t::speedBrakeRatio
float speedBrakeRatio
speed brake extension ratio [0..1]
Definition: XPMPMultiplayer.h:161
+
XPMPMultiplayerCleanup
void XPMPMultiplayerCleanup()
Clean up the multiplayer library.
Definition: XPMPMultiplayer.cpp:214
+
XPMPPlanePosition_t::multiIdx
int multiIdx
OUT: set by XPMP2 to inform application about TCAS target index in use [1..63], with [1....
Definition: XPMPMultiplayer.h:101
+
XPMPPlaneNotifier_f
void(* XPMPPlaneNotifier_f)(XPMPPlaneID inPlaneID, XPMPPlaneNotification inNotification, void *inRefcon)
Type of the callback function you provide, called when one of the events defined in XPMPPlaneNotifica...
Definition: XPMPMultiplayer.h:751
+
XPMPDumpOneCycle
void XPMPDumpOneCycle(void)
Legacy debug-support function, no longer supported.
Definition: XPMPMultiplayer.cpp:593
+
XPMPPlanePosition_t::roll
float roll
roll [degrees, positive right]
Definition: XPMPMultiplayer.h:94
+
XPMPPlaneSurfaces_t::tireRotDegree
float tireRotDegree
tire rotation angle (degrees 0..360)
Definition: XPMPMultiplayer.h:172
+
XPMPGetNumberOfInstalledModels
int XPMPGetNumberOfInstalledModels()
Returns the number of loaded CSL models.
Definition: XPMPMultiplayer.cpp:260
+
XPMPMultiplayerDisable
void XPMPMultiplayerDisable()
Release TCAS targets control.
Definition: AIMultiplayer.cpp:1151
+
XPMPGetModelInfo
void XPMPGetModelInfo(int inIndex, const char **outModelName, const char **outIcao, const char **outAirline, const char **outLivery)
Fetch information about a CSL model identified by an index.
Definition: XPMPMultiplayer.cpp:266
+
XPMPSoundEnable
bool XPMPSoundEnable(bool bEnable=true)
Enable/Disable Sound.
Definition: Sound.cpp:853
+
XPMPDrawingAircraftLabels
bool XPMPDrawingAircraftLabels()
Returns if labels are currently configured to be drawn.
Definition: 2D.cpp:280
+
XPMPAddModelDataRef
size_t XPMPAddModelDataRef(const std::string &dataRef)
Add a user-defined dataRef to the list of dataRefs supported by every plane.
Definition: Aircraft.cpp:1125
+
XPMPPlaneSurfaces_t::slatRatio
float slatRatio
slats extension ratio [0..1]
Definition: XPMPMultiplayer.h:162
+
XPMPGetPlaneModelQuality
int XPMPGetPlaneModelQuality(XPMPPlaneID inPlane)
Returns the match quality of the currently used model, or -1 if inPlane is invalid.
Definition: XPMPMultiplayer.cpp:477
+
XPMPSetPlaneRenderer
void XPMPSetPlaneRenderer(XPMPRenderPlanes_f inRenderer, void *inRef)
The original libxplanemp allowed to override rendering; no longer supported.
Definition: XPMPMultiplayer.cpp:588
+
XPMPPlaneSurfaces_t::size
long size
structure size
Definition: XPMPMultiplayer.h:157
+
XPMPLoadPlanesIfNecessary
void XPMPLoadPlanesIfNecessary()
Legacy function only provided for backwards compatibility. Does not actually do anything.
Definition: XPMPMultiplayer.cpp:256
+
XPMPInfoTexts_t::aptTo
char aptTo[5]
Destination airport (ICAO)
Definition: XPMPMultiplayer.h:218
+
XPMPEnableAircraftLabels
void XPMPEnableAircraftLabels(bool _enable=true)
Enable or disable drawing of labels with the aircraft.
Definition: 2D.cpp:260
+
XPMPInfoTexts_t
Textual information of planes to be passed on via shared dataRefs to other plugins.
Definition: XPMPMultiplayer.h:208
+
XPMPPlanePosition_t
This data structure contains the basic position info for an aircraft.
Definition: XPMPMultiplayer.h:88
+
XPMPPlaneRadar_t
defines information about an aircraft visible to radar.
Definition: XPMPMultiplayer.h:198
+
XPMPPlaneSurfaces_t
External physical configuration of the plane.
Definition: XPMPMultiplayer.h:156
+
xpmp_LightStatus
Defines, which lights of the aircraft are on.
Definition: XPMPMultiplayer.h:128
+
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:181
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
diff --git a/docs/html/XPMPPlaneRenderer_8h_source.html b/docs/html/XPMPPlaneRenderer_8h_source.html index aba7af1f..a0a3e5fd 100644 --- a/docs/html/XPMPPlaneRenderer_8h_source.html +++ b/docs/html/XPMPPlaneRenderer_8h_source.html @@ -65,9 +65,9 @@
46 void XPMPDeinitDefaultPlaneRenderer(void);
47 
48 #endif
-
XPMPDeinitDefaultPlaneRenderer
void XPMPDeinitDefaultPlaneRenderer(void)
Was an internal libxplanemp functions.
Definition: XPMPMultiplayer.cpp:584
-
XPMPInitDefaultPlaneRenderer
void XPMPInitDefaultPlaneRenderer(void)
Was an internal libxplanemp functions.
Definition: XPMPMultiplayer.cpp:582
-
XPMPDefaultPlaneRenderer
void XPMPDefaultPlaneRenderer(int is_blend)
Was an internal libxplanemp functions.
Definition: XPMPMultiplayer.cpp:583
+
XPMPDeinitDefaultPlaneRenderer
void XPMPDeinitDefaultPlaneRenderer(void)
Was an internal libxplanemp functions.
Definition: XPMPMultiplayer.cpp:596
+
XPMPInitDefaultPlaneRenderer
void XPMPInitDefaultPlaneRenderer(void)
Was an internal libxplanemp functions.
Definition: XPMPMultiplayer.cpp:594
+
XPMPDefaultPlaneRenderer
void XPMPDefaultPlaneRenderer(int is_blend)
Was an internal libxplanemp functions.
Definition: XPMPMultiplayer.cpp:595
diff --git a/docs/html/XPMPRemote_8h.html b/docs/html/XPMPRemote_8h.html index d7d7e75a..a14c10bc 100644 --- a/docs/html/XPMPRemote_8h.html +++ b/docs/html/XPMPRemote_8h.html @@ -113,6 +113,7 @@

Namespaces

 XPMP2 + Defined by FMOD.
  - + diff --git a/docs/html/XPMPRemote_8h_source.html b/docs/html/XPMPRemote_8h_source.html index 827f50c7..aa3e89d8 100644 --- a/docs/html/XPMPRemote_8h_source.html +++ b/docs/html/XPMPRemote_8h_source.html @@ -392,10 +392,10 @@
453 
454 
455 #endif
-
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:243
-
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:147
+
XPMPPlaneID
unsigned XPMPPlaneID
Unique ID for an aircraft created by a plugin.
Definition: XPMPMultiplayer.h:252
+
XPMP2::Aircraft
Actual representation of all aircraft in XPMP2.
Definition: XPMPAircraft.h:181
XPMP2::CSLModel
Represetns a CSL model as it is saved on disk.
Definition: CSLModels.h:113
-
XPMP2
Definition: XPMPAircraft.h:41
+
XPMP2
Defined by FMOD.
Definition: XPMPAircraft.h:73
XPMP2::RMT_VER_BEACON
constexpr std::uint8_t RMT_VER_BEACON
Interest Beacon message version number.
Definition: XPMPRemote.h:136
XPMP2::RMT_VER_AC_DETAIL_0
constexpr std::uint8_t RMT_VER_AC_DETAIL_0
Definition: XPMPRemote.h:181
XPMP2::RMT_VER_SETTINGS
constexpr std::uint8_t RMT_VER_SETTINGS
Setttings message version number.
Definition: XPMPRemote.h:152
@@ -414,7 +414,7 @@
XPMP2::REMOTE_MAX_DIFF_TIME
constexpr float REMOTE_MAX_DIFF_TIME
maximum time difference thatn can be represented in a pos update msg
Definition: XPMPRemote.h:268
XPMP2::clamp
constexpr const T & clamp(const T &v, const T &lo, const T &hi)
Clamps v between lo and hi: lo if v < lo, hi if hi < v, otherwise v
Definition: XPMPRemote.h:66
XPMP2::RMT_VER_AC_DETAIL_1
constexpr std::uint8_t RMT_VER_AC_DETAIL_1
Definition: XPMPRemote.h:180
-
XPMP2::CSLModelByPkgShortId
CSLModel * CSLModelByPkgShortId(std::uint16_t _pkgHash, const std::string &_shortId)
Find a model by package name hash and short id.
Definition: CSLModels.cpp:1151
+
XPMP2::CSLModelByPkgShortId
CSLModel * CSLModelByPkgShortId(std::uint16_t _pkgHash, const std::string &_shortId)
Find a model by package name hash and short id.
Definition: CSLModels.cpp:1150
XPMP2::RemoteStatusTy
RemoteStatusTy
State of remote communcations.
Definition: XPMPRemote.h:435
XPMP2::REMOTE_RECV_WAITING
@ REMOTE_RECV_WAITING
waiting to receive data, periodically sending a token of interest
Definition: XPMPRemote.h:439
XPMP2::REMOTE_OFF
@ REMOTE_OFF
no remote connectivtiy, not listening, not sending
Definition: XPMPRemote.h:436
@@ -426,10 +426,10 @@
XPMP2::REMOTE_TIME_RES
constexpr float REMOTE_TIME_RES
resolution of time difference
Definition: XPMPRemote.h:267
XPMP2::REMOTE_MAX_DIFF_ALT_FT
constexpr double REMOTE_MAX_DIFF_ALT_FT
maximum altitude[ft] difference that can be represented in a pos update msg
Definition: XPMPRemote.h:266
XPMP2::REMOTE_SEND_SETTINGS_INTVL
constexpr int REMOTE_SEND_SETTINGS_INTVL
How often to send settings? [s].
Definition: XPMPRemote.h:149
-
XPMP2::PJWHash16
std::uint16_t PJWHash16(const char *s)
Produces a reproducible(!) hash value for strings.
Definition: Utilities.cpp:572
+
XPMP2::PJWHash16
std::uint16_t PJWHash16(const char *s)
Produces a reproducible(!) hash value for strings.
Definition: Utilities.cpp:601
XPMP2::PACKED
struct XPMP2::RemoteMsgBaseTy PACKED
-
XPMP2::DR_VALS
DR_VALS
The dataRefs provided by XPMP2 to the CSL models.
Definition: XPMPAircraft.h:56
-
XPMP2::V_COUNT
@ V_COUNT
always last, number of dataRefs XPMP2 pre-defines
Definition: XPMPAircraft.h:106
+
XPMP2::DR_VALS
DR_VALS
The dataRefs provided by XPMP2 to the CSL models.
Definition: XPMPAircraft.h:90
+
XPMP2::V_COUNT
@ V_COUNT
always last, number of dataRefs XPMP2 pre-defines
Definition: XPMPAircraft.h:140
XPMP2::REMOTE_ALT_FT_RES
constexpr double REMOTE_ALT_FT_RES
resolution of altitude[ft] updates
Definition: XPMPRemote.h:265
XPMP2::REMOTE_DR_DEF
const std::array< RemoteDataRefPackTy, V_COUNT > REMOTE_DR_DEF
An array holding all dataRef packing definitions.
Definition: Remote.cpp:36
XPMP2::REMOTE_SIGNATURE
constexpr const char * REMOTE_SIGNATURE
The signature of the XPMP2 Remote Client.
Definition: XPMPRemote.h:42
diff --git a/docs/html/annotated.html b/docs/html/annotated.html index afd9360c..167236e8 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -45,67 +45,72 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]

@@ -167,7 +168,7 @@

Variables

constexpr const char * XPMP2::REMOTE_SIGNATURE = "TwinFan.plugin.XPMP2.Remote"
 The signature of the XPMP2 Remote Client. More...
 The signature of the XPMP2 Remote Client. More...
 
const std::array< RemoteDataRefPackTy, V_COUNT > XPMP2::REMOTE_DR_DEF
 An array holding all dataRef packing definitions. More...
- + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼NXPMP2
 ▼NXPMP2Defined by FMOD
 ▼CCSLModelInfo_tCollates some information on the CSL model
 CMatchCrit_tAny number of airline codes and/or liveries can be assigned to a model for matching purpose
 ▼CAircraftActual representation of all aircraft in XPMP2
 CwakeTyWake dataRef support
 CXPMP2ErrorXPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft
 CRemoteDataRefPackTyDefinition for how to map dataRef values to (u)int8, ie. to an integer range of 8 bits
 CRemoteMsgBaseTyMessage header, identical for all message types
 CRemoteMsgBeaconTy"Beacon of Interest", ie. some message on the multicast just to wake up sender
 CRemoteMsgSettingsTySettings message, identifying a sending plugin, regularly providing its settings
 CRemoteAcDetailTyA/C details, packed into an array message
 CRemoteMsgAcDetailTyA/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
 CRemoteAcPosUpdateTyA/C Position updates based on global coordinates
 CRemoteMsgAcPosUpdateTyA/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
 ▼CRemoteAcAnimTyA/C animation dataRef changes
 CDataRefValTyDataRef animation types and value
 CRemoteMsgAcAnimTyA/C animation dataRef message, has an inherited header plus an array of variable sized XPMP2::RemoteAcAnimTy elements
 CRemoteAcRemoveTyA/C Removal only includes the plane id, structure required for msgSize() function
 CRemoteMsgAcRemoveTyA/C removal message, an array of plane ids
 CRemoteCBFctTyFunction prototypes for callback functions to handle the received messages
 CmultiDataRefsTyKeeps the dataRef handles for one of the up to 19 legacy AI/Multiplayer slots ("sim/multiplayer/position")
 CinfoDataRefsTyKeeps the dataRef handles for one of the up to 63 shared data slots ("sim/multiplayer/position/plane#...")
 ▼CTcasLightsTyA structure simplifying communicaton with sim/cockpit2/tcas/targets/position/lights
 CBitsTy
 CLegacyAircraftThis class helps creating aircraft via the legacy global functions. It provides standard implementations of the abstract callbacks
 CCSLObjOne .obj file of a CSL model (of which it can have multiple)
 ▼CCSLModelRepresetns a CSL model as it is saved on disk
 CMatchCritTyCombines match-relevant fields (beside ICAO a/c type)
 CNetRuntimeErrorException raised by XPMP2::SocketNetworking objects
 CSocketNetworkingBase class for any socket-based networking
 CUDPReceiverReceives UDP messages
 CUDPMulticastUDP Multicast, always binding to INADDR_ANY
 CTCPConnectionListens to TCP connections and opens a session socket upon connect
 CInetAddrTyNumerical IP address, used for both ipv4 and ipv6, for ease of handling
 CDoc8643Represents a line in the Doc8643.txt file, of which we use only classification and WTC
 CObj8DataRefsA pair of strings, first one to search for, second one to replace it with
 CRemoteAcDetailTy_v0Version 0 A/C details, packed into an array message
 CRemoteMsgAcDetailTy_v0Version 0 A/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
 CRmtAcCacheTyHolds a copy of some aircraft data as was sent out last
 CRmtDataBaseTyBase structure for passing information from XP's main thread to the multicast thread
 CRmtDataEnqeueTyPassing information about any data type (like a/c full detail message); the data is contained as copy
 CRmtDataAcAnimTyAnimation dataRef requires a special queue data type as each msg element is already of variable length
 CRmtMsgBufTyHelper class to manage the temporary buffers in which the network message are put together
 CXPMPPlaneNotifierTyStores the function and refcon pointer for plane creation/destrcution notifications
 CGlobVarsAll global config settings and variables are kept in one structure for convenient access and central definition
 CRmtDataAcAnimTy.__unnamed4__
 CCmdMenuDefTyCommand definition per menu item
 CLegacySampleAircraftSubclassing XPCAircraft to create our own class
 CpositionTySummarizes the 3 values of a position in the local coordinate system
 CRemoteACRepresentation of a remote aircraft
 CSampleAircraftSubclassing XPMP2::Aircraft to create our own class
 CSenderAddrTyUniquely identifies a sending plugin
 CSenderTy
 CXPCAircraftLegacy wrapper class as provided by original libxplanemp
 CXPMP2RCGlobalsHolds all global variables
 Cxpmp_LightStatusDefines, which lights of the aircraft are on
 Cxpmp_LightStatus.__unnamed2__
 CXPMPInfoTexts_tTextual information of planes to be passed on via shared dataRefs to other plugins
 CXPMPPlanePosition_tThis data structure contains the basic position info for an aircraft
 CXPMPPlaneRadar_tDefines information about an aircraft visible to radar
 CXPMPPlaneSurfaces_tExternal physical configuration of the plane
 ▼CAircraftActual representation of all aircraft in XPMP2
 CSndChTyOperational values per sound channel, that is triggered by a standard sound event
 CwakeTyWake dataRef support
 CXPMP2ErrorXPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft
 CRemoteDataRefPackTyDefinition for how to map dataRef values to (u)int8, ie. to an integer range of 8 bits
 CRemoteMsgBaseTyMessage header, identical for all message types
 CRemoteMsgBeaconTy"Beacon of Interest", ie. some message on the multicast just to wake up sender
 CRemoteMsgSettingsTySettings message, identifying a sending plugin, regularly providing its settings
 CRemoteAcDetailTyA/C details, packed into an array message
 CRemoteMsgAcDetailTyA/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
 CRemoteAcPosUpdateTyA/C Position updates based on global coordinates
 CRemoteMsgAcPosUpdateTyA/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
 ▼CRemoteAcAnimTyA/C animation dataRef changes
 CDataRefValTyDataRef animation types and value
 CRemoteMsgAcAnimTyA/C animation dataRef message, has an inherited header plus an array of variable sized XPMP2::RemoteAcAnimTy elements
 CRemoteAcRemoveTyA/C Removal only includes the plane id, structure required for msgSize() function
 CRemoteMsgAcRemoveTyA/C removal message, an array of plane ids
 CRemoteCBFctTyFunction prototypes for callback functions to handle the received messages
 CmultiDataRefsTyKeeps the dataRef handles for one of the up to 19 legacy AI/Multiplayer slots ("sim/multiplayer/position")
 CinfoDataRefsTyKeeps the dataRef handles for one of the up to 63 shared data slots ("sim/multiplayer/position/plane#...")
 ▼CTcasLightsTyA structure simplifying communicaton with sim/cockpit2/tcas/targets/position/lights
 CBitsTy
 CLegacyAircraftThis class helps creating aircraft via the legacy global functions. It provides standard implementations of the abstract callbacks
 CCSLObjOne .obj file of a CSL model (of which it can have multiple)
 ▼CCSLModelRepresetns a CSL model as it is saved on disk
 CMatchCritTyCombines match-relevant fields (beside ICAO a/c type)
 CNetRuntimeErrorException raised by XPMP2::SocketNetworking objects
 CSocketNetworkingBase class for any socket-based networking
 CUDPReceiverReceives UDP messages
 CUDPMulticastUDP Multicast, always binding to INADDR_ANY
 CTCPConnectionListens to TCP connections and opens a session socket upon connect
 CInetAddrTyNumerical IP address, used for both ipv4 and ipv6, for ease of handling
 CDoc8643Represents a line in the Doc8643.txt file, of which we use only classification and WTC
 CObj8DataRefsA pair of strings, first one to search for, second one to replace it with
 CRemoteAcDetailTy_v0Version 0 A/C details, packed into an array message
 CRemoteMsgAcDetailTy_v0Version 0 A/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
 CRmtAcCacheTyHolds a copy of some aircraft data as was sent out last
 CRmtDataBaseTyBase structure for passing information from XP's main thread to the multicast thread
 CRmtDataEnqeueTyPassing information about any data type (like a/c full detail message); the data is contained as copy
 CRmtDataAcAnimTyAnimation dataRef requires a special queue data type as each msg element is already of variable length
 CRmtMsgBufTyHelper class to manage the temporary buffers in which the network message are put together
 CFMOD_10830_ADVANCEDSETTINGSFMOD 1.08.30 version of FMOD_ADVANCEDSETTINGS
 CSoundDefTyDefinition of how sound is handled based on dataRef values (type)
 CFmodErrorException class to pass on error information
 CSoundFileRepresents a sound file
 CXPMPPlaneNotifierTyStores the function and refcon pointer for plane creation/destrcution notifications
 CGlobVarsAll global config settings and variables are kept in one structure for convenient access and central definition
 CRmtDataAcAnimTy.__unnamed4__
 CCmdMenuDefTyCommand definition per menu item
 CLegacySampleAircraftSubclassing XPCAircraft to create our own class
 CpositionTySummarizes the 3 values of a position in the local coordinate system
 CRemoteACRepresentation of a remote aircraft
 CSampleAircraftSubclassing XPMP2::Aircraft to create our own class
 CSenderAddrTyUniquely identifies a sending plugin
 CSenderTy
 CXPCAircraftLegacy wrapper class as provided by original libxplanemp
 CXPMP2RCGlobalsHolds all global variables
 Cxpmp_LightStatusDefines, which lights of the aircraft are on
 Cxpmp_LightStatus.__unnamed2__
 CXPMPInfoTexts_tTextual information of planes to be passed on via shared dataRefs to other plugins
 CXPMPPlanePosition_tThis data structure contains the basic position info for an aircraft
 CXPMPPlaneRadar_tDefines information about an aircraft visible to radar
 CXPMPPlaneSurfaces_tExternal physical configuration of the plane
diff --git a/docs/html/classLegacySampleAircraft-members.html b/docs/html/classLegacySampleAircraft-members.html index b8decd97..9d331d03 100644 --- a/docs/html/classLegacySampleAircraft-members.html +++ b/docs/html/classLegacySampleAircraft-members.html @@ -58,39 +58,45 @@ Aircraft(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="")XPMP2::Aircraft Aircraft()XPMP2::Aircraft Aircraft(const Aircraft &)=deleteXPMP2::Aircraft - AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft - bClampToGroundXPMP2::Aircraft - bDrawLabelXPMP2::Aircraft - bOnGrndXPMP2::Aircraft - bRenderXPMP2::Aircraftprotected - bValidXPMP2::Aircraftprotected - bVisibleXPMP2::Aircraftprotected - camBearingXPMP2::Aircraftprotected - camDistXPMP2::Aircraftprotected - camTimLstUpdXPMP2::Aircraftprotected - ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft - ClampToGround()XPMP2::Aircraftprotected - colLabelXPMP2::Aircraft - ComputeMapLabel()XPMP2::Aircraftprotectedvirtual - Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft - CreateInstances()XPMP2::Aircraftprotected - DestroyInstances()XPMP2::Aircraftprotected - DoMove()XPMP2::Aircraftprotected - drawInfoXPMP2::Aircraft - FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic - gearDeflectRatioXPMP2::Aircraft - GetAoA() constXPMP2::Aircraftinlinevirtual - GetCameraBearing() constXPMP2::Aircraftinline - GetCameraDist() constXPMP2::Aircraftinline - GetEngineRotAngle() constXPMP2::Aircraftinline - GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline - GetEngineRotRad() constXPMP2::Aircraftinline - GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline - GetEngineRotRpm() constXPMP2::Aircraftinline - GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline - GetFlapRatio() constXPMP2::Aircraftinline - GetFlightId() constXPMP2::Aircraftvirtual - GetGearRatio() constXPMP2::Aircraftinline + aSndChXPMP2::Aircraftprotected + AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft + bChnLowPassXPMP2::Aircraftprotected + bChnMutedXPMP2::Aircraftprotected + bClampToGroundXPMP2::Aircraft + bDrawLabelXPMP2::Aircraft + bOnGrndXPMP2::Aircraft + bRenderXPMP2::Aircraftprotected + bValidXPMP2::Aircraftprotected + bVisibleXPMP2::Aircraftprotected + camBearingXPMP2::Aircraftprotected + camDistXPMP2::Aircraftprotected + camTimLstUpdXPMP2::Aircraftprotected + ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft + chnListXPMP2::Aircraftprotected + ChnListTy typedefXPMP2::Aircraft + ClampToGround()XPMP2::Aircraftprotected + colLabelXPMP2::Aircraft + ComputeMapLabel()XPMP2::Aircraftprotectedvirtual + Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft + CreateInstances()XPMP2::Aircraftprotected + DestroyInstances()XPMP2::Aircraftprotected + DoMove()XPMP2::Aircraftprotected + drawInfoXPMP2::Aircraft + FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic + gearDeflectRatioXPMP2::Aircraft + GetAoA() constXPMP2::Aircraftinlinevirtual + GetCameraBearing() constXPMP2::Aircraftinline + GetCameraDist() constXPMP2::Aircraftinline + GetEngineRotAngle() constXPMP2::Aircraftinline + GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline + GetEngineRotRad() constXPMP2::Aircraftinline + GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline + GetEngineRotRpm() constXPMP2::Aircraftinline + GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline + GetFlapRatio() constXPMP2::Aircraftinline + GetFlightId() constXPMP2::Aircraftvirtual + GetGearRatio() constXPMP2::Aircraftinline + GetGS_kn() constXPMP2::Aircraftinline GetHeading() constXPMP2::Aircraftinline GetInfoTexts(XPMPInfoTexts_t *outInfoTexts)LegacySampleAircraftinlinevirtual GetLift() constXPMP2::Aircraftinlinevirtual @@ -137,98 +143,119 @@ GetYokeHeadingRatio() constXPMP2::Aircraftinline GetYokePitchRatio() constXPMP2::Aircraftinline GetYokeRollRatio() constXPMP2::Aircraftinline - hProbeXPMP2::Aircraftprotected - IsCurrentlyShownAsAI() constXPMP2::Aircraft - IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline - IsGroundVehicle() constXPMP2::Aircraft - IsInstanciated() constXPMP2::Aircraftinline - IsOnGrnd() constXPMP2::Aircraftinline - IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft - IsRendered() constXPMP2::Aircraftinline - IsValid() constXPMP2::Aircraftinline - IsVisible() constXPMP2::Aircraftinline - labelXPMP2::Aircraft - LegacySampleAircraft(const char *inICAOCode, const char *inAirline, const char *inLivery, XPMPPlaneID _modeS_id=0, const char *inModelName=nullptr)LegacySampleAircraftinline - listInstXPMP2::Aircraftprotected - MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft - MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft - MapFindIcon()XPMP2::Aircraft - mapIconColXPMP2::Aircraftprotected - mapIconRowXPMP2::Aircraftprotected - mapLabelXPMP2::Aircraftprotected - MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft - mapXXPMP2::Aircraftprotected - mapYXPMP2::Aircraftprotected - matchQualityXPMP2::Aircraftprotected - modeS_idXPMP2::Aircraftprotected - operator=(const Aircraft &)=deleteXPMP2::Aircraft - pCSLMdlXPMP2::Aircraftprotected - prev_tsXPMP2::Aircraftprotected - prev_xXPMP2::Aircraftprotected - prev_yXPMP2::Aircraftprotected - prev_zXPMP2::Aircraftprotected - ReMatchModel()XPMP2::Aircraftinline - ResetTcasTargetIdx()XPMP2::Aircraftinline - SetDrawLabel(bool _b)XPMP2::Aircraftinline - SetEngineRotAngle(float _deg)XPMP2::Aircraft - SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft - SetEngineRotRad(float _rad)XPMP2::Aircraft - SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft - SetEngineRotRpm(float _rpm)XPMP2::Aircraft - SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft - SetFlapRatio(float _f)XPMP2::Aircraftinline - SetGearRatio(float _f)XPMP2::Aircraftinline - SetHeading(float _deg)XPMP2::Aircraftinline - SetInvalid()XPMP2::Aircraftvirtual - SetLightsBeacon(bool _b)XPMP2::Aircraftinline - SetLightsLanding(bool _b)XPMP2::Aircraftinline - SetLightsNav(bool _b)XPMP2::Aircraftinline - SetLightsStrobe(bool _b)XPMP2::Aircraftinline - SetLightsTaxi(bool _b)XPMP2::Aircraftinline - SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline - SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline - SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft - SetMass(float _kg)XPMP2::Aircraftinline - SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline - SetNoseWheelAngle(float _f)XPMP2::Aircraftinline - SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft - SetPitch(float _deg)XPMP2::Aircraftinline - SetPropRotAngle(float _deg)XPMP2::Aircraftinline - SetPropRotRad(float _rad)XPMP2::Aircraftinline - SetPropRotRpm(float _rpm)XPMP2::Aircraftinline - SetRender(bool _bRender)XPMP2::Aircraftvirtual - SetReversDeployRatio(float _f)XPMP2::Aircraftinline - SetRoll(float _deg)XPMP2::Aircraftinline - SetSlatRatio(float _f)XPMP2::Aircraftinline - SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline - SetSpoilerRatio(float _f)XPMP2::Aircraftinline - SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual - SetThrustRatio(float _f)XPMP2::Aircraftinline - SetThrustReversRatio(float _f)XPMP2::Aircraftinline - SetTireDeflection(float _mtr)XPMP2::Aircraftinline - SetTireRotAngle(float _deg)XPMP2::Aircraftinline - SetTireRotRad(float _rad)XPMP2::Aircraftinline - SetTireRotRpm(float _rpm)XPMP2::Aircraftinline - SetTouchDown(bool _b)XPMP2::Aircraftinline - SetVisible(bool _bVisible)XPMP2::Aircraftvirtual - SetWingArea(float _m2)XPMP2::Aircraftinline - SetWingSpan(float _m)XPMP2::Aircraftinline - SetWingSweepRatio(float _f)XPMP2::Aircraftinline - SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline - SetYokePitchRatio(float _f)XPMP2::Aircraftinline - SetYokeRollRatio(float _f)XPMP2::Aircraftinline - ShallDrawLabel() constXPMP2::Aircraftinline - ShowAsAIPlane() constXPMP2::Aircraftinline + gs_knXPMP2::Aircraftprotected + hProbeXPMP2::Aircraftprotected + IsCurrentlyShownAsAI() constXPMP2::Aircraft + IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline + IsGroundVehicle() constXPMP2::Aircraft + IsInstanciated() constXPMP2::Aircraftinline + IsOnGrnd() constXPMP2::Aircraftinline + IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft + IsRendered() constXPMP2::Aircraftinline + IsValid() constXPMP2::Aircraftinline + IsVisible() constXPMP2::Aircraftinline + labelXPMP2::Aircraft + LegacySampleAircraft(const char *inICAOCode, const char *inAirline, const char *inLivery, XPMPPlaneID _modeS_id=0, const char *inModelName=nullptr)LegacySampleAircraftinline + listInstXPMP2::Aircraftprotected + MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft + MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft + MapFindIcon()XPMP2::Aircraft + mapIconColXPMP2::Aircraftprotected + mapIconRowXPMP2::Aircraftprotected + mapLabelXPMP2::Aircraftprotected + MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft + mapXXPMP2::Aircraftprotected + mapYXPMP2::Aircraftprotected + matchQualityXPMP2::Aircraftprotected + modeS_idXPMP2::Aircraftprotected + operator=(const Aircraft &)=deleteXPMP2::Aircraft + pCSLMdlXPMP2::Aircraftprotected + prev_tsXPMP2::Aircraftprotected + prev_xXPMP2::Aircraftprotected + prev_yXPMP2::Aircraftprotected + prev_zXPMP2::Aircraftprotected + ReMatchModel()XPMP2::Aircraftinline + ResetTcasTargetIdx()XPMP2::Aircraftinline + SetDrawLabel(bool _b)XPMP2::Aircraftinline + SetEngineRotAngle(float _deg)XPMP2::Aircraft + SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft + SetEngineRotRad(float _rad)XPMP2::Aircraft + SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft + SetEngineRotRpm(float _rpm)XPMP2::Aircraft + SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft + SetFlapRatio(float _f)XPMP2::Aircraftinline + SetGearRatio(float _f)XPMP2::Aircraftinline + SetHeading(float _deg)XPMP2::Aircraftinline + SetInvalid()XPMP2::Aircraftvirtual + SetLightsBeacon(bool _b)XPMP2::Aircraftinline + SetLightsLanding(bool _b)XPMP2::Aircraftinline + SetLightsNav(bool _b)XPMP2::Aircraftinline + SetLightsStrobe(bool _b)XPMP2::Aircraftinline + SetLightsTaxi(bool _b)XPMP2::Aircraftinline + SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline + SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline + SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft + SetMass(float _kg)XPMP2::Aircraftinline + SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline + SetNoseWheelAngle(float _f)XPMP2::Aircraftinline + SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft + SetPitch(float _deg)XPMP2::Aircraftinline + SetPropRotAngle(float _deg)XPMP2::Aircraftinline + SetPropRotRad(float _rad)XPMP2::Aircraftinline + SetPropRotRpm(float _rpm)XPMP2::Aircraftinline + SetRender(bool _bRender)XPMP2::Aircraftvirtual + SetReversDeployRatio(float _f)XPMP2::Aircraftinline + SetRoll(float _deg)XPMP2::Aircraftinline + SetSlatRatio(float _f)XPMP2::Aircraftinline + SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline + SetSpoilerRatio(float _f)XPMP2::Aircraftinline + SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual + SetThrustRatio(float _f)XPMP2::Aircraftinline + SetThrustReversRatio(float _f)XPMP2::Aircraftinline + SetTireDeflection(float _mtr)XPMP2::Aircraftinline + SetTireRotAngle(float _deg)XPMP2::Aircraftinline + SetTireRotRad(float _rad)XPMP2::Aircraftinline + SetTireRotRpm(float _rpm)XPMP2::Aircraftinline + SetTouchDown(bool _b)XPMP2::Aircraftinline + SetVisible(bool _bVisible)XPMP2::Aircraftvirtual + SetWingArea(float _m2)XPMP2::Aircraftinline + SetWingSpan(float _m)XPMP2::Aircraftinline + SetWingSweepRatio(float _f)XPMP2::Aircraftinline + SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline + SetYokePitchRatio(float _f)XPMP2::Aircraftinline + SetYokeRollRatio(float _f)XPMP2::Aircraftinline + ShallDrawLabel() constXPMP2::Aircraftinline + ShowAsAIPlane() constXPMP2::Aircraftinline + skipCounterXPMP2::Aircraftprotected + SND_ENG enum valueXPMP2::Aircraft + SND_FLAPS enum valueXPMP2::Aircraft + SND_GEAR enum valueXPMP2::Aircraft + SND_NUM_EVENTS enum valueXPMP2::Aircraft + SND_REVERSE_THRUST enum valueXPMP2::Aircraft + SND_TIRE enum valueXPMP2::Aircraft + sndMinDistXPMP2::Aircraft + SoundEventsTy enum nameXPMP2::Aircraft + SoundGetName(SoundEventsTy sndEvent, float &volAdj) constXPMP2::Aircraftvirtual + SoundMuteAll(bool bMute)XPMP2::Aircraft + SoundPlay(const std::string &sndName, float vol=1.0f)XPMP2::Aircraft + SoundRemoveAll()XPMP2::Aircraftprotectedvirtual + SoundSetup()XPMP2::Aircraftprotectedvirtual + SoundStop(FMOD_CHANNEL *pChn)XPMP2::Aircraft + SoundUpdate()XPMP2::Aircraftprotectedvirtual + SoundVolume(FMOD_CHANNEL *pChn, float vol)XPMP2::Aircraft tcasTargetIdxXPMP2::Aircraftprotected tsResetTouchDownXPMP2::Aircraftprotected UpdateDistBearingCamera(const XPLMCameraPosition_t &posCam)XPMP2::Aircraftprotected UpdatePosition(float _elapsedSinceLastCall, int _flCounter)XPCAircraftvirtual vXPMP2::Aircraft - vertOfsRatioXPMP2::Aircraft - wakeXPMP2::Aircraft - WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft - XPCAircraft(const char *_icaoType, const char *_icaoAirline, const char *_livery, XPMPPlaneID _modeS_id=0, const char *_modelId=nullptr)XPCAircraft - ~Aircraft()XPMP2::Aircraftvirtual + v_xXPMP2::Aircraftprotected + v_yXPMP2::Aircraftprotected + v_zXPMP2::Aircraftprotected + vertOfsRatioXPMP2::Aircraft + wakeXPMP2::Aircraft + WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft + XPCAircraft(const char *_icaoType, const char *_icaoAirline, const char *_livery, XPMPPlaneID _modeS_id=0, const char *_modelId=nullptr)XPCAircraft + ~Aircraft()XPMP2::Aircraftvirtual
diff --git a/docs/html/classLegacySampleAircraft.html b/docs/html/classLegacySampleAircraft.html index d1fdeef3..65278131 100644 --- a/docs/html/classLegacySampleAircraft.html +++ b/docs/html/classLegacySampleAircraft.html @@ -106,7 +106,7 @@  Creates a plane, only a valid operation if object was created using the default constructor. More...
  XPMPPlaneID GetModeS_ID () const - return the XPMP2 plane id More...
+ return the XPMP2 plane id More...
  bool IsGroundVehicle () const  Is this object a ground vehicle? More...
@@ -228,6 +228,9 @@ void SetRoll (float _deg)  roll [degree] More...
  +float GetGS_kn () const + Rough estimate of a ground speed based on v_x/z More...
+  float GetGearRatio () const  Gear deploy ratio. More...
  @@ -450,7 +453,7 @@  Angle of Attach, returns pitch (but you can override in your class) More...
  virtual float GetLift () const - Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
+ Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
  void MapFindIcon ()  Determine which map icon to use for this aircraft. More...
@@ -464,9 +467,40 @@ void MapDrawLabel (XPLMMapLayerID inLayer, float yOfs)  Actually draw the map label. More...
  +FMOD_CHANNEL * SoundPlay (const std::string &sndName, float vol=1.0f) + Play a sound; a looping sound plays until explicitely stopped. More...
+  +void SoundStop (FMOD_CHANNEL *pChn) + Stop a continuously playing sound. More...
+  +void SoundVolume (FMOD_CHANNEL *pChn, float vol) + Sets the sound's volume (after applying master volume and Sound File's adjustments) More...
+  +void SoundMuteAll (bool bMute) + Mute/Unmute all sounds of the airplane temporarily. More...
+  +virtual std::string SoundGetName (SoundEventsTy sndEvent, float &volAdj) const + Returns the name of the sound to play per event. More...
+  + + + + + + + @@ -523,6 +557,9 @@ + + + @@ -545,6 +582,15 @@ + + + + + + + + + @@ -580,8 +626,17 @@ + + + + + + + + + - + @@ -616,6 +671,21 @@ + + + + + + + + + + + + + + +

Additional Inherited Members

- Public Types inherited from XPMP2::Aircraft
enum  SoundEventsTy {
+  SND_ENG = 0 +, SND_REVERSE_THRUST +, SND_TIRE +, SND_GEAR +,
+  SND_FLAPS +, SND_NUM_EVENTS +
+ }
 Types of sound supported directly by XPMP2. More...
 
typedef std::list< FMOD_CHANNEL * > ChnListTy
 List of FMOD channels, also beyond sounds created for SoundEvetsTy. More...
 
- Public Attributes inherited from XPCAircraft
XPMPPlanePosition_t acPos
 Last position data. GetPlanePosition() passes a pointer to this member variable. More...
XPMPInfoTexts_t acInfoTexts
 Informational texts passed on via multiplayer shared dataRefs. More...
 
int sndMinDist = 50.0
 Minimum distance in [m] to play sound in full volume, the larger the 'louder' the aircraft. More...
 
- Protected Member Functions inherited from XPMP2::Aircraft
void DoMove ()
 Internal: This puts the instance into XP's sky and makes it move. More...
virtual void SetTcasTargetIdx (int _idx)
 Define the TCAS target index in use. More...
 
virtual void SoundSetup ()
 Sound-related initializations, called by Create() and ChangeModel() More...
 
virtual void SoundUpdate ()
 Update sound, like position and volume, called once per frame. More...
 
virtual void SoundRemoveAll ()
 Remove all sound, e.g. during destruction. More...
 
- Static Protected Member Functions inherited from XPMP2::Aircraft
static float FlightLoopCB (float, float, int, void *)
 Internal: Flight loop callback function controlling update and movement of all planes. More...
float prev_ts = 0.0f
 last update of prev_x/y/z in XP's network time More...
 
float v_x = 0.0f
 
float v_y = 0.0f
 
float v_z = 0.0f
 Cartesian velocity in m/s per axis. More...
 
float gs_kn = 0.0f
 
float tsResetTouchDown = NAN
 Set by SetOnGrnd() with the timestamp when to reset SetTouchDown() More...
 ground speed in [kn] based on above v_x/z More...
 
std::list< XPLMInstanceRef > listInst
 X-Plane instance handles for all objects making up the model. More...
std::string mapLabel
 label for map drawing More...
 
SndChTy aSndCh [SND_NUM_EVENTS]
 Operational values per sound channel, that is triggered by a standard sound event. More...
 
bool bChnLowPass = false
 Is Low Pass Filter currently being active? More...
 
bool bChnMuted = false
 Is sound for this aircraft currently muted? More...
 
ChnListTy chnList
 List of channels produced via calls to SoundPlay() More...
 
int skipCounter = 0
 Counts how often we skipped expensive computations. More...
 

Detailed Description

Subclassing XPCAircraft to create our own class.

diff --git a/docs/html/classRemoteAC-members.html b/docs/html/classRemoteAC-members.html index 58969479..24b4e457 100644 --- a/docs/html/classRemoteAC-members.html +++ b/docs/html/classRemoteAC-members.html @@ -57,44 +57,50 @@ Aircraft()XPMP2::Aircraft Aircraft(const Aircraft &)=deleteXPMP2::Aircraft alt_ftRemoteACprotected - AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft - bClampToGroundXPMP2::Aircraft - bCSLModelChangedRemoteACprotected - bDeleteMeRemoteACprotected - bDrawLabelXPMP2::Aircraft - bOnGrndXPMP2::Aircraft - bRenderXPMP2::Aircraftprotected - bValidXPMP2::Aircraftprotected - bVisibleXPMP2::Aircraftprotected - bWorldCoordUpdatedRemoteACprotected - camBearingXPMP2::Aircraftprotected - camDistXPMP2::Aircraftprotected - camTimLstUpdXPMP2::Aircraftprotected - ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft - ClampToGround()XPMP2::Aircraftprotected - colLabelXPMP2::Aircraft - ComputeMapLabel()XPMP2::Aircraftprotectedvirtual - Create()RemoteAC - XPMP2::Aircraft::Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft - CreateInstances()XPMP2::Aircraftprotected - DestroyInstances()XPMP2::Aircraftprotected - diffTimeRemoteACprotected - DoMove()XPMP2::Aircraftprotected - drawInfoXPMP2::Aircraft - FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic - gearDeflectRatioXPMP2::Aircraft - GetAoA() constXPMP2::Aircraftinlinevirtual - GetCameraBearing() constXPMP2::Aircraftinline - GetCameraDist() constXPMP2::Aircraftinline - GetEngineRotAngle() constXPMP2::Aircraftinline - GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline - GetEngineRotRad() constXPMP2::Aircraftinline - GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline - GetEngineRotRpm() constXPMP2::Aircraftinline - GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline - GetFlapRatio() constXPMP2::Aircraftinline - GetFlightId() constXPMP2::Aircraftvirtual - GetGearRatio() constXPMP2::Aircraftinline + aSndChXPMP2::Aircraftprotected + AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft + bChnLowPassXPMP2::Aircraftprotected + bChnMutedXPMP2::Aircraftprotected + bClampToGroundXPMP2::Aircraft + bCSLModelChangedRemoteACprotected + bDeleteMeRemoteACprotected + bDrawLabelXPMP2::Aircraft + bOnGrndXPMP2::Aircraft + bRenderXPMP2::Aircraftprotected + bValidXPMP2::Aircraftprotected + bVisibleXPMP2::Aircraftprotected + bWorldCoordUpdatedRemoteACprotected + camBearingXPMP2::Aircraftprotected + camDistXPMP2::Aircraftprotected + camTimLstUpdXPMP2::Aircraftprotected + ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft + chnListXPMP2::Aircraftprotected + ChnListTy typedefXPMP2::Aircraft + ClampToGround()XPMP2::Aircraftprotected + colLabelXPMP2::Aircraft + ComputeMapLabel()XPMP2::Aircraftprotectedvirtual + Create()RemoteAC + XPMP2::Aircraft::Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft + CreateInstances()XPMP2::Aircraftprotected + DestroyInstances()XPMP2::Aircraftprotected + diffTimeRemoteACprotected + DoMove()XPMP2::Aircraftprotected + drawInfoXPMP2::Aircraft + FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic + gearDeflectRatioXPMP2::Aircraft + GetAoA() constXPMP2::Aircraftinlinevirtual + GetCameraBearing() constXPMP2::Aircraftinline + GetCameraDist() constXPMP2::Aircraftinline + GetEngineRotAngle() constXPMP2::Aircraftinline + GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline + GetEngineRotRad() constXPMP2::Aircraftinline + GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline + GetEngineRotRpm() constXPMP2::Aircraftinline + GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline + GetFlapRatio() constXPMP2::Aircraftinline + GetFlightId() constXPMP2::Aircraftvirtual + GetGearRatio() constXPMP2::Aircraftinline + GetGS_kn() constXPMP2::Aircraftinline GetHeading() constXPMP2::Aircraftinline GetLift() constXPMP2::Aircraftinlinevirtual GetLightsBeacon() constXPMP2::Aircraftinline @@ -137,97 +143,115 @@ GetYokeHeadingRatio() constXPMP2::Aircraftinline GetYokePitchRatio() constXPMP2::Aircraftinline GetYokeRollRatio() constXPMP2::Aircraftinline - histPosRemoteACprotected - histTsRemoteACprotected - hProbeXPMP2::Aircraftprotected - IsCurrentlyShownAsAI() constXPMP2::Aircraft - IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline - IsGroundVehicle() constXPMP2::Aircraft - IsInstanciated() constXPMP2::Aircraftinline - IsOnGrnd() constXPMP2::Aircraftinline - IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft - IsRendered() constXPMP2::Aircraftinline - IsToBeDeleted() constRemoteACinline - IsValid() constXPMP2::Aircraftinline - IsVisible() constXPMP2::Aircraftinline - labelXPMP2::Aircraft - latRemoteACprotected - listInstXPMP2::Aircraftprotected - lonRemoteACprotected - MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft - MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft - MapFindIcon()XPMP2::Aircraft - mapIconColXPMP2::Aircraftprotected - mapIconRowXPMP2::Aircraftprotected - mapLabelXPMP2::Aircraftprotected - MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft - mapXXPMP2::Aircraftprotected - mapYXPMP2::Aircraftprotected - MarkForDeletion()RemoteACinline - matchQualityXPMP2::Aircraftprotected - modeS_idXPMP2::Aircraftprotected - operator=(const Aircraft &)=deleteXPMP2::Aircraft - pCSLMdlXPMP2::Aircraftprotected - pkgHashRemoteACprotected - prev_tsXPMP2::Aircraftprotected - prev_xXPMP2::Aircraftprotected - prev_yXPMP2::Aircraftprotected - prev_zXPMP2::Aircraftprotected - ReMatchModel()XPMP2::Aircraftinline - RemoteAC(SenderTy &_sender, const XPMP2::RemoteAcDetailTy &_acDetails)RemoteAC - ResetTcasTargetIdx()XPMP2::Aircraftinline - senderRemoteACprotected - senderIdRemoteACprotected - SetDrawLabel(bool _b)XPMP2::Aircraftinline - SetEngineRotAngle(float _deg)XPMP2::Aircraft - SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft - SetEngineRotRad(float _rad)XPMP2::Aircraft - SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft - SetEngineRotRpm(float _rpm)XPMP2::Aircraft - SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft - SetFlapRatio(float _f)XPMP2::Aircraftinline - SetGearRatio(float _f)XPMP2::Aircraftinline - SetHeading(float _deg)XPMP2::Aircraftinline - SetInvalid()XPMP2::Aircraftvirtual - SetLightsBeacon(bool _b)XPMP2::Aircraftinline - SetLightsLanding(bool _b)XPMP2::Aircraftinline - SetLightsNav(bool _b)XPMP2::Aircraftinline - SetLightsStrobe(bool _b)XPMP2::Aircraftinline - SetLightsTaxi(bool _b)XPMP2::Aircraftinline - SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline - SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline - SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft - SetMass(float _kg)XPMP2::Aircraftinline - SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline - SetNoseWheelAngle(float _f)XPMP2::Aircraftinline - SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft - SetPitch(float _deg)XPMP2::Aircraftinline - SetPropRotAngle(float _deg)XPMP2::Aircraftinline - SetPropRotRad(float _rad)XPMP2::Aircraftinline - SetPropRotRpm(float _rpm)XPMP2::Aircraftinline - SetRender(bool _bRender)XPMP2::Aircraftvirtual - SetReversDeployRatio(float _f)XPMP2::Aircraftinline - SetRoll(float _deg)XPMP2::Aircraftinline - SetSlatRatio(float _f)XPMP2::Aircraftinline - SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline - SetSpoilerRatio(float _f)XPMP2::Aircraftinline - SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual - SetThrustRatio(float _f)XPMP2::Aircraftinline - SetThrustReversRatio(float _f)XPMP2::Aircraftinline - SetTireDeflection(float _mtr)XPMP2::Aircraftinline - SetTireRotAngle(float _deg)XPMP2::Aircraftinline - SetTireRotRad(float _rad)XPMP2::Aircraftinline - SetTireRotRpm(float _rpm)XPMP2::Aircraftinline - SetTouchDown(bool _b)XPMP2::Aircraftinline - SetVisible(bool _bVisible)XPMP2::Aircraftvirtual - SetWingArea(float _m2)XPMP2::Aircraftinline - SetWingSpan(float _m)XPMP2::Aircraftinline - SetWingSweepRatio(float _f)XPMP2::Aircraftinline - SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline - SetYokePitchRatio(float _f)XPMP2::Aircraftinline - SetYokeRollRatio(float _f)XPMP2::Aircraftinline - ShallDrawLabel() constXPMP2::Aircraftinline - ShowAsAIPlane() constXPMP2::Aircraftinline + gs_knXPMP2::Aircraftprotected + histPosRemoteACprotected + histTsRemoteACprotected + hProbeXPMP2::Aircraftprotected + IsCurrentlyShownAsAI() constXPMP2::Aircraft + IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline + IsGroundVehicle() constXPMP2::Aircraft + IsInstanciated() constXPMP2::Aircraftinline + IsOnGrnd() constXPMP2::Aircraftinline + IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft + IsRendered() constXPMP2::Aircraftinline + IsToBeDeleted() constRemoteACinline + IsValid() constXPMP2::Aircraftinline + IsVisible() constXPMP2::Aircraftinline + labelXPMP2::Aircraft + latRemoteACprotected + listInstXPMP2::Aircraftprotected + lonRemoteACprotected + MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft + MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft + MapFindIcon()XPMP2::Aircraft + mapIconColXPMP2::Aircraftprotected + mapIconRowXPMP2::Aircraftprotected + mapLabelXPMP2::Aircraftprotected + MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft + mapXXPMP2::Aircraftprotected + mapYXPMP2::Aircraftprotected + MarkForDeletion()RemoteACinline + matchQualityXPMP2::Aircraftprotected + modeS_idXPMP2::Aircraftprotected + operator=(const Aircraft &)=deleteXPMP2::Aircraft + pCSLMdlXPMP2::Aircraftprotected + pkgHashRemoteACprotected + prev_tsXPMP2::Aircraftprotected + prev_xXPMP2::Aircraftprotected + prev_yXPMP2::Aircraftprotected + prev_zXPMP2::Aircraftprotected + ReMatchModel()XPMP2::Aircraftinline + RemoteAC(SenderTy &_sender, const XPMP2::RemoteAcDetailTy &_acDetails)RemoteAC + ResetTcasTargetIdx()XPMP2::Aircraftinline + senderRemoteACprotected + senderIdRemoteACprotected + SetDrawLabel(bool _b)XPMP2::Aircraftinline + SetEngineRotAngle(float _deg)XPMP2::Aircraft + SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft + SetEngineRotRad(float _rad)XPMP2::Aircraft + SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft + SetEngineRotRpm(float _rpm)XPMP2::Aircraft + SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft + SetFlapRatio(float _f)XPMP2::Aircraftinline + SetGearRatio(float _f)XPMP2::Aircraftinline + SetHeading(float _deg)XPMP2::Aircraftinline + SetInvalid()XPMP2::Aircraftvirtual + SetLightsBeacon(bool _b)XPMP2::Aircraftinline + SetLightsLanding(bool _b)XPMP2::Aircraftinline + SetLightsNav(bool _b)XPMP2::Aircraftinline + SetLightsStrobe(bool _b)XPMP2::Aircraftinline + SetLightsTaxi(bool _b)XPMP2::Aircraftinline + SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline + SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline + SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft + SetMass(float _kg)XPMP2::Aircraftinline + SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline + SetNoseWheelAngle(float _f)XPMP2::Aircraftinline + SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft + SetPitch(float _deg)XPMP2::Aircraftinline + SetPropRotAngle(float _deg)XPMP2::Aircraftinline + SetPropRotRad(float _rad)XPMP2::Aircraftinline + SetPropRotRpm(float _rpm)XPMP2::Aircraftinline + SetRender(bool _bRender)XPMP2::Aircraftvirtual + SetReversDeployRatio(float _f)XPMP2::Aircraftinline + SetRoll(float _deg)XPMP2::Aircraftinline + SetSlatRatio(float _f)XPMP2::Aircraftinline + SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline + SetSpoilerRatio(float _f)XPMP2::Aircraftinline + SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual + SetThrustRatio(float _f)XPMP2::Aircraftinline + SetThrustReversRatio(float _f)XPMP2::Aircraftinline + SetTireDeflection(float _mtr)XPMP2::Aircraftinline + SetTireRotAngle(float _deg)XPMP2::Aircraftinline + SetTireRotRad(float _rad)XPMP2::Aircraftinline + SetTireRotRpm(float _rpm)XPMP2::Aircraftinline + SetTouchDown(bool _b)XPMP2::Aircraftinline + SetVisible(bool _bVisible)XPMP2::Aircraftvirtual + SetWingArea(float _m2)XPMP2::Aircraftinline + SetWingSpan(float _m)XPMP2::Aircraftinline + SetWingSweepRatio(float _f)XPMP2::Aircraftinline + SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline + SetYokePitchRatio(float _f)XPMP2::Aircraftinline + SetYokeRollRatio(float _f)XPMP2::Aircraftinline + ShallDrawLabel() constXPMP2::Aircraftinline + ShowAsAIPlane() constXPMP2::Aircraftinline + skipCounterXPMP2::Aircraftprotected + SND_ENG enum valueXPMP2::Aircraft + SND_FLAPS enum valueXPMP2::Aircraft + SND_GEAR enum valueXPMP2::Aircraft + SND_NUM_EVENTS enum valueXPMP2::Aircraft + SND_REVERSE_THRUST enum valueXPMP2::Aircraft + SND_TIRE enum valueXPMP2::Aircraft + sndMinDistXPMP2::Aircraft + SoundEventsTy enum nameXPMP2::Aircraft + SoundGetName(SoundEventsTy sndEvent, float &volAdj) constXPMP2::Aircraftvirtual + SoundMuteAll(bool bMute)XPMP2::Aircraft + SoundPlay(const std::string &sndName, float vol=1.0f)XPMP2::Aircraft + SoundRemoveAll()XPMP2::Aircraftprotectedvirtual + SoundSetup()XPMP2::Aircraftprotectedvirtual + SoundStop(FMOD_CHANNEL *pChn)XPMP2::Aircraft + SoundUpdate()XPMP2::Aircraftprotectedvirtual + SoundVolume(FMOD_CHANNEL *pChn, float vol)XPMP2::Aircraft sShortIdRemoteACprotected tcasTargetIdxXPMP2::Aircraftprotected tsResetTouchDownXPMP2::Aircraftprotected @@ -237,11 +261,14 @@ UpdateDistBearingCamera(const XPLMCameraPosition_t &posCam)XPMP2::Aircraftprotected UpdatePosition(float, int) overrideRemoteACvirtual vXPMP2::Aircraft - vertOfsRatioXPMP2::Aircraft - wakeXPMP2::Aircraft - WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft - ~Aircraft()XPMP2::Aircraftvirtual - ~RemoteAC()RemoteACvirtual + v_xXPMP2::Aircraftprotected + v_yXPMP2::Aircraftprotected + v_zXPMP2::Aircraftprotected + vertOfsRatioXPMP2::Aircraft + wakeXPMP2::Aircraft + WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft + ~Aircraft()XPMP2::Aircraftvirtual + ~RemoteAC()RemoteACvirtual
diff --git a/docs/html/classRemoteAC.html b/docs/html/classRemoteAC.html index 34b3a4cd..87afdb14 100644 --- a/docs/html/classRemoteAC.html +++ b/docs/html/classRemoteAC.html @@ -85,7 +85,7 @@  Update data from an a/c animation dataRefs message. More...
  void UpdatePosition (float, int) override - Called by XPMP2 for position updates, extrapolates from historic positions. More...
+ Called by XPMP2 for position updates, extrapolates from historic positions. More...
  void MarkForDeletion ()  Mark this aircraft as to-be-deleted in the next flight loop (can't do in worker thread) More...
@@ -113,7 +113,7 @@  Creates a plane, only a valid operation if object was created using the default constructor. More...
  XPMPPlaneID GetModeS_ID () const - return the XPMP2 plane id More...
+ return the XPMP2 plane id More...
  bool IsGroundVehicle () const  Is this object a ground vehicle? More...
@@ -235,6 +235,9 @@ void SetRoll (float _deg)  roll [degree] More...
  +float GetGS_kn () const + Rough estimate of a ground speed based on v_x/z More...
+  float GetGearRatio () const  Gear deploy ratio. More...
  @@ -457,7 +460,7 @@  Angle of Attach, returns pitch (but you can override in your class) More...
  virtual float GetLift () const - Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
+ Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
  void MapFindIcon ()  Determine which map icon to use for this aircraft. More...
@@ -471,6 +474,21 @@ void MapDrawLabel (XPLMMapLayerID inLayer, float yOfs)  Actually draw the map label. More...
  +FMOD_CHANNEL * SoundPlay (const std::string &sndName, float vol=1.0f) + Play a sound; a looping sound plays until explicitely stopped. More...
+  +void SoundStop (FMOD_CHANNEL *pChn) + Stop a continuously playing sound. More...
+  +void SoundVolume (FMOD_CHANNEL *pChn, float vol) + Sets the sound's volume (after applying master volume and Sound File's adjustments) More...
+  +void SoundMuteAll (bool bMute) + Mute/Unmute all sounds of the airplane temporarily. More...
+  +virtual std::string SoundGetName (SoundEventsTy sndEvent, float &volAdj) const + Returns the name of the sound to play per event. More...
+  @@ -542,8 +560,17 @@ + + + + + + + + + - + @@ -578,9 +605,40 @@ + + + + + + + + + + + + + + +

Protected Attributes

float prev_ts = 0.0f
 last update of prev_x/y/z in XP's network time More...
 
float v_x = 0.0f
 
float v_y = 0.0f
 
float v_z = 0.0f
 Cartesian velocity in m/s per axis. More...
 
float gs_kn = 0.0f
 
float tsResetTouchDown = NAN
 Set by SetOnGrnd() with the timestamp when to reset SetTouchDown() More...
 ground speed in [kn] based on above v_x/z More...
 
std::list< XPLMInstanceRef > listInst
 X-Plane instance handles for all objects making up the model. More...
std::string mapLabel
 label for map drawing More...
 
SndChTy aSndCh [SND_NUM_EVENTS]
 Operational values per sound channel, that is triggered by a standard sound event. More...
 
bool bChnLowPass = false
 Is Low Pass Filter currently being active? More...
 
bool bChnMuted = false
 Is sound for this aircraft currently muted? More...
 
ChnListTy chnList
 List of channels produced via calls to SoundPlay() More...
 
int skipCounter = 0
 Counts how often we skipped expensive computations. More...
 
+ + + + + + + @@ -630,6 +688,9 @@ + + + @@ -652,6 +713,15 @@ + + + + + + + + + @@ -885,7 +955,7 @@

-

Called by XPMP2 for position updates, extrapolates from historic positions.

+

Called by XPMP2 for position updates, extrapolates from historic positions.

Implements XPMP2::Aircraft.

diff --git a/docs/html/classSampleAircraft-members.html b/docs/html/classSampleAircraft-members.html index c3b3044f..fa83c638 100644 --- a/docs/html/classSampleAircraft-members.html +++ b/docs/html/classSampleAircraft-members.html @@ -56,39 +56,45 @@

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -131,97 +137,118 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + + + +

Additional Inherited Members

- Public Types inherited from XPMP2::Aircraft
enum  SoundEventsTy {
+  SND_ENG = 0 +, SND_REVERSE_THRUST +, SND_TIRE +, SND_GEAR +,
+  SND_FLAPS +, SND_NUM_EVENTS +
+ }
 Types of sound supported directly by XPMP2. More...
 
typedef std::list< FMOD_CHANNEL * > ChnListTy
 List of FMOD channels, also beyond sounds created for SoundEvetsTy. More...
 
- Public Attributes inherited from XPMP2::Aircraft
std::string acIcaoType
 ICAO aircraft type designator of this plane. More...
XPMPInfoTexts_t acInfoTexts
 Informational texts passed on via multiplayer shared dataRefs. More...
 
int sndMinDist = 50.0
 Minimum distance in [m] to play sound in full volume, the larger the 'louder' the aircraft. More...
 
- Protected Member Functions inherited from XPMP2::Aircraft
void DoMove ()
 Internal: This puts the instance into XP's sky and makes it move. More...
virtual void SetTcasTargetIdx (int _idx)
 Define the TCAS target index in use. More...
 
virtual void SoundSetup ()
 Sound-related initializations, called by Create() and ChangeModel() More...
 
virtual void SoundUpdate ()
 Update sound, like position and volume, called once per frame. More...
 
virtual void SoundRemoveAll ()
 Remove all sound, e.g. during destruction. More...
 
- Static Protected Member Functions inherited from XPMP2::Aircraft
static float FlightLoopCB (float, float, int, void *)
 Internal: Flight loop callback function controlling update and movement of all planes. More...
Aircraft(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="")XPMP2::Aircraft
Aircraft()XPMP2::Aircraft
Aircraft(const Aircraft &)=deleteXPMP2::Aircraft
AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft
bClampToGroundXPMP2::Aircraft
bDrawLabelXPMP2::Aircraft
bOnGrndXPMP2::Aircraft
bRenderXPMP2::Aircraftprotected
bValidXPMP2::Aircraftprotected
bVisibleXPMP2::Aircraftprotected
camBearingXPMP2::Aircraftprotected
camDistXPMP2::Aircraftprotected
camTimLstUpdXPMP2::Aircraftprotected
ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft
ClampToGround()XPMP2::Aircraftprotected
colLabelXPMP2::Aircraft
ComputeMapLabel()XPMP2::Aircraftprotectedvirtual
Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft
CreateInstances()XPMP2::Aircraftprotected
DestroyInstances()XPMP2::Aircraftprotected
DoMove()XPMP2::Aircraftprotected
drawInfoXPMP2::Aircraft
FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic
gearDeflectRatioXPMP2::Aircraft
GetAoA() constXPMP2::Aircraftinlinevirtual
GetCameraBearing() constXPMP2::Aircraftinline
GetCameraDist() constXPMP2::Aircraftinline
GetEngineRotAngle() constXPMP2::Aircraftinline
GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline
GetEngineRotRad() constXPMP2::Aircraftinline
GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline
GetEngineRotRpm() constXPMP2::Aircraftinline
GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline
GetFlapRatio() constXPMP2::Aircraftinline
GetFlightId() constXPMP2::Aircraftvirtual
GetGearRatio() constXPMP2::Aircraftinline
aSndChXPMP2::Aircraftprotected
AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft
bChnLowPassXPMP2::Aircraftprotected
bChnMutedXPMP2::Aircraftprotected
bClampToGroundXPMP2::Aircraft
bDrawLabelXPMP2::Aircraft
bOnGrndXPMP2::Aircraft
bRenderXPMP2::Aircraftprotected
bValidXPMP2::Aircraftprotected
bVisibleXPMP2::Aircraftprotected
camBearingXPMP2::Aircraftprotected
camDistXPMP2::Aircraftprotected
camTimLstUpdXPMP2::Aircraftprotected
ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft
chnListXPMP2::Aircraftprotected
ChnListTy typedefXPMP2::Aircraft
ClampToGround()XPMP2::Aircraftprotected
colLabelXPMP2::Aircraft
ComputeMapLabel()XPMP2::Aircraftprotectedvirtual
Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft
CreateInstances()XPMP2::Aircraftprotected
DestroyInstances()XPMP2::Aircraftprotected
DoMove()XPMP2::Aircraftprotected
drawInfoXPMP2::Aircraft
FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic
gearDeflectRatioXPMP2::Aircraft
GetAoA() constXPMP2::Aircraftinlinevirtual
GetCameraBearing() constXPMP2::Aircraftinline
GetCameraDist() constXPMP2::Aircraftinline
GetEngineRotAngle() constXPMP2::Aircraftinline
GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline
GetEngineRotRad() constXPMP2::Aircraftinline
GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline
GetEngineRotRpm() constXPMP2::Aircraftinline
GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline
GetFlapRatio() constXPMP2::Aircraftinline
GetFlightId() constXPMP2::Aircraftvirtual
GetGearRatio() constXPMP2::Aircraftinline
GetGS_kn() constXPMP2::Aircraftinline
GetHeading() constXPMP2::Aircraftinline
GetLift() constXPMP2::Aircraftinlinevirtual
GetLightsBeacon() constXPMP2::Aircraftinline
GetYokeHeadingRatio() constXPMP2::Aircraftinline
GetYokePitchRatio() constXPMP2::Aircraftinline
GetYokeRollRatio() constXPMP2::Aircraftinline
hProbeXPMP2::Aircraftprotected
IsCurrentlyShownAsAI() constXPMP2::Aircraft
IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline
IsGroundVehicle() constXPMP2::Aircraft
IsInstanciated() constXPMP2::Aircraftinline
IsOnGrnd() constXPMP2::Aircraftinline
IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft
IsRendered() constXPMP2::Aircraftinline
IsValid() constXPMP2::Aircraftinline
IsVisible() constXPMP2::Aircraftinline
labelXPMP2::Aircraft
listInstXPMP2::Aircraftprotected
MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft
MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft
MapFindIcon()XPMP2::Aircraft
mapIconColXPMP2::Aircraftprotected
mapIconRowXPMP2::Aircraftprotected
mapLabelXPMP2::Aircraftprotected
MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft
mapXXPMP2::Aircraftprotected
mapYXPMP2::Aircraftprotected
matchQualityXPMP2::Aircraftprotected
modeS_idXPMP2::Aircraftprotected
operator=(const Aircraft &)=deleteXPMP2::Aircraft
pCSLMdlXPMP2::Aircraftprotected
prev_tsXPMP2::Aircraftprotected
prev_xXPMP2::Aircraftprotected
prev_yXPMP2::Aircraftprotected
prev_zXPMP2::Aircraftprotected
ReMatchModel()XPMP2::Aircraftinline
ResetTcasTargetIdx()XPMP2::Aircraftinline
SampleAircraft(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="")SampleAircraftinline
SetDrawLabel(bool _b)XPMP2::Aircraftinline
SetEngineRotAngle(float _deg)XPMP2::Aircraft
SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft
SetEngineRotRad(float _rad)XPMP2::Aircraft
SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft
SetEngineRotRpm(float _rpm)XPMP2::Aircraft
SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft
SetFlapRatio(float _f)XPMP2::Aircraftinline
SetGearRatio(float _f)XPMP2::Aircraftinline
SetHeading(float _deg)XPMP2::Aircraftinline
SetInvalid()XPMP2::Aircraftvirtual
SetLightsBeacon(bool _b)XPMP2::Aircraftinline
SetLightsLanding(bool _b)XPMP2::Aircraftinline
SetLightsNav(bool _b)XPMP2::Aircraftinline
SetLightsStrobe(bool _b)XPMP2::Aircraftinline
SetLightsTaxi(bool _b)XPMP2::Aircraftinline
SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline
SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline
SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft
SetMass(float _kg)XPMP2::Aircraftinline
SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline
SetNoseWheelAngle(float _f)XPMP2::Aircraftinline
SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft
SetPitch(float _deg)XPMP2::Aircraftinline
SetPropRotAngle(float _deg)XPMP2::Aircraftinline
SetPropRotRad(float _rad)XPMP2::Aircraftinline
SetPropRotRpm(float _rpm)XPMP2::Aircraftinline
SetRender(bool _bRender)XPMP2::Aircraftvirtual
SetReversDeployRatio(float _f)XPMP2::Aircraftinline
SetRoll(float _deg)XPMP2::Aircraftinline
SetSlatRatio(float _f)XPMP2::Aircraftinline
SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline
SetSpoilerRatio(float _f)XPMP2::Aircraftinline
SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual
SetThrustRatio(float _f)XPMP2::Aircraftinline
SetThrustReversRatio(float _f)XPMP2::Aircraftinline
SetTireDeflection(float _mtr)XPMP2::Aircraftinline
SetTireRotAngle(float _deg)XPMP2::Aircraftinline
SetTireRotRad(float _rad)XPMP2::Aircraftinline
SetTireRotRpm(float _rpm)XPMP2::Aircraftinline
SetTouchDown(bool _b)XPMP2::Aircraftinline
SetVisible(bool _bVisible)XPMP2::Aircraftvirtual
SetWingArea(float _m2)XPMP2::Aircraftinline
SetWingSpan(float _m)XPMP2::Aircraftinline
SetWingSweepRatio(float _f)XPMP2::Aircraftinline
SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline
SetYokePitchRatio(float _f)XPMP2::Aircraftinline
SetYokeRollRatio(float _f)XPMP2::Aircraftinline
ShallDrawLabel() constXPMP2::Aircraftinline
ShowAsAIPlane() constXPMP2::Aircraftinline
gs_knXPMP2::Aircraftprotected
hProbeXPMP2::Aircraftprotected
IsCurrentlyShownAsAI() constXPMP2::Aircraft
IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline
IsGroundVehicle() constXPMP2::Aircraft
IsInstanciated() constXPMP2::Aircraftinline
IsOnGrnd() constXPMP2::Aircraftinline
IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft
IsRendered() constXPMP2::Aircraftinline
IsValid() constXPMP2::Aircraftinline
IsVisible() constXPMP2::Aircraftinline
labelXPMP2::Aircraft
listInstXPMP2::Aircraftprotected
MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft
MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft
MapFindIcon()XPMP2::Aircraft
mapIconColXPMP2::Aircraftprotected
mapIconRowXPMP2::Aircraftprotected
mapLabelXPMP2::Aircraftprotected
MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft
mapXXPMP2::Aircraftprotected
mapYXPMP2::Aircraftprotected
matchQualityXPMP2::Aircraftprotected
modeS_idXPMP2::Aircraftprotected
operator=(const Aircraft &)=deleteXPMP2::Aircraft
pCSLMdlXPMP2::Aircraftprotected
prev_tsXPMP2::Aircraftprotected
prev_xXPMP2::Aircraftprotected
prev_yXPMP2::Aircraftprotected
prev_zXPMP2::Aircraftprotected
ReMatchModel()XPMP2::Aircraftinline
ResetTcasTargetIdx()XPMP2::Aircraftinline
SampleAircraft(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="")SampleAircraftinline
SetDrawLabel(bool _b)XPMP2::Aircraftinline
SetEngineRotAngle(float _deg)XPMP2::Aircraft
SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft
SetEngineRotRad(float _rad)XPMP2::Aircraft
SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft
SetEngineRotRpm(float _rpm)XPMP2::Aircraft
SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft
SetFlapRatio(float _f)XPMP2::Aircraftinline
SetGearRatio(float _f)XPMP2::Aircraftinline
SetHeading(float _deg)XPMP2::Aircraftinline
SetInvalid()XPMP2::Aircraftvirtual
SetLightsBeacon(bool _b)XPMP2::Aircraftinline
SetLightsLanding(bool _b)XPMP2::Aircraftinline
SetLightsNav(bool _b)XPMP2::Aircraftinline
SetLightsStrobe(bool _b)XPMP2::Aircraftinline
SetLightsTaxi(bool _b)XPMP2::Aircraftinline
SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline
SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline
SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft
SetMass(float _kg)XPMP2::Aircraftinline
SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline
SetNoseWheelAngle(float _f)XPMP2::Aircraftinline
SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft
SetPitch(float _deg)XPMP2::Aircraftinline
SetPropRotAngle(float _deg)XPMP2::Aircraftinline
SetPropRotRad(float _rad)XPMP2::Aircraftinline
SetPropRotRpm(float _rpm)XPMP2::Aircraftinline
SetRender(bool _bRender)XPMP2::Aircraftvirtual
SetReversDeployRatio(float _f)XPMP2::Aircraftinline
SetRoll(float _deg)XPMP2::Aircraftinline
SetSlatRatio(float _f)XPMP2::Aircraftinline
SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline
SetSpoilerRatio(float _f)XPMP2::Aircraftinline
SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual
SetThrustRatio(float _f)XPMP2::Aircraftinline
SetThrustReversRatio(float _f)XPMP2::Aircraftinline
SetTireDeflection(float _mtr)XPMP2::Aircraftinline
SetTireRotAngle(float _deg)XPMP2::Aircraftinline
SetTireRotRad(float _rad)XPMP2::Aircraftinline
SetTireRotRpm(float _rpm)XPMP2::Aircraftinline
SetTouchDown(bool _b)XPMP2::Aircraftinline
SetVisible(bool _bVisible)XPMP2::Aircraftvirtual
SetWingArea(float _m2)XPMP2::Aircraftinline
SetWingSpan(float _m)XPMP2::Aircraftinline
SetWingSweepRatio(float _f)XPMP2::Aircraftinline
SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline
SetYokePitchRatio(float _f)XPMP2::Aircraftinline
SetYokeRollRatio(float _f)XPMP2::Aircraftinline
ShallDrawLabel() constXPMP2::Aircraftinline
ShowAsAIPlane() constXPMP2::Aircraftinline
skipCounterXPMP2::Aircraftprotected
SND_ENG enum valueXPMP2::Aircraft
SND_FLAPS enum valueXPMP2::Aircraft
SND_GEAR enum valueXPMP2::Aircraft
SND_NUM_EVENTS enum valueXPMP2::Aircraft
SND_REVERSE_THRUST enum valueXPMP2::Aircraft
SND_TIRE enum valueXPMP2::Aircraft
sndMinDistXPMP2::Aircraft
SoundEventsTy enum nameXPMP2::Aircraft
SoundGetName(SoundEventsTy sndEvent, float &volAdj) constXPMP2::Aircraftvirtual
SoundMuteAll(bool bMute)XPMP2::Aircraft
SoundPlay(const std::string &sndName, float vol=1.0f)XPMP2::Aircraft
SoundRemoveAll()XPMP2::Aircraftprotectedvirtual
SoundSetup()XPMP2::Aircraftprotectedvirtual
SoundStop(FMOD_CHANNEL *pChn)XPMP2::Aircraft
SoundUpdate()XPMP2::Aircraftprotectedvirtual
SoundVolume(FMOD_CHANNEL *pChn, float vol)XPMP2::Aircraft
tcasTargetIdxXPMP2::Aircraftprotected
tsResetTouchDownXPMP2::Aircraftprotected
UpdateDistBearingCamera(const XPLMCameraPosition_t &posCam)XPMP2::Aircraftprotected
UpdatePosition(float, int)SampleAircraftinlinevirtual
vXPMP2::Aircraft
vertOfsRatioXPMP2::Aircraft
wakeXPMP2::Aircraft
WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft
~Aircraft()XPMP2::Aircraftvirtual
v_xXPMP2::Aircraftprotected
v_yXPMP2::Aircraftprotected
v_zXPMP2::Aircraftprotected
vertOfsRatioXPMP2::Aircraft
wakeXPMP2::Aircraft
WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft
~Aircraft()XPMP2::Aircraftvirtual
diff --git a/docs/html/classSampleAircraft.html b/docs/html/classSampleAircraft.html index 27f78155..f56824eb 100644 --- a/docs/html/classSampleAircraft.html +++ b/docs/html/classSampleAircraft.html @@ -89,7 +89,7 @@  Creates a plane, only a valid operation if object was created using the default constructor. More...
  XPMPPlaneID GetModeS_ID () const - return the XPMP2 plane id More...
+ return the XPMP2 plane id More...
  bool IsGroundVehicle () const  Is this object a ground vehicle? More...
@@ -211,6 +211,9 @@ void SetRoll (float _deg)  roll [degree] More...
  +float GetGS_kn () const + Rough estimate of a ground speed based on v_x/z More...
+  float GetGearRatio () const  Gear deploy ratio. More...
  @@ -433,7 +436,7 @@  Angle of Attach, returns pitch (but you can override in your class) More...
  virtual float GetLift () const - Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
+ Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
  void MapFindIcon ()  Determine which map icon to use for this aircraft. More...
@@ -447,9 +450,40 @@ void MapDrawLabel (XPLMMapLayerID inLayer, float yOfs)  Actually draw the map label. More...
  +FMOD_CHANNEL * SoundPlay (const std::string &sndName, float vol=1.0f) + Play a sound; a looping sound plays until explicitely stopped. More...
+  +void SoundStop (FMOD_CHANNEL *pChn) + Stop a continuously playing sound. More...
+  +void SoundVolume (FMOD_CHANNEL *pChn, float vol) + Sets the sound's volume (after applying master volume and Sound File's adjustments) More...
+  +void SoundMuteAll (bool bMute) + Mute/Unmute all sounds of the airplane temporarily. More...
+  +virtual std::string SoundGetName (SoundEventsTy sndEvent, float &volAdj) const + Returns the name of the sound to play per event. More...
+  + + + + + + + @@ -499,6 +533,9 @@ + + + @@ -521,6 +558,15 @@ + + + + + + + + + @@ -556,8 +602,17 @@ + + + + + + + + + - + @@ -592,6 +647,21 @@ + + + + + + + + + + + + + + +

Additional Inherited Members

- Public Types inherited from XPMP2::Aircraft
enum  SoundEventsTy {
+  SND_ENG = 0 +, SND_REVERSE_THRUST +, SND_TIRE +, SND_GEAR +,
+  SND_FLAPS +, SND_NUM_EVENTS +
+ }
 Types of sound supported directly by XPMP2. More...
 
typedef std::list< FMOD_CHANNEL * > ChnListTy
 List of FMOD channels, also beyond sounds created for SoundEvetsTy. More...
 
- Public Attributes inherited from XPMP2::Aircraft
std::string acIcaoType
 ICAO aircraft type designator of this plane. More...
XPMPInfoTexts_t acInfoTexts
 Informational texts passed on via multiplayer shared dataRefs. More...
 
int sndMinDist = 50.0
 Minimum distance in [m] to play sound in full volume, the larger the 'louder' the aircraft. More...
 
- Protected Member Functions inherited from XPMP2::Aircraft
void DoMove ()
 Internal: This puts the instance into XP's sky and makes it move. More...
virtual void SetTcasTargetIdx (int _idx)
 Define the TCAS target index in use. More...
 
virtual void SoundSetup ()
 Sound-related initializations, called by Create() and ChangeModel() More...
 
virtual void SoundUpdate ()
 Update sound, like position and volume, called once per frame. More...
 
virtual void SoundRemoveAll ()
 Remove all sound, e.g. during destruction. More...
 
- Static Protected Member Functions inherited from XPMP2::Aircraft
static float FlightLoopCB (float, float, int, void *)
 Internal: Flight loop callback function controlling update and movement of all planes. More...
float prev_ts = 0.0f
 last update of prev_x/y/z in XP's network time More...
 
float v_x = 0.0f
 
float v_y = 0.0f
 
float v_z = 0.0f
 Cartesian velocity in m/s per axis. More...
 
float gs_kn = 0.0f
 
float tsResetTouchDown = NAN
 Set by SetOnGrnd() with the timestamp when to reset SetTouchDown() More...
 ground speed in [kn] based on above v_x/z More...
 
std::list< XPLMInstanceRef > listInst
 X-Plane instance handles for all objects making up the model. More...
std::string mapLabel
 label for map drawing More...
 
SndChTy aSndCh [SND_NUM_EVENTS]
 Operational values per sound channel, that is triggered by a standard sound event. More...
 
bool bChnLowPass = false
 Is Low Pass Filter currently being active? More...
 
bool bChnMuted = false
 Is sound for this aircraft currently muted? More...
 
ChnListTy chnList
 List of channels produced via calls to SoundPlay() More...
 
int skipCounter = 0
 Counts how often we skipped expensive computations. More...
 

Detailed Description

Subclassing XPMP2::Aircraft to create our own class.

diff --git a/docs/html/classXPCAircraft-members.html b/docs/html/classXPCAircraft-members.html index 68bf8ed9..eb642dd5 100644 --- a/docs/html/classXPCAircraft-members.html +++ b/docs/html/classXPCAircraft-members.html @@ -58,39 +58,45 @@ Aircraft(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="")XPMP2::Aircraft Aircraft()XPMP2::Aircraft Aircraft(const Aircraft &)=deleteXPMP2::Aircraft - AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft - bClampToGroundXPMP2::Aircraft - bDrawLabelXPMP2::Aircraft - bOnGrndXPMP2::Aircraft - bRenderXPMP2::Aircraftprotected - bValidXPMP2::Aircraftprotected - bVisibleXPMP2::Aircraftprotected - camBearingXPMP2::Aircraftprotected - camDistXPMP2::Aircraftprotected - camTimLstUpdXPMP2::Aircraftprotected - ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft - ClampToGround()XPMP2::Aircraftprotected - colLabelXPMP2::Aircraft - ComputeMapLabel()XPMP2::Aircraftprotectedvirtual - Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft - CreateInstances()XPMP2::Aircraftprotected - DestroyInstances()XPMP2::Aircraftprotected - DoMove()XPMP2::Aircraftprotected - drawInfoXPMP2::Aircraft - FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic - gearDeflectRatioXPMP2::Aircraft - GetAoA() constXPMP2::Aircraftinlinevirtual - GetCameraBearing() constXPMP2::Aircraftinline - GetCameraDist() constXPMP2::Aircraftinline - GetEngineRotAngle() constXPMP2::Aircraftinline - GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline - GetEngineRotRad() constXPMP2::Aircraftinline - GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline - GetEngineRotRpm() constXPMP2::Aircraftinline - GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline - GetFlapRatio() constXPMP2::Aircraftinline - GetFlightId() constXPMP2::Aircraftvirtual - GetGearRatio() constXPMP2::Aircraftinline + aSndChXPMP2::Aircraftprotected + AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft + bChnLowPassXPMP2::Aircraftprotected + bChnMutedXPMP2::Aircraftprotected + bClampToGroundXPMP2::Aircraft + bDrawLabelXPMP2::Aircraft + bOnGrndXPMP2::Aircraft + bRenderXPMP2::Aircraftprotected + bValidXPMP2::Aircraftprotected + bVisibleXPMP2::Aircraftprotected + camBearingXPMP2::Aircraftprotected + camDistXPMP2::Aircraftprotected + camTimLstUpdXPMP2::Aircraftprotected + ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft + chnListXPMP2::Aircraftprotected + ChnListTy typedefXPMP2::Aircraft + ClampToGround()XPMP2::Aircraftprotected + colLabelXPMP2::Aircraft + ComputeMapLabel()XPMP2::Aircraftprotectedvirtual + Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft + CreateInstances()XPMP2::Aircraftprotected + DestroyInstances()XPMP2::Aircraftprotected + DoMove()XPMP2::Aircraftprotected + drawInfoXPMP2::Aircraft + FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic + gearDeflectRatioXPMP2::Aircraft + GetAoA() constXPMP2::Aircraftinlinevirtual + GetCameraBearing() constXPMP2::Aircraftinline + GetCameraDist() constXPMP2::Aircraftinline + GetEngineRotAngle() constXPMP2::Aircraftinline + GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline + GetEngineRotRad() constXPMP2::Aircraftinline + GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline + GetEngineRotRpm() constXPMP2::Aircraftinline + GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline + GetFlapRatio() constXPMP2::Aircraftinline + GetFlightId() constXPMP2::Aircraftvirtual + GetGearRatio() constXPMP2::Aircraftinline + GetGS_kn() constXPMP2::Aircraftinline GetHeading() constXPMP2::Aircraftinline GetInfoTexts(XPMPInfoTexts_t *)XPCAircraftinlinevirtual GetLift() constXPMP2::Aircraftinlinevirtual @@ -137,97 +143,118 @@ GetYokeHeadingRatio() constXPMP2::Aircraftinline GetYokePitchRatio() constXPMP2::Aircraftinline GetYokeRollRatio() constXPMP2::Aircraftinline - hProbeXPMP2::Aircraftprotected - IsCurrentlyShownAsAI() constXPMP2::Aircraft - IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline - IsGroundVehicle() constXPMP2::Aircraft - IsInstanciated() constXPMP2::Aircraftinline - IsOnGrnd() constXPMP2::Aircraftinline - IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft - IsRendered() constXPMP2::Aircraftinline - IsValid() constXPMP2::Aircraftinline - IsVisible() constXPMP2::Aircraftinline - labelXPMP2::Aircraft - listInstXPMP2::Aircraftprotected - MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft - MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft - MapFindIcon()XPMP2::Aircraft - mapIconColXPMP2::Aircraftprotected - mapIconRowXPMP2::Aircraftprotected - mapLabelXPMP2::Aircraftprotected - MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft - mapXXPMP2::Aircraftprotected - mapYXPMP2::Aircraftprotected - matchQualityXPMP2::Aircraftprotected - modeS_idXPMP2::Aircraftprotected - operator=(const Aircraft &)=deleteXPMP2::Aircraft - pCSLMdlXPMP2::Aircraftprotected - prev_tsXPMP2::Aircraftprotected - prev_xXPMP2::Aircraftprotected - prev_yXPMP2::Aircraftprotected - prev_zXPMP2::Aircraftprotected - ReMatchModel()XPMP2::Aircraftinline - ResetTcasTargetIdx()XPMP2::Aircraftinline - SetDrawLabel(bool _b)XPMP2::Aircraftinline - SetEngineRotAngle(float _deg)XPMP2::Aircraft - SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft - SetEngineRotRad(float _rad)XPMP2::Aircraft - SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft - SetEngineRotRpm(float _rpm)XPMP2::Aircraft - SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft - SetFlapRatio(float _f)XPMP2::Aircraftinline - SetGearRatio(float _f)XPMP2::Aircraftinline - SetHeading(float _deg)XPMP2::Aircraftinline - SetInvalid()XPMP2::Aircraftvirtual - SetLightsBeacon(bool _b)XPMP2::Aircraftinline - SetLightsLanding(bool _b)XPMP2::Aircraftinline - SetLightsNav(bool _b)XPMP2::Aircraftinline - SetLightsStrobe(bool _b)XPMP2::Aircraftinline - SetLightsTaxi(bool _b)XPMP2::Aircraftinline - SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline - SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline - SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft - SetMass(float _kg)XPMP2::Aircraftinline - SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline - SetNoseWheelAngle(float _f)XPMP2::Aircraftinline - SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft - SetPitch(float _deg)XPMP2::Aircraftinline - SetPropRotAngle(float _deg)XPMP2::Aircraftinline - SetPropRotRad(float _rad)XPMP2::Aircraftinline - SetPropRotRpm(float _rpm)XPMP2::Aircraftinline - SetRender(bool _bRender)XPMP2::Aircraftvirtual - SetReversDeployRatio(float _f)XPMP2::Aircraftinline - SetRoll(float _deg)XPMP2::Aircraftinline - SetSlatRatio(float _f)XPMP2::Aircraftinline - SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline - SetSpoilerRatio(float _f)XPMP2::Aircraftinline - SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual - SetThrustRatio(float _f)XPMP2::Aircraftinline - SetThrustReversRatio(float _f)XPMP2::Aircraftinline - SetTireDeflection(float _mtr)XPMP2::Aircraftinline - SetTireRotAngle(float _deg)XPMP2::Aircraftinline - SetTireRotRad(float _rad)XPMP2::Aircraftinline - SetTireRotRpm(float _rpm)XPMP2::Aircraftinline - SetTouchDown(bool _b)XPMP2::Aircraftinline - SetVisible(bool _bVisible)XPMP2::Aircraftvirtual - SetWingArea(float _m2)XPMP2::Aircraftinline - SetWingSpan(float _m)XPMP2::Aircraftinline - SetWingSweepRatio(float _f)XPMP2::Aircraftinline - SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline - SetYokePitchRatio(float _f)XPMP2::Aircraftinline - SetYokeRollRatio(float _f)XPMP2::Aircraftinline - ShallDrawLabel() constXPMP2::Aircraftinline - ShowAsAIPlane() constXPMP2::Aircraftinline + gs_knXPMP2::Aircraftprotected + hProbeXPMP2::Aircraftprotected + IsCurrentlyShownAsAI() constXPMP2::Aircraft + IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline + IsGroundVehicle() constXPMP2::Aircraft + IsInstanciated() constXPMP2::Aircraftinline + IsOnGrnd() constXPMP2::Aircraftinline + IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft + IsRendered() constXPMP2::Aircraftinline + IsValid() constXPMP2::Aircraftinline + IsVisible() constXPMP2::Aircraftinline + labelXPMP2::Aircraft + listInstXPMP2::Aircraftprotected + MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft + MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft + MapFindIcon()XPMP2::Aircraft + mapIconColXPMP2::Aircraftprotected + mapIconRowXPMP2::Aircraftprotected + mapLabelXPMP2::Aircraftprotected + MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft + mapXXPMP2::Aircraftprotected + mapYXPMP2::Aircraftprotected + matchQualityXPMP2::Aircraftprotected + modeS_idXPMP2::Aircraftprotected + operator=(const Aircraft &)=deleteXPMP2::Aircraft + pCSLMdlXPMP2::Aircraftprotected + prev_tsXPMP2::Aircraftprotected + prev_xXPMP2::Aircraftprotected + prev_yXPMP2::Aircraftprotected + prev_zXPMP2::Aircraftprotected + ReMatchModel()XPMP2::Aircraftinline + ResetTcasTargetIdx()XPMP2::Aircraftinline + SetDrawLabel(bool _b)XPMP2::Aircraftinline + SetEngineRotAngle(float _deg)XPMP2::Aircraft + SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft + SetEngineRotRad(float _rad)XPMP2::Aircraft + SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft + SetEngineRotRpm(float _rpm)XPMP2::Aircraft + SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft + SetFlapRatio(float _f)XPMP2::Aircraftinline + SetGearRatio(float _f)XPMP2::Aircraftinline + SetHeading(float _deg)XPMP2::Aircraftinline + SetInvalid()XPMP2::Aircraftvirtual + SetLightsBeacon(bool _b)XPMP2::Aircraftinline + SetLightsLanding(bool _b)XPMP2::Aircraftinline + SetLightsNav(bool _b)XPMP2::Aircraftinline + SetLightsStrobe(bool _b)XPMP2::Aircraftinline + SetLightsTaxi(bool _b)XPMP2::Aircraftinline + SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline + SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline + SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft + SetMass(float _kg)XPMP2::Aircraftinline + SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline + SetNoseWheelAngle(float _f)XPMP2::Aircraftinline + SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft + SetPitch(float _deg)XPMP2::Aircraftinline + SetPropRotAngle(float _deg)XPMP2::Aircraftinline + SetPropRotRad(float _rad)XPMP2::Aircraftinline + SetPropRotRpm(float _rpm)XPMP2::Aircraftinline + SetRender(bool _bRender)XPMP2::Aircraftvirtual + SetReversDeployRatio(float _f)XPMP2::Aircraftinline + SetRoll(float _deg)XPMP2::Aircraftinline + SetSlatRatio(float _f)XPMP2::Aircraftinline + SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline + SetSpoilerRatio(float _f)XPMP2::Aircraftinline + SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual + SetThrustRatio(float _f)XPMP2::Aircraftinline + SetThrustReversRatio(float _f)XPMP2::Aircraftinline + SetTireDeflection(float _mtr)XPMP2::Aircraftinline + SetTireRotAngle(float _deg)XPMP2::Aircraftinline + SetTireRotRad(float _rad)XPMP2::Aircraftinline + SetTireRotRpm(float _rpm)XPMP2::Aircraftinline + SetTouchDown(bool _b)XPMP2::Aircraftinline + SetVisible(bool _bVisible)XPMP2::Aircraftvirtual + SetWingArea(float _m2)XPMP2::Aircraftinline + SetWingSpan(float _m)XPMP2::Aircraftinline + SetWingSweepRatio(float _f)XPMP2::Aircraftinline + SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline + SetYokePitchRatio(float _f)XPMP2::Aircraftinline + SetYokeRollRatio(float _f)XPMP2::Aircraftinline + ShallDrawLabel() constXPMP2::Aircraftinline + ShowAsAIPlane() constXPMP2::Aircraftinline + skipCounterXPMP2::Aircraftprotected + SND_ENG enum valueXPMP2::Aircraft + SND_FLAPS enum valueXPMP2::Aircraft + SND_GEAR enum valueXPMP2::Aircraft + SND_NUM_EVENTS enum valueXPMP2::Aircraft + SND_REVERSE_THRUST enum valueXPMP2::Aircraft + SND_TIRE enum valueXPMP2::Aircraft + sndMinDistXPMP2::Aircraft + SoundEventsTy enum nameXPMP2::Aircraft + SoundGetName(SoundEventsTy sndEvent, float &volAdj) constXPMP2::Aircraftvirtual + SoundMuteAll(bool bMute)XPMP2::Aircraft + SoundPlay(const std::string &sndName, float vol=1.0f)XPMP2::Aircraft + SoundRemoveAll()XPMP2::Aircraftprotectedvirtual + SoundSetup()XPMP2::Aircraftprotectedvirtual + SoundStop(FMOD_CHANNEL *pChn)XPMP2::Aircraft + SoundUpdate()XPMP2::Aircraftprotectedvirtual + SoundVolume(FMOD_CHANNEL *pChn, float vol)XPMP2::Aircraft tcasTargetIdxXPMP2::Aircraftprotected tsResetTouchDownXPMP2::Aircraftprotected UpdateDistBearingCamera(const XPLMCameraPosition_t &posCam)XPMP2::Aircraftprotected UpdatePosition(float _elapsedSinceLastCall, int _flCounter)XPCAircraftvirtual vXPMP2::Aircraft - vertOfsRatioXPMP2::Aircraft - wakeXPMP2::Aircraft - WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft - XPCAircraft(const char *_icaoType, const char *_icaoAirline, const char *_livery, XPMPPlaneID _modeS_id=0, const char *_modelId=nullptr)XPCAircraft - ~Aircraft()XPMP2::Aircraftvirtual + v_xXPMP2::Aircraftprotected + v_yXPMP2::Aircraftprotected + v_zXPMP2::Aircraftprotected + vertOfsRatioXPMP2::Aircraft + wakeXPMP2::Aircraft + WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft + XPCAircraft(const char *_icaoType, const char *_icaoAirline, const char *_livery, XPMPPlaneID _modeS_id=0, const char *_modelId=nullptr)XPCAircraft + ~Aircraft()XPMP2::Aircraftvirtual
diff --git a/docs/html/classXPCAircraft.html b/docs/html/classXPCAircraft.html index c2520899..d645f17e 100644 --- a/docs/html/classXPCAircraft.html +++ b/docs/html/classXPCAircraft.html @@ -106,7 +106,7 @@  Creates a plane, only a valid operation if object was created using the default constructor. More...
  XPMPPlaneID GetModeS_ID () const - return the XPMP2 plane id More...
+ return the XPMP2 plane id More...
  bool IsGroundVehicle () const  Is this object a ground vehicle? More...
@@ -228,6 +228,9 @@ void SetRoll (float _deg)  roll [degree] More...
  +float GetGS_kn () const + Rough estimate of a ground speed based on v_x/z More...
+  float GetGearRatio () const  Gear deploy ratio. More...
  @@ -450,7 +453,7 @@  Angle of Attach, returns pitch (but you can override in your class) More...
  virtual float GetLift () const - Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
+ Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
  void MapFindIcon ()  Determine which map icon to use for this aircraft. More...
@@ -464,6 +467,21 @@ void MapDrawLabel (XPLMMapLayerID inLayer, float yOfs)  Actually draw the map label. More...
  +FMOD_CHANNEL * SoundPlay (const std::string &sndName, float vol=1.0f) + Play a sound; a looping sound plays until explicitely stopped. More...
+  +void SoundStop (FMOD_CHANNEL *pChn) + Stop a continuously playing sound. More...
+  +void SoundVolume (FMOD_CHANNEL *pChn, float vol) + Sets the sound's volume (after applying master volume and Sound File's adjustments) More...
+  +void SoundMuteAll (bool bMute) + Mute/Unmute all sounds of the airplane temporarily. More...
+  +virtual std::string SoundGetName (SoundEventsTy sndEvent, float &volAdj) const + Returns the name of the sound to play per event. More...
+  @@ -522,9 +540,28 @@ + + +

Public Attributes

XPMPInfoTexts_t acInfoTexts
 Informational texts passed on via multiplayer shared dataRefs. More...
 
int sndMinDist = 50.0
 Minimum distance in [m] to play sound in full volume, the larger the 'louder' the aircraft. More...
 
+ + + + + + + @@ -547,6 +584,15 @@ + + + + + + + + + @@ -582,8 +628,17 @@ + + + + + + + + + - + @@ -618,6 +673,21 @@ + + + + + + + + + + + + + + +

Additional Inherited Members

- Public Types inherited from XPMP2::Aircraft
enum  SoundEventsTy {
+  SND_ENG = 0 +, SND_REVERSE_THRUST +, SND_TIRE +, SND_GEAR +,
+  SND_FLAPS +, SND_NUM_EVENTS +
+ }
 Types of sound supported directly by XPMP2. More...
 
typedef std::list< FMOD_CHANNEL * > ChnListTy
 List of FMOD channels, also beyond sounds created for SoundEvetsTy. More...
 
- Protected Member Functions inherited from XPMP2::Aircraft
void DoMove ()
 Internal: This puts the instance into XP's sky and makes it move. More...
virtual void SetTcasTargetIdx (int _idx)
 Define the TCAS target index in use. More...
 
virtual void SoundSetup ()
 Sound-related initializations, called by Create() and ChangeModel() More...
 
virtual void SoundUpdate ()
 Update sound, like position and volume, called once per frame. More...
 
virtual void SoundRemoveAll ()
 Remove all sound, e.g. during destruction. More...
 
- Static Protected Member Functions inherited from XPMP2::Aircraft
static float FlightLoopCB (float, float, int, void *)
 Internal: Flight loop callback function controlling update and movement of all planes. More...
float prev_ts = 0.0f
 last update of prev_x/y/z in XP's network time More...
 
float v_x = 0.0f
 
float v_y = 0.0f
 
float v_z = 0.0f
 Cartesian velocity in m/s per axis. More...
 
float gs_kn = 0.0f
 
float tsResetTouchDown = NAN
 Set by SetOnGrnd() with the timestamp when to reset SetTouchDown() More...
 ground speed in [kn] based on above v_x/z More...
 
std::list< XPLMInstanceRef > listInst
 X-Plane instance handles for all objects making up the model. More...
std::string mapLabel
 label for map drawing More...
 
SndChTy aSndCh [SND_NUM_EVENTS]
 Operational values per sound channel, that is triggered by a standard sound event. More...
 
bool bChnLowPass = false
 Is Low Pass Filter currently being active? More...
 
bool bChnMuted = false
 Is sound for this aircraft currently muted? More...
 
ChnListTy chnList
 List of channels produced via calls to SoundPlay() More...
 
int skipCounter = 0
 Counts how often we skipped expensive computations. More...
 

Detailed Description

Legacy wrapper class as provided by original libxplanemp.

@@ -679,7 +749,7 @@

_icaoTypeICAO aircraft type designator, like 'A320', 'B738', 'C172' _icaoAirlineICAO airline code, like 'BAW', 'DLH', can be an empty string _liverySpecial livery designator, can be an empty string - _modeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given + _modeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given _modelId(optional) specific model id to be used (no folder/package name, just the id as defined in the OBJ8_AIRCRAFT line)

diff --git a/docs/html/classXPMP2_1_1Aircraft-members.html b/docs/html/classXPMP2_1_1Aircraft-members.html index 074b2184..e23ec9b1 100644 --- a/docs/html/classXPMP2_1_1Aircraft-members.html +++ b/docs/html/classXPMP2_1_1Aircraft-members.html @@ -63,39 +63,45 @@ Aircraft(const Aircraft &)=deleteXPMP2::Aircraft AIUpdateMultiplayerDataRefs()XPMP2::Aircraftfriend AIUpdateTCASTargets()XPMP2::Aircraftfriend - AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft - bClampToGroundXPMP2::Aircraft - bDrawLabelXPMP2::Aircraft - bOnGrndXPMP2::Aircraft - bRenderXPMP2::Aircraftprotected - bValidXPMP2::Aircraftprotected - bVisibleXPMP2::Aircraftprotected - camBearingXPMP2::Aircraftprotected - camDistXPMP2::Aircraftprotected - camTimLstUpdXPMP2::Aircraftprotected - ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft - ClampToGround()XPMP2::Aircraftprotected - colLabelXPMP2::Aircraft - ComputeMapLabel()XPMP2::Aircraftprotectedvirtual - Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft - CreateInstances()XPMP2::Aircraftprotected - DestroyInstances()XPMP2::Aircraftprotected - DoMove()XPMP2::Aircraftprotected - drawInfoXPMP2::Aircraft - FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic - gearDeflectRatioXPMP2::Aircraft - GetAoA() constXPMP2::Aircraftinlinevirtual - GetCameraBearing() constXPMP2::Aircraftinline - GetCameraDist() constXPMP2::Aircraftinline - GetEngineRotAngle() constXPMP2::Aircraftinline - GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline - GetEngineRotRad() constXPMP2::Aircraftinline - GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline - GetEngineRotRpm() constXPMP2::Aircraftinline - GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline - GetFlapRatio() constXPMP2::Aircraftinline - GetFlightId() constXPMP2::Aircraftvirtual - GetGearRatio() constXPMP2::Aircraftinline + aSndChXPMP2::Aircraftprotected + AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft + bChnLowPassXPMP2::Aircraftprotected + bChnMutedXPMP2::Aircraftprotected + bClampToGroundXPMP2::Aircraft + bDrawLabelXPMP2::Aircraft + bOnGrndXPMP2::Aircraft + bRenderXPMP2::Aircraftprotected + bValidXPMP2::Aircraftprotected + bVisibleXPMP2::Aircraftprotected + camBearingXPMP2::Aircraftprotected + camDistXPMP2::Aircraftprotected + camTimLstUpdXPMP2::Aircraftprotected + ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft + chnListXPMP2::Aircraftprotected + ChnListTy typedefXPMP2::Aircraft + ClampToGround()XPMP2::Aircraftprotected + colLabelXPMP2::Aircraft + ComputeMapLabel()XPMP2::Aircraftprotectedvirtual + Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft + CreateInstances()XPMP2::Aircraftprotected + DestroyInstances()XPMP2::Aircraftprotected + DoMove()XPMP2::Aircraftprotected + drawInfoXPMP2::Aircraft + FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic + gearDeflectRatioXPMP2::Aircraft + GetAoA() constXPMP2::Aircraftinlinevirtual + GetCameraBearing() constXPMP2::Aircraftinline + GetCameraDist() constXPMP2::Aircraftinline + GetEngineRotAngle() constXPMP2::Aircraftinline + GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline + GetEngineRotRad() constXPMP2::Aircraftinline + GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline + GetEngineRotRpm() constXPMP2::Aircraftinline + GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline + GetFlapRatio() constXPMP2::Aircraftinline + GetFlightId() constXPMP2::Aircraftvirtual + GetGearRatio() constXPMP2::Aircraftinline + GetGS_kn() constXPMP2::Aircraftinline GetHeading() constXPMP2::Aircraftinline GetLift() constXPMP2::Aircraftinlinevirtual GetLightsBeacon() constXPMP2::Aircraftinline @@ -138,96 +144,117 @@ GetYokeHeadingRatio() constXPMP2::Aircraftinline GetYokePitchRatio() constXPMP2::Aircraftinline GetYokeRollRatio() constXPMP2::Aircraftinline - hProbeXPMP2::Aircraftprotected - IsCurrentlyShownAsAI() constXPMP2::Aircraft - IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline - IsGroundVehicle() constXPMP2::Aircraft - IsInstanciated() constXPMP2::Aircraftinline - IsOnGrnd() constXPMP2::Aircraftinline - IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft - IsRendered() constXPMP2::Aircraftinline - IsValid() constXPMP2::Aircraftinline - IsVisible() constXPMP2::Aircraftinline - labelXPMP2::Aircraft - listInstXPMP2::Aircraftprotected - MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft - MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft - MapFindIcon()XPMP2::Aircraft - mapIconColXPMP2::Aircraftprotected - mapIconRowXPMP2::Aircraftprotected - mapLabelXPMP2::Aircraftprotected - MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft - mapXXPMP2::Aircraftprotected - mapYXPMP2::Aircraftprotected - matchQualityXPMP2::Aircraftprotected - modeS_idXPMP2::Aircraftprotected - operator=(const Aircraft &)=deleteXPMP2::Aircraft - pCSLMdlXPMP2::Aircraftprotected - prev_tsXPMP2::Aircraftprotected - prev_xXPMP2::Aircraftprotected - prev_yXPMP2::Aircraftprotected - prev_zXPMP2::Aircraftprotected - ReMatchModel()XPMP2::Aircraftinline - ResetTcasTargetIdx()XPMP2::Aircraftinline - SetDrawLabel(bool _b)XPMP2::Aircraftinline - SetEngineRotAngle(float _deg)XPMP2::Aircraft - SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft - SetEngineRotRad(float _rad)XPMP2::Aircraft - SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft - SetEngineRotRpm(float _rpm)XPMP2::Aircraft - SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft - SetFlapRatio(float _f)XPMP2::Aircraftinline - SetGearRatio(float _f)XPMP2::Aircraftinline - SetHeading(float _deg)XPMP2::Aircraftinline - SetInvalid()XPMP2::Aircraftvirtual - SetLightsBeacon(bool _b)XPMP2::Aircraftinline - SetLightsLanding(bool _b)XPMP2::Aircraftinline - SetLightsNav(bool _b)XPMP2::Aircraftinline - SetLightsStrobe(bool _b)XPMP2::Aircraftinline - SetLightsTaxi(bool _b)XPMP2::Aircraftinline - SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline - SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline - SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft - SetMass(float _kg)XPMP2::Aircraftinline - SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline - SetNoseWheelAngle(float _f)XPMP2::Aircraftinline - SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft - SetPitch(float _deg)XPMP2::Aircraftinline - SetPropRotAngle(float _deg)XPMP2::Aircraftinline - SetPropRotRad(float _rad)XPMP2::Aircraftinline - SetPropRotRpm(float _rpm)XPMP2::Aircraftinline - SetRender(bool _bRender)XPMP2::Aircraftvirtual - SetReversDeployRatio(float _f)XPMP2::Aircraftinline - SetRoll(float _deg)XPMP2::Aircraftinline - SetSlatRatio(float _f)XPMP2::Aircraftinline - SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline - SetSpoilerRatio(float _f)XPMP2::Aircraftinline - SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual - SetThrustRatio(float _f)XPMP2::Aircraftinline - SetThrustReversRatio(float _f)XPMP2::Aircraftinline - SetTireDeflection(float _mtr)XPMP2::Aircraftinline - SetTireRotAngle(float _deg)XPMP2::Aircraftinline - SetTireRotRad(float _rad)XPMP2::Aircraftinline - SetTireRotRpm(float _rpm)XPMP2::Aircraftinline - SetTouchDown(bool _b)XPMP2::Aircraftinline - SetVisible(bool _bVisible)XPMP2::Aircraftvirtual - SetWingArea(float _m2)XPMP2::Aircraftinline - SetWingSpan(float _m)XPMP2::Aircraftinline - SetWingSweepRatio(float _f)XPMP2::Aircraftinline - SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline - SetYokePitchRatio(float _f)XPMP2::Aircraftinline - SetYokeRollRatio(float _f)XPMP2::Aircraftinline - ShallDrawLabel() constXPMP2::Aircraftinline - ShowAsAIPlane() constXPMP2::Aircraftinline + gs_knXPMP2::Aircraftprotected + hProbeXPMP2::Aircraftprotected + IsCurrentlyShownAsAI() constXPMP2::Aircraft + IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline + IsGroundVehicle() constXPMP2::Aircraft + IsInstanciated() constXPMP2::Aircraftinline + IsOnGrnd() constXPMP2::Aircraftinline + IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft + IsRendered() constXPMP2::Aircraftinline + IsValid() constXPMP2::Aircraftinline + IsVisible() constXPMP2::Aircraftinline + labelXPMP2::Aircraft + listInstXPMP2::Aircraftprotected + MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft + MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft + MapFindIcon()XPMP2::Aircraft + mapIconColXPMP2::Aircraftprotected + mapIconRowXPMP2::Aircraftprotected + mapLabelXPMP2::Aircraftprotected + MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft + mapXXPMP2::Aircraftprotected + mapYXPMP2::Aircraftprotected + matchQualityXPMP2::Aircraftprotected + modeS_idXPMP2::Aircraftprotected + operator=(const Aircraft &)=deleteXPMP2::Aircraft + pCSLMdlXPMP2::Aircraftprotected + prev_tsXPMP2::Aircraftprotected + prev_xXPMP2::Aircraftprotected + prev_yXPMP2::Aircraftprotected + prev_zXPMP2::Aircraftprotected + ReMatchModel()XPMP2::Aircraftinline + ResetTcasTargetIdx()XPMP2::Aircraftinline + SetDrawLabel(bool _b)XPMP2::Aircraftinline + SetEngineRotAngle(float _deg)XPMP2::Aircraft + SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft + SetEngineRotRad(float _rad)XPMP2::Aircraft + SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft + SetEngineRotRpm(float _rpm)XPMP2::Aircraft + SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft + SetFlapRatio(float _f)XPMP2::Aircraftinline + SetGearRatio(float _f)XPMP2::Aircraftinline + SetHeading(float _deg)XPMP2::Aircraftinline + SetInvalid()XPMP2::Aircraftvirtual + SetLightsBeacon(bool _b)XPMP2::Aircraftinline + SetLightsLanding(bool _b)XPMP2::Aircraftinline + SetLightsNav(bool _b)XPMP2::Aircraftinline + SetLightsStrobe(bool _b)XPMP2::Aircraftinline + SetLightsTaxi(bool _b)XPMP2::Aircraftinline + SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline + SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline + SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft + SetMass(float _kg)XPMP2::Aircraftinline + SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline + SetNoseWheelAngle(float _f)XPMP2::Aircraftinline + SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft + SetPitch(float _deg)XPMP2::Aircraftinline + SetPropRotAngle(float _deg)XPMP2::Aircraftinline + SetPropRotRad(float _rad)XPMP2::Aircraftinline + SetPropRotRpm(float _rpm)XPMP2::Aircraftinline + SetRender(bool _bRender)XPMP2::Aircraftvirtual + SetReversDeployRatio(float _f)XPMP2::Aircraftinline + SetRoll(float _deg)XPMP2::Aircraftinline + SetSlatRatio(float _f)XPMP2::Aircraftinline + SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline + SetSpoilerRatio(float _f)XPMP2::Aircraftinline + SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual + SetThrustRatio(float _f)XPMP2::Aircraftinline + SetThrustReversRatio(float _f)XPMP2::Aircraftinline + SetTireDeflection(float _mtr)XPMP2::Aircraftinline + SetTireRotAngle(float _deg)XPMP2::Aircraftinline + SetTireRotRad(float _rad)XPMP2::Aircraftinline + SetTireRotRpm(float _rpm)XPMP2::Aircraftinline + SetTouchDown(bool _b)XPMP2::Aircraftinline + SetVisible(bool _bVisible)XPMP2::Aircraftvirtual + SetWingArea(float _m2)XPMP2::Aircraftinline + SetWingSpan(float _m)XPMP2::Aircraftinline + SetWingSweepRatio(float _f)XPMP2::Aircraftinline + SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline + SetYokePitchRatio(float _f)XPMP2::Aircraftinline + SetYokeRollRatio(float _f)XPMP2::Aircraftinline + ShallDrawLabel() constXPMP2::Aircraftinline + ShowAsAIPlane() constXPMP2::Aircraftinline + skipCounterXPMP2::Aircraftprotected + SND_ENG enum valueXPMP2::Aircraft + SND_FLAPS enum valueXPMP2::Aircraft + SND_GEAR enum valueXPMP2::Aircraft + SND_NUM_EVENTS enum valueXPMP2::Aircraft + SND_REVERSE_THRUST enum valueXPMP2::Aircraft + SND_TIRE enum valueXPMP2::Aircraft + sndMinDistXPMP2::Aircraft + SoundEventsTy enum nameXPMP2::Aircraft + SoundGetName(SoundEventsTy sndEvent, float &volAdj) constXPMP2::Aircraftvirtual + SoundMuteAll(bool bMute)XPMP2::Aircraft + SoundPlay(const std::string &sndName, float vol=1.0f)XPMP2::Aircraft + SoundRemoveAll()XPMP2::Aircraftprotectedvirtual + SoundSetup()XPMP2::Aircraftprotectedvirtual + SoundStop(FMOD_CHANNEL *pChn)XPMP2::Aircraft + SoundUpdate()XPMP2::Aircraftprotectedvirtual + SoundVolume(FMOD_CHANNEL *pChn, float vol)XPMP2::Aircraft tcasTargetIdxXPMP2::Aircraftprotected tsResetTouchDownXPMP2::Aircraftprotected UpdateDistBearingCamera(const XPLMCameraPosition_t &posCam)XPMP2::Aircraftprotected UpdatePosition(float _elapsedSinceLastCall, int _flCounter)=0XPMP2::Aircraftpure virtual vXPMP2::Aircraft - vertOfsRatioXPMP2::Aircraft - wakeXPMP2::Aircraft - WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft - ~Aircraft()XPMP2::Aircraftvirtual + v_xXPMP2::Aircraftprotected + v_yXPMP2::Aircraftprotected + v_zXPMP2::Aircraftprotected + vertOfsRatioXPMP2::Aircraft + wakeXPMP2::Aircraft + WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft + ~Aircraft()XPMP2::Aircraftvirtual
diff --git a/docs/html/classXPMP2_1_1Aircraft.html b/docs/html/classXPMP2_1_1Aircraft.html index c2ad19a2..64900787 100644 --- a/docs/html/classXPMP2_1_1Aircraft.html +++ b/docs/html/classXPMP2_1_1Aircraft.html @@ -45,9 +45,8 @@
Classes | -Public Member Functions | +Public Types | Public Attributes | -Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | @@ -57,7 +56,7 @@
-

Actual representation of all aircraft in XPMP2. +

Actual representation of all aircraft in XPMP2. More...

#include <XPMPAircraft.h>

@@ -79,12 +78,34 @@ + + +

Classes

struct  SndChTy
 Operational values per sound channel, that is triggered by a standard sound event. More...
 
struct  wakeTy
 Wake dataRef support. More...
 
+ + + + + + + +

+Public Types

enum  SoundEventsTy {
+  SND_ENG = 0 +, SND_REVERSE_THRUST +, SND_TIRE +, SND_GEAR +,
+  SND_FLAPS +, SND_NUM_EVENTS +
+ }
 Types of sound supported directly by XPMP2. More...
 
typedef std::list< FMOD_CHANNEL * > ChnListTy
 List of FMOD channels, also beyond sounds created for SoundEvetsTy. More...
 
+ @@ -103,8 +124,9 @@ + - + @@ -130,6 +152,9 @@ + + @@ -151,6 +176,7 @@ + @@ -196,6 +222,7 @@ + @@ -229,6 +256,12 @@ + + + + + @@ -423,6 +456,13 @@ + + @@ -451,8 +491,11 @@ - + + + @@ -465,6 +508,24 @@ + + + + + + + + + + + + + + + + +

Public Member Functions

Construction
 Aircraft (const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="")
 Constructor creates a new aircraft object, which will be managed and displayed. More...
 
void Create (const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)
 Creates a plane, only a valid operation if object was created using the default constructor. More...
 
Information
XPMPPlaneID GetModeS_ID () const
 return the XPMP2 plane id More...
 return the XPMP2 plane id More...
 
bool IsGroundVehicle () const
 Is this object a ground vehicle? More...
virtual std::string GetFlightId () const
 Return a value for dataRef .../tcas/target/flight_id. More...
 
Model Matching
See also
https://twinfan.github.io/XPMP2/Matching.html
+
int ChangeModel (const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)
 (Potentially) changes the plane's model after doing a new match attempt More...
 
int GetMatchQuality () const
 quality of the match with the CSL model More...
 
Visualization
float GetVertOfs () const
 Vertical offset, ie. the value that needs to be added to drawInfo.y to make the aircraft appear on the ground. More...
 
void SetOnGrnd (bool on_grnd, float setTouchDownTime=NAN)
 Set if the aircraft is on the ground. More...
 
Getters and Setters for the values in Aircraft::drawInfo
void SetLocation (double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)
 Converts world coordinates to local coordinates, writes to Aircraft::drawInfo. More...
 
void SetRoll (float _deg)
 roll [degree] More...
 
float GetGS_kn () const
 Rough estimate of a ground speed based on v_x/z More...
 
Getters and Setters for the values in the Aircraft::v array
See also
https://twinfan.github.io/XPMP2/CSLdataRefs.html
+
float GetGearRatio () const
 Gear deploy ratio. More...
 
void SetTouchDown (bool _b)
 Moment of touch down. More...
 
Wake support as per X-Plane 12
See also
https://twinfan.github.io/XPMP2/Wake.html
+
+https://developer.x-plane.com/2022/02/wake-turbulence/
+
+https://developer.x-plane.com/article/plugin-traffic-wake-turbulence/
+
void WakeApplyDefaults (bool _bOverwriteAllFields=true)
 Fill in default wake turbulence support data based on Doc8643 wake turbulence category. More...
 
 Angle of Attach, returns pitch (but you can override in your class) More...
 
virtual float GetLift () const
 Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
 Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
 
Map Support
Note
Implemented in Map.cpp
+
void MapFindIcon ()
 Determine which map icon to use for this aircraft. More...
 
void MapDrawLabel (XPLMMapLayerID inLayer, float yOfs)
 Actually draw the map label. More...
 
Sound Support
Note
Implemented in Sound.cpp only if built with INCLUDE_FMOD_SOUND
+
FMOD_CHANNEL * SoundPlay (const std::string &sndName, float vol=1.0f)
 Play a sound; a looping sound plays until explicitely stopped. More...
 
void SoundStop (FMOD_CHANNEL *pChn)
 Stop a continuously playing sound. More...
 
void SoundVolume (FMOD_CHANNEL *pChn, float vol)
 Sets the sound's volume (after applying master volume and Sound File's adjustments) More...
 
void SoundMuteAll (bool bMute)
 Mute/Unmute all sounds of the airplane temporarily. More...
 
virtual std::string SoundGetName (SoundEventsTy sndEvent, float &volAdj) const
 Returns the name of the sound to play per event. More...
 
@@ -516,9 +577,13 @@ + + +

Public Attributes

XPMPInfoTexts_t acInfoTexts
 Informational texts passed on via multiplayer shared dataRefs. More...
 
int sndMinDist = 50.0
 Minimum distance in [m] to play sound in full volume, the larger the 'louder' the aircraft. More...
 
+ @@ -540,6 +605,18 @@ + + + + + + + + + + +

Protected Member Functions

Internal Control Functions
void DoMove ()
 Internal: This puts the instance into XP's sky and makes it move. More...
 
virtual void SetTcasTargetIdx (int _idx)
 Define the TCAS target index in use. More...
 
Sound Support (internal)
Note
Implemented in Sound.cpp only if built with INCLUDE_FMOD_SOUND
+
virtual void SoundSetup ()
 Sound-related initializations, called by Create() and ChangeModel() More...
 
virtual void SoundUpdate ()
 Update sound, like position and volume, called once per frame. More...
 
virtual void SoundRemoveAll ()
 Remove all sound, e.g. during destruction. More...
 
@@ -579,8 +656,17 @@ + + + + + + + + + - + @@ -615,6 +701,21 @@ + + + + + + + + + + + + + + +

Static Protected Member Functions

float prev_ts = 0.0f
 last update of prev_x/y/z in XP's network time More...
 
float v_x = 0.0f
 
float v_y = 0.0f
 
float v_z = 0.0f
 Cartesian velocity in m/s per axis. More...
 
float gs_kn = 0.0f
 
float tsResetTouchDown = NAN
 Set by SetOnGrnd() with the timestamp when to reset SetTouchDown() More...
 ground speed in [kn] based on above v_x/z More...
 
std::list< XPLMInstanceRef > listInst
 X-Plane instance handles for all objects making up the model. More...
std::string mapLabel
 label for map drawing More...
 
SndChTy aSndCh [SND_NUM_EVENTS]
 Operational values per sound channel, that is triggered by a standard sound event. More...
 
bool bChnLowPass = false
 Is Low Pass Filter currently being active? More...
 
bool bChnMuted = false
 Is sound for this aircraft currently muted? More...
 
ChnListTy chnList
 List of channels produced via calls to SoundPlay() More...
 
int skipCounter = 0
 Counts how often we skipped expensive computations. More...
 
@@ -629,9 +730,100 @@

Friends

 

Detailed Description

-

Actual representation of all aircraft in XPMP2.

+

Actual representation of all aircraft in XPMP2.

Note
In modern implementations, this class shall be subclassed by your plugin's code.
-

Constructor & Destructor Documentation

+

Class Documentation

+ +

◆ XPMP2::Aircraft::SndChTy

+ +
+
+ + + + +
struct XPMP2::Aircraft::SndChTy
+
+

Operational values per sound channel, that is triggered by a standard sound event.

+
+ + + + + + + + + + + + + +
Class Members
+bool +bAuto +Shall this sound event be handled automatically? (Set to false in your constructor or in Aircraft::SoundSetup() if you want to control that event type yourself)
+float +lastDRVal +last observed dataRef value to see if sound is to be triggered
+FMOD_CHANNEL * +pChn +channel playing the sound currently
+float +volAdj +Volume adjustment, fed from Aircraft::SoundGetName()
+ +
+
+

Member Typedef Documentation

+ +

◆ ChnListTy

+ +
+
+ + + + +
typedef std::list<FMOD_CHANNEL*> XPMP2::Aircraft::ChnListTy
+
+ +

List of FMOD channels, also beyond sounds created for SoundEvetsTy.

+ +
+
+

Member Enumeration Documentation

+ +

◆ SoundEventsTy

+ +
+
+ + + + +
enum XPMP2::Aircraft::SoundEventsTy
+
+ +

Types of sound supported directly by XPMP2.

+ + + + + + + +
Enumerator
SND_ENG 

Engine sound (continuously while engine running), bases on GetThrustRatio()

+
SND_REVERSE_THRUST 

Engine sound while reverse thrust (continuously while reversers deployed), bases on GetThrustReversRatio()

+
SND_TIRE 

Tires rolling on the ground (continuously while rolling on ground), bases on GetTireRotRpm()

+
SND_GEAR 

Gear extending/retracting (once per event), bases on GetGearRatio()

+
SND_FLAPS 

Flaps extending/retracting (once per event), bases on GetFlapRatio()

+
SND_NUM_EVENTS 

Number of events (always last in enum)

+
+ +
+
+

Constructor & Destructor Documentation

◆ Aircraft() [1/3]

@@ -688,7 +880,7 @@

_icaoTypeICAO aircraft type designator, like 'A320', 'B738', 'C172' _icaoAirlineICAO airline code, like 'BAW', 'DLH', can be an empty string _liverySpecial livery designator, can be an empty string - _modeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given + _modeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given _cslId(optional) specific unique model id to be used (package name/short id, as defined in the OBJ8_AIRCRAFT line) @@ -971,7 +1163,7 @@

_icaoTypeICAO aircraft type designator, like 'A320', 'B738', 'C172' _icaoAirlineICAO airline code, like 'BAW', 'DLH', can be an empty string _liverySpecial livery designator, can be an empty string - _modeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given + _modeS_id(optional) Unique identification of the plane [0x01..0xFFFFFF], e.g. the 24bit mode S transponder code. XPMP2 assigns an arbitrary unique number of not given _cslId(optional) specific unique model id to be used (package name/short id, as defined in the OBJ8_AIRCRAFT line) _pCSLModel(optional) The actual model to use (no matching or search by _cslId if model is given this way) @@ -1437,6 +1629,33 @@

+

◆ GetGS_kn()

+ +
+
+ + + + + +
+ + + + + + + +
float XPMP2::Aircraft::GetGS_kn () const
+ 		+inline
+
+ +

Rough estimate of a ground speed based on v_x/z

+
@@ -1489,7 +1708,7 @@

-

Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag.

+

Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag.

@@ -1842,7 +2061,7 @@

-

return the XPMP2 plane id

+

return the XPMP2 plane id

@@ -4436,6 +4655,255 @@

+

◆ SoundGetName()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::string XPMP2::Aircraft::SoundGetName (SoundEventsTy sndEvent,
float & volAdj 
) const
+ 		+virtual
+
+ +

Returns the name of the sound to play per event.

+

This standard implementation determines the engine sound via aircraft classification and returns constant names for the other sound types.

Note
Override in derived class if you want to assign (some) sounds yourself
+
Parameters
+ + + +
sndEventThe type of sound event, like engine or gear
[out]volAdjVolume adjustment factor, allows to make sound louder (>1.0) or quiter, defaults to 1.0
+
+
+
Returns
Name of the sound to play
+ +
+
+ +

◆ SoundMuteAll()

+ +
+
+ + + + + + + + +
void XPMP2::Aircraft::SoundMuteAll (bool bMute)
+
+ +

Mute/Unmute all sounds of the airplane temporarily.

+ +
+
+ +

◆ SoundPlay()

+ +
+
+ + + + + + + + + + + + + + + + + + +
FMOD_CHANNEL * XPMP2::Aircraft::SoundPlay (const std::string & sndName,
float vol = 1.0f 
)
+
+ +

Play a sound; a looping sound plays until explicitely stopped.

+
Parameters
+ + + +
sndNameOne of the sounds available or registered with XPMP2, see XPMPSoundAdd() and XPMPSoundEnumerate()
vol[opt] Volume level. 0 = silent, 1 = full. Negative level inverts the signal. Values larger than 1 amplify the signal.
+
+
+
Returns
an FMOD sound channel, or nullptr if unsuccessful
+ +
+
+ +

◆ SoundRemoveAll()

+ +
+
+ + + + + +
+ + + + + + + +
void XPMP2::Aircraft::SoundRemoveAll ()
+ 		+protectedvirtual
+
+ +

Remove all sound, e.g. during destruction.

+ +
+
+ +

◆ SoundSetup()

+ +
+
+ + + + + +
+ + + + + + + +
void XPMP2::Aircraft::SoundSetup ()
+ 		+protectedvirtual
+
+ +

Sound-related initializations, called by Create() and ChangeModel()

+ +
+
+ +

◆ SoundStop()

+ +
+
+ + + + + + + + +
void XPMP2::Aircraft::SoundStop (FMOD_CHANNEL * pChn)
+
+ +

Stop a continuously playing sound.

+
Parameters
+ + +
pChnThe channel returned by SoundLoopPlay()
+
+
+ +
+
+ +

◆ SoundUpdate()

+ +
+
+ + + + + +
+ + + + + + + +
void XPMP2::Aircraft::SoundUpdate ()
+ 		+protectedvirtual
+
+ +

Update sound, like position and volume, called once per frame.

+ +
+
+ +

◆ SoundVolume()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void XPMP2::Aircraft::SoundVolume (FMOD_CHANNEL * pChn,
float vol 
)
+
+ +

Sets the sound's volume (after applying master volume and Sound File's adjustments)

+
Parameters
+ + + +
pChnThe channel returned by SoundLoopPlay()
volVolume level. 0 = silent, 1 = full. Negative level inverts the signal. Values larger than 1 amplify the signal.
+
+
+
@@ -4703,7 +5171,7 @@

Current radar status.

-
Note
Only the condition mode != Standby is of interest to XPMP2 for considering the aircraft for TCAS display
+
Note
Only the condition mode != Standby is of interest to XPMP2 for considering the aircraft for TCAS display
@@ -4746,6 +5214,78 @@

+

◆ aSndCh

+ +
+
+ + + + + +
+ + + + +
SndChTy XPMP2::Aircraft::aSndCh[SND_NUM_EVENTS]
+ 		+protected
+
+ +

Operational values per sound channel, that is triggered by a standard sound event.

+ +
+
+ +

◆ bChnLowPass

+ +
+
+ + + + + +
+ + + + +
bool XPMP2::Aircraft::bChnLowPass = false
+ 		+protected
+
+ +

Is Low Pass Filter currently being active?

+ +
+
+ +

◆ bChnMuted

+ +
+
+ + + + + +
+ + + + +
bool XPMP2::Aircraft::bChnMuted = false
+ 		+protected
+
+ +

Is sound for this aircraft currently muted?

+
@@ -4940,6 +5480,30 @@

+

◆ chnList

+ +
+
+ + + + + +
+ + + + +
ChnListTy XPMP2::Aircraft::chnList
+ 		+protected
+
+ +

List of channels produced via calls to SoundPlay()

+
@@ -4991,7 +5555,29 @@

XPMP2 to correct for gear deflection, set 0.0.

+ If you don't want XPMP2 to correct for gear deflection, set 0.0.

+ + + + +

◆ gs_kn

+ +
+
+ + + + + +
+ + + + +
float XPMP2::Aircraft::gs_kn = 0.0f
+ 		+protected
+
@@ -5340,6 +5926,47 @@

+ + + +

◆ skipCounter

+ +
+
+ + + + + +
+ + + + +
int XPMP2::Aircraft::skipCounter = 0
+ 		+protected
+
+ +

Counts how often we skipped expensive computations.

+ +
+
+ +

◆ sndMinDist

+ +
+
+ + + + +
int XPMP2::Aircraft::sndMinDist = 50.0
+
+ +

Minimum distance in [m] to play sound in full volume, the larger the 'louder' the aircraft.

+

Initialized based on engine type and numbers, overwrite in your constructor if you want to control "size" of aircraft in terms of its sound volume

+
@@ -5386,6 +6013,7 @@

+

ground speed in [kn] based on above v_x/z

Set by SetOnGrnd() with the timestamp when to reset SetTouchDown()

@@ -5403,9 +6031,77 @@

actual dataRef values to be provided to the CSL model

-

XPMP2 provides a minimum set of dataRefs and also getter/setter member functions, see below. This is the one place where current dataRef values are stored. This array is passed on directly to the XP instance.
+

XPMP2 provides a minimum set of dataRefs and also getter/setter member functions, see below. This is the one place where current dataRef values are stored. This array is passed on directly to the XP instance.
The size of the vector can increase if adding user-defined dataRefs through XPMPAddModelDataRef().

+ + + +

◆ v_x

+ +
+
+ + + + + +
+ + + + +
float XPMP2::Aircraft::v_x = 0.0f
+ 		+protected
+
+ +
+
+ +

◆ v_y

+ +
+
+ + + + + +
+ + + + +
float XPMP2::Aircraft::v_y = 0.0f
+ 		+protected
+
+ +
+
+ +

◆ v_z

+ +
+
+ + + + + +
+ + + + +
float XPMP2::Aircraft::v_z = 0.0f
+ 		+protected
+
+ +

Cartesian velocity in m/s per axis.

+
@@ -5445,6 +6141,7 @@

AIMultiplayer.cpp
  • src/Aircraft.cpp
  • src/Map.cpp
    • +
  • src/Sound.cpp
    • diff --git a/docs/html/classXPMP2_1_1CSLModel-members.html b/docs/html/classXPMP2_1_1CSLModel-members.html index cc49969a..1a17e0e7 100644 --- a/docs/html/classXPMP2_1_1CSLModel-members.html +++ b/docs/html/classXPMP2_1_1CSLModel-members.html @@ -72,32 +72,33 @@ GetKeyString() constXPMP2::CSLModel GetLivery() constXPMP2::CSLModelinline GetModelName() constXPMP2::CSLModelinline - GetObjState() constXPMP2::CSLModel - GetRefCnt() constXPMP2::CSLModelinline - GetRelatedGrp() constXPMP2::CSLModelinline - GetShortId() constXPMP2::CSLModelinline - GetVertOfs() constXPMP2::CSLModelinline - GetWTC() constXPMP2::CSLModelinline - HasRotor() constXPMP2::CSLModelinline - icaoTypeXPMP2::CSLModelprotected - IncRefCnt()XPMP2::CSLModelinline - IsObjInvalid() constXPMP2::CSLModelinline - IsValid() constXPMP2::CSLModelinline - listObjXPMP2::CSLModel - MatchCritVecTy typedefXPMP2::CSLModel - modelNameXPMP2::CSLModel - operator=(CSLModel &&o)=defaultXPMP2::CSLModel - pkgHashXPMP2::CSLModel - refCntXPMP2::CSLModelprotected - refZeroTsXPMP2::CSLModelprotected - relatedXPMP2::CSLModelprotected - shortIdXPMP2::CSLModel - Unload()XPMP2::CSLModelprotected - vecMatchCritXPMP2::CSLModel - vertOfsXPMP2::CSLModel - xsbAircraftLnXPMP2::CSLModel - xsbAircraftPathXPMP2::CSLModel - ~CSLModel()XPMP2::CSLModelvirtual + GetNumEngines() constXPMP2::CSLModelinline + GetObjState() constXPMP2::CSLModel + GetRefCnt() constXPMP2::CSLModelinline + GetRelatedGrp() constXPMP2::CSLModelinline + GetShortId() constXPMP2::CSLModelinline + GetVertOfs() constXPMP2::CSLModelinline + GetWTC() constXPMP2::CSLModelinline + HasRotor() constXPMP2::CSLModelinline + icaoTypeXPMP2::CSLModelprotected + IncRefCnt()XPMP2::CSLModelinline + IsObjInvalid() constXPMP2::CSLModelinline + IsValid() constXPMP2::CSLModelinline + listObjXPMP2::CSLModel + MatchCritVecTy typedefXPMP2::CSLModel + modelNameXPMP2::CSLModel + operator=(CSLModel &&o)=defaultXPMP2::CSLModel + pkgHashXPMP2::CSLModel + refCntXPMP2::CSLModelprotected + refZeroTsXPMP2::CSLModelprotected + relatedXPMP2::CSLModelprotected + shortIdXPMP2::CSLModel + Unload()XPMP2::CSLModelprotected + vecMatchCritXPMP2::CSLModel + vertOfsXPMP2::CSLModel + xsbAircraftLnXPMP2::CSLModel + xsbAircraftPathXPMP2::CSLModel + ~CSLModel()XPMP2::CSLModelvirtual
    diff --git a/docs/html/classXPMP2_1_1CSLModel.html b/docs/html/classXPMP2_1_1CSLModel.html index 6890cf38..c6c56f5a 100644 --- a/docs/html/classXPMP2_1_1CSLModel.html +++ b/docs/html/classXPMP2_1_1CSLModel.html @@ -130,6 +130,8 @@   char GetClassNumEng () const   +int GetNumEngines () const +  char GetClassEngType () const   bool HasRotor () const @@ -755,6 +757,31 @@

    +

    ◆ GetNumEngines()

    + +
    +
    + + + + + +
    + + + + + + + +
    int XPMP2::CSLModel::GetNumEngines () const
    +     		+inline
    +
    +
    diff --git a/docs/html/classXPMP2_1_1RmtDataAcDetailTy-members.html b/docs/html/classXPMP2_1_1FmodError-members.html similarity index 50% rename from docs/html/classXPMP2_1_1RmtDataAcDetailTy-members.html rename to docs/html/classXPMP2_1_1FmodError-members.html index e5c23e44..9e528075 100644 --- a/docs/html/classXPMP2_1_1RmtDataAcDetailTy-members.html +++ b/docs/html/classXPMP2_1_1FmodError-members.html @@ -3,7 +3,7 @@ - + XPMP2: Member List @@ -27,7 +27,7 @@ - + + + + + +
    +
    + + + + + + +
    +
    XPMP2 +
    +
    X-Plane multiplayer library 2 - using instancing
    +
    +
    + + + + + + + +
    +
    +
    +Public Member Functions | +Public Attributes | +List of all members
    +
    +
    XPMP2::FmodError Class Reference
    +
    +
    + +

    Exception class to pass on error information. + More...

    +
    + + Inheritance diagram for XPMP2::FmodError:
    +
    +
    + + + + + + + + + +

    +Public Member Functions

     FmodError (const std::string &_what, FMOD_RESULT _r, int _ln, const std::string &_sFunc)
     Constructor taking on a descriptive string and the FMOD_RESULT More...
     
    void LogErr () const
     Log myself to Log.txt as an error. More...
     
    + + + + + + + + + + +

    +Public Attributes

    FMOD_RESULT fmodRes
     the actual FMOD result code More...
     
    int ln
     line number here in the code More...
     
    std::string sFunc
     name of the function the error occurred in More...
     
    +

    Detailed Description

    +

    Exception class to pass on error information.

    +

    Constructor & Destructor Documentation

    + +

    ◆ FmodError()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    XPMP2::FmodError::FmodError (const std::string & _what,
    FMOD_RESULT _r,
    int _ln,
    const std::string & _sFunc 
    )
    +     		+inline
    +
    + +

    Constructor taking on a descriptive string and the FMOD_RESULT

    + +
    +
    +

    Member Function Documentation

    + +

    ◆ LogErr()

    + +
    +
    + + + + + +
    + + + + + + + +
    void XPMP2::FmodError::LogErr () const
    +     		+inline
    +
    + +

    Log myself to Log.txt as an error.

    + +
    +
    +

    Member Data Documentation

    + +

    ◆ fmodRes

    + +
    +
    + + + + +
    FMOD_RESULT XPMP2::FmodError::fmodRes
    +
    + +

    the actual FMOD result code

    + +
    +
    + +

    ◆ ln

    + +
    +
    + + + + +
    int XPMP2::FmodError::ln
    +
    + +

    line number here in the code

    + +
    +
    + +

    ◆ sFunc

    + +
    +
    + + + + +
    std::string XPMP2::FmodError::sFunc
    +
    + +

    name of the function the error occurred in

    + +
    +
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/html/classXPMP2_1_1FmodError.png b/docs/html/classXPMP2_1_1FmodError.png new file mode 100644 index 00000000..d134928e Binary files /dev/null and b/docs/html/classXPMP2_1_1FmodError.png differ diff --git a/docs/html/classXPMP2_1_1LegacyAircraft-members.html b/docs/html/classXPMP2_1_1LegacyAircraft-members.html index 3226244b..94ea1106 100644 --- a/docs/html/classXPMP2_1_1LegacyAircraft-members.html +++ b/docs/html/classXPMP2_1_1LegacyAircraft-members.html @@ -62,40 +62,46 @@ Aircraft(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="")XPMP2::Aircraft Aircraft()XPMP2::Aircraft Aircraft(const Aircraft &)=deleteXPMP2::Aircraft - AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft - bClampToGroundXPMP2::Aircraft - bDrawLabelXPMP2::Aircraft - bOnGrndXPMP2::Aircraft - bRenderXPMP2::Aircraftprotected - bValidXPMP2::Aircraftprotected - bVisibleXPMP2::Aircraftprotected - camBearingXPMP2::Aircraftprotected - camDistXPMP2::Aircraftprotected - camTimLstUpdXPMP2::Aircraftprotected - ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft - ClampToGround()XPMP2::Aircraftprotected - colLabelXPMP2::Aircraft - ComputeMapLabel()XPMP2::Aircraftprotectedvirtual - Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft - CreateInstances()XPMP2::Aircraftprotected - dataFuncXPMP2::LegacyAircraftprotected - DestroyInstances()XPMP2::Aircraftprotected - DoMove()XPMP2::Aircraftprotected - drawInfoXPMP2::Aircraft - FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic - gearDeflectRatioXPMP2::Aircraft - GetAoA() constXPMP2::Aircraftinlinevirtual - GetCameraBearing() constXPMP2::Aircraftinline - GetCameraDist() constXPMP2::Aircraftinline - GetEngineRotAngle() constXPMP2::Aircraftinline - GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline - GetEngineRotRad() constXPMP2::Aircraftinline - GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline - GetEngineRotRpm() constXPMP2::Aircraftinline - GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline - GetFlapRatio() constXPMP2::Aircraftinline - GetFlightId() constXPMP2::Aircraftvirtual - GetGearRatio() constXPMP2::Aircraftinline + aSndChXPMP2::Aircraftprotected + AssignModel(const std::string &_cslId, CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft + bChnLowPassXPMP2::Aircraftprotected + bChnMutedXPMP2::Aircraftprotected + bClampToGroundXPMP2::Aircraft + bDrawLabelXPMP2::Aircraft + bOnGrndXPMP2::Aircraft + bRenderXPMP2::Aircraftprotected + bValidXPMP2::Aircraftprotected + bVisibleXPMP2::Aircraftprotected + camBearingXPMP2::Aircraftprotected + camDistXPMP2::Aircraftprotected + camTimLstUpdXPMP2::Aircraftprotected + ChangeModel(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery)XPMP2::Aircraft + chnListXPMP2::Aircraftprotected + ChnListTy typedefXPMP2::Aircraft + ClampToGround()XPMP2::Aircraftprotected + colLabelXPMP2::Aircraft + ComputeMapLabel()XPMP2::Aircraftprotectedvirtual + Create(const std::string &_icaoType, const std::string &_icaoAirline, const std::string &_livery, XPMPPlaneID _modeS_id=0, const std::string &_cslId="", CSLModel *_pCSLModel=nullptr)XPMP2::Aircraft + CreateInstances()XPMP2::Aircraftprotected + dataFuncXPMP2::LegacyAircraftprotected + DestroyInstances()XPMP2::Aircraftprotected + DoMove()XPMP2::Aircraftprotected + drawInfoXPMP2::Aircraft + FlightLoopCB(float, float, int, void *)XPMP2::Aircraftprotectedstatic + gearDeflectRatioXPMP2::Aircraft + GetAoA() constXPMP2::Aircraftinlinevirtual + GetCameraBearing() constXPMP2::Aircraftinline + GetCameraDist() constXPMP2::Aircraftinline + GetEngineRotAngle() constXPMP2::Aircraftinline + GetEngineRotAngle(size_t idx) constXPMP2::Aircraftinline + GetEngineRotRad() constXPMP2::Aircraftinline + GetEngineRotRad(size_t idx) constXPMP2::Aircraftinline + GetEngineRotRpm() constXPMP2::Aircraftinline + GetEngineRotRpm(size_t idx) constXPMP2::Aircraftinline + GetFlapRatio() constXPMP2::Aircraftinline + GetFlightId() constXPMP2::Aircraftvirtual + GetGearRatio() constXPMP2::Aircraftinline + GetGS_kn() constXPMP2::Aircraftinline GetHeading() constXPMP2::Aircraftinline GetInfoTexts(XPMPInfoTexts_t *outInfoTexts)XPMP2::LegacyAircraftvirtual GetLift() constXPMP2::Aircraftinlinevirtual @@ -142,99 +148,120 @@ GetYokeHeadingRatio() constXPMP2::Aircraftinline GetYokePitchRatio() constXPMP2::Aircraftinline GetYokeRollRatio() constXPMP2::Aircraftinline - hProbeXPMP2::Aircraftprotected - IsCurrentlyShownAsAI() constXPMP2::Aircraft - IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline - IsGroundVehicle() constXPMP2::Aircraft - IsInstanciated() constXPMP2::Aircraftinline - IsOnGrnd() constXPMP2::Aircraftinline - IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft - IsRendered() constXPMP2::Aircraftinline - IsValid() constXPMP2::Aircraftinline - IsVisible() constXPMP2::Aircraftinline - labelXPMP2::Aircraft - LegacyAircraft(const char *inICAOCode, const char *inAirline, const char *inLivery, XPMPPlaneData_f inDataFunc, void *inRefcon, XPMPPlaneID inModeS_id=0, const char *inModelName=nullptr)XPMP2::LegacyAircraft - listInstXPMP2::Aircraftprotected - MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft - MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft - MapFindIcon()XPMP2::Aircraft - mapIconColXPMP2::Aircraftprotected - mapIconRowXPMP2::Aircraftprotected - mapLabelXPMP2::Aircraftprotected - MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft - mapXXPMP2::Aircraftprotected - mapYXPMP2::Aircraftprotected - matchQualityXPMP2::Aircraftprotected - modeS_idXPMP2::Aircraftprotected - operator=(const Aircraft &)=deleteXPMP2::Aircraft - pCSLMdlXPMP2::Aircraftprotected - prev_tsXPMP2::Aircraftprotected - prev_xXPMP2::Aircraftprotected - prev_yXPMP2::Aircraftprotected - prev_zXPMP2::Aircraftprotected - refconXPMP2::LegacyAircraftprotected - ReMatchModel()XPMP2::Aircraftinline - ResetTcasTargetIdx()XPMP2::Aircraftinline - SetDrawLabel(bool _b)XPMP2::Aircraftinline - SetEngineRotAngle(float _deg)XPMP2::Aircraft - SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft - SetEngineRotRad(float _rad)XPMP2::Aircraft - SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft - SetEngineRotRpm(float _rpm)XPMP2::Aircraft - SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft - SetFlapRatio(float _f)XPMP2::Aircraftinline - SetGearRatio(float _f)XPMP2::Aircraftinline - SetHeading(float _deg)XPMP2::Aircraftinline - SetInvalid()XPMP2::Aircraftvirtual - SetLightsBeacon(bool _b)XPMP2::Aircraftinline - SetLightsLanding(bool _b)XPMP2::Aircraftinline - SetLightsNav(bool _b)XPMP2::Aircraftinline - SetLightsStrobe(bool _b)XPMP2::Aircraftinline - SetLightsTaxi(bool _b)XPMP2::Aircraftinline - SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline - SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline - SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft - SetMass(float _kg)XPMP2::Aircraftinline - SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline - SetNoseWheelAngle(float _f)XPMP2::Aircraftinline - SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft - SetPitch(float _deg)XPMP2::Aircraftinline - SetPropRotAngle(float _deg)XPMP2::Aircraftinline - SetPropRotRad(float _rad)XPMP2::Aircraftinline - SetPropRotRpm(float _rpm)XPMP2::Aircraftinline - SetRender(bool _bRender)XPMP2::Aircraftvirtual - SetReversDeployRatio(float _f)XPMP2::Aircraftinline - SetRoll(float _deg)XPMP2::Aircraftinline - SetSlatRatio(float _f)XPMP2::Aircraftinline - SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline - SetSpoilerRatio(float _f)XPMP2::Aircraftinline - SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual - SetThrustRatio(float _f)XPMP2::Aircraftinline - SetThrustReversRatio(float _f)XPMP2::Aircraftinline - SetTireDeflection(float _mtr)XPMP2::Aircraftinline - SetTireRotAngle(float _deg)XPMP2::Aircraftinline - SetTireRotRad(float _rad)XPMP2::Aircraftinline - SetTireRotRpm(float _rpm)XPMP2::Aircraftinline - SetTouchDown(bool _b)XPMP2::Aircraftinline - SetVisible(bool _bVisible)XPMP2::Aircraftvirtual - SetWingArea(float _m2)XPMP2::Aircraftinline - SetWingSpan(float _m)XPMP2::Aircraftinline - SetWingSweepRatio(float _f)XPMP2::Aircraftinline - SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline - SetYokePitchRatio(float _f)XPMP2::Aircraftinline - SetYokeRollRatio(float _f)XPMP2::Aircraftinline - ShallDrawLabel() constXPMP2::Aircraftinline - ShowAsAIPlane() constXPMP2::Aircraftinline + gs_knXPMP2::Aircraftprotected + hProbeXPMP2::Aircraftprotected + IsCurrentlyShownAsAI() constXPMP2::Aircraft + IsCurrentlyShownAsTcasTarget() constXPMP2::Aircraftinline + IsGroundVehicle() constXPMP2::Aircraft + IsInstanciated() constXPMP2::Aircraftinline + IsOnGrnd() constXPMP2::Aircraftinline + IsRelatedTo(const std::string &_icaoType) constXPMP2::Aircraft + IsRendered() constXPMP2::Aircraftinline + IsValid() constXPMP2::Aircraftinline + IsVisible() constXPMP2::Aircraftinline + labelXPMP2::Aircraft + LegacyAircraft(const char *inICAOCode, const char *inAirline, const char *inLivery, XPMPPlaneData_f inDataFunc, void *inRefcon, XPMPPlaneID inModeS_id=0, const char *inModelName=nullptr)XPMP2::LegacyAircraft + listInstXPMP2::Aircraftprotected + MapDrawIcon(XPLMMapLayerID inLayer, float acSize)XPMP2::Aircraft + MapDrawLabel(XPLMMapLayerID inLayer, float yOfs)XPMP2::Aircraft + MapFindIcon()XPMP2::Aircraft + mapIconColXPMP2::Aircraftprotected + mapIconRowXPMP2::Aircraftprotected + mapLabelXPMP2::Aircraftprotected + MapPreparePos(XPLMMapProjectionID projection, const float boundsLTRB[4])XPMP2::Aircraft + mapXXPMP2::Aircraftprotected + mapYXPMP2::Aircraftprotected + matchQualityXPMP2::Aircraftprotected + modeS_idXPMP2::Aircraftprotected + operator=(const Aircraft &)=deleteXPMP2::Aircraft + pCSLMdlXPMP2::Aircraftprotected + prev_tsXPMP2::Aircraftprotected + prev_xXPMP2::Aircraftprotected + prev_yXPMP2::Aircraftprotected + prev_zXPMP2::Aircraftprotected + refconXPMP2::LegacyAircraftprotected + ReMatchModel()XPMP2::Aircraftinline + ResetTcasTargetIdx()XPMP2::Aircraftinline + SetDrawLabel(bool _b)XPMP2::Aircraftinline + SetEngineRotAngle(float _deg)XPMP2::Aircraft + SetEngineRotAngle(size_t idx, float _deg)XPMP2::Aircraft + SetEngineRotRad(float _rad)XPMP2::Aircraft + SetEngineRotRad(size_t idx, float _rad)XPMP2::Aircraft + SetEngineRotRpm(float _rpm)XPMP2::Aircraft + SetEngineRotRpm(size_t idx, float _rpm)XPMP2::Aircraft + SetFlapRatio(float _f)XPMP2::Aircraftinline + SetGearRatio(float _f)XPMP2::Aircraftinline + SetHeading(float _deg)XPMP2::Aircraftinline + SetInvalid()XPMP2::Aircraftvirtual + SetLightsBeacon(bool _b)XPMP2::Aircraftinline + SetLightsLanding(bool _b)XPMP2::Aircraftinline + SetLightsNav(bool _b)XPMP2::Aircraftinline + SetLightsStrobe(bool _b)XPMP2::Aircraftinline + SetLightsTaxi(bool _b)XPMP2::Aircraftinline + SetLocalLoc(float _x, float _y, float _z)XPMP2::Aircraftinline + SetLocation(double lat, double lon, double alt_ft, bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraftinline + SetLocation(double lat, double lon, double alt_ft)XPMP2::Aircraft + SetMass(float _kg)XPMP2::Aircraftinline + SetNoseGearDeflection(float _mtr)XPMP2::Aircraftinline + SetNoseWheelAngle(float _f)XPMP2::Aircraftinline + SetOnGrnd(bool on_grnd, float setTouchDownTime=NAN)XPMP2::Aircraft + SetPitch(float _deg)XPMP2::Aircraftinline + SetPropRotAngle(float _deg)XPMP2::Aircraftinline + SetPropRotRad(float _rad)XPMP2::Aircraftinline + SetPropRotRpm(float _rpm)XPMP2::Aircraftinline + SetRender(bool _bRender)XPMP2::Aircraftvirtual + SetReversDeployRatio(float _f)XPMP2::Aircraftinline + SetRoll(float _deg)XPMP2::Aircraftinline + SetSlatRatio(float _f)XPMP2::Aircraftinline + SetSpeedbrakeRatio(float _f)XPMP2::Aircraftinline + SetSpoilerRatio(float _f)XPMP2::Aircraftinline + SetTcasTargetIdx(int _idx)XPMP2::Aircraftinlineprotectedvirtual + SetThrustRatio(float _f)XPMP2::Aircraftinline + SetThrustReversRatio(float _f)XPMP2::Aircraftinline + SetTireDeflection(float _mtr)XPMP2::Aircraftinline + SetTireRotAngle(float _deg)XPMP2::Aircraftinline + SetTireRotRad(float _rad)XPMP2::Aircraftinline + SetTireRotRpm(float _rpm)XPMP2::Aircraftinline + SetTouchDown(bool _b)XPMP2::Aircraftinline + SetVisible(bool _bVisible)XPMP2::Aircraftvirtual + SetWingArea(float _m2)XPMP2::Aircraftinline + SetWingSpan(float _m)XPMP2::Aircraftinline + SetWingSweepRatio(float _f)XPMP2::Aircraftinline + SetYokeHeadingRatio(float _f)XPMP2::Aircraftinline + SetYokePitchRatio(float _f)XPMP2::Aircraftinline + SetYokeRollRatio(float _f)XPMP2::Aircraftinline + ShallDrawLabel() constXPMP2::Aircraftinline + ShowAsAIPlane() constXPMP2::Aircraftinline + skipCounterXPMP2::Aircraftprotected + SND_ENG enum valueXPMP2::Aircraft + SND_FLAPS enum valueXPMP2::Aircraft + SND_GEAR enum valueXPMP2::Aircraft + SND_NUM_EVENTS enum valueXPMP2::Aircraft + SND_REVERSE_THRUST enum valueXPMP2::Aircraft + SND_TIRE enum valueXPMP2::Aircraft + sndMinDistXPMP2::Aircraft + SoundEventsTy enum nameXPMP2::Aircraft + SoundGetName(SoundEventsTy sndEvent, float &volAdj) constXPMP2::Aircraftvirtual + SoundMuteAll(bool bMute)XPMP2::Aircraft + SoundPlay(const std::string &sndName, float vol=1.0f)XPMP2::Aircraft + SoundRemoveAll()XPMP2::Aircraftprotectedvirtual + SoundSetup()XPMP2::Aircraftprotectedvirtual + SoundStop(FMOD_CHANNEL *pChn)XPMP2::Aircraft + SoundUpdate()XPMP2::Aircraftprotectedvirtual + SoundVolume(FMOD_CHANNEL *pChn, float vol)XPMP2::Aircraft tcasTargetIdxXPMP2::Aircraftprotected tsResetTouchDownXPMP2::Aircraftprotected UpdateDistBearingCamera(const XPLMCameraPosition_t &posCam)XPMP2::Aircraftprotected UpdatePosition(float _elapsedSinceLastCall, int _flCounter)XPCAircraftvirtual vXPMP2::Aircraft - vertOfsRatioXPMP2::Aircraft - wakeXPMP2::Aircraft - WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft - XPCAircraft(const char *_icaoType, const char *_icaoAirline, const char *_livery, XPMPPlaneID _modeS_id=0, const char *_modelId=nullptr)XPCAircraft - ~Aircraft()XPMP2::Aircraftvirtual + v_xXPMP2::Aircraftprotected + v_yXPMP2::Aircraftprotected + v_zXPMP2::Aircraftprotected + vertOfsRatioXPMP2::Aircraft + wakeXPMP2::Aircraft + WakeApplyDefaults(bool _bOverwriteAllFields=true)XPMP2::Aircraft + XPCAircraft(const char *_icaoType, const char *_icaoAirline, const char *_livery, XPMPPlaneID _modeS_id=0, const char *_modelId=nullptr)XPCAircraft + ~Aircraft()XPMP2::Aircraftvirtual
    diff --git a/docs/html/classXPMP2_1_1LegacyAircraft.html b/docs/html/classXPMP2_1_1LegacyAircraft.html index a2055cb5..81b9d8ed 100644 --- a/docs/html/classXPMP2_1_1LegacyAircraft.html +++ b/docs/html/classXPMP2_1_1LegacyAircraft.html @@ -113,7 +113,7 @@  Creates a plane, only a valid operation if object was created using the default constructor. More...
      XPMPPlaneID GetModeS_ID () const - return the XPMP2 plane id More...
    + return the XPMP2 plane id More...
      bool IsGroundVehicle () const  Is this object a ground vehicle? More...
    @@ -235,6 +235,9 @@ void SetRoll (float _deg)  roll [degree] More...
      +float GetGS_kn () const + Rough estimate of a ground speed based on v_x/z More...
    +  float GetGearRatio () const  Gear deploy ratio. More...
      @@ -457,7 +460,7 @@  Angle of Attach, returns pitch (but you can override in your class) More...
      virtual float GetLift () const - Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
    + Lift produced. You should override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag. More...
      void MapFindIcon ()  Determine which map icon to use for this aircraft. More...
    @@ -471,6 +474,21 @@ void MapDrawLabel (XPLMMapLayerID inLayer, float yOfs)  Actually draw the map label. More...
      +FMOD_CHANNEL * SoundPlay (const std::string &sndName, float vol=1.0f) + Play a sound; a looping sound plays until explicitely stopped. More...
    +  +void SoundStop (FMOD_CHANNEL *pChn) + Stop a continuously playing sound. More...
    +  +void SoundVolume (FMOD_CHANNEL *pChn, float vol) + Sets the sound's volume (after applying master volume and Sound File's adjustments) More...
    +  +void SoundMuteAll (bool bMute) + Mute/Unmute all sounds of the airplane temporarily. More...
    +  +virtual std::string SoundGetName (SoundEventsTy sndEvent, float &volAdj) const + Returns the name of the sound to play per event. More...
    +  @@ -511,8 +529,17 @@ + + + + + + + + + - + @@ -547,9 +574,40 @@ + + + + + + + + + + + + + + +

    Protected Attributes

    float prev_ts = 0.0f
     last update of prev_x/y/z in XP's network time More...
     
    float v_x = 0.0f
     
    float v_y = 0.0f
     
    float v_z = 0.0f
     Cartesian velocity in m/s per axis. More...
     
    float gs_kn = 0.0f
     
    float tsResetTouchDown = NAN
     Set by SetOnGrnd() with the timestamp when to reset SetTouchDown() More...
     ground speed in [kn] based on above v_x/z More...
     
    std::list< XPLMInstanceRef > listInst
     X-Plane instance handles for all objects making up the model. More...
    std::string mapLabel
     label for map drawing More...
     
    SndChTy aSndCh [SND_NUM_EVENTS]
     Operational values per sound channel, that is triggered by a standard sound event. More...
     
    bool bChnLowPass = false
     Is Low Pass Filter currently being active? More...
     
    bool bChnMuted = false
     Is sound for this aircraft currently muted? More...
     
    ChnListTy chnList
     List of channels produced via calls to SoundPlay() More...
     
    int skipCounter = 0
     Counts how often we skipped expensive computations. More...
     
    + + + + + + + @@ -606,6 +664,9 @@ + + + @@ -628,6 +689,15 @@ + + + + + + + + + diff --git a/docs/html/classXPMP2_1_1RmtDataAcDetailTy.html b/docs/html/classXPMP2_1_1RmtDataAcDetailTy.html deleted file mode 100644 index ae9869e9..00000000 --- a/docs/html/classXPMP2_1_1RmtDataAcDetailTy.html +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - - -XPMP2: XPMP2::RmtDataAcDetailTy Class Reference - - - - - - -
    -
    -

    Additional Inherited Members

    - Public Types inherited from XPMP2::Aircraft
    enum  SoundEventsTy {
    +  SND_ENG = 0 +, SND_REVERSE_THRUST +, SND_TIRE +, SND_GEAR +,
    +  SND_FLAPS +, SND_NUM_EVENTS +
    + }
     Types of sound supported directly by XPMP2. More...
     
    typedef std::list< FMOD_CHANNEL * > ChnListTy
     List of FMOD channels, also beyond sounds created for SoundEvetsTy. More...
     
    - Public Attributes inherited from XPCAircraft
    XPMPPlanePosition_t acPos
     Last position data. GetPlanePosition() passes a pointer to this member variable. More...
    XPMPInfoTexts_t acInfoTexts
     Informational texts passed on via multiplayer shared dataRefs. More...
     
    int sndMinDist = 50.0
     Minimum distance in [m] to play sound in full volume, the larger the 'louder' the aircraft. More...
     
    - Protected Member Functions inherited from XPMP2::Aircraft
    void DoMove ()
     Internal: This puts the instance into XP's sky and makes it move. More...
    virtual void SetTcasTargetIdx (int _idx)
     Define the TCAS target index in use. More...
     
    virtual void SoundSetup ()
     Sound-related initializations, called by Create() and ChangeModel() More...
     
    virtual void SoundUpdate ()
     Update sound, like position and volume, called once per frame. More...
     
    virtual void SoundRemoveAll ()
     Remove all sound, e.g. during destruction. More...
     
    - Static Protected Member Functions inherited from XPMP2::Aircraft
    static float FlightLoopCB (float, float, int, void *)
     Internal: Flight loop callback function controlling update and movement of all planes. More...
    - - - - - -
    -
    XPMP2 -
    -
    X-Plane multiplayer library 2 - using instancing
    -
    - - - - - - - - - -
    -
    -Public Member Functions | -Public Attributes | -List of all members
    -
    -
    XPMP2::RmtDataAcDetailTy Class Reference
    -
    -
    - -

    Passing information about an a/c full detail message: it is actually right away that message. - More...

    - -

    #include <Remote.h>

    -
    - + Inheritance diagram for XPMP2::RmtDataAcDetailTy:
    -
    -
    - - - - - - - - - - - - - - - - -

    -Public Member Functions

     RmtDataAcDetailTy ()
     Default constructor only sets message type, leaves rest empty. More...
     
     RmtDataAcDetailTy (const Aircraft &_ac)
     Aircraft copy constructor passes the XPMP2::Aircraft object on to the msg member. More...
     
    - Public Member Functions inherited from XPMP2::RmtDataBaseTy
     RmtDataBaseTy (RemoteMsgTy _ty)
     Constructor just set the message type. More...
     
    virtual ~RmtDataBaseTy ()
     Virtual destructor makes sure correct deletion of derived class' objects even through (smart) pointers to this base class. More...
     
    - - - - - - - - -

    -Public Attributes

    RemoteAcDetailTy msg
     the entire network message pre-packed More...
     
    - Public Attributes inherited from XPMP2::RmtDataBaseTy
    RemoteMsgTy msgTy
     which message to send? More...
     
    -

    Detailed Description

    -

    Passing information about an a/c full detail message: it is actually right away that message.

    -

    Constructor & Destructor Documentation

    - -

    ◆ RmtDataAcDetailTy() [1/2]

    - -
    -
    - - - - - -
    - - - - - - - -
    XPMP2::RmtDataAcDetailTy::RmtDataAcDetailTy ()
    -     		-inline
    -
    - -

    Default constructor only sets message type, leaves rest empty.

    - -
    -
    - -

    ◆ RmtDataAcDetailTy() [2/2]

    - -
    -
    - - - - - -
    - - - - - - - - -
    XPMP2::RmtDataAcDetailTy::RmtDataAcDetailTy (const Aircraft & _ac)
    -     		-inline
    -
    - -

    Aircraft copy constructor passes the XPMP2::Aircraft object on to the msg member.

    - -
    -
    -

    Member Data Documentation

    - -

    ◆ msg

    - -
    -
    - - - - -
    RemoteAcDetailTy XPMP2::RmtDataAcDetailTy::msg
    -
    - -

    the entire network message pre-packed

    - -
    -
    -
    The documentation for this class was generated from the following file: -
    - -
    -Generated by   -doxygen - 1.8.18 -
    - - diff --git a/docs/html/classXPMP2_1_1RmtDataAcDetailTy.png b/docs/html/classXPMP2_1_1RmtDataAcDetailTy.png deleted file mode 100644 index 35bda731..00000000 Binary files a/docs/html/classXPMP2_1_1RmtDataAcDetailTy.png and /dev/null differ diff --git a/docs/html/classXPMP2_1_1SoundFile-members.html b/docs/html/classXPMP2_1_1SoundFile-members.html new file mode 100644 index 00000000..bcf340d6 --- /dev/null +++ b/docs/html/classXPMP2_1_1SoundFile-members.html @@ -0,0 +1,78 @@ + + + + + + + +XPMP2: Member List + + + + + + +
    +
    + + + + + + +
    +
    XPMP2 +
    +
    X-Plane multiplayer library 2 - using instancing
    +
    +
    + + + + + + + +
    +
    +
    +
    XPMP2::SoundFile Member List
    +
    +
    + +

    This is the complete list of members for XPMP2::SoundFile, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + +
    bLoadedXPMP2::SoundFileprotected
    bLoopXPMP2::SoundFile
    coneDirXPMP2::SoundFile
    coneInAngleXPMP2::SoundFile
    coneOutAngleXPMP2::SoundFile
    coneOutVolXPMP2::SoundFile
    conePitchXPMP2::SoundFile
    filePathXPMP2::SoundFile
    firstTimeInit()XPMP2::SoundFileinline
    hasConeInfo() constXPMP2::SoundFileinline
    isReady()XPMP2::SoundFileinline
    len_msXPMP2::SoundFileprotected
    LoadXPSounds()XPMP2::SoundFileinlinestatic
    play(FMOD_CHANNELGROUP *pChGrp=nullptr, bool bPaused=false)XPMP2::SoundFileinline
    pSoundXPMP2::SoundFileprotected
    setConeOrientation(FMOD_CHANNEL *pChn, const Aircraft &ac)XPMP2::SoundFileinline
    SoundFile(const std::string &_filePath, bool _bLoop, float _coneDir, float _conePitch, float _coneInAngle, float _coneOutAngle, float _coneOutVol)XPMP2::SoundFileinline
    SoundFile(const SoundFile &o)=deleteXPMP2::SoundFile
    ~SoundFile()XPMP2::SoundFileinline
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/html/classXPMP2_1_1SoundFile.html b/docs/html/classXPMP2_1_1SoundFile.html new file mode 100644 index 00000000..e833444b --- /dev/null +++ b/docs/html/classXPMP2_1_1SoundFile.html @@ -0,0 +1,657 @@ + + + + + + + +XPMP2: XPMP2::SoundFile Class Reference + + + + + + +
    +
    + + + + + + +
    +
    XPMP2 +
    +
    X-Plane multiplayer library 2 - using instancing
    +
    +
    + + + + + + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +Public Attributes | +Protected Attributes | +List of all members
    +
    +
    XPMP2::SoundFile Class Reference
    +
    +
    + +

    Represents a sound file. + More...

    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     SoundFile (const std::string &_filePath, bool _bLoop, float _coneDir, float _conePitch, float _coneInAngle, float _coneOutAngle, float _coneOutVol)
     Construct a sound object from a file name and have it loaded asynchonously. More...
     
     SoundFile (const SoundFile &o)=delete
     Copying is not permitted. More...
     
     ~SoundFile ()
     Destructor removes the sound object. More...
     
    void firstTimeInit ()
     Called the first time the sound is played after loading has finished. More...
     
    bool isReady ()
     Has loading the sound sample finished? More...
     
    bool hasConeInfo () const
     Has full cone information? More...
     
    FMOD_CHANNEL * play (FMOD_CHANNELGROUP *pChGrp=nullptr, bool bPaused=false)
     Play the sound. More...
     
    void setConeOrientation (FMOD_CHANNEL *pChn, const Aircraft &ac)
     Set the channel's sound cone relative to the aircraft's orientation in space and the cone configuration of the SoundFile. More...
     
    + + + + +

    +Static Public Member Functions

    static int LoadXPSounds ()
     Load fixed set of X-Plane-internal sounds. More...
     
    + + + + + + + + + + + + + + + + + + + + + + +

    +Public Attributes

    std::string filePath
     File path to sound file. More...
     
    bool bLoop = true
     sound to be played in a loop? More...
     
    float coneDir = NAN
     Which direction relative to plane's heading does the cone point to? (180 would be typical for jet engines) More...
     
    float conePitch = NAN
     Which pitch does the cone point to (up/down)? (0 would be typical, ie. level with the plane) More...
     
    float coneInAngle = NAN
     Inside cone angle. This is the angle spread within which the sound is unattenuated. More...
     
    float coneOutAngle = NAN
     Outside cone angle. This is the angle spread outside of which the sound is attenuated to its SoundFile::coneOutVol. More...
     
    float coneOutVol = NAN
     Cone outside volume. More...
     
    + + + + + + + + + + +

    +Protected Attributes

    unsigned len_ms = 0
     Sound length in ms. More...
     
    FMOD_SOUND * pSound = nullptr
     FMOD sound object. More...
     
    bool bLoaded = false
     cached version of the sound's openstate More...
     
    +

    Detailed Description

    +

    Represents a sound file.

    +
    See also
    For 3D cones also see https://www.fmod.com/docs/2.01/api/core-api-channelcontrol.html#channelcontrol_set3dconesettings
    +

    Constructor & Destructor Documentation

    + +

    ◆ SoundFile() [1/2]

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    XPMP2::SoundFile::SoundFile (const std::string & _filePath,
    bool _bLoop,
    float _coneDir,
    float _conePitch,
    float _coneInAngle,
    float _coneOutAngle,
    float _coneOutVol 
    )
    +     		+inline
    +
    + +

    Construct a sound object from a file name and have it loaded asynchonously.

    +
    Exceptions
    + + +
    FmodErrorin case of errors during CreateSound
    +
    +
    + +
    +
    + +

    ◆ SoundFile() [2/2]

    + +
    +
    + + + + + +
    + + + + + + + + +
    XPMP2::SoundFile::SoundFile (const SoundFile & o)
    +     		+delete
    +
    + +

    Copying is not permitted.

    + +
    +
    + +

    ◆ ~SoundFile()

    + +
    +
    + + + + + +
    + + + + + + + +
    XPMP2::SoundFile::~SoundFile ()
    +     		+inline
    +
    + +

    Destructor removes the sound object.

    + +
    +
    +

    Member Function Documentation

    + +

    ◆ firstTimeInit()

    + +
    +
    + + + + + +
    + + + + + + + +
    void XPMP2::SoundFile::firstTimeInit ()
    +     		+inline
    +
    + +

    Called the first time the sound is played after loading has finished.

    + +
    +
    + +

    ◆ hasConeInfo()

    + +
    +
    + + + + + +
    + + + + + + + +
    bool XPMP2::SoundFile::hasConeInfo () const
    +     		+inline
    +
    + +

    Has full cone information?

    + +
    +
    + +

    ◆ isReady()

    + +
    +
    + + + + + +
    + + + + + + + +
    bool XPMP2::SoundFile::isReady ()
    +     		+inline
    +
    + +

    Has loading the sound sample finished?

    + +
    +
    + +

    ◆ LoadXPSounds()

    + +
    +
    + + + + + +
    + + + + + + + +
    static int XPMP2::SoundFile::LoadXPSounds ()
    +     		+inlinestatic
    +
    + +

    Load fixed set of X-Plane-internal sounds.

    +
    Returns
    Number of loaded sounds
    + +
    +
    + +

    ◆ play()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    FMOD_CHANNEL* XPMP2::SoundFile::play (FMOD_CHANNELGROUP * pChGrp = nullptr,
    bool bPaused = false 
    )
    +     		+inline
    +
    + +

    Play the sound.

    +
    Parameters
    + + + +
    pChGrp[opt] The channel group this sound is to be added to, can be nullptr
    bPaused[opt] Shall channel stay paused after creation?
    +
    +
    +
    Returns
    nullptr in case of failure
    + +
    +
    + +

    ◆ setConeOrientation()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void XPMP2::SoundFile::setConeOrientation (FMOD_CHANNEL * pChn,
    const Aircraft & ac 
    )
    +     		+inline
    +
    + +

    Set the channel's sound cone relative to the aircraft's orientation in space and the cone configuration of the SoundFile.

    +
    Parameters
    + + + +
    pChnThe channel, which is to be modified
    acAircraft
    +
    +
    + +
    +
    +

    Member Data Documentation

    + +

    ◆ bLoaded

    + +
    +
    + + + + + +
    + + + + +
    bool XPMP2::SoundFile::bLoaded = false
    +     		+protected
    +
    + +

    cached version of the sound's openstate

    + +
    +
    + +

    ◆ bLoop

    + +
    +
    + + + + +
    bool XPMP2::SoundFile::bLoop = true
    +
    + +

    sound to be played in a loop?

    + +
    +
    + +

    ◆ coneDir

    + +
    +
    + + + + +
    float XPMP2::SoundFile::coneDir = NAN
    +
    + +

    Which direction relative to plane's heading does the cone point to? (180 would be typical for jet engines)

    + +
    +
    + +

    ◆ coneInAngle

    + +
    +
    + + + + +
    float XPMP2::SoundFile::coneInAngle = NAN
    +
    + +

    Inside cone angle. This is the angle spread within which the sound is unattenuated.

    + +
    +
    + +

    ◆ coneOutAngle

    + +
    +
    + + + + +
    float XPMP2::SoundFile::coneOutAngle = NAN
    +
    + +

    Outside cone angle. This is the angle spread outside of which the sound is attenuated to its SoundFile::coneOutVol.

    + +
    +
    + +

    ◆ coneOutVol

    + +
    +
    + + + + +
    float XPMP2::SoundFile::coneOutVol = NAN
    +
    + +

    Cone outside volume.

    + +
    +
    + +

    ◆ conePitch

    + +
    +
    + + + + +
    float XPMP2::SoundFile::conePitch = NAN
    +
    + +

    Which pitch does the cone point to (up/down)? (0 would be typical, ie. level with the plane)

    + +
    +
    + +

    ◆ filePath

    + +
    +
    + + + + +
    std::string XPMP2::SoundFile::filePath
    +
    + +

    File path to sound file.

    + +
    +
    + +

    ◆ len_ms

    + +
    +
    + + + + + +
    + + + + +
    unsigned XPMP2::SoundFile::len_ms = 0
    +     		+protected
    +
    + +

    Sound length in ms.

    + +
    +
    + +

    ◆ pSound

    + +
    +
    + + + + + +
    + + + + +
    FMOD_SOUND* XPMP2::SoundFile::pSound = nullptr
    +     		+protected
    +
    + +

    FMOD sound object.

    + +
    +
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/html/classXPMP2_1_1XPMP2Error.html b/docs/html/classXPMP2_1_1XPMP2Error.html index 525c0683..1f026a62 100644 --- a/docs/html/classXPMP2_1_1XPMP2Error.html +++ b/docs/html/classXPMP2_1_1XPMP2Error.html @@ -52,7 +52,7 @@
    -

    XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft. +

    XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft. More...

    #include <XPMPAircraft.h>

    @@ -98,7 +98,7 @@  

    Detailed Description

    -

    XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft.

    +

    XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft.

    Constructor & Destructor Documentation

    ◆ XPMP2Error() [1/3]

    diff --git a/docs/html/classes.html b/docs/html/classes.html index d958b5a1..3cf0dce0 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -43,7 +43,7 @@
    Class Index
    -
    A | B | C | D | G | I | L | M | N | O | P | R | S | T | U | W | X
    +
    A | B | C | D | F | G | I | L | M | N | O | P | R | S | T | U | W | X
    A
    @@ -58,42 +58,45 @@
    D
    RemoteAcAnimTy::DataRefValTy (XPMP2)
    Doc8643 (XPMP2)
    +
    F
    +
    FMOD_10830_ADVANCEDSETTINGS (XPMP2)
    FmodError (XPMP2)
    +
    G
    GlobVars (XPMP2)
    -
    +
    I
    InetAddrTy (XPMP2)
    infoDataRefsTy (XPMP2)
    -
    +
    L
    LegacyAircraft (XPMP2)
    LegacySampleAircraft
    -
    +
    M
    CSLModelInfo_t::MatchCrit_t (XPMP2)
    CSLModel::MatchCritTy (XPMP2)
    multiDataRefsTy (XPMP2)
    -
    +
    N
    NetRuntimeError (XPMP2)
    -
    +
    O
    Obj8DataRefs (XPMP2)
    -
    +
    P
    positionTy
    -
    +
    R
    RemoteAC
    RemoteAcAnimTy (XPMP2)
    RemoteAcDetailTy (XPMP2)
    RemoteAcDetailTy_v0 (XPMP2)
    RemoteAcPosUpdateTy (XPMP2)
    RemoteAcRemoveTy (XPMP2)
    RemoteCBFctTy (XPMP2)
    RemoteDataRefPackTy (XPMP2)
    RemoteMsgAcAnimTy (XPMP2)
    RemoteMsgAcDetailTy (XPMP2)
    RemoteMsgAcDetailTy_v0 (XPMP2)
    RemoteMsgAcPosUpdateTy (XPMP2)
    RemoteMsgAcRemoveTy (XPMP2)
    RemoteMsgBaseTy (XPMP2)
    RemoteMsgBeaconTy (XPMP2)
    RemoteMsgSettingsTy (XPMP2)
    RmtAcCacheTy (XPMP2)
    RmtDataAcAnimTy (XPMP2)
    RmtDataAcAnimTy.__unnamed4__ (XPMP2)
    RmtDataBaseTy (XPMP2)
    RmtDataEnqeueTy (XPMP2)
    RmtMsgBufTy (XPMP2)
    -
    -
    S
    -
    SampleAircraft
    SenderAddrTy
    SenderTy
    SocketNetworking (XPMP2)
    +
    S
    +
    SampleAircraft
    SenderAddrTy
    SenderTy
    Aircraft::SndChTy (XPMP2)
    SocketNetworking (XPMP2)
    SoundDefTy (XPMP2)
    SoundFile (XPMP2)
    +
    T
    TcasLightsTy (XPMP2)
    TCPConnection (XPMP2)
    -
    +
    U
    UDPMulticast (XPMP2)
    UDPReceiver (XPMP2)
    -
    +
    W
    Aircraft::wakeTy (XPMP2)
    -
    +
    X
    XPCAircraft
    XPMP2Error (XPMP2)
    XPMP2RCGlobals
    xpmp_LightStatus
    xpmp_LightStatus.__unnamed2__
    XPMPInfoTexts_t
    XPMPPlaneNotifierTy (XPMP2)
    XPMPPlanePosition_t
    XPMPPlaneRadar_t
    XPMPPlaneSurfaces_t
    diff --git a/docs/html/deprecated.html b/docs/html/deprecated.html index 250721d8..51bc4dc9 100644 --- a/docs/html/deprecated.html +++ b/docs/html/deprecated.html @@ -47,7 +47,7 @@
    Class XPCAircraft
    Only provided for backwards compile-compatibility. New implementations should subclass XPMP2::Aircraft directly.
    File XPCAircraft.h
    -
    XPCAircraft bases on and is compile-compatible to the XPCAircraft wrapper class provided with the original libxplanemp. In XPMP2, however, this class is not a wrapper but derived from XPMP2::Aircraft, which is the actual means of managing aircraft, Hence, it includes a lot more members.
    +
    XPCAircraft bases on and is compile-compatible to the XPCAircraft wrapper class provided with the original libxplanemp. In XPMP2, however, this class is not a wrapper but derived from XPMP2::Aircraft, which is the actual means of managing aircraft, Hence, it includes a lot more members.
    New implementations should derive directly from XPMP2::Aircraft.
    Member XPMPCreatePlane (const char *inICAOCode, const char *inAirline, const char *inLivery, XPMPPlaneData_f inDataFunc, void *inRefcon, XPMPPlaneID inModeS_id)
    Subclass XPMP2::Aircraft instead
    @@ -63,9 +63,9 @@
    No longer supported as rendering is done by X-Plane's instancing
    Member XPMPGetModelInfo (int inIndex, const char **outModelName, const char **outIcao, const char **outAirline, const char **outLivery)
    Instead, use XPMPGetModelInfo2().
    - This legacy function is defined with pointers to text arrays as return type. This is rather unsafe. XPMP2's internal maps and buffers may change if more models are loaded, hence pointers may become invalid. Don't rely on these pointers staying valid over an extended period of time.
    + This legacy function is defined with pointers to text arrays as return type. This is rather unsafe. XPMP2's internal maps and buffers may change if more models are loaded, hence pointers may become invalid. Don't rely on these pointers staying valid over an extended period of time.
    Member XPMPGetPlaneData (XPMPPlaneID, XPMPPlaneDataType, void *)
    -
    Not supported in XPMP2! In the legacy library this is actually more like an internal function, calling all callback functions for querying aircraft data (much like XPCAircraft::UpdatePosition() is now in XPMP2). I doubt that it was intended to be called from the outside in the first place.
    +
    Not supported in XPMP2! In the legacy library this is actually more like an internal function, calling all callback functions for querying aircraft data (much like XPCAircraft::UpdatePosition() is now in XPMP2). I doubt that it was intended to be called from the outside in the first place.
    Member XPMPGetPlaneICAOAndLivery (XPMPPlaneID inPlane, char *outICAOCode, char *outLivery)
    This legacy function is defined in a rather unsafe way. Instead, use XPMPGetAircraft() and access PMP2::Aircraft::acIcaoType and XPMP2::Aircraft::acLivery directly.
    Member XPMPInitDefaultPlaneRenderer (void)
    @@ -73,9 +73,9 @@
    File XPMPPlaneRenderer.h
    None of these functions are supported any longer, their definitions are only provided for backward compatibility.
    Member XPMPRenderPlanes_f )(int inIsBlend, void *inRef)
    -
    Unsupported in XPMP2. The type definition is available to stay compile-time compatible, but the callback will not be called.
    +
    Unsupported in XPMP2. The type definition is available to stay compile-time compatible, but the callback will not be called.
    Member XPMPSetPlaneRenderer (XPMPRenderPlanes_f, void *)
    -
    Unsupported in XPMP2. The function is available to stay compile-time compatible, but it does nothing.
    +
    Unsupported in XPMP2. The function is available to stay compile-time compatible, but it does nothing.

    diff --git a/docs/html/dir_05cb372b8b5d29a91f8ab8956535a165.html b/docs/html/dir_05cb372b8b5d29a91f8ab8956535a165.html index 4f6e995c..39f281d9 100644 --- a/docs/html/dir_05cb372b8b5d29a91f8ab8956535a165.html +++ b/docs/html/dir_05cb372b8b5d29a91f8ab8956535a165.html @@ -48,10 +48,15 @@
    + + + +

    +Directories

    directory  lib
     
    - +

    Files

    file  XPMP2-Sample.cpp
     Example plugin demonstrating XPMP2 techniques.
     Example plugin demonstrating XPMP2 techniques.
     
    diff --git a/docs/html/dir_51881af2d47c8c327d633c4b13cbc753.html b/docs/html/dir_51881af2d47c8c327d633c4b13cbc753.html new file mode 100644 index 00000000..abef1205 --- /dev/null +++ b/docs/html/dir_51881af2d47c8c327d633c4b13cbc753.html @@ -0,0 +1,62 @@ + + + + + + + +XPMP2: XPMP2-Sample/lib/fmod Directory Reference + + + + + + +
    +
    + + + + + + +
    +
    XPMP2 +
    +
    X-Plane multiplayer library 2 - using instancing
    +
    +
    + + + + + + + +
    +
    +
    +
    fmod Directory Reference
    +
    +
    + + + + +

    +Directories

    directory  logo
     
    +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 3a293054..61c3c072 100644 --- a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -63,7 +63,7 @@  Definitions for serving TCAS target dataRef updates.
      file  Aircraft.cpp - XPCAircraft represents an aircraft as managed by XPMP2.
    + XPCAircraft represents an aircraft as managed by XPMP2.
      file  Aircraft.h [code]  Additional definitions beyond what public XPCAircraft defines.
    @@ -101,6 +101,12 @@ file  Remote.h [code]  Master/Client communication for aircraft synchronization on remote networked instances.
      +file  Sound.cpp + Sound for aircraft, based on the FMOD library.
    +  +file  Sound.h [code] + Sound for aircraft, based on the FMOD library.
    +  file  Utilities.cpp  Miscellaneous utility functions, including logging.
      @@ -108,10 +114,10 @@  Miscellaneous utility functions, including logging.
      file  XPMP2.h [code] - Header file covering all includes required for compiling XPMP2, basis for pre-compiled headers.
    + Header file covering all includes required for compiling XPMP2, basis for pre-compiled headers.
      file  XPMPMultiplayer.cpp - Initialization and general control functions for XPMP2.
    + Initialization and general control functions for XPMP2.
      diff --git a/docs/html/dir_697d5b740a2e246e51f61ae622e5094c.html b/docs/html/dir_697d5b740a2e246e51f61ae622e5094c.html new file mode 100644 index 00000000..dfcebe62 --- /dev/null +++ b/docs/html/dir_697d5b740a2e246e51f61ae622e5094c.html @@ -0,0 +1,62 @@ + + + + + + + +XPMP2: XPMP2-Sample/lib Directory Reference + + + + + + +
    +
    + + + + + + +
    +
    XPMP2 +
    +
    X-Plane multiplayer library 2 - using instancing
    +
    +
    + + + + + + + +
    +
    +
    +
    lib Directory Reference
    +
    +
    + + + + +

    +Directories

    directory  fmod
     
    +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/html/dir_7370f38adb3ae597f7d725dcce8bc0c8.html b/docs/html/dir_7370f38adb3ae597f7d725dcce8bc0c8.html new file mode 100644 index 00000000..b70b8efc --- /dev/null +++ b/docs/html/dir_7370f38adb3ae597f7d725dcce8bc0c8.html @@ -0,0 +1,66 @@ + + + + + + + +XPMP2: XPMP2-Sample/lib/fmod/logo Directory Reference + + + + + + +
    +
    + + + + + + +
    +
    XPMP2 +
    +
    X-Plane multiplayer library 2 - using instancing
    +
    +
    + + + + + + + +
    +
    +
    +
    logo Directory Reference
    +
    +
    + + + + + + + + +

    +Files

    file  FMOD_Logo.cpp
     Compressed version of the FMOD logo with code to create a texture ID in X-Plane for display with Dear ImGui.
     
    file  FMOD_Logo.h [code]
     Compressed version of the FMOD logo with code to create a texture ID in X-Plane for display with Dear ImGui.
     
    +
    + +
    +Generated by doxygen 1.9.1 +
    + + diff --git a/docs/html/dir_bfccd401955b95cf8c75461437045ac0.html b/docs/html/dir_bfccd401955b95cf8c75461437045ac0.html index 0d8cfa33..e56e3e71 100644 --- a/docs/html/dir_bfccd401955b95cf8c75461437045ac0.html +++ b/docs/html/dir_bfccd401955b95cf8c75461437045ac0.html @@ -51,13 +51,13 @@

    Files

    file  XPCAircraft.h [code] - XPMP2::Aircraft / XPCAircraft represent an aircraft as managed by XPMP2.
    + XPMP2::Aircraft / XPCAircraft represent an aircraft as managed by XPMP2.
      file  XPMPAircraft.h [code] - XPMP2::Aircraft represent an aircraft as managed by XPMP2.
    + XPMP2::Aircraft represent an aircraft as managed by XPMP2.
      file  XPMPMultiplayer.h [code] - Initialization and general control functions for XPMP2.
    + Initialization and general control functions for XPMP2.
      file  XPMPPlaneRenderer.h [code]  Rendering functions.
    diff --git a/docs/html/dir_ee4fc00837492ac40974302c5064a581.html b/docs/html/dir_ee4fc00837492ac40974302c5064a581.html index 485229d1..df8ee8c7 100644 --- a/docs/html/dir_ee4fc00837492ac40974302c5064a581.html +++ b/docs/html/dir_ee4fc00837492ac40974302c5064a581.html @@ -63,10 +63,10 @@  Miscellaneous utility functions, including logging.
      file  XPMP2-Remote.cpp - XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network.
    + XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network.
      file  XPMP2-Remote.h [code] - XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network.
    + XPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network.
      diff --git a/docs/html/doxygen.png b/docs/html/doxygen.png deleted file mode 100644 index 3ff17d80..00000000 Binary files a/docs/html/doxygen.png and /dev/null differ diff --git a/docs/html/files.html b/docs/html/files.html index e7e127b3..0424676c 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -44,12 +44,12 @@
    Here is a list of all files with brief descriptions:
    -
    [detail level 12]
    +
    [detail level 12345]
    - - - + + + @@ -57,7 +57,7 @@ - + @@ -70,19 +70,26 @@ - - - - + + + + + + - - + + - + + + + + +
     docs
     ▼ inc
     XPCAircraft.hXPMP2::Aircraft / XPCAircraft represent an aircraft as managed by XPMP2
     XPMPAircraft.hXPMP2::Aircraft represent an aircraft as managed by XPMP2
     XPMPMultiplayer.hInitialization and general control functions for XPMP2
     XPCAircraft.hXPMP2::Aircraft / XPCAircraft represent an aircraft as managed by XPMP2
     XPMPAircraft.hXPMP2::Aircraft represent an aircraft as managed by XPMP2
     XPMPMultiplayer.hInitialization and general control functions for XPMP2
     XPMPPlaneRenderer.hRendering functions
     XPMPRemote.hSemi-public remote network functionality for master/client operations
     ▼ src
     2D.hDefinitions of 2-D routines, like drawing aircraft labels
     AIMultiplayer.cppImplementation of serving TCAS target dataRef updates
     AIMultiplayer.hDefinitions for serving TCAS target dataRef updates
     Aircraft.cppXPCAircraft represents an aircraft as managed by XPMP2
     Aircraft.cppXPCAircraft represents an aircraft as managed by XPMP2
     Aircraft.hAdditional definitions beyond what public XPCAircraft defines
     CSLCopy.cppCopy .obj file just before loading, to replace dataRefs and texture
     CSLModels.cppManaging CSL Models, including matching and loading
     RelatedDoc8643.hHandling the related.txt file for creating groups of similar looking aircraft types, and Doc8643, the official list of ICAO aircraft type codes
     Remote.cppMaster/Client communication for aircraft synchronization on remote networked instances
     Remote.hMaster/Client communication for aircraft synchronization on remote networked instances
     Utilities.cppMiscellaneous utility functions, including logging
     Utilities.hMiscellaneous utility functions, including logging
     XPMP2.hHeader file covering all includes required for compiling XPMP2, basis for pre-compiled headers
     XPMPMultiplayer.cppInitialization and general control functions for XPMP2
     Sound.cppSound for aircraft, based on the FMOD library
     Sound.hSound for aircraft, based on the FMOD library
     Utilities.cppMiscellaneous utility functions, including logging
     Utilities.hMiscellaneous utility functions, including logging
     XPMP2.hHeader file covering all includes required for compiling XPMP2, basis for pre-compiled headers
     XPMPMultiplayer.cppInitialization and general control functions for XPMP2
     ▼ XPMP2-Remote
     Client.cppMain Client functionality, processing received data
     Client.hMain Client functionality, processing received data
     Utilities.cppMiscellaneous utility functions, including logging
     Utilities.hMiscellaneous utility functions, including logging
     XPMP2-Remote.cppXPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network
     XPMP2-Remote.hXPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network
     XPMP2-Remote.cppXPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network
     XPMP2-Remote.hXPMP2 Remote Client: Displays aircraft served from other XPMP2-based plugins in the network
     ▼ XPMP2-Sample
     XPMP2-Sample.cppExample plugin demonstrating XPMP2 techniques
     ▼ lib
     ▼ fmod
     ▼ logo
     FMOD_Logo.cppCompressed version of the FMOD logo with code to create a texture ID in X-Plane for display with Dear ImGui
     FMOD_Logo.hCompressed version of the FMOD logo with code to create a texture ID in X-Plane for display with Dear ImGui
     XPMP2-Sample.cppExample plugin demonstrating XPMP2 techniques
    diff --git a/docs/html/functions.html b/docs/html/functions.html index 40cb2afb..aae5112e 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -130,6 +130,18 @@

    - a -

      , XPMP2::RemoteMsgAcPosUpdateTy , XPMP2::RemoteMsgAcRemoveTy +
    • ASIOChannelList +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
      • +
    • ASIONumChannels +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
      • +
    • ASIOSpeakerList +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
      • +
    • aSndCh +: XPMP2::Aircraft +
    • AssignModel() : XPMP2::Aircraft
      • diff --git a/docs/html/functions_b.html b/docs/html/functions_b.html index 98027822..a454f3fa 100644 --- a/docs/html/functions_b.html +++ b/docs/html/functions_b.html @@ -45,6 +45,15 @@

      - b -

      • b : XPMP2::TcasLightsTy
        • +
      • bAuto +: XPMP2::Aircraft::SndChTy +
        • +
      • bChnLowPass +: XPMP2::Aircraft +
        • +
      • bChnMuted +: XPMP2::Aircraft +
      • bClampAll : XPMP2::GlobVars
        • @@ -83,6 +92,9 @@

        - b -

          : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy +
        • bLoaded +: XPMP2::SoundFile +
        • bLocal : SenderTy
          • @@ -93,6 +105,9 @@

          - b -

            : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy +
          • bLoop +: XPMP2::SoundFile +
          • bMapEnabled : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy @@ -122,6 +137,21 @@

            - b -

            • broadcast() : XPMP2::SocketNetworking
              • +
            • bSndLoop +: XPMP2::SoundDefTy +
              • +
            • bSoundAutoMuted +: XPMP2::GlobVars +
              • +
            • bSoundAvail +: XPMP2::GlobVars +
              • +
            • bSoundMuteOnPause +: XPMP2::GlobVars +
              • +
            • bSoundOnStartup +: XPMP2::GlobVars +
            • buf : XPMP2::SocketNetworking
              • diff --git a/docs/html/functions_c.html b/docs/html/functions_c.html index 20ea6280..7921b85c 100644 --- a/docs/html/functions_c.html +++ b/docs/html/functions_c.html @@ -55,9 +55,18 @@

              - c -

                : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy +
              • cbSize +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
              • ChangeModel() : XPMP2::Aircraft
                • +
              • chnList +: XPMP2::Aircraft +
                • +
              • ChnListTy +: XPMP2::Aircraft +
              • ClampToGround() : XPMP2::Aircraft
                • @@ -90,12 +99,30 @@

                - c -

                • colLabel : XPMP2::Aircraft
                  • +
                • commandQueueSize +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                • CompModelName() : XPMP2::CSLModel
                • ComputeMapLabel() : XPMP2::Aircraft
                  • +
                • coneDir +: XPMP2::SoundFile +
                  • +
                • coneInAngle +: XPMP2::SoundFile +
                  • +
                • coneOutAngle +: XPMP2::SoundFile +
                  • +
                • coneOutVol +: XPMP2::SoundFile +
                  • +
                • conePitch +: XPMP2::SoundFile +
                • Connect() : XPMP2::SocketNetworking
                  • diff --git a/docs/html/functions_d.html b/docs/html/functions_d.html index 3eb12d87..003a1718 100644 --- a/docs/html/functions_d.html +++ b/docs/html/functions_d.html @@ -54,6 +54,9 @@

                  - d -

                  • DecRefCnt() : XPMP2::CSLModel
                    • +
                  • defaultDecodeBufferSize +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                  • defaultICAO : XPMP2::GlobVars
                    • @@ -72,6 +75,9 @@

                    - d -

                    diff --git a/docs/html/functions_f.html b/docs/html/functions_f.html index 7c4694b4..c93d5a11 100644 --- a/docs/html/functions_f.html +++ b/docs/html/functions_f.html @@ -64,6 +64,9 @@

                    - f -

                    • fileName : XPMP2::XPMP2Error
                      • +
                    • filePath +: XPMP2::SoundFile +
                    • filler : XPMP2::RemoteAcAnimTy , XPMP2::RemoteAcDetailTy @@ -83,6 +86,9 @@

                      - f -

                      • Find() : SenderTy
                        • +
                      • firstTimeInit() +: XPMP2::SoundFile +
                      • flap : XPMP2::multiDataRefsTy
                        • @@ -99,6 +105,12 @@

                        - f -

                          : XPMP2::RemoteAcDetailTy , XPMPInfoTexts_t +
                        • FmodError() +: XPMP2::FmodError +
                          • +
                        • fmodRes +: XPMP2::FmodError +
                        • free() : XPMP2::RmtMsgBufTy< ElemTy, MsgTy, msgVer >
                          • diff --git a/docs/html/functions_func_f.html b/docs/html/functions_func_f.html index cffd957d..c66bb5d5 100644 --- a/docs/html/functions_func_f.html +++ b/docs/html/functions_func_f.html @@ -52,9 +52,15 @@

                          - f -

                          • Find() : SenderTy
                            • +
                          • firstTimeInit() +: XPMP2::SoundFile +
                          • FlightLoopCB() : XPMP2::Aircraft
                            • +
                          • FmodError() +: XPMP2::FmodError +
                          • free() : XPMP2::RmtMsgBufTy< ElemTy, MsgTy, msgVer >
                            • diff --git a/docs/html/functions_func_g.html b/docs/html/functions_func_g.html index 9309f5e6..b52e0973 100644 --- a/docs/html/functions_func_g.html +++ b/docs/html/functions_func_g.html @@ -108,6 +108,9 @@

                            - g -

                            • GetGearRatio() : XPMP2::Aircraft
                              • +
                            • GetGS_kn() +: XPMP2::Aircraft +
                            • GetHeading() : XPMP2::Aircraft , XPMP2::RemoteAcDetailTy @@ -185,6 +188,10 @@

                              - g -

                              • GetNoseWheelAngle() : XPMP2::Aircraft
                                • +
                              • GetNumEngines() +: XPMP2::CSLModel +, XPMP2::Doc8643 +
                              • GetObjState() : XPMP2::CSLModel , XPMP2::CSLObj diff --git a/docs/html/functions_func_h.html b/docs/html/functions_func_h.html index 109d9a54..dcfe5043 100644 --- a/docs/html/functions_func_h.html +++ b/docs/html/functions_func_h.html @@ -42,6 +42,9 @@  

                                - h -

                                  +
                                • hasConeInfo() +: XPMP2::SoundFile +
                                • HasRotor() : XPMP2::CSLModel , XPMP2::Doc8643 diff --git a/docs/html/functions_func_i.html b/docs/html/functions_func_i.html index af94b042..99b76288 100644 --- a/docs/html/functions_func_i.html +++ b/docs/html/functions_func_i.html @@ -81,6 +81,9 @@

                                  - i -

                                  • isOpen() : XPMP2::SocketNetworking
                                    • +
                                  • isReady() +: XPMP2::SoundFile +
                                  • IsRelatedTo() : XPMP2::Aircraft
                                    • diff --git a/docs/html/functions_func_l.html b/docs/html/functions_func_l.html index 3ee3df7d..9f5e45fe 100644 --- a/docs/html/functions_func_l.html +++ b/docs/html/functions_func_l.html @@ -57,6 +57,12 @@

                                    - l -

                                    diff --git a/docs/html/functions_func_p.html b/docs/html/functions_func_p.html index 417b7e36..fe6293ad 100644 --- a/docs/html/functions_func_p.html +++ b/docs/html/functions_func_p.html @@ -45,6 +45,9 @@

                                    - p -

                                    diff --git a/docs/html/functions_func_s.html b/docs/html/functions_func_s.html index e5883e00..ed22fcaa 100644 --- a/docs/html/functions_func_s.html +++ b/docs/html/functions_func_s.html @@ -61,6 +61,9 @@

                                    - s -

                                    • SetBufSize() : XPMP2::SocketNetworking
                                      • +
                                    • setConeOrientation() +: XPMP2::SoundFile +
                                    • SetCopyResult() : XPMP2::CSLObj
                                      • @@ -217,6 +220,33 @@

                                      - s -

                                      diff --git a/docs/html/functions_func_u.html b/docs/html/functions_func_u.html index edb6430d..f699795d 100644 --- a/docs/html/functions_func_u.html +++ b/docs/html/functions_func_u.html @@ -58,6 +58,9 @@

                                      - u -

                                      • Update() : RemoteAC
                                        • +
                                      • UpdateCameraPos() +: XPMP2::GlobVars +
                                      • UpdateCfgVals() : XPMP2::GlobVars
                                        • diff --git a/docs/html/functions_func_~.html b/docs/html/functions_func_~.html index f7922b31..205b741c 100644 --- a/docs/html/functions_func_~.html +++ b/docs/html/functions_func_~.html @@ -63,6 +63,9 @@

                                        - ~ -

                                        • ~SocketNetworking() : XPMP2::SocketNetworking
                                          • +
                                        • ~SoundFile() +: XPMP2::SoundFile +
                                        • ~UDPMulticast() : XPMP2::UDPMulticast
                                          • diff --git a/docs/html/functions_g.html b/docs/html/functions_g.html index c7fc4af2..2d6e461a 100644 --- a/docs/html/functions_g.html +++ b/docs/html/functions_g.html @@ -54,6 +54,9 @@

                                          - g -

                                          • gearPosition : XPMPPlaneSurfaces_t
                                            • +
                                          • geometryMaxFadeTime +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                          • getAddr() : XPMP2::SocketNetworking
                                            • @@ -117,6 +120,9 @@

                                            - g -

                                            • GetGearRatio() : XPMP2::Aircraft
                                              • +
                                            • GetGS_kn() +: XPMP2::Aircraft +
                                            • GetHeading() : XPMP2::Aircraft , XPMP2::RemoteAcDetailTy @@ -194,6 +200,10 @@

                                              - g -

                                              • GetNoseWheelAngle() : XPMP2::Aircraft
                                                • +
                                              • GetNumEngines() +: XPMP2::CSLModel +, XPMP2::Doc8643 +
                                              • GetObjState() : XPMP2::CSLModel , XPMP2::CSLObj @@ -318,6 +328,9 @@

                                                - g -

                                                diff --git a/docs/html/functions_h.html b/docs/html/functions_h.html index 6b7d5545..5f45e70a 100644 --- a/docs/html/functions_h.html +++ b/docs/html/functions_h.html @@ -42,6 +42,9 @@
                                                Here is a list of all class members with links to the classes they belong to:

                                                - h -

                                                  +
                                                • hasConeInfo() +: XPMP2::SoundFile +
                                                • HasRotor() : XPMP2::CSLModel , XPMP2::Doc8643 @@ -65,6 +68,15 @@

                                                  - h -

                                                  diff --git a/docs/html/functions_i.html b/docs/html/functions_i.html index f29662e0..ca5b8e9a 100644 --- a/docs/html/functions_i.html +++ b/docs/html/functions_i.html @@ -132,6 +132,9 @@

                                                  - i -

                                                  • isOpen() : XPMP2::SocketNetworking
                                                    • +
                                                  • isReady() +: XPMP2::SoundFile +
                                                  • IsRelatedTo() : XPMP2::Aircraft
                                                    • diff --git a/docs/html/functions_l.html b/docs/html/functions_l.html index 9e4d42ad..a1c0c810 100644 --- a/docs/html/functions_l.html +++ b/docs/html/functions_l.html @@ -73,6 +73,9 @@

                                                    - l -

                                                    • landLights : XPMP2::multiDataRefsTy
                                                      • +
                                                    • lastDRVal +: XPMP2::Aircraft::SndChTy +
                                                    • lastMsg : SenderTy
                                                      • @@ -89,6 +92,9 @@

                                                      - l -

                                                      • LegacySampleAircraft() : LegacySampleAircraft
                                                        • +
                                                      • len_ms +: XPMP2::SoundFile +
                                                      • lightFlags : xpmp_LightStatus
                                                        • @@ -118,14 +124,21 @@

                                                        - l -

                                                          , XPMP2::CSLModelInfo_t::MatchCrit_t
                                                        • ln -: XPMP2::XPMP2Error +: XPMP2::FmodError +, XPMP2::XPMP2Error
                                                        • Load() : XPMP2::CSLObj
                                                          • +
                                                        • LoadXPSounds() +: XPMP2::SoundFile +
                                                        • logAcronym : XPMP2::GlobVars
                                                          • +
                                                        • LogErr() +: XPMP2::FmodError +
                                                        • logLvl : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy diff --git a/docs/html/functions_m.html b/docs/html/functions_m.html index 039e9237..e86642d1 100644 --- a/docs/html/functions_m.html +++ b/docs/html/functions_m.html @@ -104,10 +104,31 @@

                                                          - m -

                                                          • matchQuality : XPMP2::Aircraft
                                                            • +
                                                          • maxADPCMCodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                            • +
                                                          • maxAT9Codecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                            • +
                                                          • maxFADPCMCodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                          • maxLabelDist : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy
                                                            • +
                                                          • maxMPEGCodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                            • +
                                                          • maxPCMCodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                            • +
                                                          • maxVorbisCodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                            • +
                                                          • maxXMACodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                          • menuName : CmdMenuDefTy
                                                            • diff --git a/docs/html/functions_p.html b/docs/html/functions_p.html index 8031cf8d..6b7d768f 100644 --- a/docs/html/functions_p.html +++ b/docs/html/functions_p.html @@ -63,6 +63,9 @@

                                                            - p -

                                                            • pathRelated : XPMP2::GlobVars
                                                              • +
                                                            • pChn +: XPMP2::Aircraft::SndChTy +
                                                            • pCSLMdl : XPMP2::Aircraft , XPMP2::RmtAcCacheTy @@ -104,6 +107,9 @@

                                                              - p -

                                                              • planeId : XPMP2::GlobVars
                                                                • +
                                                              • play() +: XPMP2::SoundFile +
                                                              • pluginId : SenderAddrTy , XPMP2::GlobVars @@ -118,6 +124,9 @@

                                                                - p -

                                                                • pMsg : XPMP2::RmtMsgBufTy< ElemTy, MsgTy, msgVer >
                                                                  • +
                                                                • posCamera +: XPMP2::GlobVars +
                                                                • prefsFuncInt : XPMP2::GlobVars
                                                                  • @@ -133,12 +142,27 @@

                                                                  - p -

                                                                  diff --git a/docs/html/functions_r.html b/docs/html/functions_r.html index af13ecaf..a7c5f92e 100644 --- a/docs/html/functions_r.html +++ b/docs/html/functions_r.html @@ -45,6 +45,9 @@

                                                                  - r -

                                                                  • r : XPMP2::Obj8DataRefs
                                                                    • +
                                                                  • randomSeed +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                  • range : XPMP2::RemoteDataRefPackTy
                                                                    • @@ -145,12 +148,18 @@

                                                                    - r -

                                                                    • remoteTxfFrequ : XPMP2::GlobVars
                                                                      • +
                                                                    • resamplerMethod +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                    • ResetTcasTargetIdx() : XPMP2::Aircraft
                                                                    • resourceDir : XPMP2::GlobVars
                                                                      • +
                                                                    • reverb3Dinstance +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                    • reversRatio : XPMPPlaneSurfaces_t
                                                                      • diff --git a/docs/html/functions_s.html b/docs/html/functions_s.html index 46dd9bbe..4e1c4957 100644 --- a/docs/html/functions_s.html +++ b/docs/html/functions_s.html @@ -70,6 +70,9 @@

                                                                      - s -

                                                                      • SetBufSize() : XPMP2::SocketNetworking
                                                                        • +
                                                                      • setConeOrientation() +: XPMP2::SoundFile +
                                                                      • SetCopyResult() : XPMP2::CSLObj
                                                                        • @@ -223,6 +226,9 @@

                                                                        - s -

                                                                        • sFrom : SenderTy
                                                                          • +
                                                                        • sFunc +: XPMP2::FmodError +
                                                                        • ShallDrawLabel() : XPMP2::Aircraft
                                                                          • @@ -239,15 +245,72 @@

                                                                          - s -

                                                                            , XPMPPlaneRadar_t , XPMPPlaneSurfaces_t +
                                                                          • skipCounter +: XPMP2::Aircraft +
                                                                          • slat : XPMP2::multiDataRefsTy
                                                                          • slatRatio : XPMPPlaneSurfaces_t
                                                                            • +
                                                                          • SND_ENG +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SND_FLAPS +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SND_GEAR +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SND_NUM_EVENTS +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SND_REVERSE_THRUST +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SND_TIRE +: XPMP2::Aircraft +
                                                                            • +
                                                                          • sndMasterVol +: XPMP2::GlobVars +
                                                                            • +
                                                                          • sndMinDist +: XPMP2::Aircraft +
                                                                          • SocketNetworking() : XPMP2::SocketNetworking
                                                                            • +
                                                                          • SoundEventsTy +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SoundFile() +: XPMP2::SoundFile +
                                                                            • +
                                                                          • SoundGetName() +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SoundMuteAll() +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SoundPlay() +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SoundRemoveAll() +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SoundSetup() +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SoundStop() +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SoundUpdate() +: XPMP2::Aircraft +
                                                                            • +
                                                                          • SoundVolume() +: XPMP2::Aircraft +
                                                                          • speedbrake : XPMP2::multiDataRefsTy
                                                                            • @@ -265,6 +328,15 @@

                                                                            - s -

                                                                              , XPMP2::RemoteAcDetailTy , XPMP2::RemoteAcDetailTy_v0 +
                                                                            • stackSizeMixer +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                              • +
                                                                            • stackSizeNonBlocking +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                              • +
                                                                            • stackSizeStream +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                            • strbLights : XPMP2::multiDataRefsTy
                                                                              • diff --git a/docs/html/functions_type.html b/docs/html/functions_type.html index d7dbf008..b18f862a 100644 --- a/docs/html/functions_type.html +++ b/docs/html/functions_type.html @@ -40,6 +40,9 @@
                                                                               
                                                                              diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html index 3503b9d2..efba6ffa 100644 --- a/docs/html/functions_vars.html +++ b/docs/html/functions_vars.html @@ -102,6 +102,18 @@

                                                                              - a -

                                                                              diff --git a/docs/html/functions_vars_b.html b/docs/html/functions_vars_b.html index 9ca95166..4c7d2366 100644 --- a/docs/html/functions_vars_b.html +++ b/docs/html/functions_vars_b.html @@ -45,6 +45,15 @@

                                                                              - b -

                                                                              • b : XPMP2::TcasLightsTy
                                                                                • +
                                                                              • bAuto +: XPMP2::Aircraft::SndChTy +
                                                                                • +
                                                                              • bChnLowPass +: XPMP2::Aircraft +
                                                                                • +
                                                                              • bChnMuted +: XPMP2::Aircraft +
                                                                              • bClampAll : XPMP2::GlobVars
                                                                                • @@ -83,6 +92,9 @@

                                                                                - b -

                                                                                  : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy +
                                                                                • bLoaded +: XPMP2::SoundFile +
                                                                                • bLocal : SenderTy
                                                                                  • @@ -93,6 +105,9 @@

                                                                                  - b -

                                                                                    : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy +
                                                                                  • bLoop +: XPMP2::SoundFile +
                                                                                  • bMapEnabled : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy @@ -119,6 +134,21 @@

                                                                                    - b -

                                                                                      , XPMP2::RemoteAcDetailTy_v0 , XPMP2::RmtAcCacheTy +
                                                                                    • bSndLoop +: XPMP2::SoundDefTy +
                                                                                      • +
                                                                                    • bSoundAutoMuted +: XPMP2::GlobVars +
                                                                                      • +
                                                                                    • bSoundAvail +: XPMP2::GlobVars +
                                                                                      • +
                                                                                    • bSoundMuteOnPause +: XPMP2::GlobVars +
                                                                                      • +
                                                                                    • bSoundOnStartup +: XPMP2::GlobVars +
                                                                                    • buf : XPMP2::SocketNetworking
                                                                                      • diff --git a/docs/html/functions_vars_c.html b/docs/html/functions_vars_c.html index c60d159f..5d841bef 100644 --- a/docs/html/functions_vars_c.html +++ b/docs/html/functions_vars_c.html @@ -55,6 +55,12 @@

                                                                                      - c -

                                                                                        : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy +
                                                                                      • cbSize +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                        • +
                                                                                      • chnList +: XPMP2::Aircraft +
                                                                                      • clampToGround : XPMPPlanePosition_t
                                                                                        • @@ -70,6 +76,24 @@

                                                                                        - c -

                                                                                        • colLabel : XPMP2::Aircraft
                                                                                          • +
                                                                                        • commandQueueSize +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                          • +
                                                                                        • coneDir +: XPMP2::SoundFile +
                                                                                          • +
                                                                                        • coneInAngle +: XPMP2::SoundFile +
                                                                                          • +
                                                                                        • coneOutAngle +: XPMP2::SoundFile +
                                                                                          • +
                                                                                        • coneOutVol +: XPMP2::SoundFile +
                                                                                          • +
                                                                                        • conePitch +: XPMP2::SoundFile +
                                                                                        • cslId : XPMP2::CSLModel , XPMP2::CSLModelInfo_t diff --git a/docs/html/functions_vars_d.html b/docs/html/functions_vars_d.html index b7c04cad..c9fae768 100644 --- a/docs/html/functions_vars_d.html +++ b/docs/html/functions_vars_d.html @@ -51,6 +51,9 @@

                                                                                          - d -

                                                                                          • dataFunc : XPMP2::LegacyAircraft
                                                                                            • +
                                                                                          • defaultDecodeBufferSize +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                          • defaultICAO : XPMP2::GlobVars
                                                                                            • @@ -63,6 +66,9 @@

                                                                                            - d -

                                                                                            • diffTime : RemoteAC
                                                                                              • +
                                                                                            • distanceFilterCenterFreq +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                            • dLat : XPMP2::RemoteAcPosUpdateTy
                                                                                              • @@ -82,6 +88,9 @@

                                                                                              - d -

                                                                                                : XPMP2::Aircraft , XPMP2::RmtAcCacheTy +
                                                                                              • DSPBufferPoolSize +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                              • dTime : XPMP2::RemoteAcDetailTy , XPMP2::RemoteAcDetailTy_v0 diff --git a/docs/html/functions_vars_f.html b/docs/html/functions_vars_f.html index 246092fb..1ef1b7e1 100644 --- a/docs/html/functions_vars_f.html +++ b/docs/html/functions_vars_f.html @@ -60,6 +60,9 @@

                                                                                                - f -

                                                                                                • fileName : XPMP2::XPMP2Error
                                                                                                  • +
                                                                                                • filePath +: XPMP2::SoundFile +
                                                                                                • filler : XPMP2::RemoteAcAnimTy , XPMP2::RemoteAcDetailTy @@ -86,6 +89,9 @@

                                                                                                  - f -

                                                                                                    : XPMP2::RemoteAcDetailTy , XPMPInfoTexts_t +
                                                                                                  • fmodRes +: XPMP2::FmodError +
                                                                                                  • from : SenderAddrTy
                                                                                                    • diff --git a/docs/html/functions_vars_g.html b/docs/html/functions_vars_g.html index 54e24ab6..ffb60dec 100644 --- a/docs/html/functions_vars_g.html +++ b/docs/html/functions_vars_g.html @@ -51,9 +51,15 @@

                                                                                                    - g -

                                                                                                    diff --git a/docs/html/functions_vars_h.html b/docs/html/functions_vars_h.html index cca8a370..b6e9faa0 100644 --- a/docs/html/functions_vars_h.html +++ b/docs/html/functions_vars_h.html @@ -61,6 +61,15 @@

                                                                                                    - h -

                                                                                                    diff --git a/docs/html/functions_vars_l.html b/docs/html/functions_vars_l.html index 62e07fd5..bc251eea 100644 --- a/docs/html/functions_vars_l.html +++ b/docs/html/functions_vars_l.html @@ -64,6 +64,9 @@

                                                                                                    - l -

                                                                                                    • landLights : XPMP2::multiDataRefsTy
                                                                                                      • +
                                                                                                    • lastDRVal +: XPMP2::Aircraft::SndChTy +
                                                                                                    • lastMsg : SenderTy
                                                                                                      • @@ -74,6 +77,9 @@

                                                                                                      - l -

                                                                                                        , XPMP2::RmtAcCacheTy , XPMPPlanePosition_t +
                                                                                                      • len_ms +: XPMP2::SoundFile +
                                                                                                      • lightFlags : xpmp_LightStatus
                                                                                                        • @@ -97,7 +103,8 @@

                                                                                                        - l -

                                                                                                          , XPMP2::CSLModelInfo_t::MatchCrit_t
                                                                                                        • ln -: XPMP2::XPMP2Error +: XPMP2::FmodError +, XPMP2::XPMP2Error
                                                                                                        • logAcronym : XPMP2::GlobVars diff --git a/docs/html/functions_vars_m.html b/docs/html/functions_vars_m.html index 51f18168..1eb0dd40 100644 --- a/docs/html/functions_vars_m.html +++ b/docs/html/functions_vars_m.html @@ -86,10 +86,31 @@

                                                                                                          - m -

                                                                                                          • matchQuality : XPMP2::Aircraft
                                                                                                            • +
                                                                                                          • maxADPCMCodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                            • +
                                                                                                          • maxAT9Codecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                            • +
                                                                                                          • maxFADPCMCodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                          • maxLabelDist : XPMP2::GlobVars , XPMP2::RemoteMsgSettingsTy
                                                                                                            • +
                                                                                                          • maxMPEGCodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                            • +
                                                                                                          • maxPCMCodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                            • +
                                                                                                          • maxVorbisCodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                            • +
                                                                                                          • maxXMACodecs +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                          • menuName : CmdMenuDefTy
                                                                                                            • diff --git a/docs/html/functions_vars_p.html b/docs/html/functions_vars_p.html index 921a0551..312b0350 100644 --- a/docs/html/functions_vars_p.html +++ b/docs/html/functions_vars_p.html @@ -60,6 +60,9 @@

                                                                                                            - p -

                                                                                                            • pathRelated : XPMP2::GlobVars
                                                                                                              • +
                                                                                                            • pChn +: XPMP2::Aircraft::SndChTy +
                                                                                                            • pCSLMdl : XPMP2::Aircraft , XPMP2::RmtAcCacheTy @@ -115,6 +118,9 @@

                                                                                                              - p -

                                                                                                              • pMsg : XPMP2::RmtMsgBufTy< ElemTy, MsgTy, msgVer >
                                                                                                                • +
                                                                                                              • posCamera +: XPMP2::GlobVars +
                                                                                                              • prefsFuncInt : XPMP2::GlobVars
                                                                                                                • @@ -130,12 +136,27 @@

                                                                                                                - p -

                                                                                                                diff --git a/docs/html/functions_vars_r.html b/docs/html/functions_vars_r.html index a188bf28..6d337fde 100644 --- a/docs/html/functions_vars_r.html +++ b/docs/html/functions_vars_r.html @@ -45,6 +45,9 @@

                                                                                                                - r -

                                                                                                                • r : XPMP2::Obj8DataRefs
                                                                                                                  • +
                                                                                                                • randomSeed +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                                • range : XPMP2::RemoteDataRefPackTy
                                                                                                                  • @@ -85,9 +88,15 @@

                                                                                                                  - r -

                                                                                                                  • remoteTxfFrequ : XPMP2::GlobVars
                                                                                                                    • +
                                                                                                                  • resamplerMethod +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                                  • resourceDir : XPMP2::GlobVars
                                                                                                                    • +
                                                                                                                  • reverb3Dinstance +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                                  • reversRatio : XPMPPlaneSurfaces_t
                                                                                                                    • diff --git a/docs/html/functions_vars_s.html b/docs/html/functions_vars_s.html index 694a65ec..3daca3cd 100644 --- a/docs/html/functions_vars_s.html +++ b/docs/html/functions_vars_s.html @@ -57,6 +57,9 @@

                                                                                                                    - s -

                                                                                                                    • sFrom : SenderTy
                                                                                                                      • +
                                                                                                                    • sFunc +: XPMP2::FmodError +
                                                                                                                    • shortId : XPMP2::CSLModel
                                                                                                                      • @@ -67,12 +70,21 @@

                                                                                                                      - s -

                                                                                                                        , XPMPPlaneRadar_t , XPMPPlaneSurfaces_t +
                                                                                                                      • skipCounter +: XPMP2::Aircraft +
                                                                                                                      • slat : XPMP2::multiDataRefsTy
                                                                                                                      • slatRatio : XPMPPlaneSurfaces_t
                                                                                                                        • +
                                                                                                                      • sndMasterVol +: XPMP2::GlobVars +
                                                                                                                        • +
                                                                                                                      • sndMinDist +: XPMP2::Aircraft +
                                                                                                                      • speedbrake : XPMP2::multiDataRefsTy
                                                                                                                        • @@ -90,6 +102,15 @@

                                                                                                                        - s -

                                                                                                                          , XPMP2::RemoteAcDetailTy , XPMP2::RemoteAcDetailTy_v0 +
                                                                                                                        • stackSizeMixer +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                                          • +
                                                                                                                        • stackSizeNonBlocking +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                                          • +
                                                                                                                        • stackSizeStream +: XPMP2::FMOD_10830_ADVANCEDSETTINGS +
                                                                                                                        • strbLights : XPMP2::multiDataRefsTy
                                                                                                                          • diff --git a/docs/html/functions_vars_v.html b/docs/html/functions_vars_v.html index a634f4f4..de3a0bd8 100644 --- a/docs/html/functions_vars_v.html +++ b/docs/html/functions_vars_v.html @@ -51,13 +51,31 @@

                                                                                                                          - v -

                                                                                                                            , XPMP2::RmtAcCacheTy
                                                                                                                          • v_x -: XPMP2::multiDataRefsTy +: XPMP2::Aircraft +, XPMP2::multiDataRefsTy
                                                                                                                          • v_y -: XPMP2::multiDataRefsTy +: XPMP2::Aircraft +, XPMP2::multiDataRefsTy
                                                                                                                          • v_z -: XPMP2::multiDataRefsTy +: XPMP2::Aircraft +, XPMP2::multiDataRefsTy +
                                                                                                                            • +
                                                                                                                          • valMax +: XPMP2::SoundDefTy +
                                                                                                                            • +
                                                                                                                          • valMin +: XPMP2::SoundDefTy +
                                                                                                                            • +
                                                                                                                          • vCam_x +: XPMP2::GlobVars +
                                                                                                                            • +
                                                                                                                          • vCam_y +: XPMP2::GlobVars +
                                                                                                                            • +
                                                                                                                          • vCam_z +: XPMP2::GlobVars
                                                                                                                          • vecMatchCrit : XPMP2::CSLModel @@ -75,6 +93,12 @@

                                                                                                                            - v -

                                                                                                                            diff --git a/docs/html/functions_vars_x.html b/docs/html/functions_vars_x.html index d7ffdf9b..880b2425 100644 --- a/docs/html/functions_vars_x.html +++ b/docs/html/functions_vars_x.html @@ -48,6 +48,9 @@

                                                                                                                            - x -

                                                                                                                            • X : XPMP2::multiDataRefsTy
                                                                                                                              • +
                                                                                                                            • xpCycleNum +: XPMP2::GlobVars +
                                                                                                                            • xpObj : XPMP2::CSLObj
                                                                                                                              • diff --git a/docs/html/functions_x.html b/docs/html/functions_x.html index 671c41aa..a647cefc 100644 --- a/docs/html/functions_x.html +++ b/docs/html/functions_x.html @@ -51,6 +51,9 @@

                                                                                                                              - x -

                                                                                                                              • XPCAircraft() : XPCAircraft
                                                                                                                                • +
                                                                                                                              • xpCycleNum +: XPMP2::GlobVars +
                                                                                                                              • XPMP2Error() : XPMP2::XPMP2Error
                                                                                                                                • diff --git a/docs/html/functions_~.html b/docs/html/functions_~.html index 25adc92e..6874c106 100644 --- a/docs/html/functions_~.html +++ b/docs/html/functions_~.html @@ -63,6 +63,9 @@

                                                                                                                                - ~ -

                                                                                                                                • ~SocketNetworking() : XPMP2::SocketNetworking
                                                                                                                                  • +
                                                                                                                                • ~SoundFile() +: XPMP2::SoundFile +
                                                                                                                                • ~UDPMulticast() : XPMP2::UDPMulticast
                                                                                                                                  • diff --git a/docs/html/globals.html b/docs/html/globals.html index c08bef1b..f9d5d914 100644 --- a/docs/html/globals.html +++ b/docs/html/globals.html @@ -42,6 +42,12 @@
                                                                                                                                  Here is a list of all file members with links to the files they belong to:

                                                                                                                                  - a -

                                                                                                                                    +
                                                                                                                                  • ADD_CONE +: Sound.cpp +
                                                                                                                                    • +
                                                                                                                                  • ADD_SND +: Sound.cpp +
                                                                                                                                  • ArePlanesCreated() : XPMP2-Sample.cpp
                                                                                                                                    • diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html index 56e70d88..e0f67a48 100644 --- a/docs/html/globals_defs.html +++ b/docs/html/globals_defs.html @@ -41,6 +41,16 @@
                                                                                                                                      +

                                                                                                                                    - a -

                                                                                                                                    + +

                                                                                                                                    - c -

                                                                                                                                    diff --git a/docs/html/globals_func.html b/docs/html/globals_func.html index d4481a8c..b25e5729 100644 --- a/docs/html/globals_func.html +++ b/docs/html/globals_func.html @@ -415,6 +415,30 @@

                                                                                                                                    - x -

                                                                                                                                      : XPMPMultiplayer.h , XPMPMultiplayer.cpp +
                                                                                                                                    • XPMPSoundAdd() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                      • +
                                                                                                                                    • XPMPSoundEnable() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                      • +
                                                                                                                                    • XPMPSoundEnumerate() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                      • +
                                                                                                                                    • XPMPSoundIsEnabled() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                      • +
                                                                                                                                    • XPMPSoundMute() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                      • +
                                                                                                                                    • XPMPSoundSetMasterVolume() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                    • XPMPUnregisterPlaneNotifierFunc() : XPMPMultiplayer.h , XPMPMultiplayer.cpp diff --git a/docs/html/globals_g.html b/docs/html/globals_g.html index 9c2066d0..c2889be6 100644 --- a/docs/html/globals_g.html +++ b/docs/html/globals_g.html @@ -42,6 +42,9 @@
                                                                                                                                      Here is a list of all file members with links to the files they belong to:

                                                                                                                                      - g -

                                                                                                                                        +
                                                                                                                                      • gbFreeze +: XPMP2-Sample.cpp +
                                                                                                                                      • gbMapLabels : XPMP2-Sample.cpp
                                                                                                                                        • diff --git a/docs/html/globals_m.html b/docs/html/globals_m.html index e359f374..13dcc7ec 100644 --- a/docs/html/globals_m.html +++ b/docs/html/globals_m.html @@ -58,15 +58,36 @@

                                                                                                                                        - m -

                                                                                                                                        • MENU_ACTIVE : XPMP2-Remote.cpp
                                                                                                                                          • +
                                                                                                                                        • MENU_AI +: XPMP2-Sample.cpp +
                                                                                                                                          • +
                                                                                                                                        • MENU_CYCLE_MDL +: XPMP2-Sample.cpp +
                                                                                                                                          • +
                                                                                                                                        • MENU_FREEZE +: XPMP2-Sample.cpp +
                                                                                                                                        • MENU_LABELS : XPMP2-Remote.cpp
                                                                                                                                          • +
                                                                                                                                        • MENU_PLANES +: XPMP2-Sample.cpp +
                                                                                                                                          • +
                                                                                                                                        • MENU_REMATCH_MDL +: XPMP2-Sample.cpp +
                                                                                                                                        • MENU_SENDER : XPMP2-Remote.cpp
                                                                                                                                        • MENU_TCAS : XPMP2-Remote.cpp
                                                                                                                                          • +
                                                                                                                                        • MENU_VISIBLE +: XPMP2-Sample.cpp +
                                                                                                                                          • +
                                                                                                                                        • MenuItemsTy +: XPMP2-Sample.cpp +
                                                                                                                                        • MenuLabelsCB() : XPMP2-Remote.cpp
                                                                                                                                          • diff --git a/docs/html/globals_u.html b/docs/html/globals_u.html index 575b309e..8c928b70 100644 --- a/docs/html/globals_u.html +++ b/docs/html/globals_u.html @@ -48,9 +48,6 @@

                                                                                                                                          - u -

                                                                                                                                          diff --git a/docs/html/globals_vars.html b/docs/html/globals_vars.html index d41da62b..9f1e0077 100644 --- a/docs/html/globals_vars.html +++ b/docs/html/globals_vars.html @@ -63,6 +63,9 @@

                                                                                                                                          - f -

                                                                                                                                            - g -

                                                                                                                                              +
                                                                                                                                            • gbFreeze +: XPMP2-Sample.cpp +
                                                                                                                                            • gbMapLabels : XPMP2-Sample.cpp
                                                                                                                                              • diff --git a/docs/html/globals_x.html b/docs/html/globals_x.html index c892b1e6..10860e7e 100644 --- a/docs/html/globals_x.html +++ b/docs/html/globals_x.html @@ -42,6 +42,36 @@
                                                                                                                                              Here is a list of all file members with links to the files they belong to:

                                                                                                                                              - x -

                                                                                                                                                +
                                                                                                                                              • XP_SOUND_ELECTRIC +: XPMPMultiplayer.h +
                                                                                                                                                • +
                                                                                                                                              • XP_SOUND_FLAP +: XPMPMultiplayer.h +
                                                                                                                                                • +
                                                                                                                                              • XP_SOUND_GEAR +: XPMPMultiplayer.h +
                                                                                                                                                • +
                                                                                                                                              • XP_SOUND_HIBYPASSJET +: XPMPMultiplayer.h +
                                                                                                                                                • +
                                                                                                                                              • XP_SOUND_LOBYPASSJET +: XPMPMultiplayer.h +
                                                                                                                                                • +
                                                                                                                                              • XP_SOUND_PROP_AIRPLANE +: XPMPMultiplayer.h +
                                                                                                                                                • +
                                                                                                                                              • XP_SOUND_PROP_HELI +: XPMPMultiplayer.h +
                                                                                                                                                • +
                                                                                                                                              • XP_SOUND_REVERSE_THRUST +: XPMPMultiplayer.h +
                                                                                                                                                • +
                                                                                                                                              • XP_SOUND_ROLL_RUNWAY +: XPMPMultiplayer.h +
                                                                                                                                                • +
                                                                                                                                              • XP_SOUND_TURBOPROP +: XPMPMultiplayer.h +
                                                                                                                                              • XPluginDisable() : XPMP2-Remote.cpp , XPMP2-Sample.cpp @@ -68,6 +98,9 @@

                                                                                                                                                - x -

                                                                                                                                                • XPMP2RC_FMTARGS : Utilities.h
                                                                                                                                                  • +
                                                                                                                                                • XPMP_CFG_ITM_ACTIVATE_SOUND +: XPMPMultiplayer.h +
                                                                                                                                                • XPMP_CFG_ITM_CLAMPALL : XPMPMultiplayer.h
                                                                                                                                                  • @@ -80,6 +113,9 @@

                                                                                                                                                  - x -

                                                                                                                                                  • XPMP_CFG_ITM_MODELMATCHING : XPMPMultiplayer.h
                                                                                                                                                    • +
                                                                                                                                                  • XPMP_CFG_ITM_MUTE_ON_PAUSE +: XPMPMultiplayer.h +
                                                                                                                                                  • XPMP_CFG_ITM_REPLDATAREFS : XPMPMultiplayer.h
                                                                                                                                                    • @@ -98,6 +134,9 @@

                                                                                                                                                    - x -

                                                                                                                                                    • XPMP_CFG_SEC_PLANES : XPMPMultiplayer.h
                                                                                                                                                      • +
                                                                                                                                                    • XPMP_CFG_SEC_SOUND +: XPMPMultiplayer.h +
                                                                                                                                                    • xpmp_Lights_Pattern_Default : XPMPMultiplayer.h
                                                                                                                                                      • @@ -324,6 +363,30 @@

                                                                                                                                                      - x -

                                                                                                                                                        : XPMPMultiplayer.h , XPMPMultiplayer.cpp +
                                                                                                                                                      • XPMPSoundAdd() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                                        • +
                                                                                                                                                      • XPMPSoundEnable() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                                        • +
                                                                                                                                                      • XPMPSoundEnumerate() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                                        • +
                                                                                                                                                      • XPMPSoundIsEnabled() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                                        • +
                                                                                                                                                      • XPMPSoundMute() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                                        • +
                                                                                                                                                      • XPMPSoundSetMasterVolume() +: XPMPMultiplayer.h +, Sound.cpp +
                                                                                                                                                      • XPMPTransponderMode : XPMPMultiplayer.h
                                                                                                                                                        • diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index 77e7c209..66a06230 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -45,7 +45,7 @@
                                                                                                                                                        This inheritance list is sorted roughly, but not completely, alphabetically:
                                                                                                                                                        [detail level 123]
                                                                                                                                                        - + @@ -58,55 +58,60 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                         ▼CXPMP2::AircraftActual representation of all aircraft in XPMP2
                                                                                                                                                         ▼CXPMP2::AircraftActual representation of all aircraft in XPMP2
                                                                                                                                                         CRemoteACRepresentation of a remote aircraft
                                                                                                                                                         CSampleAircraftSubclassing XPMP2::Aircraft to create our own class
                                                                                                                                                         ▼CXPCAircraftLegacy wrapper class as provided by original libxplanemp
                                                                                                                                                         CXPMP2::CSLObjOne .obj file of a CSL model (of which it can have multiple)
                                                                                                                                                         CXPMP2::RemoteAcAnimTy::DataRefValTyDataRef animation types and value
                                                                                                                                                         CXPMP2::Doc8643Represents a line in the Doc8643.txt file, of which we use only classification and WTC
                                                                                                                                                         CXPMP2::GlobVarsAll global config settings and variables are kept in one structure for convenient access and central definition
                                                                                                                                                         CXPMP2::InetAddrTyNumerical IP address, used for both ipv4 and ipv6, for ease of handling
                                                                                                                                                         CXPMP2::infoDataRefsTyKeeps the dataRef handles for one of the up to 63 shared data slots ("sim/multiplayer/position/plane#...")
                                                                                                                                                         ▼Cstd::logic_error
                                                                                                                                                         CXPMP2::XPMP2ErrorXPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft
                                                                                                                                                         CXPMP2::CSLModelInfo_t::MatchCrit_tAny number of airline codes and/or liveries can be assigned to a model for matching purpose
                                                                                                                                                         CXPMP2::CSLModel::MatchCritTyCombines match-relevant fields (beside ICAO a/c type)
                                                                                                                                                         CXPMP2::multiDataRefsTyKeeps the dataRef handles for one of the up to 19 legacy AI/Multiplayer slots ("sim/multiplayer/position")
                                                                                                                                                         CXPMP2::Obj8DataRefsA pair of strings, first one to search for, second one to replace it with
                                                                                                                                                         CpositionTySummarizes the 3 values of a position in the local coordinate system
                                                                                                                                                         CXPMP2::RemoteAcAnimTyA/C animation dataRef changes
                                                                                                                                                         CXPMP2::RemoteAcDetailTyA/C details, packed into an array message
                                                                                                                                                         CXPMP2::RemoteAcDetailTy_v0Version 0 A/C details, packed into an array message
                                                                                                                                                         CXPMP2::RemoteAcPosUpdateTyA/C Position updates based on global coordinates
                                                                                                                                                         CXPMP2::RemoteAcRemoveTyA/C Removal only includes the plane id, structure required for msgSize() function
                                                                                                                                                         CXPMP2::RemoteCBFctTyFunction prototypes for callback functions to handle the received messages
                                                                                                                                                         CXPMP2::RemoteDataRefPackTyDefinition for how to map dataRef values to (u)int8, ie. to an integer range of 8 bits
                                                                                                                                                         ▼CXPMP2::RemoteMsgBaseTyMessage header, identical for all message types
                                                                                                                                                         CXPMP2::RemoteMsgAcAnimTyA/C animation dataRef message, has an inherited header plus an array of variable sized XPMP2::RemoteAcAnimTy elements
                                                                                                                                                         CXPMP2::RemoteMsgAcDetailTyA/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
                                                                                                                                                         CXPMP2::RemoteMsgAcDetailTy_v0Version 0 A/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
                                                                                                                                                         CXPMP2::RemoteMsgAcPosUpdateTyA/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
                                                                                                                                                         CXPMP2::RemoteMsgAcRemoveTyA/C removal message, an array of plane ids
                                                                                                                                                         CXPMP2::RemoteMsgBeaconTy"Beacon of Interest", ie. some message on the multicast just to wake up sender
                                                                                                                                                         CXPMP2::RemoteMsgSettingsTySettings message, identifying a sending plugin, regularly providing its settings
                                                                                                                                                         CXPMP2::RmtAcCacheTyHolds a copy of some aircraft data as was sent out last
                                                                                                                                                         CXPMP2::RmtDataAcAnimTy.__unnamed4__
                                                                                                                                                         ▼CXPMP2::RmtDataBaseTyBase structure for passing information from XP's main thread to the multicast thread
                                                                                                                                                         CXPMP2::RmtDataAcAnimTyAnimation dataRef requires a special queue data type as each msg element is already of variable length
                                                                                                                                                         CXPMP2::RmtDataEnqeueTy< ElemTy, MsgTy >Passing information about any data type (like a/c full detail message); the data is contained as copy
                                                                                                                                                         CXPMP2::RmtMsgBufTy< ElemTy, MsgTy, msgVer >Helper class to manage the temporary buffers in which the network message are put together
                                                                                                                                                         ▼Cstd::runtime_error
                                                                                                                                                         CXPMP2::NetRuntimeErrorException raised by XPMP2::SocketNetworking objects
                                                                                                                                                         CSenderAddrTyUniquely identifies a sending plugin
                                                                                                                                                         CSenderTy
                                                                                                                                                         ▼CXPMP2::SocketNetworkingBase class for any socket-based networking
                                                                                                                                                         CXPMP2::TCPConnectionListens to TCP connections and opens a session socket upon connect
                                                                                                                                                         CXPMP2::UDPMulticastUDP Multicast, always binding to INADDR_ANY
                                                                                                                                                         CXPMP2::UDPReceiverReceives UDP messages
                                                                                                                                                         CXPMP2::TcasLightsTyA structure simplifying communicaton with sim/cockpit2/tcas/targets/position/lights
                                                                                                                                                         CXPMP2::Aircraft::wakeTyWake dataRef support
                                                                                                                                                         CXPMP2RCGlobalsHolds all global variables
                                                                                                                                                         Cxpmp_LightStatusDefines, which lights of the aircraft are on
                                                                                                                                                         Cxpmp_LightStatus.__unnamed2__
                                                                                                                                                         CXPMPInfoTexts_tTextual information of planes to be passed on via shared dataRefs to other plugins
                                                                                                                                                         CXPMP2::XPMPPlaneNotifierTyStores the function and refcon pointer for plane creation/destrcution notifications
                                                                                                                                                         CXPMPPlanePosition_tThis data structure contains the basic position info for an aircraft
                                                                                                                                                         CXPMPPlaneRadar_tDefines information about an aircraft visible to radar
                                                                                                                                                         CXPMPPlaneSurfaces_tExternal physical configuration of the plane
                                                                                                                                                         CXPMP2::FMOD_10830_ADVANCEDSETTINGSFMOD 1.08.30 version of FMOD_ADVANCEDSETTINGS
                                                                                                                                                         CXPMP2::GlobVarsAll global config settings and variables are kept in one structure for convenient access and central definition
                                                                                                                                                         CXPMP2::InetAddrTyNumerical IP address, used for both ipv4 and ipv6, for ease of handling
                                                                                                                                                         CXPMP2::infoDataRefsTyKeeps the dataRef handles for one of the up to 63 shared data slots ("sim/multiplayer/position/plane#...")
                                                                                                                                                         ▼Cstd::logic_error
                                                                                                                                                         CXPMP2::XPMP2ErrorXPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft
                                                                                                                                                         CXPMP2::CSLModelInfo_t::MatchCrit_tAny number of airline codes and/or liveries can be assigned to a model for matching purpose
                                                                                                                                                         CXPMP2::CSLModel::MatchCritTyCombines match-relevant fields (beside ICAO a/c type)
                                                                                                                                                         CXPMP2::multiDataRefsTyKeeps the dataRef handles for one of the up to 19 legacy AI/Multiplayer slots ("sim/multiplayer/position")
                                                                                                                                                         CXPMP2::Obj8DataRefsA pair of strings, first one to search for, second one to replace it with
                                                                                                                                                         CpositionTySummarizes the 3 values of a position in the local coordinate system
                                                                                                                                                         CXPMP2::RemoteAcAnimTyA/C animation dataRef changes
                                                                                                                                                         CXPMP2::RemoteAcDetailTyA/C details, packed into an array message
                                                                                                                                                         CXPMP2::RemoteAcDetailTy_v0Version 0 A/C details, packed into an array message
                                                                                                                                                         CXPMP2::RemoteAcPosUpdateTyA/C Position updates based on global coordinates
                                                                                                                                                         CXPMP2::RemoteAcRemoveTyA/C Removal only includes the plane id, structure required for msgSize() function
                                                                                                                                                         CXPMP2::RemoteCBFctTyFunction prototypes for callback functions to handle the received messages
                                                                                                                                                         CXPMP2::RemoteDataRefPackTyDefinition for how to map dataRef values to (u)int8, ie. to an integer range of 8 bits
                                                                                                                                                         ▼CXPMP2::RemoteMsgBaseTyMessage header, identical for all message types
                                                                                                                                                         CXPMP2::RemoteMsgAcAnimTyA/C animation dataRef message, has an inherited header plus an array of variable sized XPMP2::RemoteAcAnimTy elements
                                                                                                                                                         CXPMP2::RemoteMsgAcDetailTyA/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
                                                                                                                                                         CXPMP2::RemoteMsgAcDetailTy_v0Version 0 A/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
                                                                                                                                                         CXPMP2::RemoteMsgAcPosUpdateTyA/C detail message, has an inherited header plus an array of XPMP2::RemoteAcDetailTy elements
                                                                                                                                                         CXPMP2::RemoteMsgAcRemoveTyA/C removal message, an array of plane ids
                                                                                                                                                         CXPMP2::RemoteMsgBeaconTy"Beacon of Interest", ie. some message on the multicast just to wake up sender
                                                                                                                                                         CXPMP2::RemoteMsgSettingsTySettings message, identifying a sending plugin, regularly providing its settings
                                                                                                                                                         CXPMP2::RmtAcCacheTyHolds a copy of some aircraft data as was sent out last
                                                                                                                                                         CXPMP2::RmtDataAcAnimTy.__unnamed4__
                                                                                                                                                         ▼CXPMP2::RmtDataBaseTyBase structure for passing information from XP's main thread to the multicast thread
                                                                                                                                                         CXPMP2::RmtDataAcAnimTyAnimation dataRef requires a special queue data type as each msg element is already of variable length
                                                                                                                                                         CXPMP2::RmtDataEnqeueTy< ElemTy, MsgTy >Passing information about any data type (like a/c full detail message); the data is contained as copy
                                                                                                                                                         CXPMP2::RmtMsgBufTy< ElemTy, MsgTy, msgVer >Helper class to manage the temporary buffers in which the network message are put together
                                                                                                                                                         ▼Cstd::runtime_error
                                                                                                                                                         CXPMP2::FmodErrorException class to pass on error information
                                                                                                                                                         CXPMP2::NetRuntimeErrorException raised by XPMP2::SocketNetworking objects
                                                                                                                                                         CSenderAddrTyUniquely identifies a sending plugin
                                                                                                                                                         CSenderTy
                                                                                                                                                         CXPMP2::Aircraft::SndChTyOperational values per sound channel, that is triggered by a standard sound event
                                                                                                                                                         ▼CXPMP2::SocketNetworkingBase class for any socket-based networking
                                                                                                                                                         CXPMP2::TCPConnectionListens to TCP connections and opens a session socket upon connect
                                                                                                                                                         CXPMP2::UDPMulticastUDP Multicast, always binding to INADDR_ANY
                                                                                                                                                         CXPMP2::UDPReceiverReceives UDP messages
                                                                                                                                                         CXPMP2::SoundDefTyDefinition of how sound is handled based on dataRef values (type)
                                                                                                                                                         CXPMP2::SoundFileRepresents a sound file
                                                                                                                                                         CXPMP2::TcasLightsTyA structure simplifying communicaton with sim/cockpit2/tcas/targets/position/lights
                                                                                                                                                         CXPMP2::Aircraft::wakeTyWake dataRef support
                                                                                                                                                         CXPMP2RCGlobalsHolds all global variables
                                                                                                                                                         Cxpmp_LightStatusDefines, which lights of the aircraft are on
                                                                                                                                                         Cxpmp_LightStatus.__unnamed2__
                                                                                                                                                         CXPMPInfoTexts_tTextual information of planes to be passed on via shared dataRefs to other plugins
                                                                                                                                                         CXPMP2::XPMPPlaneNotifierTyStores the function and refcon pointer for plane creation/destrcution notifications
                                                                                                                                                         CXPMPPlanePosition_tThis data structure contains the basic position info for an aircraft
                                                                                                                                                         CXPMPPlaneRadar_tDefines information about an aircraft visible to radar
                                                                                                                                                         CXPMPPlaneSurfaces_tExternal physical configuration of the plane
                                                                                                                                                        diff --git a/docs/html/index.html b/docs/html/index.html index c25f63ad..24237ad0 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -47,7 +47,7 @@

                                                                                                                                                        API

                                                                                                                                                        Required Header Files

                                                                                                                                                        -

                                                                                                                                                        A new plugin, which wants to use the XPMP2 library, needs to include the following 2 header files, provided in the inc folder:

                                                                                                                                                        +

                                                                                                                                                        A new plugin, which wants to use the XPMP2 library, needs to include the following 2 header files, provided in the inc folder:

                                                                                                                                                        • XPMPMultiplayer.h - Initialization and general control functions
                                                                                                                                                        • XPMPAircraft.h - Defines the class XPMP2::Aircraft, which represents an aircraft. Subclass this class in your plugin!
                                                                                                                                                          • @@ -56,12 +56,15 @@

                                                                                                                                                          Additional Header Files

                                                                                                                                                          There are 3 additional headers files, which are usually not required:

                                                                                                                                                          The following header files are deprecated and provided only for backward compatibility with previous libxplanemp, not to be used for new projects:

                                                                                                                                                          The following header file is for use by the "XPMP2 Remote Client":

                                                                                                                                                          • XPMPRemote.h - Defines network functionality and data structure for synchronizing planes between networked computers.
                                                                                                                                                          +

                                                                                                                                                          Sound Support by FMOD

                                                                                                                                                          +

                                                                                                                                                          XPMP2's Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. Understand FMOD licensing and attribution requirements first, as they will apply to your plugin if using XPMP2 with sound support.

                                                                                                                                                          +

                                                                                                                                                          Because of the licensing requirements, XPMP2 by default is built without sound support. See the Sound Support documentation for details how to enable sound support and how to include it into your plugin.

                                                                                                                                                          Quick Links to Detailed Documentation:

                                                                                                                                                            diff --git a/docs/html/md_XPMP2-Remote_README.html b/docs/html/md_XPMP2-Remote_README.html deleted file mode 100644 index 1b39c964..00000000 --- a/docs/html/md_XPMP2-Remote_README.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - -XPMP2: XPMP2 Remote Client - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            XPMP2 -
                                                                                                                                                            -
                                                                                                                                                            X-Plane multiplayer library 2 - using instancing
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            XPMP2 Remote Client
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Synchronizing Planes across the Network

                                                                                                                                                            -

                                                                                                                                                            Planes displayed using XPMP2 can by synchronized across the network. The XPMP2 Remote Client needs to run on all remote computers, receives aircraft data from any number of XPMP2-based plugins anywhere in the network, and displays the aircraft using the same CSL model, at the same world location with the same animation dataRefs.

                                                                                                                                                            -

                                                                                                                                                            This supports usage in setups like

                                                                                                                                                            -

                                                                                                                                                            For end user documentation refer to LiveTraffic/XPMP2 Remote Client documentation.

                                                                                                                                                            -

                                                                                                                                                            For more background information refer to GitHub XPMP2 documentation.

                                                                                                                                                            -

                                                                                                                                                            One of many possible setups: XPMP2 in a Standard Networked Setup

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -Generated by   -doxygen - 1.8.18 -
                                                                                                                                                            - - diff --git a/docs/html/md_XPMP2-Sample_README.html b/docs/html/md_XPMP2-Sample_README.html deleted file mode 100644 index b4e8f34b..00000000 --- a/docs/html/md_XPMP2-Sample_README.html +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - -XPMP2: XPMP2 Sample Plugin - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            XPMP2 -
                                                                                                                                                            -
                                                                                                                                                            X-Plane multiplayer library 2 - using instancing
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            XPMP2 Sample Plugin
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            This is a fully functional sample implementation that you can use to play with XPMP2 features and as a starting point for your own implementations.

                                                                                                                                                            -

                                                                                                                                                            I am also using it as a testbed for new features, so the implementation is regularly built, tested, and sometimes even enhanced to make use of latest features.

                                                                                                                                                            -

                                                                                                                                                            -Build

                                                                                                                                                            -

                                                                                                                                                            There are separate projects available to only build the XPMP2-Sample plugin, serving as a starting point for your projects.

                                                                                                                                                            -

                                                                                                                                                            Please refer to the GitHub Build documentation for details.

                                                                                                                                                            -

                                                                                                                                                            -Features

                                                                                                                                                            -

                                                                                                                                                            This plugin creates 3 planes, one with each of the available ways of using the XPMP2 library. All planes move in a circle around a position 200m in front of the user's plane (even if the user plane moves).

                                                                                                                                                              -
                                                                                                                                                            1. Subclassing XPMP2::Aircraft in class SampleAircraft, which is the recommended way for any new plugin. This plane flies highest, 100m above the user plane.
                                                                                                                                                              2. -
                                                                                                                                                            2. Subclassing the legacy class XPCAircraft. This plane flies in the middle, 50m above the user plane.
                                                                                                                                                              3. -
                                                                                                                                                            3. Using direct C functions. This plane always rolls on the ground, no matter how high the user plane flies.
                                                                                                                                                              4. -
                                                                                                                                                            -

                                                                                                                                                            Three menu items are provided:

                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            1. "Toggle Planes" creates/removes the planes.
                                                                                                                                                              2. -
                                                                                                                                                            2. "Toggle Visibility" shows/temporary hides the planes without destroying them.
                                                                                                                                                              3. -
                                                                                                                                                            3. "Cycle Models" changes the CSL model used per plane. Also, it flips the visibility of labels in the map view...just for a change.
                                                                                                                                                              4. -
                                                                                                                                                            -

                                                                                                                                                            -Installation

                                                                                                                                                            -

                                                                                                                                                            For the plugin to work properly some CSL models are necessary in some folders under Resources (all folders under Resources are scanned for xsb_aircraft.txt file, so the actual structure underneath Resources does not matter).

                                                                                                                                                            -

                                                                                                                                                            The directory structure would look as follows: ``` XPMP2-Sample/   lin_x64/     XPMP2-Sample.xpl   mac_x64/     XPMP2-Sample.xpl   win_x64/     XPMP2-Sample.xpl   Resources/ CSL/ <– install CSL models here     Doc8643.txt MapIcons.png Obj8DataRefs.txt     related.txt

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -Generated by   -doxygen - 1.8.18 -
                                                                                                                                                            - - diff --git a/docs/html/md_XPMP2_Remote_README.html b/docs/html/md_XPMP2_Remote_README.html index 44acab50..849d3a98 100644 --- a/docs/html/md_XPMP2_Remote_README.html +++ b/docs/html/md_XPMP2_Remote_README.html @@ -40,11 +40,11 @@
                                                                                                                                                            -
                                                                                                                                                            XPMP2 Remote Client
                                                                                                                                                            +
                                                                                                                                                            XPMP2 Remote Client

                                                                                                                                                            Synchronizing Planes across the Network

                                                                                                                                                            -

                                                                                                                                                            Planes displayed using XPMP2 can by synchronized across the network. The XPMP2 Remote Client needs to run on all remote computers, receives aircraft data from any number of XPMP2-based plugins anywhere in the network, and displays the aircraft using the same CSL model, at the same world location with the same animation dataRefs.

                                                                                                                                                            +

                                                                                                                                                            Planes displayed using XPMP2 can by synchronized across the network. The XPMP2 Remote Client needs to run on all remote computers, receives aircraft data from any number of XPMP2-based plugins anywhere in the network, and displays the aircraft using the same CSL model, at the same world location with the same animation dataRefs.

                                                                                                                                                            This supports usage in setups like

                                                                                                                                                            -
                                                                                                                                                            XPMP2 Sample Plugin
                                                                                                                                                            +
                                                                                                                                                            XPMP2 Sample Plugin
                                                                                                                                                            -

                                                                                                                                                            This is a fully functional sample implementation that you can use to play with XPMP2 features and as a starting point for your own implementations.

                                                                                                                                                            +

                                                                                                                                                            This is a fully functional sample implementation that you can use to play with XPMP2 features and as a starting point for your own implementations.

                                                                                                                                                            I am also using it as a testbed for new features, so the implementation is regularly built, tested, and sometimes even enhanced to make use of latest features.

                                                                                                                                                            -

                                                                                                                                                            +

                                                                                                                                                            Build

                                                                                                                                                            There are separate projects available to only build the XPMP2-Sample plugin, serving as a starting point for your projects.

                                                                                                                                                            Please refer to the GitHub Build documentation for details.

                                                                                                                                                            -

                                                                                                                                                            +

                                                                                                                                                            Features

                                                                                                                                                            -

                                                                                                                                                            This plugin creates 3 planes, one with each of the available ways of using the XPMP2 library. All planes move in a circle around a position 200m in front of the user's plane (even if the user plane moves).

                                                                                                                                                              +

                                                                                                                                                              This plugin creates 3 planes, one with each of the available ways of using the XPMP2 library. All planes move in a circle around a position 200m in front of the user's plane (even if the user plane moves).

                                                                                                                                                              1. Subclassing XPMP2::Aircraft in class SampleAircraft, which is the recommended way for any new plugin. This plane flies highest, 100m above the user plane.
                                                                                                                                                              2. Subclassing the legacy class XPCAircraft. This plane flies in the middle, 50m above the user plane.
                                                                                                                                                              3. Using direct C functions. This plane always rolls on the ground, no matter how high the user plane flies.
                                                                                                                                                                4. @@ -62,7 +62,7 @@

                                                                                                                                                              4. "Toggle Visibility" shows/temporary hides the planes without destroying them.
                                                                                                                                                              5. "Cycle Models" changes the CSL model used per plane. Also, it flips the visibility of labels in the map view...just for a change.

                                                                                                                                                              -

                                                                                                                                                              +

                                                                                                                                                              Installation

                                                                                                                                                              For the plugin to work properly some CSL models are necessary in some folders under Resources (all folders under Resources are scanned for xsb_aircraft.txt file, so the actual structure underneath Resources does not matter).

                                                                                                                                                              The directory structure would look as follows: ``` XPMP2-Sample/   lin_x64/     XPMP2-Sample.xpl   mac_x64/     XPMP2-Sample.xpl   win_x64/     XPMP2-Sample.xpl   Resources/ CSL/ <– install CSL models here     Doc8643.txt MapIcons.png Obj8DataRefs.txt     related.txt

                                                                                                                                                              diff --git a/docs/html/md_docs_BackwardsCompatibility.html b/docs/html/md_docs_BackwardsCompatibility.html index a545f958..60612790 100644 --- a/docs/html/md_docs_BackwardsCompatibility.html +++ b/docs/html/md_docs_BackwardsCompatibility.html @@ -43,7 +43,7 @@
                                                                                                                                                              Backwards Compatibilty
                                                                                                                                                            -

                                                                                                                                                            Despite its new approach, XPMP2 shall be your drop-in replacement for the original library: The original header files are still provided with the same name. All original public functions are still there. The original XPCAircraft class is still there, now derived from XPMP2::Aircraft.

                                                                                                                                                            +

                                                                                                                                                            Despite its new approach, XPMP2 shall be your drop-in replacement for the original library: The original header files are still provided with the same name. All original public functions are still there. The original XPCAircraft class is still there, now derived from XPMP2::Aircraft.

                                                                                                                                                            Changes

                                                                                                                                                            A few changes are there, though, for clarity and to be future-proof. Some few require simple code changes:

                                                                                                                                                              @@ -59,7 +59,7 @@

                                                                                                                                                            • (optionally) a short name / acronym used for logging into Log.txt.

                                                                                                                                                            -
                                                                                                                                                          • It is no longer necessary to define the compile-time macros XPMP_CLIENT_NAME and XPMP_CLIENT_LONGNAME. Instead, you can use the new parameter inPluginName in the call to XPMPMultiplayerInit or the function XPMPSetPluginName to set the plugin's name from within your plugin. XPMP2 tries to guess the plugin's name if no name is explicitely set. This allows using the provided libraries directly without the need to recompile.
                                                                                                                                                            • +
                                                                                                                                                          • It is no longer necessary to define the compile-time macros XPMP_CLIENT_NAME and XPMP_CLIENT_LONGNAME. Instead, you can use the new parameter inPluginName in the call to XPMPMultiplayerInit or the function XPMPSetPluginName to set the plugin's name from within your plugin. XPMP2 tries to guess the plugin's name if no name is explicitely set. This allows using the provided libraries directly without the need to recompile.
                                                                                                                                                          • XPMPLoadCSLPackage walks directories hierarchically up to 5 levels until it finds an xsb_aircraft.txt file. This should not affect classic usages, where such a path was just one level away from the xsb_aircraft.txt file. It would just also search deeper if needed.
                                                                                                                                                          • Available configuration parameters have change, that will be queried in calls to the configuration function callback that you can provide in XPMPMultiplayerInit. Please see the header file documentation for XPMPIntPrefsFuncTy for details.
                                                                                                                                                          diff --git a/docs/html/md_docs_Building.html b/docs/html/md_docs_Building.html index 51d85f3d..aef87499 100644 --- a/docs/html/md_docs_Building.html +++ b/docs/html/md_docs_Building.html @@ -40,22 +40,22 @@
                                                                                                                                                          -
                                                                                                                                                          Building XPMP2 and the Sample Plugin
                                                                                                                                                          +
                                                                                                                                                          Building XPMP2 and the Sample Plugin

                                                                                                                                                          Two Projects: XPMP2 Full Build and Sample Plugin only

                                                                                                                                                          -

                                                                                                                                                          There are two separate projects provided in the XPMP2 repository:

                                                                                                                                                          +

                                                                                                                                                          There are two separate projects provided in the XPMP2 repository:

                                                                                                                                                            -
                                                                                                                                                          • One based in the XPMP2 root folder. This project builds all 3 targets:
                                                                                                                                                              -
                                                                                                                                                            • The XPMP2 static library, which is also copied into XPMP2-Sample/lib so that is thereafter accessible by the stand-alone XPMP2-Sample project;
                                                                                                                                                              • -
                                                                                                                                                            • The XPMP2 Remote Client, which builds the XPMP2-Remote.xpl binary;
                                                                                                                                                              • -
                                                                                                                                                            • The XPMP2 Sample plugin, which builds the XPMP2-Sample.xpl binary, same as with the following stand-alone project.
                                                                                                                                                              • +
                                                                                                                                                            • One based in the XPMP2 root folder. This project builds all 3 targets:
                                                                                                                                                                +
                                                                                                                                                              • The XPMP2 static library, which is also copied into XPMP2-Sample/lib so that is thereafter accessible by the stand-alone XPMP2-Sample project;
                                                                                                                                                                • +
                                                                                                                                                              • The XPMP2 Remote Client, which builds the XPMP2-Remote.xpl binary;
                                                                                                                                                                • +
                                                                                                                                                              • The XPMP2 Sample plugin, which builds the XPMP2-Sample.xpl binary, same as with the following stand-alone project.
                                                                                                                                                            • a stand-alone project only for the XPMP2-Sample plugin. This is provided separately so it can serve as basis for your own plugin implementations.
                                                                                                                                                            -

                                                                                                                                                            Using either project works similarly when it comes to building. For the main XPMP2 projects start in the XPMP2 root folder. For the XPMP2-Sample stand-alone project start in the XPMP2-Sample folder.

                                                                                                                                                            +

                                                                                                                                                            Using either project works similarly when it comes to building. For the main XPMP2 projects start in the XPMP2 root folder. For the XPMP2-Sample stand-alone project start in the XPMP2-Sample folder.

                                                                                                                                                            Then, there are four options to build from sources:

                                                                                                                                                            @@ -74,7 +74,7 @@

                                                                                                                                                            Windows

                                                                                                                                                            @@ -82,13 +82,13 @@

                                                                                                                                                            Windows

                                                                                                                                                            The XPMP2.lib library is also copied into XPMP2-Sample/lib to be available in a subsequent build of the sample plugin.

                                                                                                                                                            MacOS

                                                                                                                                                            My development environment is Mac OS, so expect the XCode environment to be maintained best. Open XPMP2.xcodeproj resp. XPMP2-Sample/XPMP2-Sample.xcodeproj in XCode.

                                                                                                                                                            -

                                                                                                                                                            In the XCode Build Settings you may want to change the definition of the User-Defined build macro XPLANE11_ROOT: Put in the path to your X-Plane 11 installation's root path, then the XPMP2 binaries will be installed right there in the appropriate Resources/plugins sub-folder structure.

                                                                                                                                                            +

                                                                                                                                                            In the XCode Build Settings you may want to change the definition of the User-Defined build macro XPLANE11_ROOT: Put in the path to your X-Plane 11 installation's root path, then the XPMP2 binaries will be installed right there in the appropriate Resources/plugins sub-folder structure.

                                                                                                                                                            Using Docker

                                                                                                                                                            Docker environments based on Ubuntu 20.04 and 18.04 are used, which can build all 3 platforms, Linux even in two flavors.

                                                                                                                                                            • Install Docker Desktop and start it.
                                                                                                                                                              • -
                                                                                                                                                            • cd to the project's docker folder, and enter make for all XPMP2 library targets on all platforms, or
                                                                                                                                                              • +
                                                                                                                                                            • cd to the project's docker folder, and enter make for all XPMP2 library targets on all platforms, or
                                                                                                                                                            • cd to XPMP2-Sample/docker, and enter make for the sample plugin only on all platforms.

                                                                                                                                                            9 individual make targets are available:

                                                                                                                                                            @@ -103,7 +103,7 @@

                                                                                                                                                          • bash_bionic starts a bash prompt in the Ubuntu 18.04 docker container
                                                                                                                                                          • doc builds the documentation based on Doxygen, will probably only work on a Mac with Doxygen provided in Applications/Doxygen.app.
                                                                                                                                                            • -

                                                                                                                                                            Find results in the respective build-<platform> folder, the XPMP2 library right there, the Sample and Remote plugins in their proper <platform>_x64 subfolder.

                                                                                                                                                            +

                                                                                                                                                            Find results in the respective build-<platform> folder, the XPMP2 library right there, the Sample and Remote plugins in their proper <platform>_x64 subfolder.

                                                                                                                                                            The resulting library/framework are also copied into XPMP2-Sample/lib/<platform> so it is accessible if building the Sample plugin from the Sample project only.

                                                                                                                                                            For more details and background information on the provided Docker environments see the docker/README.md.

                                                                                                                                                            diff --git a/docs/html/md_docs_CSLdataRefs.html b/docs/html/md_docs_CSLdataRefs.html index f37b213c..e0cdeed8 100644 --- a/docs/html/md_docs_CSLdataRefs.html +++ b/docs/html/md_docs_CSLdataRefs.html @@ -43,7 +43,7 @@
                                                                                                                                                            dataRefs available to CSL Models
                                                                                                                                                            -

                                                                                                                                                            XPMP2 provides the following dataRef values for each CSL model rendered. That means, a CSL model can use it for its animations.

                                                                                                                                                            +

                                                                                                                                                            XPMP2 provides the following dataRef values for each CSL model rendered. That means, a CSL model can use it for its animations.

                                                                                                                                                            Actual values are taken from the XPMP2::Aircraft::v array. Compare the indexes listed in the second comlumn as defined in the enum DR_VALS (XPMPAircraft.h).

                                                                                                                                                            It is recommended to use the various getter/setter member functions in XPMP2::Aircraft to get/set values. Some of them perform additional functionality like synchronising RPM and RAD/s values.

                                                                                                                                                            diff --git a/docs/html/md_docs_CopyingObjFiles.html b/docs/html/md_docs_CopyingObjFiles.html index 7e0d1433..c417783c 100644 --- a/docs/html/md_docs_CopyingObjFiles.html +++ b/docs/html/md_docs_CopyingObjFiles.html @@ -43,20 +43,20 @@
                                                                                                                                                            Copying .obj Files for Replacing Animation dataRefs and Textures

                                                                                                                                                            -

                                                                                                                                                            CSL packages come in different flavours. Popular ones for general use are the Bluebell and the X-CSL packages. Both come with different history. For XPMP2 to use all their features it needs to change their .obj files. Performing these changes is built into XPMP2.

                                                                                                                                                            +

                                                                                                                                                            CSL packages come in different flavours. Popular ones for general use are the Bluebell and the X-CSL packages. Both come with different history. For XPMP2 to use all their features it needs to change their .obj files. Performing these changes is built into XPMP2.

                                                                                                                                                              -
                                                                                                                                                            • The Bluebells have not migrated newer animation dataRefs from their World Traffic origins to the now available libxplanemp names, which means that animations already existing in the models (like props, rotors, wheels, reversers) cannot be controlled by XPMP2.
                                                                                                                                                              • +
                                                                                                                                                            • The Bluebells have not migrated newer animation dataRefs from their World Traffic origins to the now available libxplanemp names, which means that animations already existing in the models (like props, rotors, wheels, reversers) cannot be controlled by XPMP2.
                                                                                                                                                            • X-CSL avoids shipping one .obj per texture and instead uses an extended OBJ8 command syntax in the xsb_aircraft.txt file to name the texture to use. Any kind of "dynamic change of the texture to use" cannot be supported with instancing any longer. Instancing requires one .obj file to be readily available for loading.

                                                                                                                                                            Previously, the CSL2XSB.py script performed the necessary changes. But executing it was an additional step too complex for some users, and required the user to have Python 3 installed.

                                                                                                                                                            -

                                                                                                                                                            Now, XPMP2 includes the required operation as well, which will be applied to .obj files shortly before they are loaded as an instances, ie. only for models which are actually used.

                                                                                                                                                            -

                                                                                                                                                            Two kinds of operations happen and a plugin using XPMP2 can control via configuration if they shall be applied. See the XPMPIntPrefsFuncTy type definition in XPMPMultiplayer.h or the XPMP2-Sample.cpp code for CBIntPrefsFunc(). The following configuration values play a role:

                                                                                                                                                            +

                                                                                                                                                            Now, XPMP2 includes the required operation as well, which will be applied to .obj files shortly before they are loaded as an instances, ie. only for models which are actually used.

                                                                                                                                                            +

                                                                                                                                                            Two kinds of operations happen and a plugin using XPMP2 can control via configuration if they shall be applied. See the XPMPIntPrefsFuncTy type definition in XPMPMultiplayer.h or the XPMP2-Sample.cpp code for CBIntPrefsFunc(). The following configuration values play a role:

                                                                                                                                                            - +
                                                                                                                                                            section key                 type default description
                                                                                                                                                            models  replace_datarefs    int     0    Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!)
                                                                                                                                                            models  replace_datarefs    int     0    Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!)
                                                                                                                                                            models  replace_texture     int     1    Replace textures in OBJ8 files upon load if needed (specified on the OBJ8 line in xsb_aircraft.txt), creating new OBJ8 files
                                                                                                                                                            @@ -82,7 +82,7 @@

                                                                                                                                                            This is off by default, because well curated packages won't need it. To enable it return 1 when called for configuration item XPMP_CFG_ITM_REPLDATAREFS.

                                                                                                                                                            When enabled, a copy for each .obj file will be created just before it is to be loaded. In each copy, dataRefs are replaced based on the definition in <resourceDir>/Obj8DataRefs.txt. That file just lists dataRef names to be replaced with the replacement dataRef like this:

                                                                                                                                                            cjs/world_traffic/engine_rotation_angle1 libxplanemp/engines/engine_rotation_angle_deg1
                                                                                                                                                            cjs/world_traffic/main_gear_deflection libxplanemp/gear/tire_vertical_deflection_mtr
                                                                                                                                                            -

                                                                                                                                                            The Obj8DataRefs.txt file available with XPMP2 defines a number of replacements to unlock more features in the Bluebell CSL models. The simple text format allows you to add/change replacement definitions easily and ship your version with your plugin.

                                                                                                                                                            +

                                                                                                                                                          The Obj8DataRefs.txt file available with XPMP2 defines a number of replacements to unlock more features in the Bluebell CSL models. The simple text format allows you to add/change replacement definitions easily and ship your version with your plugin.

                                                                                                                                                          Replacing Texture

                                                                                                                                                          This is on by default. You could switch it off by returning 0 when asked for configuration item XPMP_CFG_ITM_REPLTEXTURE.

                                                                                                                                                          diff --git a/docs/html/md_docs_Deploying.html b/docs/html/md_docs_Deploying.html index 4cf45579..0993bbca 100644 --- a/docs/html/md_docs_Deploying.html +++ b/docs/html/md_docs_Deploying.html @@ -43,9 +43,14 @@
                                                                                                                                                          Deploying XPMP2-based Plugins
                                                                                                                                                          -

                                                                                                                                                          XPMP2 needs a couple additional files to work. In your calls to XPMPMultiplayerInit and XPMPLoadCSLPackage you provide the locations to the folders holding these files.

                                                                                                                                                          -

                                                                                                                                                          +

                                                                                                                                                          +FMOD Sound Support (XP11/Windows)

                                                                                                                                                          +

                                                                                                                                                          If you built XPMP2 and your plugin with FMOD Sound Support, and you want to allow running your plugin with X-Plane 11 under Windows, then you should ship the XPMP2-Sample/lib/fmod/fmod.dll, too, as

                                                                                                                                                          win_x64/fmod.dll
                                                                                                                                                          +

                                                                                                                                                          next to your plugin's Windows version.

                                                                                                                                                          +

                                                                                                                                                          The reason is that X-Plane updated the FMOD versions included in X-Plane between XP11 and XP12. While XPMP2 is built in a way that it can run with either version, XP11 ships a DLL by the name of fmod64.dll while XPMP2 expects it by the name fmod.dll as XP12 provides it.

                                                                                                                                                          +

                                                                                                                                                          Resources

                                                                                                                                                          +

                                                                                                                                                          XPMP2 needs a couple additional files to work. In your calls to XPMPMultiplayerInit and XPMPLoadCSLPackage you provide the locations to the folders holding these files.

                                                                                                                                                          You should ship all the files provided in the Resources folder:

                                                                                                                                                          • Doc8643.txt is a list of ICAO aircraft type designators taken from the ICAO web site. This list is required for matching rules related to the aircraft type, ie. if no direct match is found in the available models or via the related.txt lists. ICAO provides monthly updates, so this file will update here from time to time, too.
                                                                                                                                                            • @@ -53,14 +58,14 @@

                                                                                                                                                          • related.txt defines "similar looking" aircraft types, so that an A320 model could be used if no exact match for the A319 at hand is found. Without that file this "related" matching cannot take place.
                                                                                                                                                          • Obj8DataRefs.txt is only required for the "Copying .OBJ Files" functionality: It defines dataRef replacements. You don't need to ship this file if you do not enable that functionality in your plugin.

                                                                                                                                                          -

                                                                                                                                                          These files have all to be installed in the same folder. It is good practice to install these files in a folder named Resources in the plugin's folder. Your plugin provides XPMP2 with the folder location in the resourceDir parameter of the XPMPMultiplayerInit call (see XPMPMultiplayer.h for more details).

                                                                                                                                                          -

                                                                                                                                                          You do not need to and shall not ship the XPMP2 Remote Client with your plugin. This plugin is maintained and provided centrally. Please refer your users to

                                                                                                                                                            +

                                                                                                                                                            These files have all to be installed in the same folder. It is good practice to install these files in a folder named Resources in the plugin's folder. Your plugin provides XPMP2 with the folder location in the resourceDir parameter of the XPMPMultiplayerInit call (see XPMPMultiplayer.h for more details).

                                                                                                                                                            +

                                                                                                                                                            You do not need to and shall not ship the XPMP2 Remote Client with your plugin. This plugin is maintained and provided centrally. Please refer your users to

                                                                                                                                                            -

                                                                                                                                                            +

                                                                                                                                                            CSL Models

                                                                                                                                                            -

                                                                                                                                                            CSL Models are not shipped with XPMP2. They are available as separate downloads. Recommended sources are:

                                                                                                                                                            +

                                                                                                                                                            CSL Models are not shipped with XPMP2. They are available as separate downloads. Recommended sources are:

                                                                                                                                                            You may want to refer to LiveTraffic's detailed CSL model installation instructions.

                                                                                                                                                            While it is recommendable to have the models installed somewhere under the plugin's folder, the CSL packages' location is a matter of convention. Your plugin provides the folder location of CSL packages in one or more calls to XPMPLoadCSLPackage.

                                                                                                                                                            -

                                                                                                                                                            Additional .obj files next to the existing ones might be generated during runtime by XPMP2 for replacing dataRefs and textures. A plugin can control this behaviour via configuration settings. See here for details.

                                                                                                                                                            +

                                                                                                                                                            Additional .obj files next to the existing ones might be generated during runtime by XPMP2 for replacing dataRefs and textures. A plugin can control this behaviour via configuration settings. See here for details.

                                                                                                                                                          diff --git a/docs/html/md_docs_HowTo.html b/docs/html/md_docs_HowTo.html index c55f8d3b..dc8a2cad 100644 --- a/docs/html/md_docs_HowTo.html +++ b/docs/html/md_docs_HowTo.html @@ -40,16 +40,16 @@
                                                                                                                                                          -
                                                                                                                                                          How to Use XPMP2
                                                                                                                                                          +
                                                                                                                                                          How to Use XPMP2

                                                                                                                                                          This page probably requires more attention... but there is a working sample plugin available in the XPMP2-Sample folder for you to study:

                                                                                                                                                          -

                                                                                                                                                          +

                                                                                                                                                          Sample Plugin

                                                                                                                                                          This package comes with a sample plugin in the XPMP2-Sample folder. It is a complete plugin including build projects and CMake setup. It displays 3 aircraft flying circles in front of the user's plane. Each of the 3 aircraft is using a different technology: the now recommended way of subclassing XPMP2::Aircraft, the legacy way of subclassing XPCAircraft (as used by LiveTraffic v1.x), and by calling standard C functions.

                                                                                                                                                          For the sample plugin to work you need to follow instruction in Deploying XPMP2-based Plugins for

                                                                                                                                                            -
                                                                                                                                                          • a Resources folder under the plugin's folder holding the 3 files from the Resources folder provided here with XPMP2,
                                                                                                                                                            • +
                                                                                                                                                          • a Resources folder under the plugin's folder holding the 3 files from the Resources folder provided here with XPMP2,
                                                                                                                                                          • CSL models installed in folders under that Resources folder.
                                                                                                                                                            • The sample plugin tries to find matches for "B06/TXB", "DH8A/BER", and "A321", all available in the Bluebell packages. But matching will find anything if you provide at least one model.
                                                                                                                                                            @@ -66,14 +66,14 @@

                                                                                                                                                            Obj8DataRefs.txt
                                                                                                                                                            related.txt
                                                                                                                                                            win_x64/XPMP2-Sample.xpl
                                                                                                                                                            -

                                                                                                                                                          +

                                                                                                                                                          Binaries and Header Files

                                                                                                                                                          You don't need to build the library yourself if you don't want. Archives with headers and release/debug builds are available in the Release section here on GitHub.

                                                                                                                                                          -

                                                                                                                                                          +

                                                                                                                                                          Anatomy of Your Plugin using XPMP2

                                                                                                                                                          -

                                                                                                                                                          Generically you should probably use XPMP2 as follows:

                                                                                                                                                          +

                                                                                                                                                          Generically you should probably use XPMP2 as follows:

                                                                                                                                                            -
                                                                                                                                                          • XPluginEnable: Initialize XPMP2 using
                                                                                                                                                              +
                                                                                                                                                            • XPluginEnable: Initialize XPMP2 using
                                                                                                                                                              • XPMPMultiplayerInit,
                                                                                                                                                              • XPMPLoadCSLPackage once or multiple times, and
                                                                                                                                                              • XPMPMultiplayerEnable.
                                                                                                                                                                • @@ -91,7 +91,7 @@

                                                                                                                                                            -

                                                                                                                                                            +

                                                                                                                                                            Subclass <tt>XPMP2::Aircraft</tt>

                                                                                                                                                            New plugin implementations are strongly advised to directly sub-class from the new class XPMP2::Aircraft, which is the actual aircraft representation.

                                                                                                                                                            See the SampleAircraft class defined in XPMP2-Sample/XPMP2-Sample.cpp for an example implementation.

                                                                                                                                                            diff --git a/docs/html/md_docs_Matching.html b/docs/html/md_docs_Matching.html index e2d59b8d..f9416412 100644 --- a/docs/html/md_docs_Matching.html +++ b/docs/html/md_docs_Matching.html @@ -43,7 +43,7 @@
                                                                                                                                                            Model Matching
                                                                                                                                                            -

                                                                                                                                                            "Model Matching" describes how XPMP2 picks one of the installed CSL models to match with what your plugins would like to draw into the simulator's sky. Users will have installed a varying amount of CSL models from which XPMP2 can choose.

                                                                                                                                                            +

                                                                                                                                                            "Model Matching" describes how XPMP2 picks one of the installed CSL models to match with what your plugins would like to draw into the simulator's sky. Users will have installed a varying amount of CSL models from which XPMP2 can choose.

                                                                                                                                                            Matching takes place

                                                                                                                                                            All parameters are optional. Pass an empty string if you can't provide details.

                                                                                                                                                            Internally, a fourth parameter named related group is added, derived from the ICAO aircraft type designator: There are many similar looking aircraft models in the world...just think of A319, A320, A321. The related.txt files combines all similar looking models into one line, which make up such a group. Each aircraft type is allowed to appear at maximum once in the entire file. The idea is to use a A320 model if a necessary A319 model is not available.

                                                                                                                                                            -

                                                                                                                                                            Aircraft / airline / livery combinations available for the user are listed in the xsb_aircraft.txt files in the user's CSL model folders. XPMP2 reads all of these files into a cache when your plugin calls XPMPLoadCSLPackage, i.e. typically at startup.

                                                                                                                                                            +

                                                                                                                                                            Aircraft / airline / livery combinations available for the user are listed in the xsb_aircraft.txt files in the user's CSL model folders. XPMP2 reads all of these files into a cache when your plugin calls XPMPLoadCSLPackage, i.e. typically at startup.

                                                                                                                                                            Procedure

                                                                                                                                                            Model Matching now compares 10 attributes between the parameters you pass during aircraft creation and the available models. They are rated according to the following priority from broad to fine-grained attributes:

                                                                                                                                                            @@ -74,12 +74,12 @@

                                                                                                                                                          • Special Livery

                                                                                                                                                            • The better a potential CSL model matches with the passed-in parameters the more of the above attributes match, the higher is the "match quality". Higher priority attributes count more than lower ones: technically it is a bit mask with the number 1 attribute at the most significant bit.

                                                                                                                                                            -

                                                                                                                                                            The model with the best match quality is picked. If there are several models ending up with the same match quality, then XPMP2 takes a random pick. This often happens if there are several models available for the expected ICAO aircraft type designator, but none of them has the correct livery for the requested operator.

                                                                                                                                                            +

                                                                                                                                                            The model with the best match quality is picked. If there are several models ending up with the same match quality, then XPMP2 takes a random pick. This often happens if there are several models available for the expected ICAO aircraft type designator, but none of them has the correct livery for the requested operator.

                                                                                                                                                            There is no "default" livery any longer as there was in libxplanemp. The downside is that it is a bit harder to identify non-matching liveries: Asking twice with the same match parameters can end in different models being picked.

                                                                                                                                                            Logging

                                                                                                                                                            If you are interested in how models are picked then you can activate logging of model matching: In your configuration callback return 1 for key XPMP_CFG_ITM_MODELMATCHING and 0 or 1 for key XPMP_CFG_ITM_LOGLEVEL.

                                                                                                                                                            -

                                                                                                                                                            With model matching logging activated, XPMP2 writes info into Log.txt like this:

                                                                                                                                                            +

                                                                                                                                                            With model matching logging activated, XPMP2 writes info into Log.txt like this:

                                                                                                                                                            .../CSLFindMatch: MATCH INPUT: Type=BE36 (WTC=L,Class=L1P,Related=128), Airline=N13, Livery=N136HP
                                                                                                                                                            .../CSLFindMatch: MATCH FOUND: Type=BE20 (WTC=L,Class=L2T,Related=128), Airline=SLG, Livery= / Quality = 56 -> model BB_GA/BE20_CGSAE
                                                                                                                                                            @@ -91,7 +91,7 @@

                                                                                                                                                            .../CSLFindMatch: MATCH INPUT: Type=H500 (WTC=L,Class=H1T,Related=177), Airline=N91, Livery=N911WY
                                                                                                                                                            .../CSLFindMatch: MATCH FOUND: Type=B06 (WTC=L,Class=H1T,Related=177), Airline=PAT, Livery= / Quality = 8 -> model BB_Heli/B06_US3_31A
                                                                                                                                                            -

                                                                                                                                                            Note that "quality" is reported inverse here in Log.txt (as it is used in XPMP2's code): Lower numbers are better matches.

                                                                                                                                                            +

                                                                                                                                                            Note that "quality" is reported inverse here in Log.txt (as it is used in XPMP2's code): Lower numbers are better matches.

                                                                                                                                                            For example: The first match (Quality = 56) is a comparably bad one... just look at the aircraft class: Wanted is a "L1P" aircraft (one piston engine), the best we found is an L2T (two turbo engines).

                                                                                                                                                            diff --git a/docs/html/md_docs_Remote.html b/docs/html/md_docs_Remote.html index 818f0b8f..9da5c0aa 100644 --- a/docs/html/md_docs_Remote.html +++ b/docs/html/md_docs_Remote.html @@ -40,21 +40,21 @@
                                                                                                                                                            -
                                                                                                                                                            XPMP2 Remote Functionality
                                                                                                                                                            +
                                                                                                                                                            XPMP2 Remote Functionality
                                                                                                                                                            -

                                                                                                                                                            This page explains the technical background of the XPMP2 Remote functionality. For end user documentation refer to LiveTraffic/XPMP2 Remote Client documentation.

                                                                                                                                                            +

                                                                                                                                                            This page explains the technical background of the XPMP2 Remote functionality. For end user documentation refer to LiveTraffic/XPMP2 Remote Client documentation.

                                                                                                                                                            Support in your Plugin

                                                                                                                                                            -

                                                                                                                                                            You do not need to do anything specifically in your plugin to support the Remote functionality. Just build and link with the latest XPMP2 library. Don't even ship the Remote Client, but refer to the download location, which is maintained centrally.

                                                                                                                                                            +

                                                                                                                                                            You do not need to do anything specifically in your plugin to support the Remote functionality. Just build and link with the latest XPMP2 library. Don't even ship the Remote Client, but refer to the download location, which is maintained centrally.

                                                                                                                                                            Optionally, you could respond to the new XPMP_CFG_ITM_SUPPORT_REMOTE configuration item in your XPMPIntPrefsFuncTy configuration callback function, e.g. to provide the user with an option to switch Remote support on regardless of network configuration. However, the default, "auto-detect", works in by far most scenarios already. And in the few others the users would still have the chance to use the XPMP2.prf config file as documented.

                                                                                                                                                            -

                                                                                                                                                            Optionally, you could react to an inter-plugin message XPLM_MSG_RELEASE_PLANES from the XPMP2 Remote Client and cede TCAS/AI control in that case because the Remote Client will take care of your TCAS in that case, too, but will also have the chance to pick up planes of other XPMP2-based plugins. See LiveTraffic's XPluginReceiveMessage function for an example.

                                                                                                                                                            +

                                                                                                                                                            Optionally, you could react to an inter-plugin message XPLM_MSG_RELEASE_PLANES from the XPMP2 Remote Client and cede TCAS/AI control in that case because the Remote Client will take care of your TCAS in that case, too, but will also have the chance to pick up planes of other XPMP2-based plugins. See LiveTraffic's XPluginReceiveMessage function for an example.

                                                                                                                                                            Basic Ideas

                                                                                                                                                            • There are senders (the actual XPMP2-based plugins) disseminating position information via UDP multicst into the local network.
                                                                                                                                                              • -
                                                                                                                                                            • There is one centrally provided XPMP2 Remote Client plugin per networked PC, which is part of the XPMP2 project. This client reads those multicast messages and displays the aircraft in the networked PCs.
                                                                                                                                                              • -
                                                                                                                                                            • The XPMP2 master shall be independent of the X-Plane master. This would allow to run the XPMP2 master on another of the networked PCs for load balancing. Or to use the same principle for networked gaming setup with several totally independent players, which still could share the same XPMP2-driven planes.
                                                                                                                                                              • +
                                                                                                                                                            • There is one centrally provided XPMP2 Remote Client plugin per networked PC, which is part of the XPMP2 project. This client reads those multicast messages and displays the aircraft in the networked PCs.
                                                                                                                                                              • +
                                                                                                                                                            • The XPMP2 master shall be independent of the X-Plane master. This would allow to run the XPMP2 master on another of the networked PCs for load balancing. Or to use the same principle for networked gaming setup with several totally independent players, which still could share the same XPMP2-driven planes.
                                                                                                                                                            • It is possible to collect multicast data from different XPMP2-driven plugins, even if they run on different PCs. So the Remote Client is able to identify different sources and map their aircraft ids in case they are in conflict.
                                                                                                                                                            • Standard setup is "zero-config":
                                                                                                                                                              • The masters will first listen to the multicast port. As soon as they receive something they will start broadcasting their own data, too.
                                                                                                                                                                • diff --git a/docs/html/md_docs_SharedDataRefs.html b/docs/html/md_docs_SharedDataRefs.html index 404a2608..f74bd6a9 100644 --- a/docs/html/md_docs_SharedDataRefs.html +++ b/docs/html/md_docs_SharedDataRefs.html @@ -48,7 +48,7 @@

                                                                                                                                                                Information offered by XPMP2-based Plugin

                                                                                                                                                                The names of the shared dataRefs follow the naming conventions known from pre-XP11.50 times when there were just 19 multiplayer planes support with similarly named dataRefs for position and configuration information. For each plane there is a set of dataRefs, each dataRef contains up to 40 byte data to be interpreted as a zero-terminated C string.

                                                                                                                                                                -

                                                                                                                                                                XPMP2 creates and maintains up to 63 sets of these dataRefs, starting at sim/multiplayer/position/plane1_tailnum and ending at sim/multiplayer/position/plane63_apt_to.

                                                                                                                                                                +

                                                                                                                                                                XPMP2 creates and maintains up to 63 sets of these dataRefs, starting at sim/multiplayer/position/plane1_tailnum and ending at sim/multiplayer/position/plane63_apt_to.

                                                                                                                                                                If you want to pubish information in your XPMP2-based plugin via these channels, then fill the appropriate field in the XPMP2::Aircraft::acInfoTexts structure.

                                                                                                                                                                diff --git a/docs/html/md_docs_Sound.html b/docs/html/md_docs_Sound.html new file mode 100644 index 00000000..01e44e70 --- /dev/null +++ b/docs/html/md_docs_Sound.html @@ -0,0 +1,133 @@ + + + + + + + +XPMP2: Sound Support by FMOD + + + + + + +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                + + + + + +
                                                                                                                                                                +
                                                                                                                                                                XPMP2 +
                                                                                                                                                                +
                                                                                                                                                                X-Plane multiplayer library 2 - using instancing
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                            + + + + + + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Sound Support by FMOD
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            XPMP2's Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. Understand FMOD licensing and attribution requirements first, as they will apply to your plugin if using XPMP2 with sound support.

                                                                                                                                                            +

                                                                                                                                                            While X-Plane supports and uses FMOD, too, for aircraft-specific sounds, XPMP2 cannot make use of any X-Plane functionality to produce the sounds as X-Plane at the moment does not allow to dynamically add sounds to instanced objects.

                                                                                                                                                            +

                                                                                                                                                            Instead, XPMP2 creates its own fully indepent instance of the FMOD system. This also means that XPMP2 has to provide FMOD with all spacial information for each aircraft's sound to create a proper 3D sound illusion relative to the user's current camera position. Which opens a totally new are for potential bugs...

                                                                                                                                                            +

                                                                                                                                                            Building XPMP2 with FMOD Sound Support

                                                                                                                                                            +

                                                                                                                                                            Due to above licencing requirements, sound support is only included if XPMP2 is consciously built with CMake cache entry INCLUDE_FMOD_SOUND, which in turn defines a compile-time macro by the same name, e.g. by doing

                                                                                                                                                            cmake -G Ninja -DINCLUDE_FMOD_SOUND=1 ..
                                                                                                                                                            +

                                                                                                                                                            The Docker Makefile allows passing CMake parameters via the FLAGS macro:

                                                                                                                                                            make FLAGS=-DINCLUDE_FMOD_SOUND=1 {...platform(s)...}
                                                                                                                                                            +

                                                                                                                                                            The GitHub Actions triggered by default are building without FMOD support, too. Running "Build all Platforms" manually, though, allows to specify FLAGS.

                                                                                                                                                            +

                                                                                                                                                            Including FMOD Sound Support in Your Plugin

                                                                                                                                                            +

                                                                                                                                                            In your plugin, you also need to define INCLUDE_FMOD_SOUND before including the XPMP2 headers:

                                                                                                                                                            #define INCLUDE_FMOD_SOUND 1 // Include FMOD sound support
                                                                                                                                                            +
                                                                                                                                                            #include "XPMPMultiplayer.h"
                                                                                                                                                            +
                                                                                                                                                            #include "XPMPAircraft.h"
                                                                                                                                                            +

                                                                                                                                                            Then certainly link with an FMOD-enabled version of the XPMP2 library.

                                                                                                                                                            +

                                                                                                                                                            Avoid Crash

                                                                                                                                                            +

                                                                                                                                                            If the XPMP2 you linked is compiled with INCLUDE_FMOD_SOUND but your actual plugin without, then the plugin will crash in XPMP2::Aircraft::FlightLoopCB() at the point when it tries to call XPMP2::Aircraft::UpdateSound(), because the XPMP2::Aircraft object created by your plugin is created with too short a vtable as it did not consider the virtual member functions for sound support.

                                                                                                                                                            +

                                                                                                                                                            You can tell if your XPMP2 library includes FMOD support latest from the init message in Log.txt, when it says:

                                                                                                                                                            +
                                                                                                                                                            ...XPMPMultiplayerInit: XPMP2 2.60 with FMOD support initializing...`
                                                                                                                                                            +

                                                                                                                                                            Solution: Either link to an XPMP2 build without FMOD support. Or make sure to #define INCLUDE_FMOD_SOUND 1 in your plugin before including the XPMP2 headers.

                                                                                                                                                            +

                                                                                                                                                            FMOD Logo

                                                                                                                                                            +

                                                                                                                                                            Not built into XPMP2 (to avoid a link-time dependency on OpenGL) but provided separately are functions to create the FMOD logo as per attribution requirements. Include FMOD_Logo.cpp and FMOD_Logo.h from XPMP2-Sample/lib/fmod/logo into your project. Showing the FMOD logo in a Dear ImGui window is then as simple as

                                                                                                                                                            #include "FMOD_Logo.h"
                                                                                                                                                            +
                                                                                                                                                            ...
                                                                                                                                                            +
                                                                                                                                                            int logoId = 0;
                                                                                                                                                            +
                                                                                                                                                            if (FMODLogo::GetTexture(logoId)) {
                                                                                                                                                            +
                                                                                                                                                            ImGui::Image((void*)(intptr_t)logoId, ImVec2(FMODLogo::IMG_WIDTH, FMODLogo::IMG_HEIGHT));
                                                                                                                                                            +
                                                                                                                                                            }
                                                                                                                                                            +

                                                                                                                                                            Ship fmod.dll

                                                                                                                                                            +

                                                                                                                                                            If your plugin supports X-Plane 11 under Windows, then you need to ship fmod.dll in the win_x64 folder. See Deploying for details.

                                                                                                                                                            +

                                                                                                                                                            Default Sounds

                                                                                                                                                            +

                                                                                                                                                            Your are not required to provide any sound-specific coding in your plugin. As a matter of fact, the XPMP2-Sample plugin has no single line of code that controls sound. (There is only some sample code to enumerate the loaded sounds into Log.txt, purely for my personal testing purposes.)

                                                                                                                                                            +

                                                                                                                                                            Once built with sound support, XPMP2 provides a lot of sounds by default. XPMP2 distinguishes 5 sound types, see XPMP2::Aircraft::SoundEventsTy, and plays sounds that are included in any X-Plane installation's Resources/sounds folders based on the level of certain dataRefs:

                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                            Event dataRef Sound
                                                                                                                                                            Engine Thrust Ratio Depends on aircraft type, volume changes with Thrust
                                                                                                                                                            Reverse Thrust Reverse Ratio XP_SOUND_REVERSE_THRUST, volume changes with Thrust Reverse
                                                                                                                                                            Tire Tire Rotation RPM XP_SOUND_ROLL_RUNWAY, volume changes with RPM
                                                                                                                                                            Gear Gear Ratio XP_SOUND_GEAR upon a change to the Gear Ratio
                                                                                                                                                            Flaps Flap Ratio XP_SOUND_FLAP once upon a change to the Flap Ratio
                                                                                                                                                            +

                                                                                                                                                            The engine sounds depend on the aircraft type, more specifically on the ICAO aircraft type designators as provided in Resources/Doc8643.txt:

                                                                                                                                                            + + + + + + + + + + + + + + + + + +
                                                                                                                                                            Type Designator means Sound
                                                                                                                                                            ZZZC Ground vehicle XP_SOUND_ELECTRIC
                                                                                                                                                            H?? or G?? Heli, Gyrocopter XP_SOUND_PROP_HELI
                                                                                                                                                            E?? Electric XP_SOUND_ELECTRIC
                                                                                                                                                            J1? Jet, single XP_SOUND_HIBYPASSJET
                                                                                                                                                            J?? Jet, multi XP_SOUND_LOBYPASSJET
                                                                                                                                                            P?? Piston XP_SOUND_PROP_AIRPLANE
                                                                                                                                                            T?? Turboprop XP_SOUND_TURBOPROP
                                                                                                                                                            +

                                                                                                                                                            The sounds' volume additionally depends on the number of engines, which while obvious for the engine sounds is generally an ok indicator for the plane's size and hence volume.

                                                                                                                                                            +

                                                                                                                                                            Controlling Sound

                                                                                                                                                            +

                                                                                                                                                            Here are your options to influence sound.

                                                                                                                                                            +

                                                                                                                                                            Enable/Disable

                                                                                                                                                            +

                                                                                                                                                            Beside using XPMPSoundEnable() directly, you can also provides values for configuration items XPMP_CFG_ITM_ACTIVATE_SOUND and XPMP_CFG_ITM_MUTE_ON_PAUSE in your configuration callback.

                                                                                                                                                            +

                                                                                                                                                            General Volume

                                                                                                                                                            +

                                                                                                                                                            XPMPSoundSetMasterVolume() and XPMPSoundMute() allow controlling the volume of XPMP2's sounds generally across all aircraft.

                                                                                                                                                            +

                                                                                                                                                            Add your own Sounds

                                                                                                                                                            +

                                                                                                                                                            XPMPSoundAdd() allows you to add your own sounds. Sounds can be looping (like engine sounds, which play continuously) or one-time sounds.

                                                                                                                                                            +

                                                                                                                                                            The function optionally also allows to define sound cone parameters. A sound cone basically is a cone-shaped area, in which the sound is heared with full volume, while outside of it the sound is reduced (attenuated) to a lower volume. The default sounds use that for the jet eingine sounds, which are louder behind the aircraft. coneDir and conePitch are defined relative to the aircraft's heading. XPMP2 takes care of orientating the actual sound cone dynamically with the actual aircraft orientation. The other three cone-specific parameters are passed through to FMOD (see set3DConeSettings).

                                                                                                                                                            +

                                                                                                                                                            Override virtual Aircraft member functions

                                                                                                                                                            +

                                                                                                                                                            For more control over the sounds your aircraft emit you can override Aircraft's virtual member functions:

                                                                                                                                                            +
                                                                                                                                                              +
                                                                                                                                                            • Aircraft::SoundSetup() is called after aircraft creation once the CSL model to use is determined; called again after CSL model changes. Use to define/override some defaults. Is a good place to set aSndCh[SoundEventsTy].bAuto = false in case you want to have full control over any of the pre-defined sound types.
                                                                                                                                                              • +
                                                                                                                                                            • Aircraft::SoundUpdate() is called in every flight loop cycle and decides, which sounds to start/stop at which volume. You can make calls to functions like Aircraft::SoundPlay/SoundStop/SoundVolume().
                                                                                                                                                              • +
                                                                                                                                                            • Aircraft::SoundGetName() is called by XPMP2's standard implementation of SoundUpdate(). Override if you just want to have control over which sounds at which volume to play for the standard event types, but otherwise want to leave sound handling to XPMP2. You can return any sound name, ie. also additional names you have registered previously with XPMPSoundAdd().
                                                                                                                                                              • +
                                                                                                                                                            • Aircraft::SoundRemoveAll() is called during object destruction to cleanup all sound objects. If you have started playing any sounds yourself you should clean them up here before calling the standard function to give XPMP2 a chance for cleanup, too.
                                                                                                                                                              • +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + +
                                                                                                                                                            +Generated by doxygen 1.9.1 +
                                                                                                                                                            + + diff --git a/docs/html/md_docs_TCAS.html b/docs/html/md_docs_TCAS.html index 9f75925e..eaf9c550 100644 --- a/docs/html/md_docs_TCAS.html +++ b/docs/html/md_docs_TCAS.html @@ -43,32 +43,32 @@
                                                                                                                                                            TCAS and AI/multiplayer Support
                                                                                                                                                            -

                                                                                                                                                            XPMP2 provides TCAS blibs and AI/multiplayer data using TCAS Override introduced with X-Plane 11.50 Beta 8. Please do read that blog post by Laminar as it explains all what's necessary and what also XPMP2 does:

                                                                                                                                                            +

                                                                                                                                                            XPMP2 provides TCAS blibs and AI/multiplayer data using TCAS Override introduced with X-Plane 11.50 Beta 8. Please do read that blog post by Laminar as it explains all what's necessary and what also XPMP2 does:

                                                                                                                                                              -
                                                                                                                                                            • Try acquiring TCAS control via a call to XPLMAcquirePlanes. All what follows only happens if XPMP2 was granted access:
                                                                                                                                                              • +
                                                                                                                                                            • Try acquiring TCAS control via a call to XPLMAcquirePlanes. All what follows only happens if XPMP2 was granted access:
                                                                                                                                                            • Sets sim/operation/override/override_TCAS to 1 to tell X-Plane that it will use TCAS Override
                                                                                                                                                              • -
                                                                                                                                                            • Sets sim/operation/override/override_multiplayer_map_layer to 1 to tell X-Plane that it shall not draw icons into the map as XPMP2 provides a self-defined additional map layer
                                                                                                                                                              • +
                                                                                                                                                            • Sets sim/operation/override/override_multiplayer_map_layer to 1 to tell X-Plane that it shall not draw icons into the map as XPMP2 provides a self-defined additional map layer
                                                                                                                                                            • All aircraft are sorted by distance (biased by XPMP2::Aircraft::aiPrio), for each aircraft a number of dataRefs are set, see below
                                                                                                                                                            • In a call to XPLMSetActiveAircraftCount X-Plane is informed about the exact number of provided planes. (This might not be strictly necessary, but probably a cleaner approach than to wait 10 cylces for not updated dataRefs to be taken out of X-Plane's consideration.)

                                                                                                                                                            When TCS Override is not available (like up to X-Plane 11.41), then TCAS is provided by writing the classic multiplayer dataRefs directly.

                                                                                                                                                            -

                                                                                                                                                            +

                                                                                                                                                            Slotting

                                                                                                                                                            There is a limited number of "slots" available for TCAS/multiplayer purposes. With TCAS Override, this is currently 63, with classic multiplayer dataRefs, this is up to 19, though for many 3rd party plugins the number of actually configured AI Aircraft (X-Planes Flight Setup) plays a role, too.

                                                                                                                                                            -

                                                                                                                                                            XPMP2 will show the aircraft closest to current camera location. This set of aircraft will change over time. But XPMP2 will try to keep a plane, which once was shown on TCAS, in the same slot to make it easier for 3rd party plugins to follow one plane.

                                                                                                                                                            +

                                                                                                                                                            XPMP2 will show the aircraft closest to current camera location. This set of aircraft will change over time. But XPMP2 will try to keep a plane, which once was shown on TCAS, in the same slot to make it easier for 3rd party plugins to follow one plane.

                                                                                                                                                            Keeping a plane in one slot has limits. The following rules apply:

                                                                                                                                                            • TCAS Override (X-Plane 11.50b8 and above): The lower 19 slots are the "lower range" because 3rd party plugins not yet using TCAS Override have access to only these 19.
                                                                                                                                                            • Fallback with classic dataRefs: The lower n slots, for which AI Aircraft are configured, are considered "lower range" because some 3rd party plugins only access as many planes as are configured as AI Aircraft (though this is unnecessary: plugins could just read all 19 dataRefs irrespective of what XPLMCountAircraft returns.)
                                                                                                                                                            • This "lower range" is considered higher priority and will be filled up first with closest planes.
                                                                                                                                                              • -
                                                                                                                                                            • XPMP2 will fill a continuous set of slots starting at 1. If a plane is removed, which occupied a slot in the middle then another plane will take it (potentially moving down from the upper range to the lower range).
                                                                                                                                                              • +
                                                                                                                                                            • XPMP2 will fill a continuous set of slots starting at 1. If a plane is removed, which occupied a slot in the middle then another plane will take it (potentially moving down from the upper range to the lower range).
                                                                                                                                                            • Also, if a plane is moved between lower and upper range because it moved ranks in the order by distance, then it changes slots.
                                                                                                                                                            -

                                                                                                                                                            +

                                                                                                                                                            TCAS Target dataRefs

                                                                                                                                                            -

                                                                                                                                                            XPMP2 writes the folloing TCAS target dataRefs when it has TCAS control:

                                                                                                                                                            +

                                                                                                                                                            XPMP2 writes the folloing TCAS target dataRefs when it has TCAS control:

                                                                                                                                                            - + @@ -82,7 +82,7 @@

                                                                                                                                                            Values are taken from XPMP2::Aircraft::v. Compare the indexes as defined in the enum DR_VALS defined in XPMPAircraft.h:

                                                                                                                                                            .../tcas/targets/ XPMP2's value from XPMP2::Aircraft
                                                                                                                                                            .../tcas/targets/ XPMP2's value from XPMP2::Aircraft
                                                                                                                                                            modeS_id modeS_id
                                                                                                                                                            - + @@ -118,11 +118,11 @@

                                                                                                                                                            .../tcas/targets/position/ XPMP2's value from XPMP2::Aircraft
                                                                                                                                                            .../tcas/targets/position/ XPMP2's value from XPMP2::Aircraft
                                                                                                                                                            x, y, z drawInfo.x, drawInfo.y - ac.GetVertOfs(), drawInfo.z
                                                                                                                                                            weight_on_wheels -
                                                                                                                                                            -

                                                                                                                                                            +

                                                                                                                                                            Classic AI/Multiplayer support

                                                                                                                                                            ...is provided by X-Plane automatically when feeding above TCAS target dataRefs. That means: The lower 19 planes are mirrored into the well-known sim/multiplayer/position/plane#_* dataRefs. Plugins still relying on these dataRefs will mainly "just work". And this without any workarounds like defining AI Aircraft in X-Plane's settings!

                                                                                                                                                            Please note that XPLMCountAircraft can now return values larger than 20, up to 64 at the moment.

                                                                                                                                                            -

                                                                                                                                                            XPMP2 still makes sure that unused sim/multiplayer/position/plane# slots (ie. if less than 19 planes are shown) are initialised with _x/y/z set to 9999999.9. They are deliberately not set to 0 if unused, because 0/0/0 is a totally valid local geographic location.

                                                                                                                                                            +

                                                                                                                                                            XPMP2 still makes sure that unused sim/multiplayer/position/plane# slots (ie. if less than 19 planes are shown) are initialised with _x/y/z set to 9999999.9. They are deliberately not set to 0 if unused, because 0/0/0 is a totally valid local geographic location.

                                                                                                                                                            diff --git a/docs/html/md_docs_Wake.html b/docs/html/md_docs_Wake.html index 88e63abb..ff740c92 100644 --- a/docs/html/md_docs_Wake.html +++ b/docs/html/md_docs_Wake.html @@ -44,15 +44,15 @@

                                                                                                                                                            X-Plane 12 started to support wake turbulence also for TCAS targets. While X-Plane provides a fixed default (of a comparibly small jet) in case no additional information is available, its true capacbilities only come to light when fed with details about the actual plane's dimensions and mass.

                                                                                                                                                            -

                                                                                                                                                            Keep in mind that XPMP2 does not build upon AI aircraft, so from X-Plane's point of view XPMP2's planes are just some random instanced objects. X-Plane does not actually place wakes behind instanced objects! Instead, X-Plane refers to the TCAS target information to calculate wakes. Some dataRefs have been added there for additional information to calculate matching wakes, specifically:

                                                                                                                                                              +

                                                                                                                                                              Keep in mind that XPMP2 does not build upon AI aircraft, so from X-Plane's point of view XPMP2's planes are just some random instanced objects. X-Plane does not actually place wakes behind instanced objects! Instead, X-Plane refers to the TCAS target information to calculate wakes. Some dataRefs have been added there for additional information to calculate matching wakes, specifically:

                                                                                                                                                              • Wing span and area
                                                                                                                                                              • Mass
                                                                                                                                                              • Lift
                                                                                                                                                              • Angle of Attack (AoA)
                                                                                                                                                              -

                                                                                                                                                              +

                                                                                                                                                              Defaults

                                                                                                                                                              -

                                                                                                                                                              As a trade-off between complexity (knowing exact wing dimensions and weight/lift of any plane) and results (strength of the wake) XPMP2 applies defaults to the aircraft dimensions based on the Wake Turbulence Category (WTC) listed in the Doc8643 data, which is looked up based on the icaoType. If the icaoType isn't found then a default WTC of M is assumed.

                                                                                                                                                              +

                                                                                                                                                              As a trade-off between complexity (knowing exact wing dimensions and weight/lift of any plane) and results (strength of the wake) XPMP2 applies defaults to the aircraft dimensions based on the Wake Turbulence Category (WTC) listed in the Doc8643 data, which is looked up based on the icaoType. If the icaoType isn't found then a default WTC of M is assumed.

                                                                                                                                                              So even if you don't provide any overrides in your plugin implementation, there's are reasonable factors in place to provide about matching wakes:

                                                                                                                                                              @@ -71,9 +71,9 @@

                                                                                                                                                              with Weight = Empty Weight + 80% * (MTOW - Empty Weight)

                                                                                                                                                              Default Lift is Weight multiplied by 9.81, ie. standard gravity. No g load is taken into account.

                                                                                                                                                              Default AoA is the plane's pitch, which should be fairly accurate.

                                                                                                                                                              -

                                                                                                                                                              +

                                                                                                                                                              Overriding Values in Your Plugin

                                                                                                                                                              -

                                                                                                                                                              A plugin using XPMP2 can opt to provide its own values for even more precice results. Search XPMP2Aircraft.h for "Wake support" to find the group of functions to support wake tubulence definition.

                                                                                                                                                              +

                                                                                                                                                              A plugin using XPMP2 can opt to provide its own values for even more precice results. Search XPMP2Aircraft.h for "Wake support" to find the group of functions to support wake tubulence definition.

                                                                                                                                                              WakeApplyDefaults() sets wing span, area, and weight as per above defaults.

                                                                                                                                                              The various Get/Set functions get/set wing span, area, weight individually.

                                                                                                                                                              As angle of attack and lift may change very dynamically they are implemented as virtual functions that you can override in your own aircraft class:

                                                                                                                                                              @@ -82,7 +82,7 @@

                                                                                                                                                            • virtual float GetLift() const

                                                                                                                                                              • There's one specific case a plugin may want to consider, which is the transition between ground and airborne operation: There is no wake behind a taxiing wake because there is no lift produced. Wake gradually appears during the take-off roll and fades during rollout after landing.

                                                                                                                                                              -

                                                                                                                                                              If you want to simulate this you should override XPMP2::Aircraft::GetLift(). See LiveTraffic's LTAircraft::GetLift() for an example in its LTAircraft.cpp file, which take information as input that XPMP2 doesn't have but only the plugin that controls the aircraft in motion.

                                                                                                                                                              +

                                                                                                                                                              If you want to simulate this you should override XPMP2::Aircraft::GetLift(). See LiveTraffic's LTAircraft::GetLift() for an example in its LTAircraft.cpp file, which take information as input that XPMP2 doesn't have but only the plugin that controls the aircraft in motion.

                                                                                                                                                              diff --git a/docs/html/md_docs_XSBAircraftFormat.html b/docs/html/md_docs_XSBAircraftFormat.html index 55b331c4..dc72b413 100644 --- a/docs/html/md_docs_XSBAircraftFormat.html +++ b/docs/html/md_docs_XSBAircraftFormat.html @@ -43,9 +43,9 @@
                                                                                                                                                              xsb_aircraft.txt File format
                                                                                                                                                              -

                                                                                                                                                              The xsb_aircraft.txt file describes the content of one CSL model package. XPMP2 reads the file to learn about available CSL models and which ICAO aircraft type designators, airlines, and special liveries they match.

                                                                                                                                                              -

                                                                                                                                                              The original file format supported more commands necessary to support older formats like .acf or OBJ7. XPMP2 only supported OBJ8 models and processes only the commands listed here. Others are ignored. They may raise warnings in Log.txt but otherwise do no harm.

                                                                                                                                                              -

                                                                                                                                                              +

                                                                                                                                                              The xsb_aircraft.txt file describes the content of one CSL model package. XPMP2 reads the file to learn about available CSL models and which ICAO aircraft type designators, airlines, and special liveries they match.

                                                                                                                                                              +

                                                                                                                                                              The original file format supported more commands necessary to support older formats like .acf or OBJ7. XPMP2 only supported OBJ8 models and processes only the commands listed here. Others are ignored. They may raise warnings in Log.txt but otherwise do no harm.

                                                                                                                                                              +

                                                                                                                                                              Example

                                                                                                                                                              The following is taken from the beginning of Bluebell's xsb_aircraft.txt file in its BB_Airbus folder:

                                                                                                                                                              EXPORT_NAME __Bluebell_Airbus
                                                                                                                                                              @@ -59,21 +59,21 @@

                                                                                                                                                              OBJ8 SOLID YES __Bluebell_Airbus/A306/A306_AHK.obj
                                                                                                                                                              VERT_OFFSET 4.6
                                                                                                                                                              AIRLINE A306 AHK
                                                                                                                                                              -

                                                                                                                                                              +

                                                                                                                                                              Structure

                                                                                                                                                              A xsb_aircraft.txt file starts defining one (or even more) package name(s) using the EXPORT_NAME command. Packages are identified by these names, which are then used as a root name to define the .obj file locations.

                                                                                                                                                              -

                                                                                                                                                              Then follow one or typically many aircraft definitions. Each aircraft definition starts with an OBJ8_AIRCRAFT command defining a package-unique id. XPMP2 expects the combination of EXPORT_NAME and OBJ8_AIRCRAFT name to be unique and ignores any duplicates (with a warning written to Log.txt).

                                                                                                                                                              +

                                                                                                                                                              Then follow one or typically many aircraft definitions. Each aircraft definition starts with an OBJ8_AIRCRAFT command defining a package-unique id. XPMP2 expects the combination of EXPORT_NAME and OBJ8_AIRCRAFT name to be unique and ignores any duplicates (with a warning written to Log.txt).

                                                                                                                                                              Each aircraft definition then includes:

                                                                                                                                                              • One or more OBJ8 commands to defines which .obj file(s) to load for the CSL model. The OBJ8 file format is defined by Laminar.
                                                                                                                                                                • -
                                                                                                                                                              • Optionally one VERT_OFFSET command to define the vertical offset that needs to be applied to make the model sitting right on its wheel when placed on solid ground. If missing, then XPMP2 will read the .obj and find the lowest feature of the model and use this as reference.
                                                                                                                                                                • -
                                                                                                                                                              • One or more matching definitions using any of the commands ICAO, AIRLINE, LIVERY, or MATCHES. With XPMP2, all four commands are synonyms and handle 1 to 3 parameters:
                                                                                                                                                                  +
                                                                                                                                                                • Optionally one VERT_OFFSET command to define the vertical offset that needs to be applied to make the model sitting right on its wheel when placed on solid ground. If missing, then XPMP2 will read the .obj and find the lowest feature of the model and use this as reference.
                                                                                                                                                                  • +
                                                                                                                                                                • One or more matching definitions using any of the commands ICAO, AIRLINE, LIVERY, or MATCHES. With XPMP2, all four commands are synonyms and handle 1 to 3 parameters:
                                                                                                                                                                  • ICAO aircraft type designator
                                                                                                                                                                  • ICAO airline operator code
                                                                                                                                                                  • special livery text
                                                                                                                                                                -

                                                                                                                                                                +

                                                                                                                                                                Commands

                                                                                                                                                                EXPORT_NAME

                                                                                                                                                                EXPORT_NAME <package_name>
                                                                                                                                                                @@ -84,7 +84,7 @@

                                                                                                                                                                EXPORT_NAME

                                                                                                                                                                OBJ8_AIRCRAFT

                                                                                                                                                                OBJ8_AIRCRAFT <model_id>

                                                                                                                                                                Starts the definition of a CSL model.

                                                                                                                                                                -

                                                                                                                                                                XPMP2 uses the <package_name> plus the <model_id> to uniquely refer to a specific CSL model. This combination must be unique.

                                                                                                                                                                +

                                                                                                                                                                XPMP2 uses the <package_name> plus the <model_id> to uniquely refer to a specific CSL model. This combination must be unique.

                                                                                                                                                                Everything after the OBJ8_AIRCRAFT command until the end of the line is considered the <model_id>.

                                                                                                                                                                OBJ8

                                                                                                                                                                OBJ8 SOLID YES <package_name>[/<relativePathTo>]/<file.obj> [<texture.ext> [<texture_lit.ext>]]
                                                                                                                                                                @@ -94,22 +94,22 @@

                                                                                                                                                                OBJ8

                                                                                                                                                              • If a <relativePathTo> is given it needs to start in the same directory where the <package_name>'s xsb_aircraft.txt file is located;
                                                                                                                                                              • if no <relativePathTo> is given then the <file.obj> is expected to be in the same directory as the <package_name>'s xsb_aircraft.txt file.
                                                                                                                                                              -

                                                                                                                                                              Historically, other parameters than SOLID YES were supported, but the distinction is no longer needed. In fact, XPMP2 just ignores the 2nd and 3rd parameter altogether.

                                                                                                                                                              -

                                                                                                                                                              The 4th and 5th parameters are optional. They define a different texture (livery) to use than originally specified in <file.obj>. To be able to use this differing texture, XPMP2 creates a copy of <file.obj>, namely <file>.<texture>.xpmp2.obj, in which the object's TEXTURE resp. TEXTURE_LIT commands refer to <texture.ext> resp. <texture_lit.ext>. See here for details on copying .obj files.

                                                                                                                                                              +

                                                                                                                                                              Historically, other parameters than SOLID YES were supported, but the distinction is no longer needed. In fact, XPMP2 just ignores the 2nd and 3rd parameter altogether.

                                                                                                                                                              +

                                                                                                                                                              The 4th and 5th parameters are optional. They define a different texture (livery) to use than originally specified in <file.obj>. To be able to use this differing texture, XPMP2 creates a copy of <file.obj>, namely <file>.<texture>.xpmp2.obj, in which the object's TEXTURE resp. TEXTURE_LIT commands refer to <texture.ext> resp. <texture_lit.ext>. See here for details on copying .obj files.

                                                                                                                                                              VERT_OFFSET

                                                                                                                                                              VERT_OFFSET <float_num>

                                                                                                                                                              Defines the vertical offset for correct placement of the model on the ground with gears down.

                                                                                                                                                              -

                                                                                                                                                              If the VERT_OFFSET command is missing, then XPMP2 will read the .obj file(s) searching for the lowest feature defined in it and will use that point as the reference for the vertical offset.

                                                                                                                                                              +

                                                                                                                                                              If the VERT_OFFSET command is missing, then XPMP2 will read the .obj file(s) searching for the lowest feature defined in it and will use that point as the reference for the vertical offset.

                                                                                                                                                              OFFSET

                                                                                                                                                              OFFSET <unknown> <unknown> <vertical_offset>

                                                                                                                                                              The OFFSET command appears in PilotEdge packages. The meaning of the first two parameters remains a mystery.

                                                                                                                                                              The 3rd parameter has the same meaning as VERT_OFFSET, see above.

                                                                                                                                                              MATCHES (ICAO, AIRLINE, LIVERY)

                                                                                                                                                              MATCHES <acType> [<operator> [<livery]]
                                                                                                                                                              -

                                                                                                                                                              The 3 commands ICAO, AIRLINE, LIVERY are synonyms for MATCHES, provided for backward compatibility. In XPMP2, all four commands share the same syntax and semantic.

                                                                                                                                                              -

                                                                                                                                                              Defines matching parameters for XPMP2 matching algorithm.

                                                                                                                                                              +

                                                                                                                                                              The 3 commands ICAO, AIRLINE, LIVERY are synonyms for MATCHES, provided for backward compatibility. In XPMP2, all four commands share the same syntax and semantic.

                                                                                                                                                              +

                                                                                                                                                              Defines matching parameters for XPMP2 matching algorithm.

                                                                                                                                                                -
                                                                                                                                                              • <acType> (mandatory) defines the aircraft type, typically given as ICAO aircraft type designator. It is not mandatory to be an ICAO designator, but many plugins using XPMP2 will expect it to be one. Notable exceptions are ground vehicles, which are not defined by ICAO. "ZZZC" is an often used <acType> code for ground vehicles.
                                                                                                                                                                • +
                                                                                                                                                              • <acType> (mandatory) defines the aircraft type, typically given as ICAO aircraft type designator. It is not mandatory to be an ICAO designator, but many plugins using XPMP2 will expect it to be one. Notable exceptions are ground vehicles, which are not defined by ICAO. "ZZZC" is an often used <acType> code for ground vehicles.

                                                                                                                                                              • <operator> (optional) defines the aircraft's operator, often an airline. Different operators will fly different liveries, which in turn are defined as textures in the referenced .obj file (see its TEXTURE command). Most plugins will expect this <operator> code to be one of the ICAO-defined operator codes.

                                                                                                                                                                You can use a single dash - if you don't want to define an operator, but need to place a value to be able to define a livery with the 3rd parameter:

                                                                                                                                                                • diff --git a/docs/html/md_docs_index.html b/docs/html/md_docs_index.html index a48ad5fc..17197a3d 100644 --- a/docs/html/md_docs_index.html +++ b/docs/html/md_docs_index.html @@ -40,24 +40,25 @@
                                                                                                                                                              -
                                                                                                                                                              XPMP2 - Developer's documentation
                                                                                                                                                              +
                                                                                                                                                              XPMP2 - Developer's documentation
                                                                                                                                                              -

                                                                                                                                                              These pages, available as GitHub pages, document both usage and internals of the XPMP2 library.

                                                                                                                                                              +

                                                                                                                                                              These pages, available as GitHub pages, document both usage and internals of the XPMP2 library.

                                                                                                                                                              Content and availability status:

                                                                                                                                                              -

                                                                                                                                                              +

                                                                                                                                                              Requirements

                                                                                                                                                                -
                                                                                                                                                              • XPMP2 implements instancing, so it requires X-Plane 11.10 or later
                                                                                                                                                                • +
                                                                                                                                                              • XPMP2 implements instancing, so it requires X-Plane 11.10 or later
                                                                                                                                                              • CSL models in OBJ8 format (ie. older OBJ7 models are no longer supported)
                                                                                                                                                                • -
                                                                                                                                                              -

                                                                                                                                                              -Feature Details

                                                                                                                                                              -

                                                                                                                                                              Coding, Building, Deployment

                                                                                                                                                              -

                                                                                                                                                              These aspects are relevant for developers using XPMP2 in their own plugin:

                                                                                                                                                              -

                                                                                                                                                              Building XPMP2

                                                                                                                                                              +

                                                                                                                                                              These aspects are relevant for developers using XPMP2 in their own plugin:

                                                                                                                                                              +

                                                                                                                                                              Building XPMP2

                                                                                                                                                              XCode projects, Visual Studio solutions, and a Docker environment for Linux and Mac OS builds are provided. The details are documented here.

                                                                                                                                                              -

                                                                                                                                                              How to Use XPMP2

                                                                                                                                                              +

                                                                                                                                                              How to Use XPMP2

                                                                                                                                                              This part will probably need more attention, but find some first information here and study the working sample plugin in the XPMP2-Sample folder.

                                                                                                                                                              API and Code Documentation

                                                                                                                                                              All header (and code) files are documented using Doxygen-style comments. The generated doxygen files are checked in, too, so that the are available online:

                                                                                                                                                              @@ -98,7 +94,7 @@

                                                                                                                                                              API and Code Documentation

                                                                                                                                                            • XPMPAircraft.h - Defines the main class XPMP2::Aircraft, which represents an aircraft. Subclass this class in your plugin!

                                                                                                                                                              • Backward Compatibility

                                                                                                                                                              -

                                                                                                                                                              If you are familiar with the original libxplanemp and are using it already in your plugins, then you will find these information on backward compatibility useful, which explain how you can replace libxplanemp with XPMP2 with limited effort.

                                                                                                                                                              +

                                                                                                                                                              If you are familiar with the original libxplanemp and are using it already in your plugins, then you will find these information on backward compatibility useful, which explain how you can replace libxplanemp with XPMP2 with limited effort.

                                                                                                                                                              Deploying Your Plugin

                                                                                                                                                              Apart from the binaries that you build you will need to ship the files provided here in the 'Resources' folder. Also, users will need to install CSL models. Find more details here.

                                                                                                                                                              @@ -107,13 +103,16 @@

                                                                                                                                                              xsb_aircraft.txt File Format

                                                                                                                                                              The xsb_aircraft.txt file defines the content of one CSL model packages. It´s format is define here.

                                                                                                                                                              dataRefs available to CSL Models

                                                                                                                                                              -

                                                                                                                                                              To drive CSL models' ANIMations, a long list of dataRefs is provided by XPMP2. See its documentation here.

                                                                                                                                                              +

                                                                                                                                                              To drive CSL models' ANIMations, a long list of dataRefs is provided by XPMP2. See its documentation here.

                                                                                                                                                              Copying .obj files on load

                                                                                                                                                              -

                                                                                                                                                              CSL packages come in different flavours. Popular ones for general use are the Bluebell and the X-CSL packages. Both come with different history. For XPMP2 to use all their features it needs to change their .obj files. Performing these changes is built into XPMP2. See here for details.

                                                                                                                                                              +

                                                                                                                                                              CSL packages come in different flavours. Popular ones for general use are the Bluebell and the X-CSL packages. Both come with different history. For XPMP2 to use all their features it needs to change their .obj files. Performing these changes is built into XPMP2. See here for details.

                                                                                                                                                              Links to outside locations

                                                                                                                                                              -

                                                                                                                                                              TCAS Override approach explains how TCAS information is provided, the classic multiplayer dataRefs are maintained and how 3rd party plugins can access this information. XPMP2 publishes data via the sim/cockpit2/tcas/targets dataRefs.

                                                                                                                                                              -

                                                                                                                                                              Original libxplanemp:

                                                                                                                                                              +

                                                                                                                                                              TCAS Override

                                                                                                                                                              +

                                                                                                                                                              The TCAS Override approach explains how TCAS information is provided, the classic multiplayer dataRefs are maintained and how 3rd party plugins can access this information. XPMP2 publishes data via the sim/cockpit2/tcas/targets dataRefs.

                                                                                                                                                              +

                                                                                                                                                              Wake Turbulence

                                                                                                                                                              +

                                                                                                                                                              X-Plane's approach to Wake Turbulence support for TCAS targets is described in this blog post featuring LiveTraffic screenshots and this article on the dataRef details.

                                                                                                                                                              +

                                                                                                                                                              Original libxplanemp

                                                                                                                                                              • TwinFan's libxplanemp fork on GitHub
                                                                                                                                                                • wiki explaining differences to the kuroneko fork
                                                                                                                                                                  • diff --git a/docs/html/menudata.js b/docs/html/menudata.js index d9f5f0f1..3456cd02 100644 --- a/docs/html/menudata.js +++ b/docs/html/menudata.js @@ -37,6 +37,7 @@ var menudata={children:[ {text:"g",url:"namespacemembers_g.html#index_g"}, {text:"h",url:"namespacemembers_h.html#index_h"}, {text:"i",url:"namespacemembers_i.html#index_i"}, +{text:"k",url:"namespacemembers_k.html#index_k"}, {text:"l",url:"namespacemembers_l.html#index_l"}, {text:"m",url:"namespacemembers_m.html#index_m"}, {text:"n",url:"namespacemembers_n.html#index_n"}, @@ -46,6 +47,7 @@ var menudata={children:[ {text:"r",url:"namespacemembers_r.html#index_r"}, {text:"s",url:"namespacemembers_s.html#index_s"}, {text:"t",url:"namespacemembers_t.html#index_t"}, +{text:"u",url:"namespacemembers_u.html#index_u"}, {text:"v",url:"namespacemembers_v.html#index_v"}, {text:"x",url:"namespacemembers_x.html#index_x"}]}, {text:"Functions",url:"namespacemembers_func.html",children:[ @@ -65,6 +67,7 @@ var menudata={children:[ {text:"r",url:"namespacemembers_func.html#index_r"}, {text:"s",url:"namespacemembers_func.html#index_s"}, {text:"t",url:"namespacemembers_func.html#index_t"}, +{text:"u",url:"namespacemembers_func.html#index_u"}, {text:"x",url:"namespacemembers_func.html#index_x"}]}, {text:"Variables",url:"namespacemembers_vars.html",children:[ {text:"a",url:"namespacemembers_vars.html#index_a"}, @@ -73,6 +76,7 @@ var menudata={children:[ {text:"f",url:"namespacemembers_vars.html#index_f"}, {text:"g",url:"namespacemembers_vars.html#index_g"}, {text:"i",url:"namespacemembers_vars.html#index_i"}, +{text:"k",url:"namespacemembers_vars.html#index_k"}, {text:"l",url:"namespacemembers_vars.html#index_l"}, {text:"m",url:"namespacemembers_vars.html#index_m"}, {text:"p",url:"namespacemembers_vars.html#index_p"}, @@ -217,6 +221,7 @@ var menudata={children:[ {text:"Enumerations",url:"globals_enum.html"}, {text:"Enumerator",url:"globals_eval.html"}, {text:"Macros",url:"globals_defs.html",children:[ +{text:"a",url:"globals_defs.html#index_a"}, {text:"c",url:"globals_defs.html#index_c"}, {text:"d",url:"globals_defs.html#index_d"}, {text:"e",url:"globals_defs.html#index_e"}, diff --git a/docs/html/namespaceFMODLogo.html b/docs/html/namespaceFMODLogo.html new file mode 100644 index 00000000..f076afe8 --- /dev/null +++ b/docs/html/namespaceFMODLogo.html @@ -0,0 +1,256 @@ + + + + + + + +XPMP2: FMODLogo Namespace Reference + + + + + + +
                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                              + + + + + +
                                                                                                                                                              +
                                                                                                                                                              XPMP2 +
                                                                                                                                                              +
                                                                                                                                                              X-Plane multiplayer library 2 - using instancing
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                            + + + + + + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +Functions | +Variables
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            FMODLogo Namespace Reference
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + + +

                                                                                                                                                            +Functions

                                                                                                                                                            uint8_t * LoadRGBA (bool bBlack=true)
                                                                                                                                                             Load the data of the FMOD logo, expanded into RGBA data. More...
                                                                                                                                                             
                                                                                                                                                            bool GetTexture (int &texId, bool bBlack=true)
                                                                                                                                                             The one "public" function to return a texture id for the logo. More...
                                                                                                                                                             
                                                                                                                                                            + + + + + + + + + + + + + + + + +

                                                                                                                                                            +Variables

                                                                                                                                                            constexpr size_t RLE_SIZE = 5527
                                                                                                                                                             number of array entries in the RLE array More...
                                                                                                                                                             
                                                                                                                                                            const uint16_t ALPHA_RLE [RLE_SIZE]
                                                                                                                                                             Run-length encoded data of the Alpha value of each pixel in the FMOD logo. More...
                                                                                                                                                             
                                                                                                                                                            constexpr int IMG_WIDTH = 728
                                                                                                                                                             Logo image width. More...
                                                                                                                                                             
                                                                                                                                                            constexpr int IMG_HEIGHT = 192
                                                                                                                                                             Logo image height. More...
                                                                                                                                                             
                                                                                                                                                            constexpr int IMG_SIZE = IMG_WIDTH * IMG_HEIGHT
                                                                                                                                                             Logo image size in number of pixels. More...
                                                                                                                                                             
                                                                                                                                                            +

                                                                                                                                                            Function Documentation

                                                                                                                                                            + +

                                                                                                                                                            ◆ GetTexture()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + + + + + + + + + + + + +
                                                                                                                                                            bool FMODLogo::GetTexture (int & texId,
                                                                                                                                                            bool bBlack = true 
                                                                                                                                                            )
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            The one "public" function to return a texture id for the logo.

                                                                                                                                                            +

                                                                                                                                                            On first call will load the logo and create a texture from it, on subsequent calls will return the already loaded id.

                                                                                                                                                            Parameters
                                                                                                                                                            + + + +
                                                                                                                                                            [out]texIdreceives the texture id for the (black or white) FMOD logo
                                                                                                                                                            bBlack[opt] Black or White logo? (Will return different texture ids)
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Returns
                                                                                                                                                            true if successful
                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ LoadRGBA()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + + +
                                                                                                                                                            uint8_t * FMODLogo::LoadRGBA (bool bBlack = true)
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Load the data of the FMOD logo, expanded into RGBA data.

                                                                                                                                                            +

                                                                                                                                                            This function is internally used by GetTexture(). It is not typically used publicly but provided just in case what you need is not an OpenGL texture but the raw RGBA data. Data is provided in 4-byte blocks, one byte per RGBA value. The returned array has size IMG_SIZE * 4. Caller has to free the data using delete[].

                                                                                                                                                            Returns
                                                                                                                                                            pointer to raw RGBA data, 4 bytes per pixel.
                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Variable Documentation

                                                                                                                                                            + +

                                                                                                                                                            ◆ ALPHA_RLE

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + +
                                                                                                                                                            const uint16_t FMODLogo::ALPHA_RLE[RLE_SIZE]
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Run-length encoded data of the Alpha value of each pixel in the FMOD logo.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ IMG_HEIGHT

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + +
                                                                                                                                                            constexpr int FMODLogo::IMG_HEIGHT = 192
                                                                                                                                                            +                                                                                                                                                             		+constexpr
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Logo image height.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ IMG_SIZE

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + +
                                                                                                                                                            constexpr int FMODLogo::IMG_SIZE = IMG_WIDTH * IMG_HEIGHT
                                                                                                                                                            +                                                                                                                                                             		+constexpr
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Logo image size in number of pixels.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ IMG_WIDTH

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + +
                                                                                                                                                            constexpr int FMODLogo::IMG_WIDTH = 728
                                                                                                                                                            +                                                                                                                                                             		+constexpr
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Logo image width.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ RLE_SIZE

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + +
                                                                                                                                                            constexpr size_t FMODLogo::RLE_SIZE = 5527
                                                                                                                                                            +                                                                                                                                                             		+constexpr
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            number of array entries in the RLE array

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + +
                                                                                                                                                            +Generated by doxygen 1.9.1 +
                                                                                                                                                            + + diff --git a/docs/html/namespaceXPMP2.html b/docs/html/namespaceXPMP2.html index dec23fef..b570fee1 100644 --- a/docs/html/namespaceXPMP2.html +++ b/docs/html/namespaceXPMP2.html @@ -49,6 +49,9 @@
                                                                                                                                                            XPMP2 Namespace Reference
                                                                                                                                                            + +

                                                                                                                                                            Defined by FMOD. +More...

                                                                                                                                                            @@ -56,10 +59,10 @@ - + - + @@ -163,6 +166,18 @@ + + + + + + + + + + + + @@ -235,6 +250,9 @@ + + +

                                                                                                                                                            Classes

                                                                                                                                                             Collates some information on the CSL model. More...
                                                                                                                                                             
                                                                                                                                                            class  Aircraft
                                                                                                                                                             Actual representation of all aircraft in XPMP2. More...
                                                                                                                                                             Actual representation of all aircraft in XPMP2. More...
                                                                                                                                                             
                                                                                                                                                            class  XPMP2Error
                                                                                                                                                             XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft. More...
                                                                                                                                                             XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an Aircraft. More...
                                                                                                                                                             
                                                                                                                                                            struct  RemoteDataRefPackTy
                                                                                                                                                             Definition for how to map dataRef values to (u)int8, ie. to an integer range of 8 bits. More...
                                                                                                                                                            class  RmtMsgBufTy
                                                                                                                                                             Helper class to manage the temporary buffers in which the network message are put together. More...
                                                                                                                                                             
                                                                                                                                                            struct  FMOD_10830_ADVANCEDSETTINGS
                                                                                                                                                             FMOD 1.08.30 version of FMOD_ADVANCEDSETTINGS. More...
                                                                                                                                                             
                                                                                                                                                            struct  SoundDefTy
                                                                                                                                                             Definition of how sound is handled based on dataRef values (type) More...
                                                                                                                                                             
                                                                                                                                                            class  FmodError
                                                                                                                                                             Exception class to pass on error information. More...
                                                                                                                                                             
                                                                                                                                                            class  SoundFile
                                                                                                                                                             Represents a sound file. More...
                                                                                                                                                             
                                                                                                                                                            struct  XPMPPlaneNotifierTy
                                                                                                                                                             Stores the function and refcon pointer for plane creation/destrcution notifications. More...
                                                                                                                                                             
                                                                                                                                                            typedef std::unique_ptr< RmtDataAcAnimTy > ptrRmtDataAcAnimTy
                                                                                                                                                             Smart pointer to XPMP2::RmtDataAcAnimTy. More...
                                                                                                                                                             
                                                                                                                                                            typedef std::map< std::string, SoundFile > mapSoundTy
                                                                                                                                                             Map of all sounds, indexed by a sound name (type) More...
                                                                                                                                                             
                                                                                                                                                            typedef std::list< XPMPPlaneNotifierTy > listXPMPPlaneNotifierTy
                                                                                                                                                             
                                                                                                                                                            @@ -296,7 +314,7 @@ , V_COUNT
                                                                                                                                                            } - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -673,6 +728,12 @@ + + + + + + @@ -693,6 +754,9 @@ + + + @@ -738,7 +802,7 @@ - + @@ -746,11 +810,14 @@ + + + - + @@ -936,6 +1003,18 @@ + + + + + + + + + + + + @@ -953,10 +1032,12 @@ - +
                                                                                                                                                             The dataRefs provided by XPMP2 to the CSL models. More...
                                                                                                                                                             The dataRefs provided by XPMP2 to the CSL models. More...
                                                                                                                                                             
                                                                                                                                                            enum  RemoteMsgTy : std::uint8_t {
                                                                                                                                                              RMT_MSG_INTEREST_BEACON = 0 @@ -625,6 +643,43 @@
                                                                                                                                                            void RemoteAcClearAll ()
                                                                                                                                                             Informs us that there are no more aircraft, clear our caches! More...
                                                                                                                                                             
                                                                                                                                                            FMOD_VECTOR HeadPitch2Vec (const float head, const float pitch)
                                                                                                                                                             Convert heading/pitch to normalized x/y/z vector. More...
                                                                                                                                                             
                                                                                                                                                            bool UseOldFmod ()
                                                                                                                                                             Use pre-v2 FMOD version structures? More...
                                                                                                                                                             
                                                                                                                                                            FMOD_RESULT F_CALLBACK SoundLogCB (FMOD_DEBUG_FLAGS flags, const char *file, int line, const char *func, const char *message)
                                                                                                                                                             Callback function called by FMOD for logging purposes. More...
                                                                                                                                                             
                                                                                                                                                            void SoundLogEnable (bool bEnable=true)
                                                                                                                                                             Enables/disables FMOD logging. More...
                                                                                                                                                             
                                                                                                                                                            FMOD_CHANNELGROUP * SoundGetMasterChn ()
                                                                                                                                                             Get the FMOD system's master channel group, or nullptr More...
                                                                                                                                                             
                                                                                                                                                            SoundFile * SoundGetSoundFile (FMOD_CHANNEL *pChn)
                                                                                                                                                             Get pointer to Sound File that created the channel. More...
                                                                                                                                                             
                                                                                                                                                            bool SoundIsChnValid (FMOD_CHANNEL *pChn)
                                                                                                                                                             Is the channel still payling / is it valid? More...
                                                                                                                                                             
                                                                                                                                                            template<class T_ADVSET >
                                                                                                                                                            void SoundSetFmodSettings (T_ADVSET &advSet)
                                                                                                                                                             Helper functon to set FMOD settings. More...
                                                                                                                                                             
                                                                                                                                                            const char * SoundEventTxt (Aircraft::SoundEventsTy e)
                                                                                                                                                             Return a text for the values of Aircraft::SoundEventsTy. More...
                                                                                                                                                             
                                                                                                                                                            bool SoundInit ()
                                                                                                                                                             Initialize the sound module and load the sounds. More...
                                                                                                                                                             
                                                                                                                                                            void SoundUpdatesDone ()
                                                                                                                                                             Tell FMOD that all updates are done. More...
                                                                                                                                                             
                                                                                                                                                            void SoundCleanup ()
                                                                                                                                                             Graceful shoutdown. More...
                                                                                                                                                             
                                                                                                                                                            int PrefsFuncIntDefault (const char *, const char *, int _default)
                                                                                                                                                             Default config function just always returns the provided default value. More...
                                                                                                                                                             
                                                                                                                                                            const char * GetGraphicsDriverTxt ()
                                                                                                                                                             Text string for current graphics driver in use. More...
                                                                                                                                                             
                                                                                                                                                            bool IsPaused ()
                                                                                                                                                             X-Plane in a Pause state? More...
                                                                                                                                                             
                                                                                                                                                            bool IsViewExternal ()
                                                                                                                                                             Is current X-Plane view an external view (outside a cockpit)? More...
                                                                                                                                                             
                                                                                                                                                            bool CheckEverySoOften (float &_lastCheck, float _interval, float _now)
                                                                                                                                                             Convenience function to check on something at most every x seconds. More...
                                                                                                                                                             
                                                                                                                                                            std::string & trim (std::string &s, const char *t=WHITESPACE)
                                                                                                                                                             trimming of string (from both ends) More...
                                                                                                                                                             
                                                                                                                                                            std::string leftOf (const std::string &s, const std::string &terminators)
                                                                                                                                                             Returns everything left of any of terminators. More...
                                                                                                                                                             
                                                                                                                                                            template<class T >
                                                                                                                                                            T rad2deg (const T _rad)
                                                                                                                                                             Convert radians to degrees, normalized to [0..360) More...

                                                                                                                                                            Variables

                                                                                                                                                            constexpr float RPM_to_RADs = 0.10471975511966f
                                                                                                                                                             Convert revolutions-per-minute (RPM) to radians per second (rad/s) by multiplying with PI/30. More...
                                                                                                                                                             Defined by XPMP2 internally. More...
                                                                                                                                                             
                                                                                                                                                            constexpr double M_per_FT = 0.3048
                                                                                                                                                             Convert feet to meters, e.g. for altitude calculations. More...
                                                                                                                                                            constexpr int M_per_NM = 1852
                                                                                                                                                             Convert nautical miles to meters. More...
                                                                                                                                                             
                                                                                                                                                            constexpr double KT_per_M_per_S = 1.94384
                                                                                                                                                             Convert m/s to knots. More...
                                                                                                                                                             
                                                                                                                                                            constexpr float G_EARTH = 9.80665f
                                                                                                                                                             standard gravitational acceleration [m/s²] More...
                                                                                                                                                             
                                                                                                                                                            constexpr const char * REMOTE_SIGNATURE = "TwinFan.plugin.XPMP2.Remote"
                                                                                                                                                             The signature of the XPMP2 Remote Client. More...
                                                                                                                                                             The signature of the XPMP2 Remote Client. More...
                                                                                                                                                             
                                                                                                                                                            const std::array< RemoteDataRefPackTy, V_COUNT > REMOTE_DR_DEF
                                                                                                                                                             An array holding all dataRef packing definitions. More...
                                                                                                                                                            RemoteCBFctTy gRmtCBFcts
                                                                                                                                                             The callback function pointers the remote client plugin provided. More...
                                                                                                                                                             
                                                                                                                                                            constexpr int EXP_COMP_SKIP_CYCLES = 10
                                                                                                                                                             In how many cycles to skip expensive computations? More...
                                                                                                                                                             
                                                                                                                                                            constexpr int FMOD_NUM_VIRT_CHANNELS = 1000
                                                                                                                                                             Number of virtual channels during initialization. More...
                                                                                                                                                             
                                                                                                                                                            constexpr float FMOD_3D_MAX_DIST = 10000.0f
                                                                                                                                                             Value used for 3D max distance, which doesn't have much of a function for the inverse roll-off model used here. More...
                                                                                                                                                             
                                                                                                                                                            constexpr float FMOD_LOW_PASS_GAIN = 0.2f
                                                                                                                                                             Gain used when activating Low Pass filter. More...
                                                                                                                                                             
                                                                                                                                                            GlobVars glob
                                                                                                                                                             The one and only global variable structure. More...
                                                                                                                                                             
                                                                                                                                                             Pi. More...
                                                                                                                                                             
                                                                                                                                                            constexpr float XPMP2_VER = XPMP2_VER_MAJOR + float(XPMP2_VER_MINOR) / 100.0f
                                                                                                                                                             XPMP2 version number. More...
                                                                                                                                                             XPMP2 version number. More...
                                                                                                                                                             
                                                                                                                                                            -

                                                                                                                                                            Class Documentation

                                                                                                                                                            +

                                                                                                                                                            Detailed Description

                                                                                                                                                            +

                                                                                                                                                            Defined by FMOD.

                                                                                                                                                            +

                                                                                                                                                            Class Documentation

                                                                                                                                                            ◆ XPMP2::TcasLightsTy

                                                                                                                                                            @@ -985,6 +1066,186 @@

                                                                                                                                                            +

                                                                                                                                                            ◆ XPMP2::FMOD_10830_ADVANCEDSETTINGS

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + +
                                                                                                                                                            struct XPMP2::FMOD_10830_ADVANCEDSETTINGS
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            FMOD 1.08.30 version of FMOD_ADVANCEDSETTINGS.

                                                                                                                                                            +
                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                            Class Members
                                                                                                                                                            +char ** +ASIOChannelList +
                                                                                                                                                            +int +ASIONumChannels +
                                                                                                                                                            +FMOD_SPEAKER * +ASIOSpeakerList +
                                                                                                                                                            +int +cbSize +
                                                                                                                                                            +unsigned int +commandQueueSize +
                                                                                                                                                            +unsigned int +defaultDecodeBufferSize +
                                                                                                                                                            +float +distanceFilterCenterFreq +
                                                                                                                                                            +int +DSPBufferPoolSize +
                                                                                                                                                            +unsigned int +geometryMaxFadeTime +
                                                                                                                                                            +float +HRTFFreq +
                                                                                                                                                            +float +HRTFMaxAngle +
                                                                                                                                                            +float +HRTFMinAngle +
                                                                                                                                                            +int +maxADPCMCodecs +
                                                                                                                                                            +int +maxAT9Codecs +
                                                                                                                                                            +int +maxFADPCMCodecs +
                                                                                                                                                            +int +maxMPEGCodecs +
                                                                                                                                                            +int +maxPCMCodecs +
                                                                                                                                                            +int +maxVorbisCodecs +
                                                                                                                                                            +int +maxXMACodecs +
                                                                                                                                                            +unsigned short +profilePort +
                                                                                                                                                            +unsigned int +randomSeed +
                                                                                                                                                            +FMOD_DSP_RESAMPLER +resamplerMethod +
                                                                                                                                                            +int +reverb3Dinstance +
                                                                                                                                                            +unsigned int +stackSizeMixer +
                                                                                                                                                            +unsigned int +stackSizeNonBlocking +
                                                                                                                                                            +unsigned int +stackSizeStream +
                                                                                                                                                            +float +vol0virtualvol +
                                                                                                                                                            +
                                                                                                                                                            @@ -1190,6 +1451,22 @@

                                                                                                                                                            +

                                                                                                                                                            ◆ mapSoundTy

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + +
                                                                                                                                                            typedef std::map<std::string,SoundFile> XPMP2::mapSoundTy
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Map of all sounds, indexed by a sound name (type)

                                                                                                                                                            +
                                                                                                                                                            @@ -1377,7 +1654,7 @@

                                                                                                                                                            -

                                                                                                                                                            The dataRefs provided by XPMP2 to the CSL models.

                                                                                                                                                            +

                                                                                                                                                            The dataRefs provided by XPMP2 to the CSL models.

                                                                                                                                                            -
                                                                                                                                                            Enumerator
                                                                                                                                                            V_CONTROLS_GEAR_RATIO 

                                                                                                                                                            libxplanemp/controls/gear_ratio and
                                                                                                                                                            sim/cockpit2/tcas/targets/position/gear_deploy

                                                                                                                                                            @@ -1477,7 +1754,7 @@

                                                                                                                                                            V_MISC_TOUCH_DOWN 

                                                                                                                                                            libxplanemp/misc/touch_down

                                                                                                                                                            V_COUNT 

                                                                                                                                                            always last, number of dataRefs XPMP2 pre-defines

                                                                                                                                                            +
                                                                                                                                                            V_COUNT 

                                                                                                                                                            always last, number of dataRefs XPMP2 pre-defines

                                                                                                                                                            @@ -3460,6 +3737,37 @@

                                                                                                                                                            +

                                                                                                                                                            ◆ HeadPitch2Vec()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + + + + + + + + + + + + +
                                                                                                                                                            FMOD_VECTOR XPMP2::HeadPitch2Vec (const float head,
                                                                                                                                                            const float pitch 
                                                                                                                                                            )
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Convert heading/pitch to normalized x/y/z vector.

                                                                                                                                                            +
                                                                                                                                                            Note
                                                                                                                                                            Given all the trigonometric functions this is probably expensive, so use with care and avoid in flight loop callback when unnecessary.
                                                                                                                                                            +
                                                                                                                                                            @@ -3516,6 +3824,44 @@

                                                                                                                                                            +

                                                                                                                                                            ◆ IsPaused()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + +
                                                                                                                                                            bool XPMP2::IsPaused ()
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            X-Plane in a Pause state?

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ IsViewExternal()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + +
                                                                                                                                                            bool XPMP2::IsViewExternal ()
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Is current X-Plane view an external view (outside a cockpit)?

                                                                                                                                                            +
                                                                                                                                                            @@ -3548,6 +3894,44 @@

                                                                                                                                                            +

                                                                                                                                                            ◆ leftOf()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + + + + + + + + + + + + + + + +
                                                                                                                                                            std::string XPMP2::leftOf (const std::string & s,
                                                                                                                                                            const std::string & terminators 
                                                                                                                                                            )
                                                                                                                                                            +                                                                                                                                                             		+inline
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Returns everything left of any of terminators.

                                                                                                                                                            +
                                                                                                                                                            @@ -4776,58 +5160,287 @@

                                                                                                                                                            -

                                                                                                                                                            ◆ sqr()

                                                                                                                                                            + +

                                                                                                                                                            ◆ SoundCleanup()

                                                                                                                                                            -
                                                                                                                                                            -template<class T >
                                                                                                                                                            - - - - - -
                                                                                                                                                            - + - - +
                                                                                                                                                            T XPMP2::sqr void XPMP2::SoundCleanup (const T a))
                                                                                                                                                            -                                                                                                                                                             		-inline
                                                                                                                                                            -

                                                                                                                                                            Square.

                                                                                                                                                            +

                                                                                                                                                            Graceful shoutdown.

                                                                                                                                                            - -

                                                                                                                                                            ◆ str_tokenize()

                                                                                                                                                            + +

                                                                                                                                                            ◆ SoundEventTxt()

                                                                                                                                                            - + - - - - - + + - - - - - - +
                                                                                                                                                            std::vector< std::string > XPMP2::str_tokenize const char* XPMP2::SoundEventTxt (const std::string s,
                                                                                                                                                            Aircraft::SoundEventsTy e) const std::string tokens,
                                                                                                                                                            bool 
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Return a text for the values of Aircraft::SoundEventsTy.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ SoundGetMasterChn()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + +
                                                                                                                                                            FMOD_CHANNELGROUP* XPMP2::SoundGetMasterChn ()
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Get the FMOD system's master channel group, or nullptr

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ SoundGetSoundFile()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + + +
                                                                                                                                                            SoundFile* XPMP2::SoundGetSoundFile (FMOD_CHANNEL * pChn)
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Get pointer to Sound File that created the channel.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ SoundInit()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + +
                                                                                                                                                            bool XPMP2::SoundInit ()
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Initialize the sound module and load the sounds.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ SoundIsChnValid()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + + +
                                                                                                                                                            bool XPMP2::SoundIsChnValid (FMOD_CHANNEL * pChn)
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Is the channel still payling / is it valid?

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ SoundLogCB()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                            FMOD_RESULT F_CALLBACK XPMP2::SoundLogCB (FMOD_DEBUG_FLAGS flags,
                                                                                                                                                            const char * file,
                                                                                                                                                            int line,
                                                                                                                                                            const char * func,
                                                                                                                                                            const char * message 
                                                                                                                                                            )
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Callback function called by FMOD for logging purposes.

                                                                                                                                                            +
                                                                                                                                                            Note
                                                                                                                                                            FMOD warns this can be called from any thread, so strictly speaking we must not call XPLMDebugString(), but so far it didn't hurt, and it should be debug builds only anyway.
                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ SoundLogEnable()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + + +
                                                                                                                                                            void XPMP2::SoundLogEnable (bool bEnable = true)
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Enables/disables FMOD logging.

                                                                                                                                                            +
                                                                                                                                                            Note
                                                                                                                                                            FMOD Logging only works if linked to the L versions of the FMOD library
                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ SoundSetFmodSettings()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +template<class T_ADVSET >
                                                                                                                                                            + + + + + + + + +
                                                                                                                                                            void XPMP2::SoundSetFmodSettings (T_ADVSET & advSet)
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Helper functon to set FMOD settings.

                                                                                                                                                            +

                                                                                                                                                            Implement as template function so it works with both FMOD_ADVANCEDSETTINGS and FMOD_10830_ADVANCEDSETTINGS for backwards compatibility with v1.8 of FMOD as used in XP11.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ SoundUpdatesDone()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + +
                                                                                                                                                            void XPMP2::SoundUpdatesDone ()
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Tell FMOD that all updates are done.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ sqr()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +template<class T >
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + + + + + +
                                                                                                                                                            T XPMP2::sqr (const T a)
                                                                                                                                                            +                                                                                                                                                             		+inline
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Square.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ str_tokenize()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + + + + + + + + + + + + + @@ -5075,6 +5688,33 @@

                                                                                                                                                            +

                                                                                                                                                            ◆ UseOldFmod()

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            std::vector< std::string > XPMP2::str_tokenize (const std::string s,
                                                                                                                                                            const std::string tokens,
                                                                                                                                                            bool  bSkipEmpty 
                                                                                                                                                            + + + + +
                                                                                                                                                            + + + + + + + +
                                                                                                                                                            bool XPMP2::UseOldFmod ()
                                                                                                                                                            +                                                                                                                                                             		+inline
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Use pre-v2 FMOD version structures?

                                                                                                                                                            +
                                                                                                                                                            @@ -5281,6 +5921,30 @@

                                                                                                                                                            +

                                                                                                                                                            ◆ EXP_COMP_SKIP_CYCLES

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + +
                                                                                                                                                            constexpr int XPMP2::EXP_COMP_SKIP_CYCLES = 10
                                                                                                                                                            +                                                                                                                                                             		+constexpr
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            In how many cycles to skip expensive computations?

                                                                                                                                                            +
                                                                                                                                                            @@ -5321,6 +5985,78 @@

                                                                                                                                                            +

                                                                                                                                                            ◆ FMOD_3D_MAX_DIST

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + +
                                                                                                                                                            constexpr float XPMP2::FMOD_3D_MAX_DIST = 10000.0f
                                                                                                                                                            +                                                                                                                                                             		+constexpr
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Value used for 3D max distance, which doesn't have much of a function for the inverse roll-off model used here.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ FMOD_LOW_PASS_GAIN

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + +
                                                                                                                                                            constexpr float XPMP2::FMOD_LOW_PASS_GAIN = 0.2f
                                                                                                                                                            +                                                                                                                                                             		+constexpr
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Gain used when activating Low Pass filter.

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            ◆ FMOD_NUM_VIRT_CHANNELS

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + +
                                                                                                                                                            constexpr int XPMP2::FMOD_NUM_VIRT_CHANNELS = 1000
                                                                                                                                                            +                                                                                                                                                             		+constexpr
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Number of virtual channels during initialization.

                                                                                                                                                            +
                                                                                                                                                            @@ -5783,6 +6519,30 @@

                                                                                                                                                            +

                                                                                                                                                            + + +

                                                                                                                                                            ◆ KT_per_M_per_S

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + + +
                                                                                                                                                            + + + + +
                                                                                                                                                            constexpr double XPMP2::KT_per_M_per_S = 1.94384
                                                                                                                                                            +                                                                                                                                                             		+constexpr
                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            Convert m/s to knots.

                                                                                                                                                            +
                                                                                                                                                            @@ -6254,7 +7014,7 @@

                                                                                                                                                            -

                                                                                                                                                            The signature of the XPMP2 Remote Client.

                                                                                                                                                            +

                                                                                                                                                            The signature of the XPMP2 Remote Client.

                                                                                                                                                            @@ -6490,7 +7250,8 @@

                                                                                                                                                            -

                                                                                                                                                            Convert revolutions-per-minute (RPM) to radians per second (rad/s) by multiplying with PI/30.

                                                                                                                                                            +

                                                                                                                                                            Defined by XPMP2 internally.

                                                                                                                                                            +

                                                                                                                                                            Convert revolutions-per-minute (RPM) to radians per second (rad/s) by multiplying with PI/30

                                                                                                                                                            @@ -6690,7 +7451,7 @@

                                                                                                                                                            -

                                                                                                                                                            XPMP2 version number.

                                                                                                                                                            +

                                                                                                                                                            XPMP2 version number.

                                                                                                                                                            diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html index 0dd75c4f..dd1ba0c6 100644 --- a/docs/html/namespacemembers.html +++ b/docs/html/namespacemembers.html @@ -123,6 +123,9 @@

                                                                                                                                                            - a -

                                                                                                                                                            • ALL_MAPS : XPMP2
                                                                                                                                                              • +
                                                                                                                                                            • ALPHA_RLE +: FMODLogo +
                                                                                                                                                            • angleLocCoord() : XPMP2
                                                                                                                                                              • diff --git a/docs/html/namespacemembers_e.html b/docs/html/namespacemembers_e.html index bb7e6646..2f51459b 100644 --- a/docs/html/namespacemembers_e.html +++ b/docs/html/namespacemembers_e.html @@ -48,6 +48,9 @@

                                                                                                                                                              - e -

                                                                                                                                                              • ExistsFile() : XPMP2
                                                                                                                                                                • +
                                                                                                                                                              • EXP_COMP_SKIP_CYCLES +: XPMP2 +
                                                                                                                                                              diff --git a/docs/html/namespacemembers_f.html b/docs/html/namespacemembers_f.html index 6b0bd99f..41d80ea2 100644 --- a/docs/html/namespacemembers_f.html +++ b/docs/html/namespacemembers_f.html @@ -48,6 +48,15 @@

                                                                                                                                                              - f -

                                                                                                                                                              • FAR_AWAY_VAL_GL : XPMP2
                                                                                                                                                                • +
                                                                                                                                                              • FMOD_3D_MAX_DIST +: XPMP2 +
                                                                                                                                                                • +
                                                                                                                                                              • FMOD_LOW_PASS_GAIN +: XPMP2 +
                                                                                                                                                                • +
                                                                                                                                                              • FMOD_NUM_VIRT_CHANNELS +: XPMP2 +
                                                                                                                                                              • FROMPOSIX() : XPMP2
                                                                                                                                                                • diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html index 29a415d1..b0dce2bf 100644 --- a/docs/html/namespacemembers_func.html +++ b/docs/html/namespacemembers_func.html @@ -227,6 +227,9 @@

                                                                                                                                                                - g -

                                                                                                                                                                • GetMiscNetwTimeStr() : XPMP2
                                                                                                                                                                  • +
                                                                                                                                                                • GetTexture() +: FMODLogo +
                                                                                                                                                                • GetXPSystemPath() : XPMP2
                                                                                                                                                                  • @@ -249,6 +252,9 @@

                                                                                                                                                                  - h -

                                                                                                                                                                  • headNormalize() : XPMP2
                                                                                                                                                                    • +
                                                                                                                                                                  • HeadPitch2Vec() +: XPMP2 +
                                                                                                                                                                  @@ -259,6 +265,12 @@

                                                                                                                                                                  - i -

                                                                                                                                                                  • IsInRect() : XPMP2
                                                                                                                                                                    • +
                                                                                                                                                                  • IsPaused() +: XPMP2 +
                                                                                                                                                                    • +
                                                                                                                                                                  • IsViewExternal() +: XPMP2 +
                                                                                                                                                                  • iterRnd() : XPMP2
                                                                                                                                                                    • @@ -266,6 +278,12 @@

                                                                                                                                                                    - i -

                                                                                                                                                                      - l -

                                                                                                                                                                        +
                                                                                                                                                                      • leftOf() +: XPMP2 +
                                                                                                                                                                        • +
                                                                                                                                                                      • LoadRGBA() +: FMODLogo +
                                                                                                                                                                      • LogGetString() : XPMP2
                                                                                                                                                                        • @@ -428,6 +446,36 @@

                                                                                                                                                                        - s -

                                                                                                                                                                        • safeGetline() : XPMP2
                                                                                                                                                                          • +
                                                                                                                                                                        • SoundCleanup() +: XPMP2 +
                                                                                                                                                                          • +
                                                                                                                                                                        • SoundEventTxt() +: XPMP2 +
                                                                                                                                                                          • +
                                                                                                                                                                        • SoundGetMasterChn() +: XPMP2 +
                                                                                                                                                                          • +
                                                                                                                                                                        • SoundGetSoundFile() +: XPMP2 +
                                                                                                                                                                          • +
                                                                                                                                                                        • SoundInit() +: XPMP2 +
                                                                                                                                                                          • +
                                                                                                                                                                        • SoundIsChnValid() +: XPMP2 +
                                                                                                                                                                          • +
                                                                                                                                                                        • SoundLogCB() +: XPMP2 +
                                                                                                                                                                          • +
                                                                                                                                                                        • SoundLogEnable() +: XPMP2 +
                                                                                                                                                                          • +
                                                                                                                                                                        • SoundSetFmodSettings() +: XPMP2 +
                                                                                                                                                                          • +
                                                                                                                                                                        • SoundUpdatesDone() +: XPMP2 +
                                                                                                                                                                        • sqr() : XPMP2
                                                                                                                                                                          • @@ -471,6 +519,13 @@

                                                                                                                                                                          - t -

                                                                                                                                                                          +

                                                                                                                                                                          - u -

                                                                                                                                                                            +
                                                                                                                                                                          • UseOldFmod() +: XPMP2 +
                                                                                                                                                                            • +
                                                                                                                                                                          + +

                                                                                                                                                                          - x -

                                                                                                                                                                          • XPMPSendNotification() : XPMP2 diff --git a/docs/html/namespacemembers_g.html b/docs/html/namespacemembers_g.html index 730ab7f9..0d098748 100644 --- a/docs/html/namespacemembers_g.html +++ b/docs/html/namespacemembers_g.html @@ -75,6 +75,9 @@

                                                                                                                                                                            - g -

                                                                                                                                                                            • GetMiscNetwTimeStr() : XPMP2
                                                                                                                                                                              • +
                                                                                                                                                                            • GetTexture() +: FMODLogo +
                                                                                                                                                                            • GetXPSystemPath() : XPMP2
                                                                                                                                                                              • diff --git a/docs/html/namespacemembers_h.html b/docs/html/namespacemembers_h.html index 46f0e7d0..bccad165 100644 --- a/docs/html/namespacemembers_h.html +++ b/docs/html/namespacemembers_h.html @@ -48,6 +48,9 @@

                                                                                                                                                                              - h -

                                                                                                                                                                              • headNormalize() : XPMP2
                                                                                                                                                                                • +
                                                                                                                                                                              • HeadPitch2Vec() +: XPMP2 +
                                                                                                                                                                              diff --git a/docs/html/namespacemembers_i.html b/docs/html/namespacemembers_i.html index 55632a74..42e998e7 100644 --- a/docs/html/namespacemembers_i.html +++ b/docs/html/namespacemembers_i.html @@ -42,6 +42,15 @@
                                                                                                                                                                              Here is a list of all namespace members with links to the namespace documentation for each member:

                                                                                                                                                                              - i -

                                                                                                                                                                                +
                                                                                                                                                                              • IMG_HEIGHT +: FMODLogo +
                                                                                                                                                                                • +
                                                                                                                                                                              • IMG_SIZE +: FMODLogo +
                                                                                                                                                                                • +
                                                                                                                                                                              • IMG_WIDTH +: FMODLogo +
                                                                                                                                                                              • INVALID_SOCKET : XPMP2
                                                                                                                                                                                • @@ -51,6 +60,12 @@

                                                                                                                                                                                - i -

                                                                                                                                                                                • IsInRect() : XPMP2
                                                                                                                                                                                  • +
                                                                                                                                                                                • IsPaused() +: XPMP2 +
                                                                                                                                                                                  • +
                                                                                                                                                                                • IsViewExternal() +: XPMP2 +
                                                                                                                                                                                • iterRnd() : XPMP2
                                                                                                                                                                                  • diff --git a/docs/html/namespacemembers_k.html b/docs/html/namespacemembers_k.html new file mode 100644 index 00000000..f0f326a9 --- /dev/null +++ b/docs/html/namespacemembers_k.html @@ -0,0 +1,55 @@ + + + + + + + +XPMP2: Namespace Members + + + + + + +
                                                                                                                                                                                  +
                                                                                                                                                                                  + + + + + + +
                                                                                                                                                                                  +
                                                                                                                                                                                  XPMP2 +
                                                                                                                                                                                  +
                                                                                                                                                                                  X-Plane multiplayer library 2 - using instancing
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + + + + + + +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  Here is a list of all namespace members with links to the namespace documentation for each member:
                                                                                                                                                                                  + +

                                                                                                                                                                                  - k -

                                                                                                                                                                                    +
                                                                                                                                                                                  • KT_per_M_per_S +: XPMP2 +
                                                                                                                                                                                    • +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  +Generated by doxygen 1.9.1 +
                                                                                                                                                                                  + + diff --git a/docs/html/namespacemembers_l.html b/docs/html/namespacemembers_l.html index bc39ff59..2164a925 100644 --- a/docs/html/namespacemembers_l.html +++ b/docs/html/namespacemembers_l.html @@ -42,6 +42,9 @@
                                                                                                                                                                                  Here is a list of all namespace members with links to the namespace documentation for each member:

                                                                                                                                                                                  - l -

                                                                                                                                                                                    +
                                                                                                                                                                                  • leftOf() +: XPMP2 +
                                                                                                                                                                                  • listCSLObjTy : XPMP2
                                                                                                                                                                                    • @@ -51,6 +54,9 @@

                                                                                                                                                                                    - l -

                                                                                                                                                                                    • listXPMPPlaneNotifierTy : XPMP2
                                                                                                                                                                                      • +
                                                                                                                                                                                    • LoadRGBA() +: FMODLogo +
                                                                                                                                                                                    • LOG_LEVEL : XPMP2
                                                                                                                                                                                      • diff --git a/docs/html/namespacemembers_m.html b/docs/html/namespacemembers_m.html index ddb26538..be9394db 100644 --- a/docs/html/namespacemembers_m.html +++ b/docs/html/namespacemembers_m.html @@ -114,6 +114,9 @@

                                                                                                                                                                                      - m -

                                                                                                                                                                                      • mapRmtAcCacheTy : XPMP2
                                                                                                                                                                                        • +
                                                                                                                                                                                      • mapSoundTy +: XPMP2 +
                                                                                                                                                                                      • mapStrIntTy : XPMP2
                                                                                                                                                                                        • diff --git a/docs/html/namespacemembers_r.html b/docs/html/namespacemembers_r.html index b3cb3f7e..f36261de 100644 --- a/docs/html/namespacemembers_r.html +++ b/docs/html/namespacemembers_r.html @@ -153,6 +153,9 @@

                                                                                                                                                                                        - r -

                                                                                                                                                                                        • RemoveExtension() : XPMP2
                                                                                                                                                                                          • +
                                                                                                                                                                                        • RLE_SIZE +: FMODLogo +
                                                                                                                                                                                        • RMT_MSG_AC_ANIM : XPMP2
                                                                                                                                                                                          • diff --git a/docs/html/namespacemembers_s.html b/docs/html/namespacemembers_s.html index a7bf6f9e..b36ef24f 100644 --- a/docs/html/namespacemembers_s.html +++ b/docs/html/namespacemembers_s.html @@ -54,6 +54,36 @@

                                                                                                                                                                                          - s -

                                                                                                                                                                                          • SOCKET : XPMP2
                                                                                                                                                                                            • +
                                                                                                                                                                                          • SoundCleanup() +: XPMP2 +
                                                                                                                                                                                            • +
                                                                                                                                                                                          • SoundEventTxt() +: XPMP2 +
                                                                                                                                                                                            • +
                                                                                                                                                                                          • SoundGetMasterChn() +: XPMP2 +
                                                                                                                                                                                            • +
                                                                                                                                                                                          • SoundGetSoundFile() +: XPMP2 +
                                                                                                                                                                                            • +
                                                                                                                                                                                          • SoundInit() +: XPMP2 +
                                                                                                                                                                                            • +
                                                                                                                                                                                          • SoundIsChnValid() +: XPMP2 +
                                                                                                                                                                                            • +
                                                                                                                                                                                          • SoundLogCB() +: XPMP2 +
                                                                                                                                                                                            • +
                                                                                                                                                                                          • SoundLogEnable() +: XPMP2 +
                                                                                                                                                                                            • +
                                                                                                                                                                                          • SoundSetFmodSettings() +: XPMP2 +
                                                                                                                                                                                            • +
                                                                                                                                                                                          • SoundUpdatesDone() +: XPMP2 +
                                                                                                                                                                                          • sqr() : XPMP2
                                                                                                                                                                                            • diff --git a/docs/html/namespacemembers_type.html b/docs/html/namespacemembers_type.html index b6e4ea39..2101b50b 100644 --- a/docs/html/namespacemembers_type.html +++ b/docs/html/namespacemembers_type.html @@ -73,6 +73,9 @@
                                                                                                                                                                                          • mapRmtAcCacheTy : XPMP2
                                                                                                                                                                                            • +
                                                                                                                                                                                          • mapSoundTy +: XPMP2 +
                                                                                                                                                                                          • mapStrIntTy : XPMP2
                                                                                                                                                                                            • diff --git a/docs/html/namespacemembers_b.html b/docs/html/namespacemembers_u.html similarity index 82% rename from docs/html/namespacemembers_b.html rename to docs/html/namespacemembers_u.html index 998b5c89..79b560c9 100644 --- a/docs/html/namespacemembers_b.html +++ b/docs/html/namespacemembers_u.html @@ -3,7 +3,7 @@ - + XPMP2: Namespace Members @@ -27,7 +27,7 @@ - + + + + + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + + + + + +
                                                                                                                                                                                            +
                                                                                                                                                                                            XPMP2 +
                                                                                                                                                                                            +
                                                                                                                                                                                            X-Plane multiplayer library 2 - using instancing
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + + + + + + +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            XPMP2::SoundDefTy Member List
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            This is the complete list of members for XPMP2::SoundDefTy, including all inherited members.

                                                                                                                                                                                            + + + + + +
                                                                                                                                                                                            bSndLoopXPMP2::SoundDefTy
                                                                                                                                                                                            pValXPMP2::SoundDefTy
                                                                                                                                                                                            valMaxXPMP2::SoundDefTy
                                                                                                                                                                                            valMinXPMP2::SoundDefTy
                                                                                                                                                                                            + +
                                                                                                                                                                                            +Generated by doxygen 1.9.1 +
                                                                                                                                                                                            + + diff --git a/docs/html/structXPMP2_1_1SoundDefTy.html b/docs/html/structXPMP2_1_1SoundDefTy.html new file mode 100644 index 00000000..8724d868 --- /dev/null +++ b/docs/html/structXPMP2_1_1SoundDefTy.html @@ -0,0 +1,148 @@ + + + + + + + +XPMP2: XPMP2::SoundDefTy Struct Reference + + + + + + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + + + + + +
                                                                                                                                                                                            +
                                                                                                                                                                                            XPMP2 +
                                                                                                                                                                                            +
                                                                                                                                                                                            X-Plane multiplayer library 2 - using instancing
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + + + + + + +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +Public Attributes | +List of all members
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            XPMP2::SoundDefTy Struct Reference
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            Definition of how sound is handled based on dataRef values (type) + More...

                                                                                                                                                                                            + + + + + + + + + + + + + + +

                                                                                                                                                                                            +Public Attributes

                                                                                                                                                                                            float(Aircraft::* pVal )() const = nullptr
                                                                                                                                                                                             Function return the value to observe, typically a dataRef value. More...
                                                                                                                                                                                             
                                                                                                                                                                                            bool bSndLoop = true
                                                                                                                                                                                             Sound to be played in a loop while value is large than valMin? Otherwise a single sound upon detection of a change of value. More...
                                                                                                                                                                                             
                                                                                                                                                                                            float valMin = NAN
                                                                                                                                                                                             Sound to be played if *pVal > valMin More...
                                                                                                                                                                                             
                                                                                                                                                                                            float valMax = NAN
                                                                                                                                                                                             Only used to control volume, which raises for *pVal between valMin and valMax More...
                                                                                                                                                                                             
                                                                                                                                                                                            +

                                                                                                                                                                                            Detailed Description

                                                                                                                                                                                            +

                                                                                                                                                                                            Definition of how sound is handled based on dataRef values (type)

                                                                                                                                                                                            +

                                                                                                                                                                                            Member Data Documentation

                                                                                                                                                                                            + +

                                                                                                                                                                                            ◆ bSndLoop

                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + + + +
                                                                                                                                                                                            bool XPMP2::SoundDefTy::bSndLoop = true
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            Sound to be played in a loop while value is large than valMin? Otherwise a single sound upon detection of a change of value.

                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            ◆ pVal

                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + + + +
                                                                                                                                                                                            float(Aircraft::* XPMP2::SoundDefTy::pVal) () const = nullptr
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            Function return the value to observe, typically a dataRef value.

                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            ◆ valMax

                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + + + +
                                                                                                                                                                                            float XPMP2::SoundDefTy::valMax = NAN
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            Only used to control volume, which raises for *pVal between valMin and valMax

                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            ◆ valMin

                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + + + +
                                                                                                                                                                                            float XPMP2::SoundDefTy::valMin = NAN
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            Sound to be played if *pVal > valMin

                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            The documentation for this struct was generated from the following file: +
                                                                                                                                                                                            + +
                                                                                                                                                                                            +Generated by doxygen 1.9.1 +
                                                                                                                                                                                            + + diff --git a/docs/index.md b/docs/index.md index 5dcc733b..4b0bd12f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,12 +5,13 @@ document both usage and internals of the XPMP2 library. Content and availability status: -- Requirements (see below) +- [X] [Requirements](#requirements) - [ ] Feature Details - [X] [Model Matching](Matching.html) - [X] [TCAS Target and AI/multiplayer support](TCAS.html) - [ ] Additional map layer - [X] [Wake Turbulence Support](Wake.html) + - [X] [Sound Support by FMOD](Sound.html) - [X] [Shared dataRefs](SharedDataRefs.html) providing textual aircraft / flight information to interested 3rd party plugins - [X] [XPMP2 Remote](Remote.html) functionality - [ ] Coding, Building, Deployment @@ -29,11 +30,8 @@ Content and availability status: - XPMP2 implements [instancing](https://developer.x-plane.com/sdk/XPLMInstance/), so it **requires X-Plane 11.10** or later - CSL models in **OBJ8 format** (ie. older OBJ7 models are no longer supported) - -## Feature Details - -- [Model Matching](Matching.html) -- [TCAS and AI/Multiplayer support](TCAS.html) +- Potentially an FMOD license if built with sound support, see below in + [Sound Support by FMOD](#sound-support-by-fmod) ## Coding, Building, Deployment @@ -41,6 +39,7 @@ These aspects are relevant for developers using XPMP2 in their own plugin: ### Building XPMP2 +XPMP2 can be included into your projects as GitHub submodule, and into a CMake build plan via `add_subdirectory`. XCode projects, Visual Studio solutions, and a Docker environment for Linux and Mac OS builds are provided. The details are [documented here](Building.html). @@ -106,12 +105,21 @@ Performing these changes is built into XPMP2. ## Links to outside locations -[TCAS Override approach](https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/) +### TCAS Override + +The [TCAS Override approach](https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/) explains how TCAS information is provided, the classic multiplayer dataRefs are maintained and how 3rd party plugins can access this information. XPMP2 publishes data via the `sim/cockpit2/tcas/targets` dataRefs. -Original libxplanemp: +### Wake Turbulence + +X-Plane's approach to Wake Turbulence support for TCAS targets is described in +[this blog post](https://developer.x-plane.com/2022/02/wake-turbulence/) +featuring LiveTraffic screenshots and +[this article on the dataRef details](https://developer.x-plane.com/article/plugin-traffic-wake-turbulence/). + +### Original libxplanemp - [TwinFan's libxplanemp fork](https://github.com/TwinFan/libxplanemp) on GitHub - [wiki explaining differences to the kuroneko fork](https://github.com/TwinFan/libxplanemp/wiki) diff --git a/inc/XPMPAircraft.h b/inc/XPMPAircraft.h index 8ebccfb5..e74f1d4a 100644 --- a/inc/XPMPAircraft.h +++ b/inc/XPMPAircraft.h @@ -1,8 +1,37 @@ /// @file XPMPAircraft.h /// @brief XPMP2::Aircraft represent an aircraft as managed by XPMP2 /// @details New implementations should derive directly from XPMP2::Aircraft. +/// +/// @details This is one of two main header files for using XPMP2. +/// (The other is `XPMPMultiplayer.h`). +/// XPMP2 is a library allowing an X-Plane plugin to have +/// planes rendered in X-Plane's 3D world based on OBJ8 +/// CSL models, which need to be installed separately. +/// The plugin shall subclass XPMP2::Aircraft and override +/// the abstract virtual function XPMP2::Aircraft::UpdatePosition() +/// to provide updated position and attitude information. +/// XPMP2 takes care of reading and initializaing CSL models, +/// instanciating and updating the aircraft objects in X-Plane, +/// display in a map layer, provisioning information via X-Plane's +/// TCAS targets and AI/multiplayer (and more) dataRefs. +/// +/// @see For more developer's information see +/// https://twinfan.github.io/XPMP2/ +/// +/// @see Sample and "How to" available, see +/// https://twinfan.github.io/XPMP2/HowTo.html +/// +/// @see For TCAS Override approach see +/// https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/ +/// +/// @see For a definition of ICAO aircraft type designators see +/// https://www.icao.int/publications/DOC8643/Pages/Search.aspx +/// +/// @see For a list of ICAO airline/operator codes see +/// https://en.wikipedia.org/wiki/List_of_airline_codes +/// /// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe +/// @copyright (c) 2020-2022 Birger Hoppe /// @copyright Permission is hereby granted, free of charge, to any person obtaining a /// copy of this software and associated documentation files (the "Software"), /// to deal in the Software without restriction, including without limitation @@ -38,9 +67,12 @@ // MARK: XPMP2 New Definitions // +struct FMOD_CHANNELGROUP; ///< Defined by FMOD +struct FMOD_CHANNEL; ///< Defined by FMOD + namespace XPMP2 { -class CSLModel; +class CSLModel; ///< Defined by XPMP2 internally /// Convert revolutions-per-minute (RPM) to radians per second (rad/s) by multiplying with PI/30 constexpr float RPM_to_RADs = 0.10471975511966f; @@ -48,6 +80,8 @@ constexpr float RPM_to_RADs = 0.10471975511966f; constexpr double M_per_FT = 0.3048; // meter per 1 foot /// Convert nautical miles to meters constexpr int M_per_NM = 1852; // meter per one nautical mile +/// Convert m/s to knots +constexpr double KT_per_M_per_S = 1.94384; // 1m/s = 1.94384kt /// @brief standard gravitational acceleration [m/s²] /// @see https://en.wikipedia.org/wiki/Gravity_of_Earth constexpr float G_EARTH = 9.80665f; @@ -245,6 +279,8 @@ class Aircraft { // this is data from about a second ago to calculate cartesian velocities float prev_x = 0.0f, prev_y = 0.0f, prev_z = 0.0f; float prev_ts = 0.0f; ///< last update of `prev_x/y/z` in XP's network time + float v_x = 0.0f, v_y = 0.0f, v_z = 0.0f; ///< Cartesian velocity in m/s per axis + float gs_kn = 0.0f; /// ground speed in [kn] based on above v_x/z /// Set by SetOnGrnd() with the timestamp when to reset SetTouchDown() float tsResetTouchDown = NAN; @@ -271,9 +307,53 @@ class Aircraft { float mapY = 0.0f; ///< temporary: map coordinates (NAN = not to be drawn) std::string mapLabel; ///< label for map drawing +#ifdef INCLUDE_FMOD_SOUND + // *** Sound support *** +public: + /// Types of sound supported directly by XPMP2 + enum SoundEventsTy { + SND_ENG = 0, ///< Engine sound (continuously while engine running), bases on GetThrustRatio() + SND_REVERSE_THRUST, ///< Engine sound while reverse thrust (continuously while reversers deployed), bases on GetThrustReversRatio() + SND_TIRE, ///< Tires rolling on the ground (continuously while rolling on ground), bases on GetTireRotRpm() + SND_GEAR, ///< Gear extending/retracting (once per event), bases on GetGearRatio() + SND_FLAPS, ///< Flaps extending/retracting (once per event), bases on GetFlapRatio() + SND_NUM_EVENTS ///< Number of events (always last in `enum`) + }; + /// List of FMOD channels, also beyond sounds created for SoundEvetsTy + typedef std::list ChnListTy; + + /// Operational values per sound channel, that is triggered by a standard sound event + struct SndChTy { + bool bAuto = true; ///< Shall this sound event be handled automatically? (Set to false in your constructor or in Aircraft::SoundSetup() if you want to control that event type yourself) + FMOD_CHANNEL* pChn = nullptr; ///< channel playing the sound currently + float lastDRVal = NAN; ///< last observed dataRef value to see if sound is to be triggered + float volAdj = 1.0f; ///< Volume adjustment, fed from Aircraft::SoundGetName() + }; + + /// @brief Minimum distance in [m] to play sound in full volume, the larger the 'louder' the aircraft + /// @details Initialized based on engine type and numbers, overwrite in your constructor if you want to control "size" of aircraft in terms of its sound volume + int sndMinDist = 50; + +protected: + /// Operational values per sound channel, that is triggered by a standard sound event + SndChTy aSndCh[SND_NUM_EVENTS]; + /// Is Low Pass Filter currently being active? + bool bChnLowPass = false; + /// Is sound for this aircraft currently muted? + bool bChnMuted = false; + /// List of channels produced via calls to SoundPlay() + ChnListTy chnList; + /// Counts how often we skipped expensive computations + int skipCounter = 0; +#endif // INCLUDE_FMOD_SOUND + private: bool bDestroyInst = false; ///< Instance to be destroyed in next flight loop callback? public: + + /// @name Construction + /// @{ + /// @brief Constructor creates a new aircraft object, which will be managed and displayed /// @exception XPMP2::XPMP2Error Mode S id invalid or duplicate, no model found during model matching /// @param _icaoType ICAO aircraft type designator, like 'A320', 'B738', 'C172' @@ -310,15 +390,20 @@ class Aircraft { XPMPPlaneID _modeS_id = 0, const std::string& _cslId = "", CSLModel* _pCSLModel = nullptr); - + /// @} + /// @name Information + /// @{ + /// return the XPMP2 plane id XPMPPlaneID GetModeS_ID () const { return modeS_id; } - /// Is this object a ground vehicle? - bool IsGroundVehicle() const; /// @brief Is this object "related" to the given ICAO code? (named in the same line in related.txt) /// @param _icaoType ICAO aircraft type designator, to which `*this` is compared /// @details For example, `IsRelatedTo("GLID")` returns if `*this` is a glider bool IsRelatedTo (const std::string& _icaoType) const; + /// Is this object a ground vehicle? (related to `glob.carIcaoType`) + bool IsGroundVehicle() const; + /// Is this object a glider? + bool IsGlider() const { return IsRelatedTo("GLID"); } /// @brief return the current TCAS target index (into `sim/cockpit2/tcas/targets`), 1-based, `-1` if not used int GetTcasTargetIdx () const { return tcasTargetIdx; } /// Is this plane currently also being tracked as a TCAS target, ie. will appear on TCAS? @@ -334,6 +419,11 @@ class Aircraft { /// @returns The first non-empty string out of: flight number, registration, departure/arrival airports virtual std::string GetFlightId() const; + /// @} + /// @name Model Matching + /// @see https://twinfan.github.io/XPMP2/Matching.html + /// @{ + /// @brief (Potentially) changes the plane's model after doing a new match attempt /// @param _icaoType ICAO aircraft type designator, like 'A320', 'B738', 'C172' /// @param _icaoAirline ICAO airline code, like 'BAW', 'DLH', can be an empty string @@ -362,6 +452,11 @@ class Aircraft { CSLModelInfo_t GetModelInfo() const { return pCSLMdl ? CSLModelInfo_t(*pCSLMdl) : CSLModelInfo_t(); } /// quality of the match with the CSL model int GetMatchQuality () const { return matchQuality; } + + /// @} + /// @name Visualization + /// @{ + /// Vertical offset, ie. the value that needs to be added to `drawInfo.y` to make the aircraft appear on the ground float GetVertOfs () const; @@ -410,7 +505,9 @@ class Aircraft { /// @param setTouchDownTime [opt] If not `NAN` activates SetTouchDown(), and automatically resets it after the given time in seconds void SetOnGrnd (bool on_grnd, float setTouchDownTime = NAN); - // --- Getters and Setters for the values in `drawInfo` --- + /// @} + /// @name Getters and Setters for the values in Aircraft::drawInfo + /// @{ /// @brief Converts world coordinates to local coordinates, writes to Aircraft::drawInfo /// @note Alternatively, the calling plugin can set local coordinates in Aircraft::drawInfo directly @@ -443,7 +540,13 @@ class Aircraft { float GetRoll () const { return drawInfo.roll; } ///< roll [degree] void SetRoll (float _deg) { drawInfo.roll = _deg; } ///< roll [degree] - // --- Getters and Setters for the values in the `v` array --- + float GetGS_kn() const { return gs_kn; } ///< Rough estimate of a ground speed based on `v_x/z` + + /// @} + /// @name Getters and Setters for the values in the Aircraft::v array + /// @see https://twinfan.github.io/XPMP2/CSLdataRefs.html + /// @{ + float GetGearRatio () const { return v[V_CONTROLS_GEAR_RATIO]; } ///< Gear deploy ratio void SetGearRatio (float _f) { v[V_CONTROLS_GEAR_RATIO] = _f; } ///< Gear deploy ratio float GetNoseWheelAngle () const { return v[V_CONTROLS_NWS_RATIO]; } ///< Nose Wheel angle in degrees @@ -525,7 +628,12 @@ class Aircraft { bool GetTouchDown () const { return v[V_MISC_TOUCH_DOWN] > 0.5f; } ///< Moment of touch down void SetTouchDown (bool _b) { v[V_MISC_TOUCH_DOWN] = float(_b); } ///< Moment of touch down - // Wake support as per X-Plane 12 + /// @} + /// @name Wake support as per X-Plane 12 + /// @see https://twinfan.github.io/XPMP2/Wake.html + /// @see https://developer.x-plane.com/2022/02/wake-turbulence/ + /// @see https://developer.x-plane.com/article/plugin-traffic-wake-turbulence/ + /// @{ /// @brief Fill in default wake turbulence support data based on Doc8643 wake turbulence category /// @param _bOverwriteAllFields If `false` only overwrites `NAN` values in `wakeTy` @@ -546,7 +654,11 @@ class Aircraft { virtual float GetAoA() const { return GetPitch(); } ///< Angle of Attach, returns pitch (but you can override in your class) virtual float GetLift() const { return GetMass() * G_EARTH; } ///< Lift produced. You _should_ override to blend in/out for take-off/landing, but XPMP2 has no dynamic info of your plane, not even an on-the-ground flag - // The following is implemented in Map.cpp: + /// @} + /// @name Map Support + /// @note Implemented in Map.cpp + /// @{ + /// Determine which map icon to use for this aircraft void MapFindIcon (); /// Prepare map coordinates @@ -556,10 +668,52 @@ class Aircraft { void MapDrawIcon (XPLMMapLayerID inLayer, float acSize); /// Actually draw the map label void MapDrawLabel (XPLMMapLayerID inLayer, float yOfs); + +#ifdef INCLUDE_FMOD_SOUND + /// @} + /// @name Sound Support + /// @note Implemented in Sound.cpp only if built with `INCLUDE_FMOD_SOUND` + /// @{ + + /// @brief Play a sound; a looping sound plays until explicitely stopped + /// @param sndName One of the sounds available or registered with XPMP2, see XPMPSoundAdd() and XPMPSoundEnumerate() + /// @param vol [opt] Volume level. 0 = silent, 1 = full. Negative level inverts the signal. Values larger than 1 amplify the signal. + /// @returns an FMOD sound channel, or `nullptr` if unsuccessful + FMOD_CHANNEL* SoundPlay (const std::string& sndName, float vol = 1.0f); + + /// @brief Stop a continuously playing sound + /// @param pChn The channel returned by SoundLoopPlay() + void SoundStop (FMOD_CHANNEL* pChn); + + /// @brief Sets the sound's volume (after applying master volume and Sound File's adjustments) + /// @param pChn The channel returned by SoundLoopPlay() + /// @param vol Volume level. 0 = silent, 1 = full. Negative level inverts the signal. Values larger than 1 amplify the signal. + void SoundVolume (FMOD_CHANNEL* pChn, float vol); + + /// @brief Mute/Unmute all sounds of the airplane temporarily + void SoundMuteAll (bool bMute); + + /// @brief Returns the name of the sound to play per event + /// @details This standard implementation determines the engine sound via + /// aircraft classification and returns constant + /// names for the other sound types. + /// @note Override in derived class if you want to assign (some) sounds yourself + /// @param sndEvent The type of sound event, like engine or gear + /// @param[out] volAdj Volume adjustment factor, allows to make sound louder (>1.0) or quiter, defaults to 1.0 + /// @returns Name of the sound to play, empty string if no sound shall play + virtual std::string SoundGetName (SoundEventsTy sndEvent, float& volAdj) const; +#endif protected: + + /// @} + /// Internal: Flight loop callback function controlling update and movement of all planes static float FlightLoopCB (float, float, int, void*); + + /// @name Internal Control Functions + /// @{ + /// Internal: This puts the instance into XP's sky and makes it move void DoMove (); /// Internal: Update the plane's distance/bearing from the camera location @@ -578,10 +732,28 @@ class Aircraft { // The following functions are implemented in AIMultiplayer.cpp: /// Define the TCAS target index in use virtual void SetTcasTargetIdx (int _idx) { tcasTargetIdx = _idx; } + + /// @} + // These functions perform the TCAS target / multiplayer data updates friend void AIMultiUpdate (); friend size_t AIUpdateTCASTargets (); friend size_t AIUpdateMultiplayerDataRefs (); + +#ifdef INCLUDE_FMOD_SOUND + /// @name Sound Support (internal) + /// @note Implemented in Sound.cpp only if built with `INCLUDE_FMOD_SOUND` + /// @{ + + /// Sound-related initializations, called by Create() and ChangeModel() + virtual void SoundSetup (); + /// Update sound, like position and volume, called once per frame + virtual void SoundUpdate (); + /// Remove all sound, e.g. during destruction + virtual void SoundRemoveAll (); + + /// @} +#endif }; /// Find aircraft by its plane ID, can return nullptr diff --git a/inc/XPMPMultiplayer.h b/inc/XPMPMultiplayer.h index 7beae655..21f3639b 100644 --- a/inc/XPMPMultiplayer.h +++ b/inc/XPMPMultiplayer.h @@ -12,7 +12,7 @@ /// XPMP2 is a library allowing an X-Plane plugin to have /// planes rendered in X-Plane's 3D world based on OBJ8 /// CSL models, which need to be installed separately. -/// The plugin shall subclass XPMP2::Aircraft:: and override +/// The plugin shall subclass XPMP2::Aircraft and override /// the abstract virtual function XPMP2::Aircraft::UpdatePosition() /// to provide updated position and attitude information. /// XPMP2 takes care of reading and initializaing CSL models, @@ -23,6 +23,9 @@ /// @see For more developer's information see /// https://twinfan.github.io/XPMP2/ /// +/// @see Sample and "How to" available, see +/// https://twinfan.github.io/XPMP2/HowTo.html +/// /// @see For TCAS Override approach see /// https://developer.x-plane.com/article/overriding-tcas-and-providing-traffic-information/ /// @@ -32,10 +35,15 @@ /// @see For a list of ICAO airline/operator codes see /// https://en.wikipedia.org/wiki/List_of_airline_codes /// +/// @note Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. +/// Understand FMOD [licensing](https://www.fmod.com/licensing) and +/// [attribution requirements](https://www.fmod.com/attribution) first!\n +/// Sound support is only included if built with CMake cache entry `INCLUDE_FMOD_SOUND`.\n +/// /// @author Ben Supnik and Chris Serio /// @copyright Copyright (c) 2004, Ben Supnik and Chris Serio. /// @author Birger Hoppe -/// @copyright (c) 2020 Birger Hoppe +/// @copyright (c) 2020-2022 Birger Hoppe /// @copyright Permission is hereby granted, free of charge, to any person obtaining a /// copy of this software and associated documentation files (the "Software"), /// to deal in the Software without restriction, including without limitation @@ -56,6 +64,7 @@ #define _XPLMMultiplayer_h_ #include +#include #include "XPLMDefs.h" #ifdef __cplusplus @@ -95,7 +104,7 @@ struct XPMPPlanePosition_t { /// @brief Light flash patterns /// @note Unused in XPMP2 -/// @note Not changed to proper enum type as it is used in bitfields in xpmp_LightStatus, +/// @note Now changed to proper enum type as it is used in bitfields in XPMP2::xpmp_LightStatus, /// which causes misleading, non-suppressable warnings in gcc:\n /// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=51242 enum { @@ -252,19 +261,28 @@ constexpr XPMPPlaneID MAX_MODE_S_ID = 0x00FFFFFF; * MARK: INITIALIZATION ************************************************************************************/ -// Config section is defined for legacy reasons only +/// @name Configuration Sections +/// Config section is defined for legacy reasons only +/// @{ #define XPMP_CFG_SEC_MODELS "models" ///< Config section "models" #define XPMP_CFG_SEC_PLANES "planes" ///< Config section "planes" +#define XPMP_CFG_SEC_SOUND "sound" ///< Config section "sound" #define XPMP_CFG_SEC_DEBUG "debug" ///< Config section "debug" +/// @} -// Config key definitions +/// @name Configuration Items +/// Configuration Items are unique in itself even without considering the configuration section +/// @{ #define XPMP_CFG_ITM_REPLDATAREFS "replace_datarefs" ///< Config key: Replace dataRefs in OBJ8 files upon load, creating new OBJ8 files for XPMP2 (defaults to OFF!) #define XPMP_CFG_ITM_REPLTEXTURE "replace_texture" ///< Config key: Replace textures in OBJ8 files upon load if needed (specified on the OBJ8 line in xsb_aircraft.txt), creating new OBJ8 files #define XPMP_CFG_ITM_CLAMPALL "clamp_all_to_ground" ///< Config key: Ensure no plane sinks below ground, no matter of XPMP2::Aircraft::bClampToGround #define XPMP_CFG_ITM_HANDLE_DUP_ID "handle_dup_id" ///< Config key: Boolean: If XPMP2::Aircraft::modeS_id already exists then assign a new unique one, overwrites XPMP2::Aircraft::modeS_id #define XPMP_CFG_ITM_SUPPORT_REMOTE "support_remote" ///< Config key: Support remote connections? `<0` force off, `0` default: on if in a networked or multiplayer setup, `>0` force on +#define XPMP_CFG_ITM_ACTIVATE_SOUND "activate_sound" ///< Config key: Activate Sound upon initial startup? (No effect later) +#define XPMP_CFG_ITM_MUTE_ON_PAUSE "mute_on_pause" ///< Config key: Mute all sound temporarily while X-Plane is in a paused state? #define XPMP_CFG_ITM_LOGLEVEL "log_level" ///< Config key: General level of logging into `Log.txt` (0 = Debug, 1 = Info, 2 = Warning, 3 = Error, 4 = Fatal) -#define XPMP_CFG_ITM_MODELMATCHING "model_matching" ///< Config key: Write information on model matching into `Log.txt` +#define XPMP_CFG_ITM_MODELMATCHING "model_matching" ///< Config key: Write information on model matching and sound selection into `Log.txt` +/// @} /// @brief Definition for the type of configuration callback function /// @details The plugin using XPMP2 can provide such a callback function via XPMPMultiplayerInit(). @@ -277,8 +295,10 @@ constexpr XPMPPlaneID MAX_MODE_S_ID = 0x00FFFFFF; /// `planes  | clamp_all_to_ground | int  |    1    | Ensure no plane sinks below ground, no matter of XPMP2::Aircraft::bClampToGround`\n /// `planes  | handle_dup_id       | int  |    0    | Boolean: If XPMP2::Aircraft::modeS_id already exists then assign a new unique one, overwrites XPMP2::Aircraft::modeS_id`\n /// `planes  | support_remote      | int  |    0    | 3-state integer: Support remote connections? <0 force off, 0 default: on if in a networked or multiplayer setup, >0 force on`\n +/// `sound   | activate_sound      | int  |    1    | Activate Sound upon initial startup? (No effect later)`\n +/// `sound   | mute_on_pause       | int  |    1    | Mute all sound temporarily while X-Plane is in a paused state?`\n /// `debug   | log_level           | int  |    2    | General level of logging into Log.txt (0 = Debug, 1 = Info, 2 = Warning, 3 = Error, 4 = Fatal)`\n -/// `debug   | model_matching      | int  |    0    | Write information on model matching into Log.txt`\n +/// `debug   | model_matching      | int  |    0    | Write information on model matching and sound selection into Log.txt`\n /// @note There is no immediate requirement to check the value of `_section` in your implementation. /// `_key` by itself is unique. Compare it with any of the `XPMP_CFG_ITM_*` values and return your value. /// @param _section Configuration section, ie. group of values, any of the `XPMP_CFG_SEC_...` values @@ -287,6 +307,9 @@ constexpr XPMPPlaneID MAX_MODE_S_ID = 0x00FFFFFF; /// @return Your callback shall return your config value for config item `_key` typedef int (*XPMPIntPrefsFuncTy)(const char* _section, const char* _key, int _default); +/// @name Initialization +/// @{ + /// @brief Deprecated legacy initialization of XPMP2. /// @note Parameters changed compared to libxplanemp! /// @details Effectively calls, in this order, @@ -333,14 +356,96 @@ void XPMPMultiplayerCleanup(); /// @brief Used to set the light textures for old OBJ7 models. /// @note Unsupported with XPMP2, will always return "OBJ7 format is no longer supported" -[[deprecated("Unsupported feature, will alsways return 'OBJ7 format is no longer supported'")]] +[[deprecated("Unsupported feature, will always return 'OBJ7 format is no longer supported'")]] const char * XPMPMultiplayerOBJ7SupportEnable(const char * inTexturePath); +/// @} + +/************************************************************************************ +* MARK: Sound +************************************************************************************/ + +// Only included if specified. Understand FMOD licensing and attribution first! +#ifdef INCLUDE_FMOD_SOUND + +/// @name Sound +/// @note Only included if built with `INCLUDE_FMOD_SOUND` +/// @{ + +/// @brief Enable/Disable Sound +/// @details Enable or disable sound support. +/// The default on startup is controlled by the configuration item +/// `sound / activate_sound`, which in turn defaults to `1`. +/// @returns Is sound now available? (Could still be `false` even in case +/// of activation if there was a problem during sound initialization) +bool XPMPSoundEnable (bool bEnable = true); + +/// @brief Is Sound enabled? +bool XPMPSoundIsEnabled (); + +/// @brief Set Master Volume +/// @param fVol Volume level. 0 = silent, 1 = full. Negative level inverts the signal. Values larger than 1 amplify the signal. +void XPMPSoundSetMasterVolume (float fVol = 1.0f); + +/// @brief Mute all sounds (temporarily) +/// @param bMute Mute (`true`) or unmute (`false`)? +void XPMPSoundMute (bool bMute); + +/// @brief Add a sound that can later be referenced from an XPMP2::Aircraft +/// @details XPMP2 loads a number of default sounds from what X-Plane ships. +/// This function allows to add your own. It will try to load the +/// sound immediately. +/// @param sName A descriptive name, used as a key to refer to this sound later +/// @param filePath Path to the sound file; a relative path is relative to `resourceDir` as set by XPMPMultiplayerInit() +/// @param bLoop Is this sound to be played in a loop? +/// @param coneDir [opt] Which direction relative to plane's heading does the cone point to? (180 would be typical for jet engines) +/// @param conePitch [opt] Which pitch does the cone point to (up/down)? (0 would be typical, ie. level with the plane) +/// @param coneInAngle [opt] Inside cone angle. This is the angle spread within which the sound is unattenuated. +/// @param coneOutAngle [opt] Outside cone angle. This is the angle spread outside of which the sound is attenuated to its `coneOutVol`. +/// @param coneOutVol [opt] Cone outside volume. +/// @return Empty string in case of success, otherwise a human-readable error message. +const char* XPMPSoundAdd (const char* sName, + const char* filePath, + bool bLoop, + float coneDir = NAN, float conePitch = NAN, + float coneInAngle = NAN, float coneOutAngle = NAN, + float coneOutVol = NAN); + +/// @brief Enumerate all sounds, including the internal ones +/// @param prevName `nullptr` or empty string to start from beginning, last returned name to continue with next sound +/// @param[out] ppFilePath (optional) Receives pointer to file path +/// @returns Next sound's name. +/// @note String pointers can change any frame. If you want to use the strings +/// longer than immediately, make yourself a string copy. +const char* XPMPSoundEnumerate (const char* prevName, const char** ppFilePath = nullptr); + +/// @} + +/// @name Sound Macros +/// @{ + +// Standard sounds loaded by XPMP2 from XP's `Resource/sounds` folders +#define XP_SOUND_ELECTRIC "Electric" +#define XP_SOUND_HIBYPASSJET "HiBypassJet" +#define XP_SOUND_LOBYPASSJET "LoBypassJet" +#define XP_SOUND_TURBOPROP "Turboprop" +#define XP_SOUND_PROP_AIRPLANE "PropAirplane" +#define XP_SOUND_PROP_HELI "PropHeli" +#define XP_SOUND_REVERSE_THRUST "ReverseThrust" +#define XP_SOUND_ROLL_RUNWAY "RollRunway" +#define XP_SOUND_FLAP "Flap" +#define XP_SOUND_GEAR "Gear" + +/// @} + +#endif // INCLUDE_FMOD_SOUND /************************************************************************************ * MARK: AI / Multiplayer plane control ************************************************************************************/ +/// @name AI / Multiplayer plane control +/// @{ /// @brief Tries to grab control of TCAS targets (formerly known as AI/multiplayer) from X-Plane /// @details Only one plugin can have TCAS targets control at any one time. @@ -377,10 +482,15 @@ void XPMPMultiplayerDisable(); /// @see XPMPMultiplayerEnable() bool XPMPHasControlOfAIAircraft(); +/// @} + /************************************************************************************ * MARK: CSL Package Handling ************************************************************************************/ +/// @name CSL Package Handling +/// @{ + /// @brief Loads CSL packages from the given folder, searching up to 5 folder levels deep. /// @details This function mainly searches the given folder for packages. /// It traverses all folders in search for `xsb_aircraft.txt` files. @@ -470,6 +580,8 @@ bool XPMPIsICAOValid(const char * inICAO); /// for display on network-connected X-Plane instances. size_t XPMPAddModelDataRef (const std::string& dataRef); +/// @} + /************************************************************************************ * MARK: PLANE CREATION API ************************************************************************************/ @@ -491,6 +603,8 @@ typedef XPMPPlaneCallbackResult (* XPMPPlaneData_f)(XPMPPlaneID inPlane, void * ioData, void * inRefcon); +/// @name Plane Creation API +/// @{ /// @brief Creates a new plane /// @deprecated Subclass XPMP2::Aircraft instead @@ -614,6 +728,8 @@ XPMP2::Aircraft* XPMPGetAircraft (XPMPPlaneID _id); void XPMPSetDefaultPlaneICAO(const char* _acIcaoType, const char* _carIcaoType = nullptr); +/// @} + /************************************************************************************ * MARK: PLANE OBSERVATION API ************************************************************************************/ @@ -636,6 +752,8 @@ typedef void (*XPMPPlaneNotifier_f)(XPMPPlaneID inPlaneID, XPMPPlaneNotification inNotification, void * inRefcon); +/// @name Plane Observation API +/// @{ /// @brief Registers a callback, which is called when one of the /// events defined in ::XPMPPlaneNotification happens @@ -652,6 +770,8 @@ void XPMPRegisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc, void XPMPUnregisterPlaneNotifierFunc(XPMPPlaneNotifier_f inFunc, void * inRefcon); +/// @} + /************************************************************************************ * MARK: PLANE RENDERING API (unsued in XPMP2) ************************************************************************************/ @@ -664,6 +784,8 @@ typedef void (* XPMPRenderPlanes_f)( int inIsBlend, void * inRef); +/// @name Plane Rendering API +/// @{ /// @brief The original libxplanemp allowed to override rendering; no longer supported /// @deprecated Unsupported in XPMP2. The function is available to stay compile-time compatible, @@ -709,6 +831,8 @@ void XPMPSetAircraftLabelDist (float _dist_nm, bool _bCutOffAtVisibility = true) /// By default, the map functionality is enabled including label writing. void XPMPEnableMap (bool _bEnable, bool _bLabels = true); +/// @} + #ifdef __cplusplus } #endif diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMCamera.h b/lib/SDK/CHeaders/XPLM/XPLMCamera.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMCamera.h rename to lib/SDK/CHeaders/XPLM/XPLMCamera.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMDataAccess.h b/lib/SDK/CHeaders/XPLM/XPLMDataAccess.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMDataAccess.h rename to lib/SDK/CHeaders/XPLM/XPLMDataAccess.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMDefs.h b/lib/SDK/CHeaders/XPLM/XPLMDefs.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMDefs.h rename to lib/SDK/CHeaders/XPLM/XPLMDefs.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMDisplay.h b/lib/SDK/CHeaders/XPLM/XPLMDisplay.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMDisplay.h rename to lib/SDK/CHeaders/XPLM/XPLMDisplay.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMGraphics.h b/lib/SDK/CHeaders/XPLM/XPLMGraphics.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMGraphics.h rename to lib/SDK/CHeaders/XPLM/XPLMGraphics.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMInstance.h b/lib/SDK/CHeaders/XPLM/XPLMInstance.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMInstance.h rename to lib/SDK/CHeaders/XPLM/XPLMInstance.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMMap.h b/lib/SDK/CHeaders/XPLM/XPLMMap.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMMap.h rename to lib/SDK/CHeaders/XPLM/XPLMMap.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMMenus.h b/lib/SDK/CHeaders/XPLM/XPLMMenus.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMMenus.h rename to lib/SDK/CHeaders/XPLM/XPLMMenus.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMNavigation.h b/lib/SDK/CHeaders/XPLM/XPLMNavigation.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMNavigation.h rename to lib/SDK/CHeaders/XPLM/XPLMNavigation.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMPlanes.h b/lib/SDK/CHeaders/XPLM/XPLMPlanes.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMPlanes.h rename to lib/SDK/CHeaders/XPLM/XPLMPlanes.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMPlugin.h b/lib/SDK/CHeaders/XPLM/XPLMPlugin.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMPlugin.h rename to lib/SDK/CHeaders/XPLM/XPLMPlugin.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMProcessing.h b/lib/SDK/CHeaders/XPLM/XPLMProcessing.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMProcessing.h rename to lib/SDK/CHeaders/XPLM/XPLMProcessing.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMScenery.h b/lib/SDK/CHeaders/XPLM/XPLMScenery.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMScenery.h rename to lib/SDK/CHeaders/XPLM/XPLMScenery.h diff --git a/XPMP2-Sample/SDK/CHeaders/XPLM/XPLMUtilities.h b/lib/SDK/CHeaders/XPLM/XPLMUtilities.h similarity index 100% rename from XPMP2-Sample/SDK/CHeaders/XPLM/XPLMUtilities.h rename to lib/SDK/CHeaders/XPLM/XPLMUtilities.h diff --git a/XPMP2-Sample/SDK/Libraries/Mac/XPLM.framework/XPLM b/lib/SDK/Libraries/Mac/XPLM.framework/XPLM similarity index 100% rename from XPMP2-Sample/SDK/Libraries/Mac/XPLM.framework/XPLM rename to lib/SDK/Libraries/Mac/XPLM.framework/XPLM diff --git a/XPMP2-Sample/SDK/Libraries/Win/XPLM_64.lib b/lib/SDK/Libraries/Win/XPLM_64.lib similarity index 100% rename from XPMP2-Sample/SDK/Libraries/Win/XPLM_64.lib rename to lib/SDK/Libraries/Win/XPLM_64.lib diff --git a/XPMP2-Sample/SDK/README.txt b/lib/SDK/README.txt similarity index 100% rename from XPMP2-Sample/SDK/README.txt rename to lib/SDK/README.txt diff --git a/XPMP2-Sample/SDK/license.txt b/lib/SDK/license.txt similarity index 100% rename from XPMP2-Sample/SDK/license.txt rename to lib/SDK/license.txt diff --git a/lib/fmod/inc/fmod.h b/lib/fmod/inc/fmod.h new file mode 100644 index 00000000..e6ae1f93 --- /dev/null +++ b/lib/fmod/inc/fmod.h @@ -0,0 +1,667 @@ +/* ======================================================================================== */ +/* FMOD Core API - C header file. */ +/* Copyright (c), Firelight Technologies Pty, Ltd. 2004-2022. */ +/* */ +/* Use this header in conjunction with fmod_common.h (which contains all the constants / */ +/* callbacks) to develop using the C interface */ +/* */ +/* For more detail visit: */ +/* https://fmod.com/docs/2.02/api/core-api.html */ +/* ======================================================================================== */ + +#ifndef _FMOD_H +#define _FMOD_H + +#include "fmod_common.h" + +#ifdef __cplusplus +extern "C" +{ +#endif + +/* + FMOD global system functions (optional). +*/ +FMOD_RESULT F_API FMOD_Memory_Initialize (void *poolmem, int poollen, FMOD_MEMORY_ALLOC_CALLBACK useralloc, FMOD_MEMORY_REALLOC_CALLBACK userrealloc, FMOD_MEMORY_FREE_CALLBACK userfree, FMOD_MEMORY_TYPE memtypeflags); +FMOD_RESULT F_API FMOD_Memory_GetStats (int *currentalloced, int *maxalloced, FMOD_BOOL blocking); +FMOD_RESULT F_API FMOD_Debug_Initialize (FMOD_DEBUG_FLAGS flags, FMOD_DEBUG_MODE mode, FMOD_DEBUG_CALLBACK callback, const char *filename); +FMOD_RESULT F_API FMOD_File_SetDiskBusy (int busy); +FMOD_RESULT F_API FMOD_File_GetDiskBusy (int *busy); +FMOD_RESULT F_API FMOD_Thread_SetAttributes (FMOD_THREAD_TYPE type, FMOD_THREAD_AFFINITY affinity, FMOD_THREAD_PRIORITY priority, FMOD_THREAD_STACK_SIZE stacksize); + +/* + FMOD System factory functions. Use this to create an FMOD System Instance. below you will see FMOD_System_Init/Close to get started. +*/ +FMOD_RESULT F_API FMOD_System_Create (FMOD_SYSTEM **system, unsigned int headerversion); +FMOD_RESULT F_API FMOD_System_Release (FMOD_SYSTEM *system); + +/* + 'System' API +*/ + +/* Setup functions. */ +FMOD_RESULT F_API FMOD_System_SetOutput (FMOD_SYSTEM *system, FMOD_OUTPUTTYPE output); +FMOD_RESULT F_API FMOD_System_GetOutput (FMOD_SYSTEM *system, FMOD_OUTPUTTYPE *output); +FMOD_RESULT F_API FMOD_System_GetNumDrivers (FMOD_SYSTEM *system, int *numdrivers); +FMOD_RESULT F_API FMOD_System_GetDriverInfo (FMOD_SYSTEM *system, int id, char *name, int namelen, FMOD_GUID *guid, int *systemrate, FMOD_SPEAKERMODE *speakermode, int *speakermodechannels); +FMOD_RESULT F_API FMOD_System_SetDriver (FMOD_SYSTEM *system, int driver); +FMOD_RESULT F_API FMOD_System_GetDriver (FMOD_SYSTEM *system, int *driver); +FMOD_RESULT F_API FMOD_System_SetSoftwareChannels (FMOD_SYSTEM *system, int numsoftwarechannels); +FMOD_RESULT F_API FMOD_System_GetSoftwareChannels (FMOD_SYSTEM *system, int *numsoftwarechannels); +FMOD_RESULT F_API FMOD_System_SetSoftwareFormat (FMOD_SYSTEM *system, int samplerate, FMOD_SPEAKERMODE speakermode, int numrawspeakers); +FMOD_RESULT F_API FMOD_System_GetSoftwareFormat (FMOD_SYSTEM *system, int *samplerate, FMOD_SPEAKERMODE *speakermode, int *numrawspeakers); +FMOD_RESULT F_API FMOD_System_SetDSPBufferSize (FMOD_SYSTEM *system, unsigned int bufferlength, int numbuffers); +FMOD_RESULT F_API FMOD_System_GetDSPBufferSize (FMOD_SYSTEM *system, unsigned int *bufferlength, int *numbuffers); +FMOD_RESULT F_API FMOD_System_SetFileSystem (FMOD_SYSTEM *system, FMOD_FILE_OPEN_CALLBACK useropen, FMOD_FILE_CLOSE_CALLBACK userclose, FMOD_FILE_READ_CALLBACK userread, FMOD_FILE_SEEK_CALLBACK userseek, FMOD_FILE_ASYNCREAD_CALLBACK userasyncread, FMOD_FILE_ASYNCCANCEL_CALLBACK userasynccancel, int blockalign); +FMOD_RESULT F_API FMOD_System_AttachFileSystem (FMOD_SYSTEM *system, FMOD_FILE_OPEN_CALLBACK useropen, FMOD_FILE_CLOSE_CALLBACK userclose, FMOD_FILE_READ_CALLBACK userread, FMOD_FILE_SEEK_CALLBACK userseek); +FMOD_RESULT F_API FMOD_System_SetAdvancedSettings (FMOD_SYSTEM *system, FMOD_ADVANCEDSETTINGS *settings); +FMOD_RESULT F_API FMOD_System_GetAdvancedSettings (FMOD_SYSTEM *system, FMOD_ADVANCEDSETTINGS *settings); +FMOD_RESULT F_API FMOD_System_SetCallback (FMOD_SYSTEM *system, FMOD_SYSTEM_CALLBACK callback, FMOD_SYSTEM_CALLBACK_TYPE callbackmask); + +/* Plug-in support. */ +FMOD_RESULT F_API FMOD_System_SetPluginPath (FMOD_SYSTEM *system, const char *path); +FMOD_RESULT F_API FMOD_System_LoadPlugin (FMOD_SYSTEM *system, const char *filename, unsigned int *handle, unsigned int priority); +FMOD_RESULT F_API FMOD_System_UnloadPlugin (FMOD_SYSTEM *system, unsigned int handle); +FMOD_RESULT F_API FMOD_System_GetNumNestedPlugins (FMOD_SYSTEM *system, unsigned int handle, int *count); +FMOD_RESULT F_API FMOD_System_GetNestedPlugin (FMOD_SYSTEM *system, unsigned int handle, int index, unsigned int *nestedhandle); +FMOD_RESULT F_API FMOD_System_GetNumPlugins (FMOD_SYSTEM *system, FMOD_PLUGINTYPE plugintype, int *numplugins); +FMOD_RESULT F_API FMOD_System_GetPluginHandle (FMOD_SYSTEM *system, FMOD_PLUGINTYPE plugintype, int index, unsigned int *handle); +FMOD_RESULT F_API FMOD_System_GetPluginInfo (FMOD_SYSTEM *system, unsigned int handle, FMOD_PLUGINTYPE *plugintype, char *name, int namelen, unsigned int *version); +FMOD_RESULT F_API FMOD_System_SetOutputByPlugin (FMOD_SYSTEM *system, unsigned int handle); +FMOD_RESULT F_API FMOD_System_GetOutputByPlugin (FMOD_SYSTEM *system, unsigned int *handle); +FMOD_RESULT F_API FMOD_System_CreateDSPByPlugin (FMOD_SYSTEM *system, unsigned int handle, FMOD_DSP **dsp); +FMOD_RESULT F_API FMOD_System_GetDSPInfoByPlugin (FMOD_SYSTEM *system, unsigned int handle, const FMOD_DSP_DESCRIPTION **description); +FMOD_RESULT F_API FMOD_System_RegisterCodec (FMOD_SYSTEM *system, FMOD_CODEC_DESCRIPTION *description, unsigned int *handle, unsigned int priority); +FMOD_RESULT F_API FMOD_System_RegisterDSP (FMOD_SYSTEM *system, const FMOD_DSP_DESCRIPTION *description, unsigned int *handle); +FMOD_RESULT F_API FMOD_System_RegisterOutput (FMOD_SYSTEM *system, const FMOD_OUTPUT_DESCRIPTION *description, unsigned int *handle); + +/* Init/Close. */ +FMOD_RESULT F_API FMOD_System_Init (FMOD_SYSTEM *system, int maxchannels, FMOD_INITFLAGS flags, void *extradriverdata); +FMOD_RESULT F_API FMOD_System_Close (FMOD_SYSTEM *system); + +/* General post-init system functions. */ +FMOD_RESULT F_API FMOD_System_Update (FMOD_SYSTEM *system); +FMOD_RESULT F_API FMOD_System_SetSpeakerPosition (FMOD_SYSTEM *system, FMOD_SPEAKER speaker, float x, float y, FMOD_BOOL active); +FMOD_RESULT F_API FMOD_System_GetSpeakerPosition (FMOD_SYSTEM *system, FMOD_SPEAKER speaker, float *x, float *y, FMOD_BOOL *active); +FMOD_RESULT F_API FMOD_System_SetStreamBufferSize (FMOD_SYSTEM *system, unsigned int filebuffersize, FMOD_TIMEUNIT filebuffersizetype); +FMOD_RESULT F_API FMOD_System_GetStreamBufferSize (FMOD_SYSTEM *system, unsigned int *filebuffersize, FMOD_TIMEUNIT *filebuffersizetype); +FMOD_RESULT F_API FMOD_System_Set3DSettings (FMOD_SYSTEM *system, float dopplerscale, float distancefactor, float rolloffscale); +FMOD_RESULT F_API FMOD_System_Get3DSettings (FMOD_SYSTEM *system, float *dopplerscale, float *distancefactor, float *rolloffscale); +FMOD_RESULT F_API FMOD_System_Set3DNumListeners (FMOD_SYSTEM *system, int numlisteners); +FMOD_RESULT F_API FMOD_System_Get3DNumListeners (FMOD_SYSTEM *system, int *numlisteners); +FMOD_RESULT F_API FMOD_System_Set3DListenerAttributes (FMOD_SYSTEM *system, int listener, const FMOD_VECTOR *pos, const FMOD_VECTOR *vel, const FMOD_VECTOR *forward, const FMOD_VECTOR *up); +FMOD_RESULT F_API FMOD_System_Get3DListenerAttributes (FMOD_SYSTEM *system, int listener, FMOD_VECTOR *pos, FMOD_VECTOR *vel, FMOD_VECTOR *forward, FMOD_VECTOR *up); +FMOD_RESULT F_API FMOD_System_Set3DRolloffCallback (FMOD_SYSTEM *system, FMOD_3D_ROLLOFF_CALLBACK callback); +FMOD_RESULT F_API FMOD_System_MixerSuspend (FMOD_SYSTEM *system); +FMOD_RESULT F_API FMOD_System_MixerResume (FMOD_SYSTEM *system); +FMOD_RESULT F_API FMOD_System_GetDefaultMixMatrix (FMOD_SYSTEM *system, FMOD_SPEAKERMODE sourcespeakermode, FMOD_SPEAKERMODE targetspeakermode, float *matrix, int matrixhop); +FMOD_RESULT F_API FMOD_System_GetSpeakerModeChannels (FMOD_SYSTEM *system, FMOD_SPEAKERMODE mode, int *channels); + +/* System information functions. */ +FMOD_RESULT F_API FMOD_System_GetVersion (FMOD_SYSTEM *system, unsigned int *version); +FMOD_RESULT F_API FMOD_System_GetOutputHandle (FMOD_SYSTEM *system, void **handle); +FMOD_RESULT F_API FMOD_System_GetChannelsPlaying (FMOD_SYSTEM *system, int *channels, int *realchannels); +FMOD_RESULT F_API FMOD_System_GetCPUUsage (FMOD_SYSTEM *system, FMOD_CPU_USAGE *usage); +FMOD_RESULT F_API FMOD_System_GetFileUsage (FMOD_SYSTEM *system, long long *sampleBytesRead, long long *streamBytesRead, long long *otherBytesRead); + +/* Sound/DSP/Channel/FX creation and retrieval. */ +FMOD_RESULT F_API FMOD_System_CreateSound (FMOD_SYSTEM *system, const char *name_or_data, FMOD_MODE mode, FMOD_CREATESOUNDEXINFO *exinfo, FMOD_SOUND **sound); +FMOD_RESULT F_API FMOD_System_CreateStream (FMOD_SYSTEM *system, const char *name_or_data, FMOD_MODE mode, FMOD_CREATESOUNDEXINFO *exinfo, FMOD_SOUND **sound); +FMOD_RESULT F_API FMOD_System_CreateDSP (FMOD_SYSTEM *system, const FMOD_DSP_DESCRIPTION *description, FMOD_DSP **dsp); +FMOD_RESULT F_API FMOD_System_CreateDSPByType (FMOD_SYSTEM *system, FMOD_DSP_TYPE type, FMOD_DSP **dsp); +FMOD_RESULT F_API FMOD_System_CreateChannelGroup (FMOD_SYSTEM *system, const char *name, FMOD_CHANNELGROUP **channelgroup); +FMOD_RESULT F_API FMOD_System_CreateSoundGroup (FMOD_SYSTEM *system, const char *name, FMOD_SOUNDGROUP **soundgroup); +FMOD_RESULT F_API FMOD_System_CreateReverb3D (FMOD_SYSTEM *system, FMOD_REVERB3D **reverb); +FMOD_RESULT F_API FMOD_System_PlaySound (FMOD_SYSTEM *system, FMOD_SOUND *sound, FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL paused, FMOD_CHANNEL **channel); +FMOD_RESULT F_API FMOD_System_PlayDSP (FMOD_SYSTEM *system, FMOD_DSP *dsp, FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL paused, FMOD_CHANNEL **channel); +FMOD_RESULT F_API FMOD_System_GetChannel (FMOD_SYSTEM *system, int channelid, FMOD_CHANNEL **channel); +FMOD_RESULT F_API FMOD_System_GetDSPInfoByType (FMOD_SYSTEM *system, FMOD_DSP_TYPE type, const FMOD_DSP_DESCRIPTION **description); +FMOD_RESULT F_API FMOD_System_GetMasterChannelGroup (FMOD_SYSTEM *system, FMOD_CHANNELGROUP **channelgroup); +FMOD_RESULT F_API FMOD_System_GetMasterSoundGroup (FMOD_SYSTEM *system, FMOD_SOUNDGROUP **soundgroup); + +/* Routing to ports. */ +FMOD_RESULT F_API FMOD_System_AttachChannelGroupToPort (FMOD_SYSTEM *system, FMOD_PORT_TYPE portType, FMOD_PORT_INDEX portIndex, FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL passThru); +FMOD_RESULT F_API FMOD_System_DetachChannelGroupFromPort(FMOD_SYSTEM *system, FMOD_CHANNELGROUP *channelgroup); + +/* Reverb API. */ +FMOD_RESULT F_API FMOD_System_SetReverbProperties (FMOD_SYSTEM *system, int instance, const FMOD_REVERB_PROPERTIES *prop); +FMOD_RESULT F_API FMOD_System_GetReverbProperties (FMOD_SYSTEM *system, int instance, FMOD_REVERB_PROPERTIES *prop); + +/* System level DSP functionality. */ +FMOD_RESULT F_API FMOD_System_LockDSP (FMOD_SYSTEM *system); +FMOD_RESULT F_API FMOD_System_UnlockDSP (FMOD_SYSTEM *system); + +/* Recording API. */ +FMOD_RESULT F_API FMOD_System_GetRecordNumDrivers (FMOD_SYSTEM *system, int *numdrivers, int *numconnected); +FMOD_RESULT F_API FMOD_System_GetRecordDriverInfo (FMOD_SYSTEM *system, int id, char *name, int namelen, FMOD_GUID *guid, int *systemrate, FMOD_SPEAKERMODE *speakermode, int *speakermodechannels, FMOD_DRIVER_STATE *state); +FMOD_RESULT F_API FMOD_System_GetRecordPosition (FMOD_SYSTEM *system, int id, unsigned int *position); +FMOD_RESULT F_API FMOD_System_RecordStart (FMOD_SYSTEM *system, int id, FMOD_SOUND *sound, FMOD_BOOL loop); +FMOD_RESULT F_API FMOD_System_RecordStop (FMOD_SYSTEM *system, int id); +FMOD_RESULT F_API FMOD_System_IsRecording (FMOD_SYSTEM *system, int id, FMOD_BOOL *recording); + +/* Geometry API. */ +FMOD_RESULT F_API FMOD_System_CreateGeometry (FMOD_SYSTEM *system, int maxpolygons, int maxvertices, FMOD_GEOMETRY **geometry); +FMOD_RESULT F_API FMOD_System_SetGeometrySettings (FMOD_SYSTEM *system, float maxworldsize); +FMOD_RESULT F_API FMOD_System_GetGeometrySettings (FMOD_SYSTEM *system, float *maxworldsize); +FMOD_RESULT F_API FMOD_System_LoadGeometry (FMOD_SYSTEM *system, const void *data, int datasize, FMOD_GEOMETRY **geometry); +FMOD_RESULT F_API FMOD_System_GetGeometryOcclusion (FMOD_SYSTEM *system, const FMOD_VECTOR *listener, const FMOD_VECTOR *source, float *direct, float *reverb); + +/* Network functions. */ +FMOD_RESULT F_API FMOD_System_SetNetworkProxy (FMOD_SYSTEM *system, const char *proxy); +FMOD_RESULT F_API FMOD_System_GetNetworkProxy (FMOD_SYSTEM *system, char *proxy, int proxylen); +FMOD_RESULT F_API FMOD_System_SetNetworkTimeout (FMOD_SYSTEM *system, int timeout); +FMOD_RESULT F_API FMOD_System_GetNetworkTimeout (FMOD_SYSTEM *system, int *timeout); + +/* Userdata set/get. */ +FMOD_RESULT F_API FMOD_System_SetUserData (FMOD_SYSTEM *system, void *userdata); +FMOD_RESULT F_API FMOD_System_GetUserData (FMOD_SYSTEM *system, void **userdata); + +/* Sound API +*/ + +FMOD_RESULT F_API FMOD_Sound_Release (FMOD_SOUND *sound); +FMOD_RESULT F_API FMOD_Sound_GetSystemObject (FMOD_SOUND *sound, FMOD_SYSTEM **system); + +/* + Standard sound manipulation functions. +*/ + +FMOD_RESULT F_API FMOD_Sound_Lock (FMOD_SOUND *sound, unsigned int offset, unsigned int length, void **ptr1, void **ptr2, unsigned int *len1, unsigned int *len2); +FMOD_RESULT F_API FMOD_Sound_Unlock (FMOD_SOUND *sound, void *ptr1, void *ptr2, unsigned int len1, unsigned int len2); +FMOD_RESULT F_API FMOD_Sound_SetDefaults (FMOD_SOUND *sound, float frequency, int priority); +FMOD_RESULT F_API FMOD_Sound_GetDefaults (FMOD_SOUND *sound, float *frequency, int *priority); +FMOD_RESULT F_API FMOD_Sound_Set3DMinMaxDistance (FMOD_SOUND *sound, float min, float max); +FMOD_RESULT F_API FMOD_Sound_Get3DMinMaxDistance (FMOD_SOUND *sound, float *min, float *max); +FMOD_RESULT F_API FMOD_Sound_Set3DConeSettings (FMOD_SOUND *sound, float insideconeangle, float outsideconeangle, float outsidevolume); +FMOD_RESULT F_API FMOD_Sound_Get3DConeSettings (FMOD_SOUND *sound, float *insideconeangle, float *outsideconeangle, float *outsidevolume); +FMOD_RESULT F_API FMOD_Sound_Set3DCustomRolloff (FMOD_SOUND *sound, FMOD_VECTOR *points, int numpoints); +FMOD_RESULT F_API FMOD_Sound_Get3DCustomRolloff (FMOD_SOUND *sound, FMOD_VECTOR **points, int *numpoints); +FMOD_RESULT F_API FMOD_Sound_GetSubSound (FMOD_SOUND *sound, int index, FMOD_SOUND **subsound); +FMOD_RESULT F_API FMOD_Sound_GetSubSoundParent (FMOD_SOUND *sound, FMOD_SOUND **parentsound); +FMOD_RESULT F_API FMOD_Sound_GetName (FMOD_SOUND *sound, char *name, int namelen); +FMOD_RESULT F_API FMOD_Sound_GetLength (FMOD_SOUND *sound, unsigned int *length, FMOD_TIMEUNIT lengthtype); +FMOD_RESULT F_API FMOD_Sound_GetFormat (FMOD_SOUND *sound, FMOD_SOUND_TYPE *type, FMOD_SOUND_FORMAT *format, int *channels, int *bits); +FMOD_RESULT F_API FMOD_Sound_GetNumSubSounds (FMOD_SOUND *sound, int *numsubsounds); +FMOD_RESULT F_API FMOD_Sound_GetNumTags (FMOD_SOUND *sound, int *numtags, int *numtagsupdated); +FMOD_RESULT F_API FMOD_Sound_GetTag (FMOD_SOUND *sound, const char *name, int index, FMOD_TAG *tag); +FMOD_RESULT F_API FMOD_Sound_GetOpenState (FMOD_SOUND *sound, FMOD_OPENSTATE *openstate, unsigned int *percentbuffered, FMOD_BOOL *starving, FMOD_BOOL *diskbusy); +FMOD_RESULT F_API FMOD_Sound_ReadData (FMOD_SOUND *sound, void *buffer, unsigned int length, unsigned int *read); +FMOD_RESULT F_API FMOD_Sound_SeekData (FMOD_SOUND *sound, unsigned int pcm); + +FMOD_RESULT F_API FMOD_Sound_SetSoundGroup (FMOD_SOUND *sound, FMOD_SOUNDGROUP *soundgroup); +FMOD_RESULT F_API FMOD_Sound_GetSoundGroup (FMOD_SOUND *sound, FMOD_SOUNDGROUP **soundgroup); + +/* + Synchronization point API. These points can come from markers embedded in wav files, and can also generate channel callbacks. +*/ + +FMOD_RESULT F_API FMOD_Sound_GetNumSyncPoints (FMOD_SOUND *sound, int *numsyncpoints); +FMOD_RESULT F_API FMOD_Sound_GetSyncPoint (FMOD_SOUND *sound, int index, FMOD_SYNCPOINT **point); +FMOD_RESULT F_API FMOD_Sound_GetSyncPointInfo (FMOD_SOUND *sound, FMOD_SYNCPOINT *point, char *name, int namelen, unsigned int *offset, FMOD_TIMEUNIT offsettype); +FMOD_RESULT F_API FMOD_Sound_AddSyncPoint (FMOD_SOUND *sound, unsigned int offset, FMOD_TIMEUNIT offsettype, const char *name, FMOD_SYNCPOINT **point); +FMOD_RESULT F_API FMOD_Sound_DeleteSyncPoint (FMOD_SOUND *sound, FMOD_SYNCPOINT *point); + +/* + Functions also in Channel class but here they are the 'default' to save having to change it in Channel all the time. +*/ + +FMOD_RESULT F_API FMOD_Sound_SetMode (FMOD_SOUND *sound, FMOD_MODE mode); +FMOD_RESULT F_API FMOD_Sound_GetMode (FMOD_SOUND *sound, FMOD_MODE *mode); +FMOD_RESULT F_API FMOD_Sound_SetLoopCount (FMOD_SOUND *sound, int loopcount); +FMOD_RESULT F_API FMOD_Sound_GetLoopCount (FMOD_SOUND *sound, int *loopcount); +FMOD_RESULT F_API FMOD_Sound_SetLoopPoints (FMOD_SOUND *sound, unsigned int loopstart, FMOD_TIMEUNIT loopstarttype, unsigned int loopend, FMOD_TIMEUNIT loopendtype); +FMOD_RESULT F_API FMOD_Sound_GetLoopPoints (FMOD_SOUND *sound, unsigned int *loopstart, FMOD_TIMEUNIT loopstarttype, unsigned int *loopend, FMOD_TIMEUNIT loopendtype); + +/* + For MOD/S3M/XM/IT/MID sequenced formats only. +*/ + +FMOD_RESULT F_API FMOD_Sound_GetMusicNumChannels (FMOD_SOUND *sound, int *numchannels); +FMOD_RESULT F_API FMOD_Sound_SetMusicChannelVolume (FMOD_SOUND *sound, int channel, float volume); +FMOD_RESULT F_API FMOD_Sound_GetMusicChannelVolume (FMOD_SOUND *sound, int channel, float *volume); +FMOD_RESULT F_API FMOD_Sound_SetMusicSpeed (FMOD_SOUND *sound, float speed); +FMOD_RESULT F_API FMOD_Sound_GetMusicSpeed (FMOD_SOUND *sound, float *speed); + +/* + Userdata set/get. +*/ + +FMOD_RESULT F_API FMOD_Sound_SetUserData (FMOD_SOUND *sound, void *userdata); +FMOD_RESULT F_API FMOD_Sound_GetUserData (FMOD_SOUND *sound, void **userdata); + +/* + 'Channel' API +*/ + +FMOD_RESULT F_API FMOD_Channel_GetSystemObject (FMOD_CHANNEL *channel, FMOD_SYSTEM **system); + +/* + General control functionality for Channels and ChannelGroups. +*/ + +FMOD_RESULT F_API FMOD_Channel_Stop (FMOD_CHANNEL *channel); +FMOD_RESULT F_API FMOD_Channel_SetPaused (FMOD_CHANNEL *channel, FMOD_BOOL paused); +FMOD_RESULT F_API FMOD_Channel_GetPaused (FMOD_CHANNEL *channel, FMOD_BOOL *paused); +FMOD_RESULT F_API FMOD_Channel_SetVolume (FMOD_CHANNEL *channel, float volume); +FMOD_RESULT F_API FMOD_Channel_GetVolume (FMOD_CHANNEL *channel, float *volume); +FMOD_RESULT F_API FMOD_Channel_SetVolumeRamp (FMOD_CHANNEL *channel, FMOD_BOOL ramp); +FMOD_RESULT F_API FMOD_Channel_GetVolumeRamp (FMOD_CHANNEL *channel, FMOD_BOOL *ramp); +FMOD_RESULT F_API FMOD_Channel_GetAudibility (FMOD_CHANNEL *channel, float *audibility); +FMOD_RESULT F_API FMOD_Channel_SetPitch (FMOD_CHANNEL *channel, float pitch); +FMOD_RESULT F_API FMOD_Channel_GetPitch (FMOD_CHANNEL *channel, float *pitch); +FMOD_RESULT F_API FMOD_Channel_SetMute (FMOD_CHANNEL *channel, FMOD_BOOL mute); +FMOD_RESULT F_API FMOD_Channel_GetMute (FMOD_CHANNEL *channel, FMOD_BOOL *mute); +FMOD_RESULT F_API FMOD_Channel_SetReverbProperties (FMOD_CHANNEL *channel, int instance, float wet); +FMOD_RESULT F_API FMOD_Channel_GetReverbProperties (FMOD_CHANNEL *channel, int instance, float *wet); +FMOD_RESULT F_API FMOD_Channel_SetLowPassGain (FMOD_CHANNEL *channel, float gain); +FMOD_RESULT F_API FMOD_Channel_GetLowPassGain (FMOD_CHANNEL *channel, float *gain); +FMOD_RESULT F_API FMOD_Channel_SetMode (FMOD_CHANNEL *channel, FMOD_MODE mode); +FMOD_RESULT F_API FMOD_Channel_GetMode (FMOD_CHANNEL *channel, FMOD_MODE *mode); +FMOD_RESULT F_API FMOD_Channel_SetCallback (FMOD_CHANNEL *channel, FMOD_CHANNELCONTROL_CALLBACK callback); +FMOD_RESULT F_API FMOD_Channel_IsPlaying (FMOD_CHANNEL *channel, FMOD_BOOL *isplaying); + +/* + Note all 'set' functions alter a final matrix, this is why the only get function is getMixMatrix, to avoid other get functions returning incorrect/obsolete values. +*/ + +FMOD_RESULT F_API FMOD_Channel_SetPan (FMOD_CHANNEL *channel, float pan); +FMOD_RESULT F_API FMOD_Channel_SetMixLevelsOutput (FMOD_CHANNEL *channel, float frontleft, float frontright, float center, float lfe, float surroundleft, float surroundright, float backleft, float backright); +FMOD_RESULT F_API FMOD_Channel_SetMixLevelsInput (FMOD_CHANNEL *channel, float *levels, int numlevels); +FMOD_RESULT F_API FMOD_Channel_SetMixMatrix (FMOD_CHANNEL *channel, float *matrix, int outchannels, int inchannels, int inchannel_hop); +FMOD_RESULT F_API FMOD_Channel_GetMixMatrix (FMOD_CHANNEL *channel, float *matrix, int *outchannels, int *inchannels, int inchannel_hop); + +/* + Clock based functionality. +*/ + +FMOD_RESULT F_API FMOD_Channel_GetDSPClock (FMOD_CHANNEL *channel, unsigned long long *dspclock, unsigned long long *parentclock); +FMOD_RESULT F_API FMOD_Channel_SetDelay (FMOD_CHANNEL *channel, unsigned long long dspclock_start, unsigned long long dspclock_end, FMOD_BOOL stopchannels); +FMOD_RESULT F_API FMOD_Channel_GetDelay (FMOD_CHANNEL *channel, unsigned long long *dspclock_start, unsigned long long *dspclock_end, FMOD_BOOL *stopchannels); +FMOD_RESULT F_API FMOD_Channel_AddFadePoint (FMOD_CHANNEL *channel, unsigned long long dspclock, float volume); +FMOD_RESULT F_API FMOD_Channel_SetFadePointRamp (FMOD_CHANNEL *channel, unsigned long long dspclock, float volume); +FMOD_RESULT F_API FMOD_Channel_RemoveFadePoints (FMOD_CHANNEL *channel, unsigned long long dspclock_start, unsigned long long dspclock_end); +FMOD_RESULT F_API FMOD_Channel_GetFadePoints (FMOD_CHANNEL *channel, unsigned int *numpoints, unsigned long long *point_dspclock, float *point_volume); + +/* + DSP effects. +*/ + +FMOD_RESULT F_API FMOD_Channel_GetDSP (FMOD_CHANNEL *channel, int index, FMOD_DSP **dsp); +FMOD_RESULT F_API FMOD_Channel_AddDSP (FMOD_CHANNEL *channel, int index, FMOD_DSP *dsp); +FMOD_RESULT F_API FMOD_Channel_RemoveDSP (FMOD_CHANNEL *channel, FMOD_DSP *dsp); +FMOD_RESULT F_API FMOD_Channel_GetNumDSPs (FMOD_CHANNEL *channel, int *numdsps); +FMOD_RESULT F_API FMOD_Channel_SetDSPIndex (FMOD_CHANNEL *channel, FMOD_DSP *dsp, int index); +FMOD_RESULT F_API FMOD_Channel_GetDSPIndex (FMOD_CHANNEL *channel, FMOD_DSP *dsp, int *index); + +/* + 3D functionality. +*/ + +FMOD_RESULT F_API FMOD_Channel_Set3DAttributes (FMOD_CHANNEL *channel, const FMOD_VECTOR *pos, const FMOD_VECTOR *vel); +FMOD_RESULT F_API FMOD_Channel_Get3DAttributes (FMOD_CHANNEL *channel, FMOD_VECTOR *pos, FMOD_VECTOR *vel); +FMOD_RESULT F_API FMOD_Channel_Set3DMinMaxDistance (FMOD_CHANNEL *channel, float mindistance, float maxdistance); +FMOD_RESULT F_API FMOD_Channel_Get3DMinMaxDistance (FMOD_CHANNEL *channel, float *mindistance, float *maxdistance); +FMOD_RESULT F_API FMOD_Channel_Set3DConeSettings (FMOD_CHANNEL *channel, float insideconeangle, float outsideconeangle, float outsidevolume); +FMOD_RESULT F_API FMOD_Channel_Get3DConeSettings (FMOD_CHANNEL *channel, float *insideconeangle, float *outsideconeangle, float *outsidevolume); +FMOD_RESULT F_API FMOD_Channel_Set3DConeOrientation (FMOD_CHANNEL *channel, FMOD_VECTOR *orientation); +FMOD_RESULT F_API FMOD_Channel_Get3DConeOrientation (FMOD_CHANNEL *channel, FMOD_VECTOR *orientation); +FMOD_RESULT F_API FMOD_Channel_Set3DCustomRolloff (FMOD_CHANNEL *channel, FMOD_VECTOR *points, int numpoints); +FMOD_RESULT F_API FMOD_Channel_Get3DCustomRolloff (FMOD_CHANNEL *channel, FMOD_VECTOR **points, int *numpoints); +FMOD_RESULT F_API FMOD_Channel_Set3DOcclusion (FMOD_CHANNEL *channel, float directocclusion, float reverbocclusion); +FMOD_RESULT F_API FMOD_Channel_Get3DOcclusion (FMOD_CHANNEL *channel, float *directocclusion, float *reverbocclusion); +FMOD_RESULT F_API FMOD_Channel_Set3DSpread (FMOD_CHANNEL *channel, float angle); +FMOD_RESULT F_API FMOD_Channel_Get3DSpread (FMOD_CHANNEL *channel, float *angle); +FMOD_RESULT F_API FMOD_Channel_Set3DLevel (FMOD_CHANNEL *channel, float level); +FMOD_RESULT F_API FMOD_Channel_Get3DLevel (FMOD_CHANNEL *channel, float *level); +FMOD_RESULT F_API FMOD_Channel_Set3DDopplerLevel (FMOD_CHANNEL *channel, float level); +FMOD_RESULT F_API FMOD_Channel_Get3DDopplerLevel (FMOD_CHANNEL *channel, float *level); +FMOD_RESULT F_API FMOD_Channel_Set3DDistanceFilter (FMOD_CHANNEL *channel, FMOD_BOOL custom, float customLevel, float centerFreq); +FMOD_RESULT F_API FMOD_Channel_Get3DDistanceFilter (FMOD_CHANNEL *channel, FMOD_BOOL *custom, float *customLevel, float *centerFreq); + +/* + Userdata set/get. +*/ + +FMOD_RESULT F_API FMOD_Channel_SetUserData (FMOD_CHANNEL *channel, void *userdata); +FMOD_RESULT F_API FMOD_Channel_GetUserData (FMOD_CHANNEL *channel, void **userdata); + +/* + Channel specific control functionality. +*/ + +FMOD_RESULT F_API FMOD_Channel_SetFrequency (FMOD_CHANNEL *channel, float frequency); +FMOD_RESULT F_API FMOD_Channel_GetFrequency (FMOD_CHANNEL *channel, float *frequency); +FMOD_RESULT F_API FMOD_Channel_SetPriority (FMOD_CHANNEL *channel, int priority); +FMOD_RESULT F_API FMOD_Channel_GetPriority (FMOD_CHANNEL *channel, int *priority); +FMOD_RESULT F_API FMOD_Channel_SetPosition (FMOD_CHANNEL *channel, unsigned int position, FMOD_TIMEUNIT postype); +FMOD_RESULT F_API FMOD_Channel_GetPosition (FMOD_CHANNEL *channel, unsigned int *position, FMOD_TIMEUNIT postype); +FMOD_RESULT F_API FMOD_Channel_SetChannelGroup (FMOD_CHANNEL *channel, FMOD_CHANNELGROUP *channelgroup); +FMOD_RESULT F_API FMOD_Channel_GetChannelGroup (FMOD_CHANNEL *channel, FMOD_CHANNELGROUP **channelgroup); +FMOD_RESULT F_API FMOD_Channel_SetLoopCount (FMOD_CHANNEL *channel, int loopcount); +FMOD_RESULT F_API FMOD_Channel_GetLoopCount (FMOD_CHANNEL *channel, int *loopcount); +FMOD_RESULT F_API FMOD_Channel_SetLoopPoints (FMOD_CHANNEL *channel, unsigned int loopstart, FMOD_TIMEUNIT loopstarttype, unsigned int loopend, FMOD_TIMEUNIT loopendtype); +FMOD_RESULT F_API FMOD_Channel_GetLoopPoints (FMOD_CHANNEL *channel, unsigned int *loopstart, FMOD_TIMEUNIT loopstarttype, unsigned int *loopend, FMOD_TIMEUNIT loopendtype); + +/* + Information only functions. +*/ + +FMOD_RESULT F_API FMOD_Channel_IsVirtual (FMOD_CHANNEL *channel, FMOD_BOOL *isvirtual); +FMOD_RESULT F_API FMOD_Channel_GetCurrentSound (FMOD_CHANNEL *channel, FMOD_SOUND **sound); +FMOD_RESULT F_API FMOD_Channel_GetIndex (FMOD_CHANNEL *channel, int *index); + +/* + 'ChannelGroup' API +*/ + +FMOD_RESULT F_API FMOD_ChannelGroup_GetSystemObject (FMOD_CHANNELGROUP *channelgroup, FMOD_SYSTEM **system); + +/* + General control functionality for Channels and ChannelGroups. +*/ + +FMOD_RESULT F_API FMOD_ChannelGroup_Stop (FMOD_CHANNELGROUP *channelgroup); +FMOD_RESULT F_API FMOD_ChannelGroup_SetPaused (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL paused); +FMOD_RESULT F_API FMOD_ChannelGroup_GetPaused (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL *paused); +FMOD_RESULT F_API FMOD_ChannelGroup_SetVolume (FMOD_CHANNELGROUP *channelgroup, float volume); +FMOD_RESULT F_API FMOD_ChannelGroup_GetVolume (FMOD_CHANNELGROUP *channelgroup, float *volume); +FMOD_RESULT F_API FMOD_ChannelGroup_SetVolumeRamp (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL ramp); +FMOD_RESULT F_API FMOD_ChannelGroup_GetVolumeRamp (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL *ramp); +FMOD_RESULT F_API FMOD_ChannelGroup_GetAudibility (FMOD_CHANNELGROUP *channelgroup, float *audibility); +FMOD_RESULT F_API FMOD_ChannelGroup_SetPitch (FMOD_CHANNELGROUP *channelgroup, float pitch); +FMOD_RESULT F_API FMOD_ChannelGroup_GetPitch (FMOD_CHANNELGROUP *channelgroup, float *pitch); +FMOD_RESULT F_API FMOD_ChannelGroup_SetMute (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL mute); +FMOD_RESULT F_API FMOD_ChannelGroup_GetMute (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL *mute); +FMOD_RESULT F_API FMOD_ChannelGroup_SetReverbProperties (FMOD_CHANNELGROUP *channelgroup, int instance, float wet); +FMOD_RESULT F_API FMOD_ChannelGroup_GetReverbProperties (FMOD_CHANNELGROUP *channelgroup, int instance, float *wet); +FMOD_RESULT F_API FMOD_ChannelGroup_SetLowPassGain (FMOD_CHANNELGROUP *channelgroup, float gain); +FMOD_RESULT F_API FMOD_ChannelGroup_GetLowPassGain (FMOD_CHANNELGROUP *channelgroup, float *gain); +FMOD_RESULT F_API FMOD_ChannelGroup_SetMode (FMOD_CHANNELGROUP *channelgroup, FMOD_MODE mode); +FMOD_RESULT F_API FMOD_ChannelGroup_GetMode (FMOD_CHANNELGROUP *channelgroup, FMOD_MODE *mode); +FMOD_RESULT F_API FMOD_ChannelGroup_SetCallback (FMOD_CHANNELGROUP *channelgroup, FMOD_CHANNELCONTROL_CALLBACK callback); +FMOD_RESULT F_API FMOD_ChannelGroup_IsPlaying (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL *isplaying); + +/* + Note all 'set' functions alter a final matrix, this is why the only get function is getMixMatrix, to avoid other get functions returning incorrect/obsolete values. +*/ + +FMOD_RESULT F_API FMOD_ChannelGroup_SetPan (FMOD_CHANNELGROUP *channelgroup, float pan); +FMOD_RESULT F_API FMOD_ChannelGroup_SetMixLevelsOutput (FMOD_CHANNELGROUP *channelgroup, float frontleft, float frontright, float center, float lfe, float surroundleft, float surroundright, float backleft, float backright); +FMOD_RESULT F_API FMOD_ChannelGroup_SetMixLevelsInput (FMOD_CHANNELGROUP *channelgroup, float *levels, int numlevels); +FMOD_RESULT F_API FMOD_ChannelGroup_SetMixMatrix (FMOD_CHANNELGROUP *channelgroup, float *matrix, int outchannels, int inchannels, int inchannel_hop); +FMOD_RESULT F_API FMOD_ChannelGroup_GetMixMatrix (FMOD_CHANNELGROUP *channelgroup, float *matrix, int *outchannels, int *inchannels, int inchannel_hop); + +/* + Clock based functionality. +*/ + +FMOD_RESULT F_API FMOD_ChannelGroup_GetDSPClock (FMOD_CHANNELGROUP *channelgroup, unsigned long long *dspclock, unsigned long long *parentclock); +FMOD_RESULT F_API FMOD_ChannelGroup_SetDelay (FMOD_CHANNELGROUP *channelgroup, unsigned long long dspclock_start, unsigned long long dspclock_end, FMOD_BOOL stopchannels); +FMOD_RESULT F_API FMOD_ChannelGroup_GetDelay (FMOD_CHANNELGROUP *channelgroup, unsigned long long *dspclock_start, unsigned long long *dspclock_end, FMOD_BOOL *stopchannels); +FMOD_RESULT F_API FMOD_ChannelGroup_AddFadePoint (FMOD_CHANNELGROUP *channelgroup, unsigned long long dspclock, float volume); +FMOD_RESULT F_API FMOD_ChannelGroup_SetFadePointRamp (FMOD_CHANNELGROUP *channelgroup, unsigned long long dspclock, float volume); +FMOD_RESULT F_API FMOD_ChannelGroup_RemoveFadePoints (FMOD_CHANNELGROUP *channelgroup, unsigned long long dspclock_start, unsigned long long dspclock_end); +FMOD_RESULT F_API FMOD_ChannelGroup_GetFadePoints (FMOD_CHANNELGROUP *channelgroup, unsigned int *numpoints, unsigned long long *point_dspclock, float *point_volume); + +/* + DSP effects. +*/ + +FMOD_RESULT F_API FMOD_ChannelGroup_GetDSP (FMOD_CHANNELGROUP *channelgroup, int index, FMOD_DSP **dsp); +FMOD_RESULT F_API FMOD_ChannelGroup_AddDSP (FMOD_CHANNELGROUP *channelgroup, int index, FMOD_DSP *dsp); +FMOD_RESULT F_API FMOD_ChannelGroup_RemoveDSP (FMOD_CHANNELGROUP *channelgroup, FMOD_DSP *dsp); +FMOD_RESULT F_API FMOD_ChannelGroup_GetNumDSPs (FMOD_CHANNELGROUP *channelgroup, int *numdsps); +FMOD_RESULT F_API FMOD_ChannelGroup_SetDSPIndex (FMOD_CHANNELGROUP *channelgroup, FMOD_DSP *dsp, int index); +FMOD_RESULT F_API FMOD_ChannelGroup_GetDSPIndex (FMOD_CHANNELGROUP *channelgroup, FMOD_DSP *dsp, int *index); + +/* + 3D functionality. +*/ + +FMOD_RESULT F_API FMOD_ChannelGroup_Set3DAttributes (FMOD_CHANNELGROUP *channelgroup, const FMOD_VECTOR *pos, const FMOD_VECTOR *vel); +FMOD_RESULT F_API FMOD_ChannelGroup_Get3DAttributes (FMOD_CHANNELGROUP *channelgroup, FMOD_VECTOR *pos, FMOD_VECTOR *vel); +FMOD_RESULT F_API FMOD_ChannelGroup_Set3DMinMaxDistance (FMOD_CHANNELGROUP *channelgroup, float mindistance, float maxdistance); +FMOD_RESULT F_API FMOD_ChannelGroup_Get3DMinMaxDistance (FMOD_CHANNELGROUP *channelgroup, float *mindistance, float *maxdistance); +FMOD_RESULT F_API FMOD_ChannelGroup_Set3DConeSettings (FMOD_CHANNELGROUP *channelgroup, float insideconeangle, float outsideconeangle, float outsidevolume); +FMOD_RESULT F_API FMOD_ChannelGroup_Get3DConeSettings (FMOD_CHANNELGROUP *channelgroup, float *insideconeangle, float *outsideconeangle, float *outsidevolume); +FMOD_RESULT F_API FMOD_ChannelGroup_Set3DConeOrientation(FMOD_CHANNELGROUP *channelgroup, FMOD_VECTOR *orientation); +FMOD_RESULT F_API FMOD_ChannelGroup_Get3DConeOrientation(FMOD_CHANNELGROUP *channelgroup, FMOD_VECTOR *orientation); +FMOD_RESULT F_API FMOD_ChannelGroup_Set3DCustomRolloff (FMOD_CHANNELGROUP *channelgroup, FMOD_VECTOR *points, int numpoints); +FMOD_RESULT F_API FMOD_ChannelGroup_Get3DCustomRolloff (FMOD_CHANNELGROUP *channelgroup, FMOD_VECTOR **points, int *numpoints); +FMOD_RESULT F_API FMOD_ChannelGroup_Set3DOcclusion (FMOD_CHANNELGROUP *channelgroup, float directocclusion, float reverbocclusion); +FMOD_RESULT F_API FMOD_ChannelGroup_Get3DOcclusion (FMOD_CHANNELGROUP *channelgroup, float *directocclusion, float *reverbocclusion); +FMOD_RESULT F_API FMOD_ChannelGroup_Set3DSpread (FMOD_CHANNELGROUP *channelgroup, float angle); +FMOD_RESULT F_API FMOD_ChannelGroup_Get3DSpread (FMOD_CHANNELGROUP *channelgroup, float *angle); +FMOD_RESULT F_API FMOD_ChannelGroup_Set3DLevel (FMOD_CHANNELGROUP *channelgroup, float level); +FMOD_RESULT F_API FMOD_ChannelGroup_Get3DLevel (FMOD_CHANNELGROUP *channelgroup, float *level); +FMOD_RESULT F_API FMOD_ChannelGroup_Set3DDopplerLevel (FMOD_CHANNELGROUP *channelgroup, float level); +FMOD_RESULT F_API FMOD_ChannelGroup_Get3DDopplerLevel (FMOD_CHANNELGROUP *channelgroup, float *level); +FMOD_RESULT F_API FMOD_ChannelGroup_Set3DDistanceFilter (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL custom, float customLevel, float centerFreq); +FMOD_RESULT F_API FMOD_ChannelGroup_Get3DDistanceFilter (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL *custom, float *customLevel, float *centerFreq); + +/* + Userdata set/get. +*/ + +FMOD_RESULT F_API FMOD_ChannelGroup_SetUserData (FMOD_CHANNELGROUP *channelgroup, void *userdata); +FMOD_RESULT F_API FMOD_ChannelGroup_GetUserData (FMOD_CHANNELGROUP *channelgroup, void **userdata); + +FMOD_RESULT F_API FMOD_ChannelGroup_Release (FMOD_CHANNELGROUP *channelgroup); + +/* + Nested channel groups. +*/ + +FMOD_RESULT F_API FMOD_ChannelGroup_AddGroup (FMOD_CHANNELGROUP *channelgroup, FMOD_CHANNELGROUP *group, FMOD_BOOL propagatedspclock, FMOD_DSPCONNECTION **connection); +FMOD_RESULT F_API FMOD_ChannelGroup_GetNumGroups (FMOD_CHANNELGROUP *channelgroup, int *numgroups); +FMOD_RESULT F_API FMOD_ChannelGroup_GetGroup (FMOD_CHANNELGROUP *channelgroup, int index, FMOD_CHANNELGROUP **group); +FMOD_RESULT F_API FMOD_ChannelGroup_GetParentGroup (FMOD_CHANNELGROUP *channelgroup, FMOD_CHANNELGROUP **group); + +/* + Information only functions. +*/ + +FMOD_RESULT F_API FMOD_ChannelGroup_GetName (FMOD_CHANNELGROUP *channelgroup, char *name, int namelen); +FMOD_RESULT F_API FMOD_ChannelGroup_GetNumChannels (FMOD_CHANNELGROUP *channelgroup, int *numchannels); +FMOD_RESULT F_API FMOD_ChannelGroup_GetChannel (FMOD_CHANNELGROUP *channelgroup, int index, FMOD_CHANNEL **channel); + +/* + 'SoundGroup' API +*/ + +FMOD_RESULT F_API FMOD_SoundGroup_Release (FMOD_SOUNDGROUP *soundgroup); +FMOD_RESULT F_API FMOD_SoundGroup_GetSystemObject (FMOD_SOUNDGROUP *soundgroup, FMOD_SYSTEM **system); + +/* + SoundGroup control functions. +*/ + +FMOD_RESULT F_API FMOD_SoundGroup_SetMaxAudible (FMOD_SOUNDGROUP *soundgroup, int maxaudible); +FMOD_RESULT F_API FMOD_SoundGroup_GetMaxAudible (FMOD_SOUNDGROUP *soundgroup, int *maxaudible); +FMOD_RESULT F_API FMOD_SoundGroup_SetMaxAudibleBehavior (FMOD_SOUNDGROUP *soundgroup, FMOD_SOUNDGROUP_BEHAVIOR behavior); +FMOD_RESULT F_API FMOD_SoundGroup_GetMaxAudibleBehavior (FMOD_SOUNDGROUP *soundgroup, FMOD_SOUNDGROUP_BEHAVIOR *behavior); +FMOD_RESULT F_API FMOD_SoundGroup_SetMuteFadeSpeed (FMOD_SOUNDGROUP *soundgroup, float speed); +FMOD_RESULT F_API FMOD_SoundGroup_GetMuteFadeSpeed (FMOD_SOUNDGROUP *soundgroup, float *speed); +FMOD_RESULT F_API FMOD_SoundGroup_SetVolume (FMOD_SOUNDGROUP *soundgroup, float volume); +FMOD_RESULT F_API FMOD_SoundGroup_GetVolume (FMOD_SOUNDGROUP *soundgroup, float *volume); +FMOD_RESULT F_API FMOD_SoundGroup_Stop (FMOD_SOUNDGROUP *soundgroup); + +/* + Information only functions. +*/ + +FMOD_RESULT F_API FMOD_SoundGroup_GetName (FMOD_SOUNDGROUP *soundgroup, char *name, int namelen); +FMOD_RESULT F_API FMOD_SoundGroup_GetNumSounds (FMOD_SOUNDGROUP *soundgroup, int *numsounds); +FMOD_RESULT F_API FMOD_SoundGroup_GetSound (FMOD_SOUNDGROUP *soundgroup, int index, FMOD_SOUND **sound); +FMOD_RESULT F_API FMOD_SoundGroup_GetNumPlaying (FMOD_SOUNDGROUP *soundgroup, int *numplaying); + +/* + Userdata set/get. +*/ + +FMOD_RESULT F_API FMOD_SoundGroup_SetUserData (FMOD_SOUNDGROUP *soundgroup, void *userdata); +FMOD_RESULT F_API FMOD_SoundGroup_GetUserData (FMOD_SOUNDGROUP *soundgroup, void **userdata); + +/* + 'DSP' API +*/ + +FMOD_RESULT F_API FMOD_DSP_Release (FMOD_DSP *dsp); +FMOD_RESULT F_API FMOD_DSP_GetSystemObject (FMOD_DSP *dsp, FMOD_SYSTEM **system); + +/* + Connection / disconnection / input and output enumeration. +*/ + +FMOD_RESULT F_API FMOD_DSP_AddInput (FMOD_DSP *dsp, FMOD_DSP *input, FMOD_DSPCONNECTION **connection, FMOD_DSPCONNECTION_TYPE type); +FMOD_RESULT F_API FMOD_DSP_DisconnectFrom (FMOD_DSP *dsp, FMOD_DSP *target, FMOD_DSPCONNECTION *connection); +FMOD_RESULT F_API FMOD_DSP_DisconnectAll (FMOD_DSP *dsp, FMOD_BOOL inputs, FMOD_BOOL outputs); +FMOD_RESULT F_API FMOD_DSP_GetNumInputs (FMOD_DSP *dsp, int *numinputs); +FMOD_RESULT F_API FMOD_DSP_GetNumOutputs (FMOD_DSP *dsp, int *numoutputs); +FMOD_RESULT F_API FMOD_DSP_GetInput (FMOD_DSP *dsp, int index, FMOD_DSP **input, FMOD_DSPCONNECTION **inputconnection); +FMOD_RESULT F_API FMOD_DSP_GetOutput (FMOD_DSP *dsp, int index, FMOD_DSP **output, FMOD_DSPCONNECTION **outputconnection); + +/* + DSP unit control. +*/ + +FMOD_RESULT F_API FMOD_DSP_SetActive (FMOD_DSP *dsp, FMOD_BOOL active); +FMOD_RESULT F_API FMOD_DSP_GetActive (FMOD_DSP *dsp, FMOD_BOOL *active); +FMOD_RESULT F_API FMOD_DSP_SetBypass (FMOD_DSP *dsp, FMOD_BOOL bypass); +FMOD_RESULT F_API FMOD_DSP_GetBypass (FMOD_DSP *dsp, FMOD_BOOL *bypass); +FMOD_RESULT F_API FMOD_DSP_SetWetDryMix (FMOD_DSP *dsp, float prewet, float postwet, float dry); +FMOD_RESULT F_API FMOD_DSP_GetWetDryMix (FMOD_DSP *dsp, float *prewet, float *postwet, float *dry); +FMOD_RESULT F_API FMOD_DSP_SetChannelFormat (FMOD_DSP *dsp, FMOD_CHANNELMASK channelmask, int numchannels, FMOD_SPEAKERMODE source_speakermode); +FMOD_RESULT F_API FMOD_DSP_GetChannelFormat (FMOD_DSP *dsp, FMOD_CHANNELMASK *channelmask, int *numchannels, FMOD_SPEAKERMODE *source_speakermode); +FMOD_RESULT F_API FMOD_DSP_GetOutputChannelFormat (FMOD_DSP *dsp, FMOD_CHANNELMASK inmask, int inchannels, FMOD_SPEAKERMODE inspeakermode, FMOD_CHANNELMASK *outmask, int *outchannels, FMOD_SPEAKERMODE *outspeakermode); +FMOD_RESULT F_API FMOD_DSP_Reset (FMOD_DSP *dsp); + +/* + DSP parameter control. +*/ + +FMOD_RESULT F_API FMOD_DSP_SetParameterFloat (FMOD_DSP *dsp, int index, float value); +FMOD_RESULT F_API FMOD_DSP_SetParameterInt (FMOD_DSP *dsp, int index, int value); +FMOD_RESULT F_API FMOD_DSP_SetParameterBool (FMOD_DSP *dsp, int index, FMOD_BOOL value); +FMOD_RESULT F_API FMOD_DSP_SetParameterData (FMOD_DSP *dsp, int index, void *data, unsigned int length); +FMOD_RESULT F_API FMOD_DSP_GetParameterFloat (FMOD_DSP *dsp, int index, float *value, char *valuestr, int valuestrlen); +FMOD_RESULT F_API FMOD_DSP_GetParameterInt (FMOD_DSP *dsp, int index, int *value, char *valuestr, int valuestrlen); +FMOD_RESULT F_API FMOD_DSP_GetParameterBool (FMOD_DSP *dsp, int index, FMOD_BOOL *value, char *valuestr, int valuestrlen); +FMOD_RESULT F_API FMOD_DSP_GetParameterData (FMOD_DSP *dsp, int index, void **data, unsigned int *length, char *valuestr, int valuestrlen); +FMOD_RESULT F_API FMOD_DSP_GetNumParameters (FMOD_DSP *dsp, int *numparams); +FMOD_RESULT F_API FMOD_DSP_GetParameterInfo (FMOD_DSP *dsp, int index, FMOD_DSP_PARAMETER_DESC **desc); +FMOD_RESULT F_API FMOD_DSP_GetDataParameterIndex (FMOD_DSP *dsp, int datatype, int *index); +FMOD_RESULT F_API FMOD_DSP_ShowConfigDialog (FMOD_DSP *dsp, void *hwnd, FMOD_BOOL show); + +/* + DSP attributes. +*/ + +FMOD_RESULT F_API FMOD_DSP_GetInfo (FMOD_DSP *dsp, char *name, unsigned int *version, int *channels, int *configwidth, int *configheight); +FMOD_RESULT F_API FMOD_DSP_GetType (FMOD_DSP *dsp, FMOD_DSP_TYPE *type); +FMOD_RESULT F_API FMOD_DSP_GetIdle (FMOD_DSP *dsp, FMOD_BOOL *idle); + +/* + Userdata set/get. +*/ + +FMOD_RESULT F_API FMOD_DSP_SetUserData (FMOD_DSP *dsp, void *userdata); +FMOD_RESULT F_API FMOD_DSP_GetUserData (FMOD_DSP *dsp, void **userdata); + +/* + Metering. +*/ + +FMOD_RESULT F_API FMOD_DSP_SetMeteringEnabled (FMOD_DSP *dsp, FMOD_BOOL inputEnabled, FMOD_BOOL outputEnabled); +FMOD_RESULT F_API FMOD_DSP_GetMeteringEnabled (FMOD_DSP *dsp, FMOD_BOOL *inputEnabled, FMOD_BOOL *outputEnabled); +FMOD_RESULT F_API FMOD_DSP_GetMeteringInfo (FMOD_DSP *dsp, FMOD_DSP_METERING_INFO *inputInfo, FMOD_DSP_METERING_INFO *outputInfo); +FMOD_RESULT F_API FMOD_DSP_GetCPUUsage (FMOD_DSP *dsp, unsigned int *exclusive, unsigned int *inclusive); + +/* + 'DSPConnection' API +*/ + +FMOD_RESULT F_API FMOD_DSPConnection_GetInput (FMOD_DSPCONNECTION *dspconnection, FMOD_DSP **input); +FMOD_RESULT F_API FMOD_DSPConnection_GetOutput (FMOD_DSPCONNECTION *dspconnection, FMOD_DSP **output); +FMOD_RESULT F_API FMOD_DSPConnection_SetMix (FMOD_DSPCONNECTION *dspconnection, float volume); +FMOD_RESULT F_API FMOD_DSPConnection_GetMix (FMOD_DSPCONNECTION *dspconnection, float *volume); +FMOD_RESULT F_API FMOD_DSPConnection_SetMixMatrix (FMOD_DSPCONNECTION *dspconnection, float *matrix, int outchannels, int inchannels, int inchannel_hop); +FMOD_RESULT F_API FMOD_DSPConnection_GetMixMatrix (FMOD_DSPCONNECTION *dspconnection, float *matrix, int *outchannels, int *inchannels, int inchannel_hop); +FMOD_RESULT F_API FMOD_DSPConnection_GetType (FMOD_DSPCONNECTION *dspconnection, FMOD_DSPCONNECTION_TYPE *type); + +/* + Userdata set/get. +*/ + +FMOD_RESULT F_API FMOD_DSPConnection_SetUserData (FMOD_DSPCONNECTION *dspconnection, void *userdata); +FMOD_RESULT F_API FMOD_DSPConnection_GetUserData (FMOD_DSPCONNECTION *dspconnection, void **userdata); + +/* + 'Geometry' API +*/ + +FMOD_RESULT F_API FMOD_Geometry_Release (FMOD_GEOMETRY *geometry); + +/* + Polygon manipulation. +*/ + +FMOD_RESULT F_API FMOD_Geometry_AddPolygon (FMOD_GEOMETRY *geometry, float directocclusion, float reverbocclusion, FMOD_BOOL doublesided, int numvertices, const FMOD_VECTOR *vertices, int *polygonindex); +FMOD_RESULT F_API FMOD_Geometry_GetNumPolygons (FMOD_GEOMETRY *geometry, int *numpolygons); +FMOD_RESULT F_API FMOD_Geometry_GetMaxPolygons (FMOD_GEOMETRY *geometry, int *maxpolygons, int *maxvertices); +FMOD_RESULT F_API FMOD_Geometry_GetPolygonNumVertices (FMOD_GEOMETRY *geometry, int index, int *numvertices); +FMOD_RESULT F_API FMOD_Geometry_SetPolygonVertex (FMOD_GEOMETRY *geometry, int index, int vertexindex, const FMOD_VECTOR *vertex); +FMOD_RESULT F_API FMOD_Geometry_GetPolygonVertex (FMOD_GEOMETRY *geometry, int index, int vertexindex, FMOD_VECTOR *vertex); +FMOD_RESULT F_API FMOD_Geometry_SetPolygonAttributes (FMOD_GEOMETRY *geometry, int index, float directocclusion, float reverbocclusion, FMOD_BOOL doublesided); +FMOD_RESULT F_API FMOD_Geometry_GetPolygonAttributes (FMOD_GEOMETRY *geometry, int index, float *directocclusion, float *reverbocclusion, FMOD_BOOL *doublesided); + +/* + Object manipulation. +*/ + +FMOD_RESULT F_API FMOD_Geometry_SetActive (FMOD_GEOMETRY *geometry, FMOD_BOOL active); +FMOD_RESULT F_API FMOD_Geometry_GetActive (FMOD_GEOMETRY *geometry, FMOD_BOOL *active); +FMOD_RESULT F_API FMOD_Geometry_SetRotation (FMOD_GEOMETRY *geometry, const FMOD_VECTOR *forward, const FMOD_VECTOR *up); +FMOD_RESULT F_API FMOD_Geometry_GetRotation (FMOD_GEOMETRY *geometry, FMOD_VECTOR *forward, FMOD_VECTOR *up); +FMOD_RESULT F_API FMOD_Geometry_SetPosition (FMOD_GEOMETRY *geometry, const FMOD_VECTOR *position); +FMOD_RESULT F_API FMOD_Geometry_GetPosition (FMOD_GEOMETRY *geometry, FMOD_VECTOR *position); +FMOD_RESULT F_API FMOD_Geometry_SetScale (FMOD_GEOMETRY *geometry, const FMOD_VECTOR *scale); +FMOD_RESULT F_API FMOD_Geometry_GetScale (FMOD_GEOMETRY *geometry, FMOD_VECTOR *scale); +FMOD_RESULT F_API FMOD_Geometry_Save (FMOD_GEOMETRY *geometry, void *data, int *datasize); + +/* + Userdata set/get. +*/ + +FMOD_RESULT F_API FMOD_Geometry_SetUserData (FMOD_GEOMETRY *geometry, void *userdata); +FMOD_RESULT F_API FMOD_Geometry_GetUserData (FMOD_GEOMETRY *geometry, void **userdata); + +/* + 'Reverb3D' API +*/ + +FMOD_RESULT F_API FMOD_Reverb3D_Release (FMOD_REVERB3D *reverb3d); + +/* + Reverb manipulation. +*/ + +FMOD_RESULT F_API FMOD_Reverb3D_Set3DAttributes (FMOD_REVERB3D *reverb3d, const FMOD_VECTOR *position, float mindistance, float maxdistance); +FMOD_RESULT F_API FMOD_Reverb3D_Get3DAttributes (FMOD_REVERB3D *reverb3d, FMOD_VECTOR *position, float *mindistance, float *maxdistance); +FMOD_RESULT F_API FMOD_Reverb3D_SetProperties (FMOD_REVERB3D *reverb3d, const FMOD_REVERB_PROPERTIES *properties); +FMOD_RESULT F_API FMOD_Reverb3D_GetProperties (FMOD_REVERB3D *reverb3d, FMOD_REVERB_PROPERTIES *properties); +FMOD_RESULT F_API FMOD_Reverb3D_SetActive (FMOD_REVERB3D *reverb3d, FMOD_BOOL active); +FMOD_RESULT F_API FMOD_Reverb3D_GetActive (FMOD_REVERB3D *reverb3d, FMOD_BOOL *active); + +/* + Userdata set/get. +*/ + +FMOD_RESULT F_API FMOD_Reverb3D_SetUserData (FMOD_REVERB3D *reverb3d, void *userdata); +FMOD_RESULT F_API FMOD_Reverb3D_GetUserData (FMOD_REVERB3D *reverb3d, void **userdata); + +#ifdef __cplusplus +} +#endif + +#endif /* _FMOD_H */ diff --git a/lib/fmod/inc/fmod_codec.h b/lib/fmod/inc/fmod_codec.h new file mode 100644 index 00000000..009b26f1 --- /dev/null +++ b/lib/fmod/inc/fmod_codec.h @@ -0,0 +1,136 @@ +/* ======================================================================================== */ +/* FMOD Core API - Codec development header file. */ +/* Copyright (c), Firelight Technologies Pty, Ltd. 2004-2022. */ +/* */ +/* Use this header if you are wanting to develop your own file format plugin to use with */ +/* FMOD's codec system. With this header you can make your own fileformat plugin that FMOD */ +/* can register and use. See the documentation and examples on how to make a working */ +/* plugin. */ +/* */ +/* For more detail visit: */ +/* https://fmod.com/docs/2.02/api/core-api.html */ +/* ======================================================================================== */ +#ifndef _FMOD_CODEC_H +#define _FMOD_CODEC_H + +/* + Codec types +*/ +typedef struct FMOD_CODEC_STATE FMOD_CODEC_STATE; +typedef struct FMOD_CODEC_WAVEFORMAT FMOD_CODEC_WAVEFORMAT; + +/* + Codec constants +*/ +#define FMOD_CODEC_PLUGIN_VERSION 1 + +typedef int FMOD_CODEC_SEEK_METHOD; +#define FMOD_CODEC_SEEK_METHOD_SET 0 +#define FMOD_CODEC_SEEK_METHOD_CURRENT 1 +#define FMOD_CODEC_SEEK_METHOD_END 2 + +/* + Codec callbacks +*/ +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_OPEN_CALLBACK) (FMOD_CODEC_STATE *codec_state, FMOD_MODE usermode, FMOD_CREATESOUNDEXINFO *userexinfo); +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_CLOSE_CALLBACK) (FMOD_CODEC_STATE *codec_state); +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_READ_CALLBACK) (FMOD_CODEC_STATE *codec_state, void *buffer, unsigned int samples_in, unsigned int *samples_out); +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_GETLENGTH_CALLBACK) (FMOD_CODEC_STATE *codec_state, unsigned int *length, FMOD_TIMEUNIT lengthtype); +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_SETPOSITION_CALLBACK) (FMOD_CODEC_STATE *codec_state, int subsound, unsigned int position, FMOD_TIMEUNIT postype); +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_GETPOSITION_CALLBACK) (FMOD_CODEC_STATE *codec_state, unsigned int *position, FMOD_TIMEUNIT postype); +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_SOUNDCREATE_CALLBACK) (FMOD_CODEC_STATE *codec_state, int subsound, FMOD_SOUND *sound); +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_GETWAVEFORMAT_CALLBACK)(FMOD_CODEC_STATE *codec_state, int index, FMOD_CODEC_WAVEFORMAT *waveformat); + +/* + Codec functions +*/ +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_METADATA_FUNC) (FMOD_CODEC_STATE *codec_state, FMOD_TAGTYPE tagtype, char *name, void *data, unsigned int datalen, FMOD_TAGDATATYPE datatype, int unique); +typedef void * (F_CALLBACK *FMOD_CODEC_ALLOC_FUNC) (unsigned int size, unsigned int align, const char *file, int line); +typedef void (F_CALLBACK *FMOD_CODEC_FREE_FUNC) (void *ptr, const char *file, int line); +typedef void (F_CALLBACK *FMOD_CODEC_LOG_FUNC) (FMOD_DEBUG_FLAGS level, const char *file, int line, const char *function, const char *string, ...); + +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_FILE_READ_FUNC) (FMOD_CODEC_STATE *codec_state, void *buffer, unsigned int sizebytes, unsigned int *bytesread); +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_FILE_SEEK_FUNC) (FMOD_CODEC_STATE *codec_state, unsigned int pos, FMOD_CODEC_SEEK_METHOD method); +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_FILE_TELL_FUNC) (FMOD_CODEC_STATE *codec_state, unsigned int *pos); +typedef FMOD_RESULT (F_CALLBACK *FMOD_CODEC_FILE_SIZE_FUNC) (FMOD_CODEC_STATE *codec_state, unsigned int *size); + +/* + Codec structures +*/ +typedef struct FMOD_CODEC_DESCRIPTION +{ + unsigned int apiversion; + const char *name; + unsigned int version; + int defaultasstream; + FMOD_TIMEUNIT timeunits; + FMOD_CODEC_OPEN_CALLBACK open; + FMOD_CODEC_CLOSE_CALLBACK close; + FMOD_CODEC_READ_CALLBACK read; + FMOD_CODEC_GETLENGTH_CALLBACK getlength; + FMOD_CODEC_SETPOSITION_CALLBACK setposition; + FMOD_CODEC_GETPOSITION_CALLBACK getposition; + FMOD_CODEC_SOUNDCREATE_CALLBACK soundcreate; + FMOD_CODEC_GETWAVEFORMAT_CALLBACK getwaveformat; +} FMOD_CODEC_DESCRIPTION; + +struct FMOD_CODEC_WAVEFORMAT +{ + const char* name; + FMOD_SOUND_FORMAT format; + int channels; + int frequency; + unsigned int lengthbytes; + unsigned int lengthpcm; + unsigned int pcmblocksize; + int loopstart; + int loopend; + FMOD_MODE mode; + FMOD_CHANNELMASK channelmask; + FMOD_CHANNELORDER channelorder; + float peakvolume; +}; + +typedef struct FMOD_CODEC_STATE_FUNCTIONS +{ + FMOD_CODEC_METADATA_FUNC metadata; + FMOD_CODEC_ALLOC_FUNC alloc; + FMOD_CODEC_FREE_FUNC free; + FMOD_CODEC_LOG_FUNC log; + FMOD_CODEC_FILE_READ_FUNC read; + FMOD_CODEC_FILE_SEEK_FUNC seek; + FMOD_CODEC_FILE_TELL_FUNC tell; + FMOD_CODEC_FILE_SIZE_FUNC size; +} FMOD_CODEC_STATE_FUNCTIONS; + +struct FMOD_CODEC_STATE +{ + void *plugindata; + FMOD_CODEC_WAVEFORMAT *waveformat; + FMOD_CODEC_STATE_FUNCTIONS *functions; + int numsubsounds; +}; + +/* + Codec macros +*/ +#define FMOD_CODEC_METADATA(_state, _tagtype, _name, _data, _datalen, _datatype, _unique) \ + (_state)->functions->metadata(_state, _tagtype, _name, _data, _datalen, _datatype, _unique) +#define FMOD_CODEC_ALLOC(_state, _size, _align) \ + (_state)->functions->alloc(_size, _align, __FILE__, __LINE__) +#define FMOD_CODEC_FREE(_state, _ptr) \ + (_state)->functions->free(_ptr, __FILE__, __LINE__) +#define FMOD_CODEC_LOG(_state, _level, _location, _format, ...) \ + (_state)->functions->log(_level, __FILE__, __LINE__, _location, _format, __VA_ARGS__) +#define FMOD_CODEC_FILE_READ(_state, _buffer, _sizebytes, _bytesread) \ + (_state)->functions->read(_state, _buffer, _sizebytes, _bytesread) +#define FMOD_CODEC_FILE_SEEK(_state, _pos, _method) \ + (_state)->functions->seek(_state, _pos, _method) +#define FMOD_CODEC_FILE_TELL(_state, _pos) \ + (_state)->functions->tell(_state, _pos) +#define FMOD_CODEC_FILE_SIZE(_state, _size) \ + (_state)->functions->size(_state, _size) + +#endif + + diff --git a/lib/fmod/inc/fmod_common.h b/lib/fmod/inc/fmod_common.h new file mode 100644 index 00000000..8d657b84 --- /dev/null +++ b/lib/fmod/inc/fmod_common.h @@ -0,0 +1,882 @@ +/* ======================================================================================== */ +/* FMOD Core API - Common C/C++ header file. */ +/* Copyright (c), Firelight Technologies Pty, Ltd. 2004-2022. */ +/* */ +/* This header is included by fmod.hpp (C++ interface) and fmod.h (C interface) */ +/* */ +/* For more detail visit: */ +/* https://fmod.com/docs/2.02/api/core-api-common.html */ +/* ======================================================================================== */ +#ifndef _FMOD_COMMON_H +#define _FMOD_COMMON_H + +/* + Library import helpers +*/ +#if defined(_WIN32) || defined(__CYGWIN__) + #define F_CALL __stdcall +#else + #define F_CALL +#endif + +#if defined(_WIN32) || defined(__CYGWIN__) || defined(__ORBIS__) || defined(F_USE_DECLSPEC) + #define F_EXPORT __declspec(dllexport) +#elif defined(__APPLE__) || defined(__ANDROID__) || defined(__linux__) || defined(F_USE_ATTRIBUTE) + #define F_EXPORT __attribute__((visibility("default"))) +#else + #define F_EXPORT +#endif + +#ifdef DLL_EXPORTS + #define F_API F_EXPORT F_CALL +#else + #define F_API F_CALL +#endif + +#define F_CALLBACK F_CALL + +/* + FMOD core types +*/ +typedef int FMOD_BOOL; +typedef struct FMOD_SYSTEM FMOD_SYSTEM; +typedef struct FMOD_SOUND FMOD_SOUND; +typedef struct FMOD_CHANNELCONTROL FMOD_CHANNELCONTROL; +typedef struct FMOD_CHANNEL FMOD_CHANNEL; +typedef struct FMOD_CHANNELGROUP FMOD_CHANNELGROUP; +typedef struct FMOD_SOUNDGROUP FMOD_SOUNDGROUP; +typedef struct FMOD_REVERB3D FMOD_REVERB3D; +typedef struct FMOD_DSP FMOD_DSP; +typedef struct FMOD_DSPCONNECTION FMOD_DSPCONNECTION; +typedef struct FMOD_POLYGON FMOD_POLYGON; +typedef struct FMOD_GEOMETRY FMOD_GEOMETRY; +typedef struct FMOD_SYNCPOINT FMOD_SYNCPOINT; +typedef struct FMOD_ASYNCREADINFO FMOD_ASYNCREADINFO; + +/* + FMOD constants +*/ +#define FMOD_VERSION 0x00020208 /* 0xaaaabbcc -> aaaa = product version, bb = major version, cc = minor version.*/ + +typedef unsigned int FMOD_DEBUG_FLAGS; +#define FMOD_DEBUG_LEVEL_NONE 0x00000000 +#define FMOD_DEBUG_LEVEL_ERROR 0x00000001 +#define FMOD_DEBUG_LEVEL_WARNING 0x00000002 +#define FMOD_DEBUG_LEVEL_LOG 0x00000004 +#define FMOD_DEBUG_TYPE_MEMORY 0x00000100 +#define FMOD_DEBUG_TYPE_FILE 0x00000200 +#define FMOD_DEBUG_TYPE_CODEC 0x00000400 +#define FMOD_DEBUG_TYPE_TRACE 0x00000800 +#define FMOD_DEBUG_DISPLAY_TIMESTAMPS 0x00010000 +#define FMOD_DEBUG_DISPLAY_LINENUMBERS 0x00020000 +#define FMOD_DEBUG_DISPLAY_THREAD 0x00040000 + +typedef unsigned int FMOD_MEMORY_TYPE; +#define FMOD_MEMORY_NORMAL 0x00000000 +#define FMOD_MEMORY_STREAM_FILE 0x00000001 +#define FMOD_MEMORY_STREAM_DECODE 0x00000002 +#define FMOD_MEMORY_SAMPLEDATA 0x00000004 +#define FMOD_MEMORY_DSP_BUFFER 0x00000008 +#define FMOD_MEMORY_PLUGIN 0x00000010 +#define FMOD_MEMORY_PERSISTENT 0x00200000 +#define FMOD_MEMORY_ALL 0xFFFFFFFF + +typedef unsigned int FMOD_INITFLAGS; +#define FMOD_INIT_NORMAL 0x00000000 +#define FMOD_INIT_STREAM_FROM_UPDATE 0x00000001 +#define FMOD_INIT_MIX_FROM_UPDATE 0x00000002 +#define FMOD_INIT_3D_RIGHTHANDED 0x00000004 +#define FMOD_INIT_CLIP_OUTPUT 0x00000008 +#define FMOD_INIT_CHANNEL_LOWPASS 0x00000100 +#define FMOD_INIT_CHANNEL_DISTANCEFILTER 0x00000200 +#define FMOD_INIT_PROFILE_ENABLE 0x00010000 +#define FMOD_INIT_VOL0_BECOMES_VIRTUAL 0x00020000 +#define FMOD_INIT_GEOMETRY_USECLOSEST 0x00040000 +#define FMOD_INIT_PREFER_DOLBY_DOWNMIX 0x00080000 +#define FMOD_INIT_THREAD_UNSAFE 0x00100000 +#define FMOD_INIT_PROFILE_METER_ALL 0x00200000 +#define FMOD_INIT_MEMORY_TRACKING 0x00400000 + +typedef unsigned int FMOD_DRIVER_STATE; +#define FMOD_DRIVER_STATE_CONNECTED 0x00000001 +#define FMOD_DRIVER_STATE_DEFAULT 0x00000002 + +typedef unsigned int FMOD_TIMEUNIT; +#define FMOD_TIMEUNIT_MS 0x00000001 +#define FMOD_TIMEUNIT_PCM 0x00000002 +#define FMOD_TIMEUNIT_PCMBYTES 0x00000004 +#define FMOD_TIMEUNIT_RAWBYTES 0x00000008 +#define FMOD_TIMEUNIT_PCMFRACTION 0x00000010 +#define FMOD_TIMEUNIT_MODORDER 0x00000100 +#define FMOD_TIMEUNIT_MODROW 0x00000200 +#define FMOD_TIMEUNIT_MODPATTERN 0x00000400 + +typedef unsigned int FMOD_SYSTEM_CALLBACK_TYPE; +#define FMOD_SYSTEM_CALLBACK_DEVICELISTCHANGED 0x00000001 +#define FMOD_SYSTEM_CALLBACK_DEVICELOST 0x00000002 +#define FMOD_SYSTEM_CALLBACK_MEMORYALLOCATIONFAILED 0x00000004 +#define FMOD_SYSTEM_CALLBACK_THREADCREATED 0x00000008 +#define FMOD_SYSTEM_CALLBACK_BADDSPCONNECTION 0x00000010 +#define FMOD_SYSTEM_CALLBACK_PREMIX 0x00000020 +#define FMOD_SYSTEM_CALLBACK_POSTMIX 0x00000040 +#define FMOD_SYSTEM_CALLBACK_ERROR 0x00000080 +#define FMOD_SYSTEM_CALLBACK_MIDMIX 0x00000100 +#define FMOD_SYSTEM_CALLBACK_THREADDESTROYED 0x00000200 +#define FMOD_SYSTEM_CALLBACK_PREUPDATE 0x00000400 +#define FMOD_SYSTEM_CALLBACK_POSTUPDATE 0x00000800 +#define FMOD_SYSTEM_CALLBACK_RECORDLISTCHANGED 0x00001000 +#define FMOD_SYSTEM_CALLBACK_BUFFEREDNOMIX 0x00002000 +#define FMOD_SYSTEM_CALLBACK_DEVICEREINITIALIZE 0x00004000 +#define FMOD_SYSTEM_CALLBACK_OUTPUTUNDERRUN 0x00008000 +#define FMOD_SYSTEM_CALLBACK_ALL 0xFFFFFFFF + +typedef unsigned int FMOD_MODE; +#define FMOD_DEFAULT 0x00000000 +#define FMOD_LOOP_OFF 0x00000001 +#define FMOD_LOOP_NORMAL 0x00000002 +#define FMOD_LOOP_BIDI 0x00000004 +#define FMOD_2D 0x00000008 +#define FMOD_3D 0x00000010 +#define FMOD_CREATESTREAM 0x00000080 +#define FMOD_CREATESAMPLE 0x00000100 +#define FMOD_CREATECOMPRESSEDSAMPLE 0x00000200 +#define FMOD_OPENUSER 0x00000400 +#define FMOD_OPENMEMORY 0x00000800 +#define FMOD_OPENMEMORY_POINT 0x10000000 +#define FMOD_OPENRAW 0x00001000 +#define FMOD_OPENONLY 0x00002000 +#define FMOD_ACCURATETIME 0x00004000 +#define FMOD_MPEGSEARCH 0x00008000 +#define FMOD_NONBLOCKING 0x00010000 +#define FMOD_UNIQUE 0x00020000 +#define FMOD_3D_HEADRELATIVE 0x00040000 +#define FMOD_3D_WORLDRELATIVE 0x00080000 +#define FMOD_3D_INVERSEROLLOFF 0x00100000 +#define FMOD_3D_LINEARROLLOFF 0x00200000 +#define FMOD_3D_LINEARSQUAREROLLOFF 0x00400000 +#define FMOD_3D_INVERSETAPEREDROLLOFF 0x00800000 +#define FMOD_3D_CUSTOMROLLOFF 0x04000000 +#define FMOD_3D_IGNOREGEOMETRY 0x40000000 +#define FMOD_IGNORETAGS 0x02000000 +#define FMOD_LOWMEM 0x08000000 +#define FMOD_VIRTUAL_PLAYFROMSTART 0x80000000 + +typedef unsigned int FMOD_CHANNELMASK; +#define FMOD_CHANNELMASK_FRONT_LEFT 0x00000001 +#define FMOD_CHANNELMASK_FRONT_RIGHT 0x00000002 +#define FMOD_CHANNELMASK_FRONT_CENTER 0x00000004 +#define FMOD_CHANNELMASK_LOW_FREQUENCY 0x00000008 +#define FMOD_CHANNELMASK_SURROUND_LEFT 0x00000010 +#define FMOD_CHANNELMASK_SURROUND_RIGHT 0x00000020 +#define FMOD_CHANNELMASK_BACK_LEFT 0x00000040 +#define FMOD_CHANNELMASK_BACK_RIGHT 0x00000080 +#define FMOD_CHANNELMASK_BACK_CENTER 0x00000100 +#define FMOD_CHANNELMASK_MONO (FMOD_CHANNELMASK_FRONT_LEFT) +#define FMOD_CHANNELMASK_STEREO (FMOD_CHANNELMASK_FRONT_LEFT | FMOD_CHANNELMASK_FRONT_RIGHT) +#define FMOD_CHANNELMASK_LRC (FMOD_CHANNELMASK_FRONT_LEFT | FMOD_CHANNELMASK_FRONT_RIGHT | FMOD_CHANNELMASK_FRONT_CENTER) +#define FMOD_CHANNELMASK_QUAD (FMOD_CHANNELMASK_FRONT_LEFT | FMOD_CHANNELMASK_FRONT_RIGHT | FMOD_CHANNELMASK_SURROUND_LEFT | FMOD_CHANNELMASK_SURROUND_RIGHT) +#define FMOD_CHANNELMASK_SURROUND (FMOD_CHANNELMASK_FRONT_LEFT | FMOD_CHANNELMASK_FRONT_RIGHT | FMOD_CHANNELMASK_FRONT_CENTER | FMOD_CHANNELMASK_SURROUND_LEFT | FMOD_CHANNELMASK_SURROUND_RIGHT) +#define FMOD_CHANNELMASK_5POINT1 (FMOD_CHANNELMASK_FRONT_LEFT | FMOD_CHANNELMASK_FRONT_RIGHT | FMOD_CHANNELMASK_FRONT_CENTER | FMOD_CHANNELMASK_LOW_FREQUENCY | FMOD_CHANNELMASK_SURROUND_LEFT | FMOD_CHANNELMASK_SURROUND_RIGHT) +#define FMOD_CHANNELMASK_5POINT1_REARS (FMOD_CHANNELMASK_FRONT_LEFT | FMOD_CHANNELMASK_FRONT_RIGHT | FMOD_CHANNELMASK_FRONT_CENTER | FMOD_CHANNELMASK_LOW_FREQUENCY | FMOD_CHANNELMASK_BACK_LEFT | FMOD_CHANNELMASK_BACK_RIGHT) +#define FMOD_CHANNELMASK_7POINT0 (FMOD_CHANNELMASK_FRONT_LEFT | FMOD_CHANNELMASK_FRONT_RIGHT | FMOD_CHANNELMASK_FRONT_CENTER | FMOD_CHANNELMASK_SURROUND_LEFT | FMOD_CHANNELMASK_SURROUND_RIGHT | FMOD_CHANNELMASK_BACK_LEFT | FMOD_CHANNELMASK_BACK_RIGHT) +#define FMOD_CHANNELMASK_7POINT1 (FMOD_CHANNELMASK_FRONT_LEFT | FMOD_CHANNELMASK_FRONT_RIGHT | FMOD_CHANNELMASK_FRONT_CENTER | FMOD_CHANNELMASK_LOW_FREQUENCY | FMOD_CHANNELMASK_SURROUND_LEFT | FMOD_CHANNELMASK_SURROUND_RIGHT | FMOD_CHANNELMASK_BACK_LEFT | FMOD_CHANNELMASK_BACK_RIGHT) + +typedef unsigned long long FMOD_PORT_INDEX; +#define FMOD_PORT_INDEX_NONE 0xFFFFFFFFFFFFFFFF +#define FMOD_PORT_INDEX_FLAG_VR_CONTROLLER 0x1000000000000000 + +typedef int FMOD_THREAD_PRIORITY; +/* Platform specific priority range */ +#define FMOD_THREAD_PRIORITY_PLATFORM_MIN (-32 * 1024) +#define FMOD_THREAD_PRIORITY_PLATFORM_MAX ( 32 * 1024) +/* Platform agnostic priorities, maps internally to platform specific value */ +#define FMOD_THREAD_PRIORITY_DEFAULT (FMOD_THREAD_PRIORITY_PLATFORM_MIN - 1) +#define FMOD_THREAD_PRIORITY_LOW (FMOD_THREAD_PRIORITY_PLATFORM_MIN - 2) +#define FMOD_THREAD_PRIORITY_MEDIUM (FMOD_THREAD_PRIORITY_PLATFORM_MIN - 3) +#define FMOD_THREAD_PRIORITY_HIGH (FMOD_THREAD_PRIORITY_PLATFORM_MIN - 4) +#define FMOD_THREAD_PRIORITY_VERY_HIGH (FMOD_THREAD_PRIORITY_PLATFORM_MIN - 5) +#define FMOD_THREAD_PRIORITY_EXTREME (FMOD_THREAD_PRIORITY_PLATFORM_MIN - 6) +#define FMOD_THREAD_PRIORITY_CRITICAL (FMOD_THREAD_PRIORITY_PLATFORM_MIN - 7) +/* Thread defaults */ +#define FMOD_THREAD_PRIORITY_MIXER FMOD_THREAD_PRIORITY_EXTREME +#define FMOD_THREAD_PRIORITY_FEEDER FMOD_THREAD_PRIORITY_CRITICAL +#define FMOD_THREAD_PRIORITY_STREAM FMOD_THREAD_PRIORITY_VERY_HIGH +#define FMOD_THREAD_PRIORITY_FILE FMOD_THREAD_PRIORITY_HIGH +#define FMOD_THREAD_PRIORITY_NONBLOCKING FMOD_THREAD_PRIORITY_HIGH +#define FMOD_THREAD_PRIORITY_RECORD FMOD_THREAD_PRIORITY_HIGH +#define FMOD_THREAD_PRIORITY_GEOMETRY FMOD_THREAD_PRIORITY_LOW +#define FMOD_THREAD_PRIORITY_PROFILER FMOD_THREAD_PRIORITY_MEDIUM +#define FMOD_THREAD_PRIORITY_STUDIO_UPDATE FMOD_THREAD_PRIORITY_MEDIUM +#define FMOD_THREAD_PRIORITY_STUDIO_LOAD_BANK FMOD_THREAD_PRIORITY_MEDIUM +#define FMOD_THREAD_PRIORITY_STUDIO_LOAD_SAMPLE FMOD_THREAD_PRIORITY_MEDIUM +#define FMOD_THREAD_PRIORITY_CONVOLUTION1 FMOD_THREAD_PRIORITY_VERY_HIGH +#define FMOD_THREAD_PRIORITY_CONVOLUTION2 FMOD_THREAD_PRIORITY_VERY_HIGH + +typedef unsigned int FMOD_THREAD_STACK_SIZE; +#define FMOD_THREAD_STACK_SIZE_DEFAULT 0 +#define FMOD_THREAD_STACK_SIZE_MIXER (80 * 1024) +#define FMOD_THREAD_STACK_SIZE_FEEDER (16 * 1024) +#define FMOD_THREAD_STACK_SIZE_STREAM (96 * 1024) +#define FMOD_THREAD_STACK_SIZE_FILE (64 * 1024) +#define FMOD_THREAD_STACK_SIZE_NONBLOCKING (112 * 1024) +#define FMOD_THREAD_STACK_SIZE_RECORD (16 * 1024) +#define FMOD_THREAD_STACK_SIZE_GEOMETRY (48 * 1024) +#define FMOD_THREAD_STACK_SIZE_PROFILER (128 * 1024) +#define FMOD_THREAD_STACK_SIZE_STUDIO_UPDATE (96 * 1024) +#define FMOD_THREAD_STACK_SIZE_STUDIO_LOAD_BANK (96 * 1024) +#define FMOD_THREAD_STACK_SIZE_STUDIO_LOAD_SAMPLE (96 * 1024) +#define FMOD_THREAD_STACK_SIZE_CONVOLUTION1 (16 * 1024) +#define FMOD_THREAD_STACK_SIZE_CONVOLUTION2 (16 * 1024) + +typedef long long FMOD_THREAD_AFFINITY; +/* Platform agnostic thread groupings */ +#define FMOD_THREAD_AFFINITY_GROUP_DEFAULT 0x4000000000000000 +#define FMOD_THREAD_AFFINITY_GROUP_A 0x4000000000000001 +#define FMOD_THREAD_AFFINITY_GROUP_B 0x4000000000000002 +#define FMOD_THREAD_AFFINITY_GROUP_C 0x4000000000000003 +/* Thread defaults */ +#define FMOD_THREAD_AFFINITY_MIXER FMOD_THREAD_AFFINITY_GROUP_A +#define FMOD_THREAD_AFFINITY_FEEDER FMOD_THREAD_AFFINITY_GROUP_C +#define FMOD_THREAD_AFFINITY_STREAM FMOD_THREAD_AFFINITY_GROUP_C +#define FMOD_THREAD_AFFINITY_FILE FMOD_THREAD_AFFINITY_GROUP_C +#define FMOD_THREAD_AFFINITY_NONBLOCKING FMOD_THREAD_AFFINITY_GROUP_C +#define FMOD_THREAD_AFFINITY_RECORD FMOD_THREAD_AFFINITY_GROUP_C +#define FMOD_THREAD_AFFINITY_GEOMETRY FMOD_THREAD_AFFINITY_GROUP_C +#define FMOD_THREAD_AFFINITY_PROFILER FMOD_THREAD_AFFINITY_GROUP_C +#define FMOD_THREAD_AFFINITY_STUDIO_UPDATE FMOD_THREAD_AFFINITY_GROUP_B +#define FMOD_THREAD_AFFINITY_STUDIO_LOAD_BANK FMOD_THREAD_AFFINITY_GROUP_C +#define FMOD_THREAD_AFFINITY_STUDIO_LOAD_SAMPLE FMOD_THREAD_AFFINITY_GROUP_C +#define FMOD_THREAD_AFFINITY_CONVOLUTION1 FMOD_THREAD_AFFINITY_GROUP_C +#define FMOD_THREAD_AFFINITY_CONVOLUTION2 FMOD_THREAD_AFFINITY_GROUP_C +/* Core mask, valid up to 1 << 62 */ +#define FMOD_THREAD_AFFINITY_CORE_ALL 0 +#define FMOD_THREAD_AFFINITY_CORE_0 (1 << 0) +#define FMOD_THREAD_AFFINITY_CORE_1 (1 << 1) +#define FMOD_THREAD_AFFINITY_CORE_2 (1 << 2) +#define FMOD_THREAD_AFFINITY_CORE_3 (1 << 3) +#define FMOD_THREAD_AFFINITY_CORE_4 (1 << 4) +#define FMOD_THREAD_AFFINITY_CORE_5 (1 << 5) +#define FMOD_THREAD_AFFINITY_CORE_6 (1 << 6) +#define FMOD_THREAD_AFFINITY_CORE_7 (1 << 7) +#define FMOD_THREAD_AFFINITY_CORE_8 (1 << 8) +#define FMOD_THREAD_AFFINITY_CORE_9 (1 << 9) +#define FMOD_THREAD_AFFINITY_CORE_10 (1 << 10) +#define FMOD_THREAD_AFFINITY_CORE_11 (1 << 11) +#define FMOD_THREAD_AFFINITY_CORE_12 (1 << 12) +#define FMOD_THREAD_AFFINITY_CORE_13 (1 << 13) +#define FMOD_THREAD_AFFINITY_CORE_14 (1 << 14) +#define FMOD_THREAD_AFFINITY_CORE_15 (1 << 15) + +/* Preset for FMOD_REVERB_PROPERTIES */ +#define FMOD_PRESET_OFF { 1000, 7, 11, 5000, 100, 100, 100, 250, 0, 20, 96, -80.0f } +#define FMOD_PRESET_GENERIC { 1500, 7, 11, 5000, 83, 100, 100, 250, 0, 14500, 96, -8.0f } +#define FMOD_PRESET_PADDEDCELL { 170, 1, 2, 5000, 10, 100, 100, 250, 0, 160, 84, -7.8f } +#define FMOD_PRESET_ROOM { 400, 2, 3, 5000, 83, 100, 100, 250, 0, 6050, 88, -9.4f } +#define FMOD_PRESET_BATHROOM { 1500, 7, 11, 5000, 54, 100, 60, 250, 0, 2900, 83, 0.5f } +#define FMOD_PRESET_LIVINGROOM { 500, 3, 4, 5000, 10, 100, 100, 250, 0, 160, 58, -19.0f } +#define FMOD_PRESET_STONEROOM { 2300, 12, 17, 5000, 64, 100, 100, 250, 0, 7800, 71, -8.5f } +#define FMOD_PRESET_AUDITORIUM { 4300, 20, 30, 5000, 59, 100, 100, 250, 0, 5850, 64, -11.7f } +#define FMOD_PRESET_CONCERTHALL { 3900, 20, 29, 5000, 70, 100, 100, 250, 0, 5650, 80, -9.8f } +#define FMOD_PRESET_CAVE { 2900, 15, 22, 5000, 100, 100, 100, 250, 0, 20000, 59, -11.3f } +#define FMOD_PRESET_ARENA { 7200, 20, 30, 5000, 33, 100, 100, 250, 0, 4500, 80, -9.6f } +#define FMOD_PRESET_HANGAR { 10000, 20, 30, 5000, 23, 100, 100, 250, 0, 3400, 72, -7.4f } +#define FMOD_PRESET_CARPETTEDHALLWAY { 300, 2, 30, 5000, 10, 100, 100, 250, 0, 500, 56, -24.0f } +#define FMOD_PRESET_HALLWAY { 1500, 7, 11, 5000, 59, 100, 100, 250, 0, 7800, 87, -5.5f } +#define FMOD_PRESET_STONECORRIDOR { 270, 13, 20, 5000, 79, 100, 100, 250, 0, 9000, 86, -6.0f } +#define FMOD_PRESET_ALLEY { 1500, 7, 11, 5000, 86, 100, 100, 250, 0, 8300, 80, -9.8f } +#define FMOD_PRESET_FOREST { 1500, 162, 88, 5000, 54, 79, 100, 250, 0, 760, 94, -12.3f } +#define FMOD_PRESET_CITY { 1500, 7, 11, 5000, 67, 50, 100, 250, 0, 4050, 66, -26.0f } +#define FMOD_PRESET_MOUNTAINS { 1500, 300, 100, 5000, 21, 27, 100, 250, 0, 1220, 82, -24.0f } +#define FMOD_PRESET_QUARRY { 1500, 61, 25, 5000, 83, 100, 100, 250, 0, 3400, 100, -5.0f } +#define FMOD_PRESET_PLAIN { 1500, 179, 100, 5000, 50, 21, 100, 250, 0, 1670, 65, -28.0f } +#define FMOD_PRESET_PARKINGLOT { 1700, 8, 12, 5000, 100, 100, 100, 250, 0, 20000, 56, -19.5f } +#define FMOD_PRESET_SEWERPIPE { 2800, 14, 21, 5000, 14, 80, 60, 250, 0, 3400, 66, 1.2f } +#define FMOD_PRESET_UNDERWATER { 1500, 7, 11, 5000, 10, 100, 100, 250, 0, 500, 92, 7.0f } + +#define FMOD_MAX_CHANNEL_WIDTH 32 +#define FMOD_MAX_SYSTEMS 8 +#define FMOD_MAX_LISTENERS 8 +#define FMOD_REVERB_MAXINSTANCES 4 + +typedef enum FMOD_THREAD_TYPE +{ + FMOD_THREAD_TYPE_MIXER, + FMOD_THREAD_TYPE_FEEDER, + FMOD_THREAD_TYPE_STREAM, + FMOD_THREAD_TYPE_FILE, + FMOD_THREAD_TYPE_NONBLOCKING, + FMOD_THREAD_TYPE_RECORD, + FMOD_THREAD_TYPE_GEOMETRY, + FMOD_THREAD_TYPE_PROFILER, + FMOD_THREAD_TYPE_STUDIO_UPDATE, + FMOD_THREAD_TYPE_STUDIO_LOAD_BANK, + FMOD_THREAD_TYPE_STUDIO_LOAD_SAMPLE, + FMOD_THREAD_TYPE_CONVOLUTION1, + FMOD_THREAD_TYPE_CONVOLUTION2, + + FMOD_THREAD_TYPE_MAX, + FMOD_THREAD_TYPE_FORCEINT = 65536 +} FMOD_THREAD_TYPE; + +typedef enum FMOD_RESULT +{ + FMOD_OK, + FMOD_ERR_BADCOMMAND, + FMOD_ERR_CHANNEL_ALLOC, + FMOD_ERR_CHANNEL_STOLEN, + FMOD_ERR_DMA, + FMOD_ERR_DSP_CONNECTION, + FMOD_ERR_DSP_DONTPROCESS, + FMOD_ERR_DSP_FORMAT, + FMOD_ERR_DSP_INUSE, + FMOD_ERR_DSP_NOTFOUND, + FMOD_ERR_DSP_RESERVED, + FMOD_ERR_DSP_SILENCE, + FMOD_ERR_DSP_TYPE, + FMOD_ERR_FILE_BAD, + FMOD_ERR_FILE_COULDNOTSEEK, + FMOD_ERR_FILE_DISKEJECTED, + FMOD_ERR_FILE_EOF, + FMOD_ERR_FILE_ENDOFDATA, + FMOD_ERR_FILE_NOTFOUND, + FMOD_ERR_FORMAT, + FMOD_ERR_HEADER_MISMATCH, + FMOD_ERR_HTTP, + FMOD_ERR_HTTP_ACCESS, + FMOD_ERR_HTTP_PROXY_AUTH, + FMOD_ERR_HTTP_SERVER_ERROR, + FMOD_ERR_HTTP_TIMEOUT, + FMOD_ERR_INITIALIZATION, + FMOD_ERR_INITIALIZED, + FMOD_ERR_INTERNAL, + FMOD_ERR_INVALID_FLOAT, + FMOD_ERR_INVALID_HANDLE, + FMOD_ERR_INVALID_PARAM, + FMOD_ERR_INVALID_POSITION, + FMOD_ERR_INVALID_SPEAKER, + FMOD_ERR_INVALID_SYNCPOINT, + FMOD_ERR_INVALID_THREAD, + FMOD_ERR_INVALID_VECTOR, + FMOD_ERR_MAXAUDIBLE, + FMOD_ERR_MEMORY, + FMOD_ERR_MEMORY_CANTPOINT, + FMOD_ERR_NEEDS3D, + FMOD_ERR_NEEDSHARDWARE, + FMOD_ERR_NET_CONNECT, + FMOD_ERR_NET_SOCKET_ERROR, + FMOD_ERR_NET_URL, + FMOD_ERR_NET_WOULD_BLOCK, + FMOD_ERR_NOTREADY, + FMOD_ERR_OUTPUT_ALLOCATED, + FMOD_ERR_OUTPUT_CREATEBUFFER, + FMOD_ERR_OUTPUT_DRIVERCALL, + FMOD_ERR_OUTPUT_FORMAT, + FMOD_ERR_OUTPUT_INIT, + FMOD_ERR_OUTPUT_NODRIVERS, + FMOD_ERR_PLUGIN, + FMOD_ERR_PLUGIN_MISSING, + FMOD_ERR_PLUGIN_RESOURCE, + FMOD_ERR_PLUGIN_VERSION, + FMOD_ERR_RECORD, + FMOD_ERR_REVERB_CHANNELGROUP, + FMOD_ERR_REVERB_INSTANCE, + FMOD_ERR_SUBSOUNDS, + FMOD_ERR_SUBSOUND_ALLOCATED, + FMOD_ERR_SUBSOUND_CANTMOVE, + FMOD_ERR_TAGNOTFOUND, + FMOD_ERR_TOOMANYCHANNELS, + FMOD_ERR_TRUNCATED, + FMOD_ERR_UNIMPLEMENTED, + FMOD_ERR_UNINITIALIZED, + FMOD_ERR_UNSUPPORTED, + FMOD_ERR_VERSION, + FMOD_ERR_EVENT_ALREADY_LOADED, + FMOD_ERR_EVENT_LIVEUPDATE_BUSY, + FMOD_ERR_EVENT_LIVEUPDATE_MISMATCH, + FMOD_ERR_EVENT_LIVEUPDATE_TIMEOUT, + FMOD_ERR_EVENT_NOTFOUND, + FMOD_ERR_STUDIO_UNINITIALIZED, + FMOD_ERR_STUDIO_NOT_LOADED, + FMOD_ERR_INVALID_STRING, + FMOD_ERR_ALREADY_LOCKED, + FMOD_ERR_NOT_LOCKED, + FMOD_ERR_RECORD_DISCONNECTED, + FMOD_ERR_TOOMANYSAMPLES, + + FMOD_RESULT_FORCEINT = 65536 +} FMOD_RESULT; + +typedef enum FMOD_CHANNELCONTROL_TYPE +{ + FMOD_CHANNELCONTROL_CHANNEL, + FMOD_CHANNELCONTROL_CHANNELGROUP, + + FMOD_CHANNELCONTROL_MAX, + FMOD_CHANNELCONTROL_FORCEINT = 65536 +} FMOD_CHANNELCONTROL_TYPE; + +typedef enum FMOD_OUTPUTTYPE +{ + FMOD_OUTPUTTYPE_AUTODETECT, + FMOD_OUTPUTTYPE_UNKNOWN, + FMOD_OUTPUTTYPE_NOSOUND, + FMOD_OUTPUTTYPE_WAVWRITER, + FMOD_OUTPUTTYPE_NOSOUND_NRT, + FMOD_OUTPUTTYPE_WAVWRITER_NRT, + FMOD_OUTPUTTYPE_WASAPI, + FMOD_OUTPUTTYPE_ASIO, + FMOD_OUTPUTTYPE_PULSEAUDIO, + FMOD_OUTPUTTYPE_ALSA, + FMOD_OUTPUTTYPE_COREAUDIO, + FMOD_OUTPUTTYPE_AUDIOTRACK, + FMOD_OUTPUTTYPE_OPENSL, + FMOD_OUTPUTTYPE_AUDIOOUT, + FMOD_OUTPUTTYPE_AUDIO3D, + FMOD_OUTPUTTYPE_WEBAUDIO, + FMOD_OUTPUTTYPE_NNAUDIO, + FMOD_OUTPUTTYPE_WINSONIC, + FMOD_OUTPUTTYPE_AAUDIO, + FMOD_OUTPUTTYPE_AUDIOWORKLET, + + FMOD_OUTPUTTYPE_MAX, + FMOD_OUTPUTTYPE_FORCEINT = 65536 +} FMOD_OUTPUTTYPE; + +typedef enum FMOD_DEBUG_MODE +{ + FMOD_DEBUG_MODE_TTY, + FMOD_DEBUG_MODE_FILE, + FMOD_DEBUG_MODE_CALLBACK, + + FMOD_DEBUG_MODE_FORCEINT = 65536 +} FMOD_DEBUG_MODE; + +typedef enum FMOD_SPEAKERMODE +{ + FMOD_SPEAKERMODE_DEFAULT, + FMOD_SPEAKERMODE_RAW, + FMOD_SPEAKERMODE_MONO, + FMOD_SPEAKERMODE_STEREO, + FMOD_SPEAKERMODE_QUAD, + FMOD_SPEAKERMODE_SURROUND, + FMOD_SPEAKERMODE_5POINT1, + FMOD_SPEAKERMODE_7POINT1, + FMOD_SPEAKERMODE_7POINT1POINT4, + + FMOD_SPEAKERMODE_MAX, + FMOD_SPEAKERMODE_FORCEINT = 65536 +} FMOD_SPEAKERMODE; + +typedef enum FMOD_SPEAKER +{ + FMOD_SPEAKER_NONE = -1, + FMOD_SPEAKER_FRONT_LEFT = 0, + FMOD_SPEAKER_FRONT_RIGHT, + FMOD_SPEAKER_FRONT_CENTER, + FMOD_SPEAKER_LOW_FREQUENCY, + FMOD_SPEAKER_SURROUND_LEFT, + FMOD_SPEAKER_SURROUND_RIGHT, + FMOD_SPEAKER_BACK_LEFT, + FMOD_SPEAKER_BACK_RIGHT, + FMOD_SPEAKER_TOP_FRONT_LEFT, + FMOD_SPEAKER_TOP_FRONT_RIGHT, + FMOD_SPEAKER_TOP_BACK_LEFT, + FMOD_SPEAKER_TOP_BACK_RIGHT, + + FMOD_SPEAKER_MAX, + FMOD_SPEAKER_FORCEINT = 65536 +} FMOD_SPEAKER; + +typedef enum FMOD_CHANNELORDER +{ + FMOD_CHANNELORDER_DEFAULT, + FMOD_CHANNELORDER_WAVEFORMAT, + FMOD_CHANNELORDER_PROTOOLS, + FMOD_CHANNELORDER_ALLMONO, + FMOD_CHANNELORDER_ALLSTEREO, + FMOD_CHANNELORDER_ALSA, + + FMOD_CHANNELORDER_MAX, + FMOD_CHANNELORDER_FORCEINT = 65536 +} FMOD_CHANNELORDER; + +typedef enum FMOD_PLUGINTYPE +{ + FMOD_PLUGINTYPE_OUTPUT, + FMOD_PLUGINTYPE_CODEC, + FMOD_PLUGINTYPE_DSP, + + FMOD_PLUGINTYPE_MAX, + FMOD_PLUGINTYPE_FORCEINT = 65536 +} FMOD_PLUGINTYPE; + +typedef enum FMOD_SOUND_TYPE +{ + FMOD_SOUND_TYPE_UNKNOWN, + FMOD_SOUND_TYPE_AIFF, + FMOD_SOUND_TYPE_ASF, + FMOD_SOUND_TYPE_DLS, + FMOD_SOUND_TYPE_FLAC, + FMOD_SOUND_TYPE_FSB, + FMOD_SOUND_TYPE_IT, + FMOD_SOUND_TYPE_MIDI, + FMOD_SOUND_TYPE_MOD, + FMOD_SOUND_TYPE_MPEG, + FMOD_SOUND_TYPE_OGGVORBIS, + FMOD_SOUND_TYPE_PLAYLIST, + FMOD_SOUND_TYPE_RAW, + FMOD_SOUND_TYPE_S3M, + FMOD_SOUND_TYPE_USER, + FMOD_SOUND_TYPE_WAV, + FMOD_SOUND_TYPE_XM, + FMOD_SOUND_TYPE_XMA, + FMOD_SOUND_TYPE_AUDIOQUEUE, + FMOD_SOUND_TYPE_AT9, + FMOD_SOUND_TYPE_VORBIS, + FMOD_SOUND_TYPE_MEDIA_FOUNDATION, + FMOD_SOUND_TYPE_MEDIACODEC, + FMOD_SOUND_TYPE_FADPCM, + FMOD_SOUND_TYPE_OPUS, + + FMOD_SOUND_TYPE_MAX, + FMOD_SOUND_TYPE_FORCEINT = 65536 +} FMOD_SOUND_TYPE; + +typedef enum FMOD_SOUND_FORMAT +{ + FMOD_SOUND_FORMAT_NONE, + FMOD_SOUND_FORMAT_PCM8, + FMOD_SOUND_FORMAT_PCM16, + FMOD_SOUND_FORMAT_PCM24, + FMOD_SOUND_FORMAT_PCM32, + FMOD_SOUND_FORMAT_PCMFLOAT, + FMOD_SOUND_FORMAT_BITSTREAM, + + FMOD_SOUND_FORMAT_MAX, + FMOD_SOUND_FORMAT_FORCEINT = 65536 +} FMOD_SOUND_FORMAT; + +typedef enum FMOD_OPENSTATE +{ + FMOD_OPENSTATE_READY, + FMOD_OPENSTATE_LOADING, + FMOD_OPENSTATE_ERROR, + FMOD_OPENSTATE_CONNECTING, + FMOD_OPENSTATE_BUFFERING, + FMOD_OPENSTATE_SEEKING, + FMOD_OPENSTATE_PLAYING, + FMOD_OPENSTATE_SETPOSITION, + + FMOD_OPENSTATE_MAX, + FMOD_OPENSTATE_FORCEINT = 65536 +} FMOD_OPENSTATE; + +typedef enum FMOD_SOUNDGROUP_BEHAVIOR +{ + FMOD_SOUNDGROUP_BEHAVIOR_FAIL, + FMOD_SOUNDGROUP_BEHAVIOR_MUTE, + FMOD_SOUNDGROUP_BEHAVIOR_STEALLOWEST, + + FMOD_SOUNDGROUP_BEHAVIOR_MAX, + FMOD_SOUNDGROUP_BEHAVIOR_FORCEINT = 65536 +} FMOD_SOUNDGROUP_BEHAVIOR; + +typedef enum FMOD_CHANNELCONTROL_CALLBACK_TYPE +{ + FMOD_CHANNELCONTROL_CALLBACK_END, + FMOD_CHANNELCONTROL_CALLBACK_VIRTUALVOICE, + FMOD_CHANNELCONTROL_CALLBACK_SYNCPOINT, + FMOD_CHANNELCONTROL_CALLBACK_OCCLUSION, + + FMOD_CHANNELCONTROL_CALLBACK_MAX, + FMOD_CHANNELCONTROL_CALLBACK_FORCEINT = 65536 +} FMOD_CHANNELCONTROL_CALLBACK_TYPE; + +typedef enum FMOD_CHANNELCONTROL_DSP_INDEX +{ + FMOD_CHANNELCONTROL_DSP_HEAD = -1, + FMOD_CHANNELCONTROL_DSP_FADER = -2, + FMOD_CHANNELCONTROL_DSP_TAIL = -3, + + FMOD_CHANNELCONTROL_DSP_FORCEINT = 65536 +} FMOD_CHANNELCONTROL_DSP_INDEX; + +typedef enum FMOD_ERRORCALLBACK_INSTANCETYPE +{ + FMOD_ERRORCALLBACK_INSTANCETYPE_NONE, + FMOD_ERRORCALLBACK_INSTANCETYPE_SYSTEM, + FMOD_ERRORCALLBACK_INSTANCETYPE_CHANNEL, + FMOD_ERRORCALLBACK_INSTANCETYPE_CHANNELGROUP, + FMOD_ERRORCALLBACK_INSTANCETYPE_CHANNELCONTROL, + FMOD_ERRORCALLBACK_INSTANCETYPE_SOUND, + FMOD_ERRORCALLBACK_INSTANCETYPE_SOUNDGROUP, + FMOD_ERRORCALLBACK_INSTANCETYPE_DSP, + FMOD_ERRORCALLBACK_INSTANCETYPE_DSPCONNECTION, + FMOD_ERRORCALLBACK_INSTANCETYPE_GEOMETRY, + FMOD_ERRORCALLBACK_INSTANCETYPE_REVERB3D, + FMOD_ERRORCALLBACK_INSTANCETYPE_STUDIO_SYSTEM, + FMOD_ERRORCALLBACK_INSTANCETYPE_STUDIO_EVENTDESCRIPTION, + FMOD_ERRORCALLBACK_INSTANCETYPE_STUDIO_EVENTINSTANCE, + FMOD_ERRORCALLBACK_INSTANCETYPE_STUDIO_PARAMETERINSTANCE, + FMOD_ERRORCALLBACK_INSTANCETYPE_STUDIO_BUS, + FMOD_ERRORCALLBACK_INSTANCETYPE_STUDIO_VCA, + FMOD_ERRORCALLBACK_INSTANCETYPE_STUDIO_BANK, + FMOD_ERRORCALLBACK_INSTANCETYPE_STUDIO_COMMANDREPLAY, + + FMOD_ERRORCALLBACK_INSTANCETYPE_FORCEINT = 65536 +} FMOD_ERRORCALLBACK_INSTANCETYPE; + +typedef enum FMOD_DSP_RESAMPLER +{ + FMOD_DSP_RESAMPLER_DEFAULT, + FMOD_DSP_RESAMPLER_NOINTERP, + FMOD_DSP_RESAMPLER_LINEAR, + FMOD_DSP_RESAMPLER_CUBIC, + FMOD_DSP_RESAMPLER_SPLINE, + + FMOD_DSP_RESAMPLER_MAX, + FMOD_DSP_RESAMPLER_FORCEINT = 65536 +} FMOD_DSP_RESAMPLER; + +typedef enum FMOD_DSPCONNECTION_TYPE +{ + FMOD_DSPCONNECTION_TYPE_STANDARD, + FMOD_DSPCONNECTION_TYPE_SIDECHAIN, + FMOD_DSPCONNECTION_TYPE_SEND, + FMOD_DSPCONNECTION_TYPE_SEND_SIDECHAIN, + + FMOD_DSPCONNECTION_TYPE_MAX, + FMOD_DSPCONNECTION_TYPE_FORCEINT = 65536 +} FMOD_DSPCONNECTION_TYPE; + +typedef enum FMOD_TAGTYPE +{ + FMOD_TAGTYPE_UNKNOWN, + FMOD_TAGTYPE_ID3V1, + FMOD_TAGTYPE_ID3V2, + FMOD_TAGTYPE_VORBISCOMMENT, + FMOD_TAGTYPE_SHOUTCAST, + FMOD_TAGTYPE_ICECAST, + FMOD_TAGTYPE_ASF, + FMOD_TAGTYPE_MIDI, + FMOD_TAGTYPE_PLAYLIST, + FMOD_TAGTYPE_FMOD, + FMOD_TAGTYPE_USER, + + FMOD_TAGTYPE_MAX, + FMOD_TAGTYPE_FORCEINT = 65536 +} FMOD_TAGTYPE; + +typedef enum FMOD_TAGDATATYPE +{ + FMOD_TAGDATATYPE_BINARY, + FMOD_TAGDATATYPE_INT, + FMOD_TAGDATATYPE_FLOAT, + FMOD_TAGDATATYPE_STRING, + FMOD_TAGDATATYPE_STRING_UTF16, + FMOD_TAGDATATYPE_STRING_UTF16BE, + FMOD_TAGDATATYPE_STRING_UTF8, + + FMOD_TAGDATATYPE_MAX, + FMOD_TAGDATATYPE_FORCEINT = 65536 +} FMOD_TAGDATATYPE; + +typedef enum FMOD_PORT_TYPE +{ + FMOD_PORT_TYPE_MUSIC, + FMOD_PORT_TYPE_COPYRIGHT_MUSIC, + FMOD_PORT_TYPE_VOICE, + FMOD_PORT_TYPE_CONTROLLER, + FMOD_PORT_TYPE_PERSONAL, + FMOD_PORT_TYPE_VIBRATION, + FMOD_PORT_TYPE_AUX, + + FMOD_PORT_TYPE_MAX, + FMOD_PORT_TYPE_FORCEINT = 65536 +} FMOD_PORT_TYPE; + +/* + FMOD callbacks +*/ +typedef FMOD_RESULT (F_CALL *FMOD_DEBUG_CALLBACK) (FMOD_DEBUG_FLAGS flags, const char *file, int line, const char* func, const char* message); +typedef FMOD_RESULT (F_CALL *FMOD_SYSTEM_CALLBACK) (FMOD_SYSTEM *system, FMOD_SYSTEM_CALLBACK_TYPE type, void *commanddata1, void* commanddata2, void *userdata); +typedef FMOD_RESULT (F_CALL *FMOD_CHANNELCONTROL_CALLBACK) (FMOD_CHANNELCONTROL *channelcontrol, FMOD_CHANNELCONTROL_TYPE controltype, FMOD_CHANNELCONTROL_CALLBACK_TYPE callbacktype, void *commanddata1, void *commanddata2); +typedef FMOD_RESULT (F_CALL *FMOD_SOUND_NONBLOCK_CALLBACK) (FMOD_SOUND *sound, FMOD_RESULT result); +typedef FMOD_RESULT (F_CALL *FMOD_SOUND_PCMREAD_CALLBACK) (FMOD_SOUND *sound, void *data, unsigned int datalen); +typedef FMOD_RESULT (F_CALL *FMOD_SOUND_PCMSETPOS_CALLBACK) (FMOD_SOUND *sound, int subsound, unsigned int position, FMOD_TIMEUNIT postype); +typedef FMOD_RESULT (F_CALL *FMOD_FILE_OPEN_CALLBACK) (const char *name, unsigned int *filesize, void **handle, void *userdata); +typedef FMOD_RESULT (F_CALL *FMOD_FILE_CLOSE_CALLBACK) (void *handle, void *userdata); +typedef FMOD_RESULT (F_CALL *FMOD_FILE_READ_CALLBACK) (void *handle, void *buffer, unsigned int sizebytes, unsigned int *bytesread, void *userdata); +typedef FMOD_RESULT (F_CALL *FMOD_FILE_SEEK_CALLBACK) (void *handle, unsigned int pos, void *userdata); +typedef FMOD_RESULT (F_CALL *FMOD_FILE_ASYNCREAD_CALLBACK) (FMOD_ASYNCREADINFO *info, void *userdata); +typedef FMOD_RESULT (F_CALL *FMOD_FILE_ASYNCCANCEL_CALLBACK)(FMOD_ASYNCREADINFO *info, void *userdata); +typedef void (F_CALL *FMOD_FILE_ASYNCDONE_FUNC) (FMOD_ASYNCREADINFO *info, FMOD_RESULT result); +typedef void* (F_CALL *FMOD_MEMORY_ALLOC_CALLBACK) (unsigned int size, FMOD_MEMORY_TYPE type, const char *sourcestr); +typedef void* (F_CALL *FMOD_MEMORY_REALLOC_CALLBACK) (void *ptr, unsigned int size, FMOD_MEMORY_TYPE type, const char *sourcestr); +typedef void (F_CALL *FMOD_MEMORY_FREE_CALLBACK) (void *ptr, FMOD_MEMORY_TYPE type, const char *sourcestr); +typedef float (F_CALL *FMOD_3D_ROLLOFF_CALLBACK) (FMOD_CHANNELCONTROL *channelcontrol, float distance); + +/* + FMOD structs +*/ +struct FMOD_ASYNCREADINFO +{ + void *handle; + unsigned int offset; + unsigned int sizebytes; + int priority; + void *userdata; + void *buffer; + unsigned int bytesread; + FMOD_FILE_ASYNCDONE_FUNC done; +}; + +typedef struct FMOD_VECTOR +{ + float x; + float y; + float z; +} FMOD_VECTOR; + +typedef struct FMOD_3D_ATTRIBUTES +{ + FMOD_VECTOR position; + FMOD_VECTOR velocity; + FMOD_VECTOR forward; + FMOD_VECTOR up; +} FMOD_3D_ATTRIBUTES; + +typedef struct FMOD_GUID +{ + unsigned int Data1; + unsigned short Data2; + unsigned short Data3; + unsigned char Data4[8]; +} FMOD_GUID; + +typedef struct FMOD_PLUGINLIST +{ + FMOD_PLUGINTYPE type; + void *description; +} FMOD_PLUGINLIST; + +typedef struct FMOD_ADVANCEDSETTINGS +{ + int cbSize; + int maxMPEGCodecs; + int maxADPCMCodecs; + int maxXMACodecs; + int maxVorbisCodecs; + int maxAT9Codecs; + int maxFADPCMCodecs; + int maxPCMCodecs; + int ASIONumChannels; + char **ASIOChannelList; + FMOD_SPEAKER *ASIOSpeakerList; + float vol0virtualvol; + unsigned int defaultDecodeBufferSize; + unsigned short profilePort; + unsigned int geometryMaxFadeTime; + float distanceFilterCenterFreq; + int reverb3Dinstance; + int DSPBufferPoolSize; + FMOD_DSP_RESAMPLER resamplerMethod; + unsigned int randomSeed; + int maxConvolutionThreads; + int maxOpusCodecs; +} FMOD_ADVANCEDSETTINGS; + +typedef struct FMOD_TAG +{ + FMOD_TAGTYPE type; + FMOD_TAGDATATYPE datatype; + char *name; + void *data; + unsigned int datalen; + FMOD_BOOL updated; +} FMOD_TAG; + +typedef struct FMOD_CREATESOUNDEXINFO +{ + int cbsize; + unsigned int length; + unsigned int fileoffset; + int numchannels; + int defaultfrequency; + FMOD_SOUND_FORMAT format; + unsigned int decodebuffersize; + int initialsubsound; + int numsubsounds; + int *inclusionlist; + int inclusionlistnum; + FMOD_SOUND_PCMREAD_CALLBACK pcmreadcallback; + FMOD_SOUND_PCMSETPOS_CALLBACK pcmsetposcallback; + FMOD_SOUND_NONBLOCK_CALLBACK nonblockcallback; + const char *dlsname; + const char *encryptionkey; + int maxpolyphony; + void *userdata; + FMOD_SOUND_TYPE suggestedsoundtype; + FMOD_FILE_OPEN_CALLBACK fileuseropen; + FMOD_FILE_CLOSE_CALLBACK fileuserclose; + FMOD_FILE_READ_CALLBACK fileuserread; + FMOD_FILE_SEEK_CALLBACK fileuserseek; + FMOD_FILE_ASYNCREAD_CALLBACK fileuserasyncread; + FMOD_FILE_ASYNCCANCEL_CALLBACK fileuserasynccancel; + void *fileuserdata; + int filebuffersize; + FMOD_CHANNELORDER channelorder; + FMOD_SOUNDGROUP *initialsoundgroup; + unsigned int initialseekposition; + FMOD_TIMEUNIT initialseekpostype; + int ignoresetfilesystem; + unsigned int audioqueuepolicy; + unsigned int minmidigranularity; + int nonblockthreadid; + FMOD_GUID *fsbguid; +} FMOD_CREATESOUNDEXINFO; + +typedef struct FMOD_REVERB_PROPERTIES +{ + float DecayTime; + float EarlyDelay; + float LateDelay; + float HFReference; + float HFDecayRatio; + float Diffusion; + float Density; + float LowShelfFrequency; + float LowShelfGain; + float HighCut; + float EarlyLateMix; + float WetLevel; +} FMOD_REVERB_PROPERTIES; + +typedef struct FMOD_ERRORCALLBACK_INFO +{ + FMOD_RESULT result; + FMOD_ERRORCALLBACK_INSTANCETYPE instancetype; + void *instance; + const char *functionname; + const char *functionparams; +} FMOD_ERRORCALLBACK_INFO; + +typedef struct FMOD_CPU_USAGE +{ + float dsp; + float stream; + float geometry; + float update; + float convolution1; + float convolution2; +} FMOD_CPU_USAGE; + + +/* + FMOD optional headers for plugin development +*/ +#include "fmod_codec.h" +#include "fmod_dsp.h" +#include "fmod_output.h" + +#endif diff --git a/lib/fmod/inc/fmod_dsp.h b/lib/fmod/inc/fmod_dsp.h new file mode 100644 index 00000000..4c27c343 --- /dev/null +++ b/lib/fmod/inc/fmod_dsp.h @@ -0,0 +1,421 @@ +/* ======================================================================================== */ +/* FMOD Core API - DSP header file. */ +/* Copyright (c), Firelight Technologies Pty, Ltd. 2004-2022. */ +/* */ +/* Use this header if you are wanting to develop your own DSP plugin to use with FMODs */ +/* dsp system. With this header you can make your own DSP plugin that FMOD can */ +/* register and use. See the documentation and examples on how to make a working plugin. */ +/* */ +/* For more detail visit: */ +/* https://fmod.com/docs/2.02/api/plugin-api-dsp.html */ +/* =========================================================================================*/ +#ifndef _FMOD_DSP_H +#define _FMOD_DSP_H + +#include "fmod_dsp_effects.h" + +typedef struct FMOD_DSP_STATE FMOD_DSP_STATE; +typedef struct FMOD_DSP_BUFFER_ARRAY FMOD_DSP_BUFFER_ARRAY; +typedef struct FMOD_COMPLEX FMOD_COMPLEX; + +/* + DSP Constants +*/ +#define FMOD_PLUGIN_SDK_VERSION 110 +#define FMOD_DSP_GETPARAM_VALUESTR_LENGTH 32 + +typedef enum +{ + FMOD_DSP_PROCESS_PERFORM, + FMOD_DSP_PROCESS_QUERY +} FMOD_DSP_PROCESS_OPERATION; + +typedef enum FMOD_DSP_PAN_SURROUND_FLAGS +{ + FMOD_DSP_PAN_SURROUND_DEFAULT = 0, + FMOD_DSP_PAN_SURROUND_ROTATION_NOT_BIASED = 1, + + FMOD_DSP_PAN_SURROUND_FLAGS_FORCEINT = 65536 +} FMOD_DSP_PAN_SURROUND_FLAGS; + +typedef enum +{ + FMOD_DSP_PARAMETER_TYPE_FLOAT, + FMOD_DSP_PARAMETER_TYPE_INT, + FMOD_DSP_PARAMETER_TYPE_BOOL, + FMOD_DSP_PARAMETER_TYPE_DATA, + + FMOD_DSP_PARAMETER_TYPE_MAX, + FMOD_DSP_PARAMETER_TYPE_FORCEINT = 65536 +} FMOD_DSP_PARAMETER_TYPE; + +typedef enum +{ + FMOD_DSP_PARAMETER_FLOAT_MAPPING_TYPE_LINEAR, + FMOD_DSP_PARAMETER_FLOAT_MAPPING_TYPE_AUTO, + FMOD_DSP_PARAMETER_FLOAT_MAPPING_TYPE_PIECEWISE_LINEAR, + + FMOD_DSP_PARAMETER_FLOAT_MAPPING_TYPE_FORCEINT = 65536 +} FMOD_DSP_PARAMETER_FLOAT_MAPPING_TYPE; + +typedef enum +{ + FMOD_DSP_PARAMETER_DATA_TYPE_USER = 0, + FMOD_DSP_PARAMETER_DATA_TYPE_OVERALLGAIN = -1, + FMOD_DSP_PARAMETER_DATA_TYPE_3DATTRIBUTES = -2, + FMOD_DSP_PARAMETER_DATA_TYPE_SIDECHAIN = -3, + FMOD_DSP_PARAMETER_DATA_TYPE_FFT = -4, + FMOD_DSP_PARAMETER_DATA_TYPE_3DATTRIBUTES_MULTI = -5, + FMOD_DSP_PARAMETER_DATA_TYPE_ATTENUATION_RANGE = -6, +} FMOD_DSP_PARAMETER_DATA_TYPE; + +/* + DSP Callbacks +*/ +typedef FMOD_RESULT (F_CALL *FMOD_DSP_CREATE_CALLBACK) (FMOD_DSP_STATE *dsp_state); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_RELEASE_CALLBACK) (FMOD_DSP_STATE *dsp_state); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_RESET_CALLBACK) (FMOD_DSP_STATE *dsp_state); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_READ_CALLBACK) (FMOD_DSP_STATE *dsp_state, float *inbuffer, float *outbuffer, unsigned int length, int inchannels, int *outchannels); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_PROCESS_CALLBACK) (FMOD_DSP_STATE *dsp_state, unsigned int length, const FMOD_DSP_BUFFER_ARRAY *inbufferarray, FMOD_DSP_BUFFER_ARRAY *outbufferarray, FMOD_BOOL inputsidle, FMOD_DSP_PROCESS_OPERATION op); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_SETPOSITION_CALLBACK) (FMOD_DSP_STATE *dsp_state, unsigned int pos); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_SHOULDIPROCESS_CALLBACK) (FMOD_DSP_STATE *dsp_state, FMOD_BOOL inputsidle, unsigned int length, FMOD_CHANNELMASK inmask, int inchannels, FMOD_SPEAKERMODE speakermode); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_SETPARAM_FLOAT_CALLBACK) (FMOD_DSP_STATE *dsp_state, int index, float value); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_SETPARAM_INT_CALLBACK) (FMOD_DSP_STATE *dsp_state, int index, int value); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_SETPARAM_BOOL_CALLBACK) (FMOD_DSP_STATE *dsp_state, int index, FMOD_BOOL value); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_SETPARAM_DATA_CALLBACK) (FMOD_DSP_STATE *dsp_state, int index, void *data, unsigned int length); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_GETPARAM_FLOAT_CALLBACK) (FMOD_DSP_STATE *dsp_state, int index, float *value, char *valuestr); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_GETPARAM_INT_CALLBACK) (FMOD_DSP_STATE *dsp_state, int index, int *value, char *valuestr); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_GETPARAM_BOOL_CALLBACK) (FMOD_DSP_STATE *dsp_state, int index, FMOD_BOOL *value, char *valuestr); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_GETPARAM_DATA_CALLBACK) (FMOD_DSP_STATE *dsp_state, int index, void **data, unsigned int *length, char *valuestr); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_SYSTEM_REGISTER_CALLBACK) (FMOD_DSP_STATE *dsp_state); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_SYSTEM_DEREGISTER_CALLBACK) (FMOD_DSP_STATE *dsp_state); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_SYSTEM_MIX_CALLBACK) (FMOD_DSP_STATE *dsp_state, int stage); + +/* + DSP Functions +*/ +typedef void * (F_CALL *FMOD_DSP_ALLOC_FUNC) (unsigned int size, FMOD_MEMORY_TYPE type, const char *sourcestr); +typedef void * (F_CALL *FMOD_DSP_REALLOC_FUNC) (void *ptr, unsigned int size, FMOD_MEMORY_TYPE type, const char *sourcestr); +typedef void (F_CALL *FMOD_DSP_FREE_FUNC) (void *ptr, FMOD_MEMORY_TYPE type, const char *sourcestr); +typedef void (F_CALL *FMOD_DSP_LOG_FUNC) (FMOD_DEBUG_FLAGS level, const char *file, int line, const char *function, const char *str, ...); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_GETSAMPLERATE_FUNC) (FMOD_DSP_STATE *dsp_state, int *rate); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_GETBLOCKSIZE_FUNC) (FMOD_DSP_STATE *dsp_state, unsigned int *blocksize); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_GETSPEAKERMODE_FUNC) (FMOD_DSP_STATE *dsp_state, FMOD_SPEAKERMODE *speakermode_mixer, FMOD_SPEAKERMODE *speakermode_output); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_GETCLOCK_FUNC) (FMOD_DSP_STATE *dsp_state, unsigned long long *clock, unsigned int *offset, unsigned int *length); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_GETLISTENERATTRIBUTES_FUNC) (FMOD_DSP_STATE *dsp_state, int *numlisteners, FMOD_3D_ATTRIBUTES *attributes); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_GETUSERDATA_FUNC) (FMOD_DSP_STATE *dsp_state, void **userdata); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_DFT_FFTREAL_FUNC) (FMOD_DSP_STATE *dsp_state, int size, const float *signal, FMOD_COMPLEX* dft, const float *window, int signalhop); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_DFT_IFFTREAL_FUNC) (FMOD_DSP_STATE *dsp_state, int size, const FMOD_COMPLEX *dft, float* signal, const float *window, int signalhop); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_PAN_SUMMONOMATRIX_FUNC) (FMOD_DSP_STATE *dsp_state, FMOD_SPEAKERMODE sourceSpeakerMode, float lowFrequencyGain, float overallGain, float *matrix); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_PAN_SUMSTEREOMATRIX_FUNC) (FMOD_DSP_STATE *dsp_state, FMOD_SPEAKERMODE sourceSpeakerMode, float pan, float lowFrequencyGain, float overallGain, int matrixHop, float *matrix); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_PAN_SUMSURROUNDMATRIX_FUNC) (FMOD_DSP_STATE *dsp_state, FMOD_SPEAKERMODE sourceSpeakerMode, FMOD_SPEAKERMODE targetSpeakerMode, float direction, float extent, float rotation, float lowFrequencyGain, float overallGain, int matrixHop, float *matrix, FMOD_DSP_PAN_SURROUND_FLAGS flags); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_PAN_SUMMONOTOSURROUNDMATRIX_FUNC) (FMOD_DSP_STATE *dsp_state, FMOD_SPEAKERMODE targetSpeakerMode, float direction, float extent, float lowFrequencyGain, float overallGain, int matrixHop, float *matrix); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_PAN_SUMSTEREOTOSURROUNDMATRIX_FUNC) (FMOD_DSP_STATE *dsp_state, FMOD_SPEAKERMODE targetSpeakerMode, float direction, float extent, float rotation, float lowFrequencyGain, float overallGain, int matrixHop, float *matrix); +typedef FMOD_RESULT (F_CALL *FMOD_DSP_PAN_GETROLLOFFGAIN_FUNC) (FMOD_DSP_STATE *dsp_state, FMOD_DSP_PAN_3D_ROLLOFF_TYPE rolloff, float distance, float mindistance, float maxdistance, float *gain); + +/* + DSP Structures +*/ +struct FMOD_DSP_BUFFER_ARRAY +{ + int numbuffers; + int *buffernumchannels; + FMOD_CHANNELMASK *bufferchannelmask; + float **buffers; + FMOD_SPEAKERMODE speakermode; +}; + +struct FMOD_COMPLEX +{ + float real; + float imag; +}; + +typedef struct FMOD_DSP_PARAMETER_FLOAT_MAPPING_PIECEWISE_LINEAR +{ + int numpoints; + float *pointparamvalues; + float *pointpositions; +} FMOD_DSP_PARAMETER_FLOAT_MAPPING_PIECEWISE_LINEAR; + +typedef struct FMOD_DSP_PARAMETER_FLOAT_MAPPING +{ + FMOD_DSP_PARAMETER_FLOAT_MAPPING_TYPE type; + FMOD_DSP_PARAMETER_FLOAT_MAPPING_PIECEWISE_LINEAR piecewiselinearmapping; +} FMOD_DSP_PARAMETER_FLOAT_MAPPING; + +typedef struct FMOD_DSP_PARAMETER_DESC_FLOAT +{ + float min; + float max; + float defaultval; + FMOD_DSP_PARAMETER_FLOAT_MAPPING mapping; +} FMOD_DSP_PARAMETER_DESC_FLOAT; + +typedef struct FMOD_DSP_PARAMETER_DESC_INT +{ + int min; + int max; + int defaultval; + FMOD_BOOL goestoinf; + const char* const* valuenames; +} FMOD_DSP_PARAMETER_DESC_INT; + +typedef struct FMOD_DSP_PARAMETER_DESC_BOOL +{ + FMOD_BOOL defaultval; + const char* const* valuenames; +} FMOD_DSP_PARAMETER_DESC_BOOL; + +typedef struct FMOD_DSP_PARAMETER_DESC_DATA +{ + int datatype; +} FMOD_DSP_PARAMETER_DESC_DATA; + +typedef struct FMOD_DSP_PARAMETER_DESC +{ + FMOD_DSP_PARAMETER_TYPE type; + char name[16]; + char label[16]; + const char *description; + + union + { + FMOD_DSP_PARAMETER_DESC_FLOAT floatdesc; + FMOD_DSP_PARAMETER_DESC_INT intdesc; + FMOD_DSP_PARAMETER_DESC_BOOL booldesc; + FMOD_DSP_PARAMETER_DESC_DATA datadesc; + }; +} FMOD_DSP_PARAMETER_DESC; + +typedef struct FMOD_DSP_PARAMETER_OVERALLGAIN +{ + float linear_gain; + float linear_gain_additive; +} FMOD_DSP_PARAMETER_OVERALLGAIN; + +typedef struct FMOD_DSP_PARAMETER_3DATTRIBUTES +{ + FMOD_3D_ATTRIBUTES relative; + FMOD_3D_ATTRIBUTES absolute; +} FMOD_DSP_PARAMETER_3DATTRIBUTES; + +typedef struct FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI +{ + int numlisteners; + FMOD_3D_ATTRIBUTES relative[FMOD_MAX_LISTENERS]; + float weight[FMOD_MAX_LISTENERS]; + FMOD_3D_ATTRIBUTES absolute; +} FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI; + +typedef struct FMOD_DSP_PARAMETER_ATTENUATION_RANGE +{ + float min; + float max; +} FMOD_DSP_PARAMETER_ATTENUATION_RANGE; + +typedef struct FMOD_DSP_PARAMETER_SIDECHAIN +{ + FMOD_BOOL sidechainenable; +} FMOD_DSP_PARAMETER_SIDECHAIN; + +typedef struct FMOD_DSP_PARAMETER_FFT +{ + int length; + int numchannels; + float *spectrum[32]; +} FMOD_DSP_PARAMETER_FFT; + +typedef struct FMOD_DSP_DESCRIPTION +{ + unsigned int pluginsdkversion; + char name[32]; + unsigned int version; + int numinputbuffers; + int numoutputbuffers; + FMOD_DSP_CREATE_CALLBACK create; + FMOD_DSP_RELEASE_CALLBACK release; + FMOD_DSP_RESET_CALLBACK reset; + FMOD_DSP_READ_CALLBACK read; + FMOD_DSP_PROCESS_CALLBACK process; + FMOD_DSP_SETPOSITION_CALLBACK setposition; + + int numparameters; + FMOD_DSP_PARAMETER_DESC **paramdesc; + FMOD_DSP_SETPARAM_FLOAT_CALLBACK setparameterfloat; + FMOD_DSP_SETPARAM_INT_CALLBACK setparameterint; + FMOD_DSP_SETPARAM_BOOL_CALLBACK setparameterbool; + FMOD_DSP_SETPARAM_DATA_CALLBACK setparameterdata; + FMOD_DSP_GETPARAM_FLOAT_CALLBACK getparameterfloat; + FMOD_DSP_GETPARAM_INT_CALLBACK getparameterint; + FMOD_DSP_GETPARAM_BOOL_CALLBACK getparameterbool; + FMOD_DSP_GETPARAM_DATA_CALLBACK getparameterdata; + FMOD_DSP_SHOULDIPROCESS_CALLBACK shouldiprocess; + void *userdata; + + FMOD_DSP_SYSTEM_REGISTER_CALLBACK sys_register; + FMOD_DSP_SYSTEM_DEREGISTER_CALLBACK sys_deregister; + FMOD_DSP_SYSTEM_MIX_CALLBACK sys_mix; + +} FMOD_DSP_DESCRIPTION; + +typedef struct FMOD_DSP_STATE_DFT_FUNCTIONS +{ + FMOD_DSP_DFT_FFTREAL_FUNC fftreal; + FMOD_DSP_DFT_IFFTREAL_FUNC inversefftreal; +} FMOD_DSP_STATE_DFT_FUNCTIONS; + +typedef struct FMOD_DSP_STATE_PAN_FUNCTIONS +{ + FMOD_DSP_PAN_SUMMONOMATRIX_FUNC summonomatrix; + FMOD_DSP_PAN_SUMSTEREOMATRIX_FUNC sumstereomatrix; + FMOD_DSP_PAN_SUMSURROUNDMATRIX_FUNC sumsurroundmatrix; + FMOD_DSP_PAN_SUMMONOTOSURROUNDMATRIX_FUNC summonotosurroundmatrix; + FMOD_DSP_PAN_SUMSTEREOTOSURROUNDMATRIX_FUNC sumstereotosurroundmatrix; + FMOD_DSP_PAN_GETROLLOFFGAIN_FUNC getrolloffgain; +} FMOD_DSP_STATE_PAN_FUNCTIONS; + +typedef struct FMOD_DSP_STATE_FUNCTIONS +{ + FMOD_DSP_ALLOC_FUNC alloc; + FMOD_DSP_REALLOC_FUNC realloc; + FMOD_DSP_FREE_FUNC free; + FMOD_DSP_GETSAMPLERATE_FUNC getsamplerate; + FMOD_DSP_GETBLOCKSIZE_FUNC getblocksize; + FMOD_DSP_STATE_DFT_FUNCTIONS *dft; + FMOD_DSP_STATE_PAN_FUNCTIONS *pan; + FMOD_DSP_GETSPEAKERMODE_FUNC getspeakermode; + FMOD_DSP_GETCLOCK_FUNC getclock; + FMOD_DSP_GETLISTENERATTRIBUTES_FUNC getlistenerattributes; + FMOD_DSP_LOG_FUNC log; + FMOD_DSP_GETUSERDATA_FUNC getuserdata; +} FMOD_DSP_STATE_FUNCTIONS; + +struct FMOD_DSP_STATE +{ + void *instance; + void *plugindata; + FMOD_CHANNELMASK channelmask; + FMOD_SPEAKERMODE source_speakermode; + float *sidechaindata; + int sidechainchannels; + FMOD_DSP_STATE_FUNCTIONS *functions; + int systemobject; +}; + +typedef struct FMOD_DSP_METERING_INFO +{ + int numsamples; + float peaklevel[32]; + float rmslevel[32]; + short numchannels; +} FMOD_DSP_METERING_INFO; + +/* + DSP Macros +*/ +#define FMOD_DSP_INIT_PARAMDESC_FLOAT(_paramstruct, _name, _label, _description, _min, _max, _defaultval) \ + memset(&(_paramstruct), 0, sizeof(_paramstruct)); \ + (_paramstruct).type = FMOD_DSP_PARAMETER_TYPE_FLOAT; \ + strncpy((_paramstruct).name, _name, 15); \ + strncpy((_paramstruct).label, _label, 15); \ + (_paramstruct).description = _description; \ + (_paramstruct).floatdesc.min = _min; \ + (_paramstruct).floatdesc.max = _max; \ + (_paramstruct).floatdesc.defaultval = _defaultval; \ + (_paramstruct).floatdesc.mapping.type = FMOD_DSP_PARAMETER_FLOAT_MAPPING_TYPE_AUTO; + +#define FMOD_DSP_INIT_PARAMDESC_FLOAT_WITH_MAPPING(_paramstruct, _name, _label, _description, _defaultval, _values, _positions); \ + memset(&(_paramstruct), 0, sizeof(_paramstruct)); \ + (_paramstruct).type = FMOD_DSP_PARAMETER_TYPE_FLOAT; \ + strncpy((_paramstruct).name, _name , 15); \ + strncpy((_paramstruct).label, _label, 15); \ + (_paramstruct).description = _description; \ + (_paramstruct).floatdesc.min = _values[0]; \ + (_paramstruct).floatdesc.max = _values[sizeof(_values) / sizeof(float) - 1]; \ + (_paramstruct).floatdesc.defaultval = _defaultval; \ + (_paramstruct).floatdesc.mapping.type = FMOD_DSP_PARAMETER_FLOAT_MAPPING_TYPE_PIECEWISE_LINEAR; \ + (_paramstruct).floatdesc.mapping.piecewiselinearmapping.numpoints = sizeof(_values) / sizeof(float); \ + (_paramstruct).floatdesc.mapping.piecewiselinearmapping.pointparamvalues = _values; \ + (_paramstruct).floatdesc.mapping.piecewiselinearmapping.pointpositions = _positions; + +#define FMOD_DSP_INIT_PARAMDESC_INT(_paramstruct, _name, _label, _description, _min, _max, _defaultval, _goestoinf, _valuenames) \ + memset(&(_paramstruct), 0, sizeof(_paramstruct)); \ + (_paramstruct).type = FMOD_DSP_PARAMETER_TYPE_INT; \ + strncpy((_paramstruct).name, _name , 15); \ + strncpy((_paramstruct).label, _label, 15); \ + (_paramstruct).description = _description; \ + (_paramstruct).intdesc.min = _min; \ + (_paramstruct).intdesc.max = _max; \ + (_paramstruct).intdesc.defaultval = _defaultval; \ + (_paramstruct).intdesc.goestoinf = _goestoinf; \ + (_paramstruct).intdesc.valuenames = _valuenames; + +#define FMOD_DSP_INIT_PARAMDESC_INT_ENUMERATED(_paramstruct, _name, _label, _description, _defaultval, _valuenames) \ + memset(&(_paramstruct), 0, sizeof(_paramstruct)); \ + (_paramstruct).type = FMOD_DSP_PARAMETER_TYPE_INT; \ + strncpy((_paramstruct).name, _name , 15); \ + strncpy((_paramstruct).label, _label, 15); \ + (_paramstruct).description = _description; \ + (_paramstruct).intdesc.min = 0; \ + (_paramstruct).intdesc.max = sizeof(_valuenames) / sizeof(char*) - 1; \ + (_paramstruct).intdesc.defaultval = _defaultval; \ + (_paramstruct).intdesc.goestoinf = false; \ + (_paramstruct).intdesc.valuenames = _valuenames; + +#define FMOD_DSP_INIT_PARAMDESC_BOOL(_paramstruct, _name, _label, _description, _defaultval, _valuenames) \ + memset(&(_paramstruct), 0, sizeof(_paramstruct)); \ + (_paramstruct).type = FMOD_DSP_PARAMETER_TYPE_BOOL; \ + strncpy((_paramstruct).name, _name , 15); \ + strncpy((_paramstruct).label, _label, 15); \ + (_paramstruct).description = _description; \ + (_paramstruct).booldesc.defaultval = _defaultval; \ + (_paramstruct).booldesc.valuenames = _valuenames; + +#define FMOD_DSP_INIT_PARAMDESC_DATA(_paramstruct, _name, _label, _description, _datatype) \ + memset(&(_paramstruct), 0, sizeof(_paramstruct)); \ + (_paramstruct).type = FMOD_DSP_PARAMETER_TYPE_DATA; \ + strncpy((_paramstruct).name, _name , 15); \ + strncpy((_paramstruct).label, _label, 15); \ + (_paramstruct).description = _description; \ + (_paramstruct).datadesc.datatype = _datatype; + +#define FMOD_DSP_ALLOC(_state, _size) \ + (_state)->functions->alloc(_size, FMOD_MEMORY_NORMAL, __FILE__) +#define FMOD_DSP_REALLOC(_state, _ptr, _size) \ + (_state)->functions->realloc(_ptr, _size, FMOD_MEMORY_NORMAL, __FILE__) +#define FMOD_DSP_FREE(_state, _ptr) \ + (_state)->functions->free(_ptr, FMOD_MEMORY_NORMAL, __FILE__) +#define FMOD_DSP_LOG(_state, _level, _location, _format, ...) \ + (_state)->functions->log(_level, __FILE__, __LINE__, _location, _format, __VA_ARGS__) +#define FMOD_DSP_GETSAMPLERATE(_state, _rate) \ + (_state)->functions->getsamplerate(_state, _rate) +#define FMOD_DSP_GETBLOCKSIZE(_state, _blocksize) \ + (_state)->functions->getblocksize(_state, _blocksize) +#define FMOD_DSP_GETSPEAKERMODE(_state, _speakermodemix, _speakermodeout) \ + (_state)->functions->getspeakermode(_state, _speakermodemix, _speakermodeout) +#define FMOD_DSP_GETCLOCK(_state, _clock, _offset, _length) \ + (_state)->functions->getclock(_state, _clock, _offset, _length) +#define FMOD_DSP_GETLISTENERATTRIBUTES(_state, _numlisteners, _attributes) \ + (_state)->functions->getlistenerattributes(_state, _numlisteners, _attributes) +#define FMOD_DSP_GETUSERDATA(_state, _userdata) \ + (_state)->functions->getuserdata(_state, _userdata) +#define FMOD_DSP_DFT_FFTREAL(_state, _size, _signal, _dft, _window, _signalhop) \ + (_state)->functions->dft->fftreal(_state, _size, _signal, _dft, _window, _signalhop) +#define FMOD_DSP_DFT_IFFTREAL(_state, _size, _dft, _signal, _window, _signalhop) \ + (_state)->functions->dft->inversefftreal(_state, _size, _dft, _signal, _window, _signalhop) +#define FMOD_DSP_PAN_SUMMONOMATRIX(_state, _sourcespeakermode, _lowfrequencygain, _overallgain, _matrix) \ + (_state)->functions->pan->summonomatrix(_state, _sourcespeakermode, _lowfrequencygain, _overallgain, _matrix) +#define FMOD_DSP_PAN_SUMSTEREOMATRIX(_state, _sourcespeakermode, _pan, _lowfrequencygain, _overallgain, _matrixhop, _matrix) \ + (_state)->functions->pan->sumstereomatrix(_state, _sourcespeakermode, _pan, _lowfrequencygain, _overallgain, _matrixhop, _matrix) +#define FMOD_DSP_PAN_SUMSURROUNDMATRIX(_state, _sourcespeakermode, _targetspeakermode, _direction, _extent, _rotation, _lowfrequencygain, _overallgain, _matrixhop, _matrix, _flags) \ + (_state)->functions->pan->sumsurroundmatrix(_state, _sourcespeakermode, _targetspeakermode, _direction, _extent, _rotation, _lowfrequencygain, _overallgain, _matrixhop, _matrix, _flags) +#define FMOD_DSP_PAN_SUMMONOTOSURROUNDMATRIX(_state, _targetspeakermode, _direction, _extent, _lowfrequencygain, _overallgain, _matrixhop, _matrix) \ + (_state)->functions->pan->summonotosurroundmatrix(_state, _targetspeakermode, _direction, _extent, _lowfrequencygain, _overallgain, _matrixhop, _matrix) +#define FMOD_DSP_PAN_SUMSTEREOTOSURROUNDMATRIX(_state, _targetspeakermode, _direction, _extent, _rotation, _lowfrequencygain, _overallgain, matrixhop, _matrix) \ + (_state)->functions->pan->sumstereotosurroundmatrix(_state, _targetspeakermode, _direction, _extent, _rotation, _lowfrequencygain, _overallgain, matrixhop, _matrix) +#define FMOD_DSP_PAN_GETROLLOFFGAIN(_state, _rolloff, _distance, _mindistance, _maxdistance, _gain) \ + (_state)->functions->pan->getrolloffgain(_state, _rolloff, _distance, _mindistance, _maxdistance, _gain) + +#endif + diff --git a/lib/fmod/inc/fmod_dsp_effects.h b/lib/fmod/inc/fmod_dsp_effects.h new file mode 100644 index 00000000..ba0f8dd1 --- /dev/null +++ b/lib/fmod/inc/fmod_dsp_effects.h @@ -0,0 +1,577 @@ +/* ============================================================================================================= */ +/* FMOD Core API - Built-in effects header file. */ +/* Copyright (c), Firelight Technologies Pty, Ltd. 2004-2022. */ +/* */ +/* In this header you can find parameter structures for FMOD system registered DSP effects */ +/* and generators. */ +/* */ +/* For more detail visit: */ +/* https://fmod.com/docs/2.02/api/core-api-common-dsp-effects.html#fmod_dsp_type */ +/* ============================================================================================================= */ + +#ifndef _FMOD_DSP_EFFECTS_H +#define _FMOD_DSP_EFFECTS_H + +typedef enum +{ + FMOD_DSP_TYPE_UNKNOWN, + FMOD_DSP_TYPE_MIXER, + FMOD_DSP_TYPE_OSCILLATOR, + FMOD_DSP_TYPE_LOWPASS, + FMOD_DSP_TYPE_ITLOWPASS, + FMOD_DSP_TYPE_HIGHPASS, + FMOD_DSP_TYPE_ECHO, + FMOD_DSP_TYPE_FADER, + FMOD_DSP_TYPE_FLANGE, + FMOD_DSP_TYPE_DISTORTION, + FMOD_DSP_TYPE_NORMALIZE, + FMOD_DSP_TYPE_LIMITER, + FMOD_DSP_TYPE_PARAMEQ, + FMOD_DSP_TYPE_PITCHSHIFT, + FMOD_DSP_TYPE_CHORUS, + FMOD_DSP_TYPE_VSTPLUGIN, + FMOD_DSP_TYPE_WINAMPPLUGIN, + FMOD_DSP_TYPE_ITECHO, + FMOD_DSP_TYPE_COMPRESSOR, + FMOD_DSP_TYPE_SFXREVERB, + FMOD_DSP_TYPE_LOWPASS_SIMPLE, + FMOD_DSP_TYPE_DELAY, + FMOD_DSP_TYPE_TREMOLO, + FMOD_DSP_TYPE_LADSPAPLUGIN, + FMOD_DSP_TYPE_SEND, + FMOD_DSP_TYPE_RETURN, + FMOD_DSP_TYPE_HIGHPASS_SIMPLE, + FMOD_DSP_TYPE_PAN, + FMOD_DSP_TYPE_THREE_EQ, + FMOD_DSP_TYPE_FFT, + FMOD_DSP_TYPE_LOUDNESS_METER, + FMOD_DSP_TYPE_ENVELOPEFOLLOWER, + FMOD_DSP_TYPE_CONVOLUTIONREVERB, + FMOD_DSP_TYPE_CHANNELMIX, + FMOD_DSP_TYPE_TRANSCEIVER, + FMOD_DSP_TYPE_OBJECTPAN, + FMOD_DSP_TYPE_MULTIBAND_EQ, + + FMOD_DSP_TYPE_MAX, + FMOD_DSP_TYPE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ +} FMOD_DSP_TYPE; + +/* + =================================================================================================== + + FMOD built in effect parameters. + Use DSP::setParameter with these enums for the 'index' parameter. + + =================================================================================================== +*/ + +typedef enum +{ + FMOD_DSP_OSCILLATOR_TYPE, + FMOD_DSP_OSCILLATOR_RATE +} FMOD_DSP_OSCILLATOR; + + +typedef enum +{ + FMOD_DSP_LOWPASS_CUTOFF, + FMOD_DSP_LOWPASS_RESONANCE +} FMOD_DSP_LOWPASS; + + +typedef enum +{ + FMOD_DSP_ITLOWPASS_CUTOFF, + FMOD_DSP_ITLOWPASS_RESONANCE +} FMOD_DSP_ITLOWPASS; + + +typedef enum +{ + FMOD_DSP_HIGHPASS_CUTOFF, + FMOD_DSP_HIGHPASS_RESONANCE +} FMOD_DSP_HIGHPASS; + + +typedef enum +{ + FMOD_DSP_ECHO_DELAY, + FMOD_DSP_ECHO_FEEDBACK, + FMOD_DSP_ECHO_DRYLEVEL, + FMOD_DSP_ECHO_WETLEVEL +} FMOD_DSP_ECHO; + + +typedef enum FMOD_DSP_FADER +{ + FMOD_DSP_FADER_GAIN, + FMOD_DSP_FADER_OVERALL_GAIN, +} FMOD_DSP_FADER; + + +typedef enum +{ + FMOD_DSP_FLANGE_MIX, + FMOD_DSP_FLANGE_DEPTH, + FMOD_DSP_FLANGE_RATE +} FMOD_DSP_FLANGE; + + +typedef enum +{ + FMOD_DSP_DISTORTION_LEVEL +} FMOD_DSP_DISTORTION; + + +typedef enum +{ + FMOD_DSP_NORMALIZE_FADETIME, + FMOD_DSP_NORMALIZE_THRESHOLD, + FMOD_DSP_NORMALIZE_MAXAMP +} FMOD_DSP_NORMALIZE; + + +typedef enum +{ + FMOD_DSP_LIMITER_RELEASETIME, + FMOD_DSP_LIMITER_CEILING, + FMOD_DSP_LIMITER_MAXIMIZERGAIN, + FMOD_DSP_LIMITER_MODE, +} FMOD_DSP_LIMITER; + + +typedef enum +{ + FMOD_DSP_PARAMEQ_CENTER, + FMOD_DSP_PARAMEQ_BANDWIDTH, + FMOD_DSP_PARAMEQ_GAIN +} FMOD_DSP_PARAMEQ; + + +typedef enum FMOD_DSP_MULTIBAND_EQ +{ + FMOD_DSP_MULTIBAND_EQ_A_FILTER, + FMOD_DSP_MULTIBAND_EQ_A_FREQUENCY, + FMOD_DSP_MULTIBAND_EQ_A_Q, + FMOD_DSP_MULTIBAND_EQ_A_GAIN, + FMOD_DSP_MULTIBAND_EQ_B_FILTER, + FMOD_DSP_MULTIBAND_EQ_B_FREQUENCY, + FMOD_DSP_MULTIBAND_EQ_B_Q, + FMOD_DSP_MULTIBAND_EQ_B_GAIN, + FMOD_DSP_MULTIBAND_EQ_C_FILTER, + FMOD_DSP_MULTIBAND_EQ_C_FREQUENCY, + FMOD_DSP_MULTIBAND_EQ_C_Q, + FMOD_DSP_MULTIBAND_EQ_C_GAIN, + FMOD_DSP_MULTIBAND_EQ_D_FILTER, + FMOD_DSP_MULTIBAND_EQ_D_FREQUENCY, + FMOD_DSP_MULTIBAND_EQ_D_Q, + FMOD_DSP_MULTIBAND_EQ_D_GAIN, + FMOD_DSP_MULTIBAND_EQ_E_FILTER, + FMOD_DSP_MULTIBAND_EQ_E_FREQUENCY, + FMOD_DSP_MULTIBAND_EQ_E_Q, + FMOD_DSP_MULTIBAND_EQ_E_GAIN, +} FMOD_DSP_MULTIBAND_EQ; + + +typedef enum FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE +{ + FMOD_DSP_MULTIBAND_EQ_FILTER_DISABLED, + FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_12DB, + FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_24DB, + FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_48DB, + FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_12DB, + FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_24DB, + FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_48DB, + FMOD_DSP_MULTIBAND_EQ_FILTER_LOWSHELF, + FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHSHELF, + FMOD_DSP_MULTIBAND_EQ_FILTER_PEAKING, + FMOD_DSP_MULTIBAND_EQ_FILTER_BANDPASS, + FMOD_DSP_MULTIBAND_EQ_FILTER_NOTCH, + FMOD_DSP_MULTIBAND_EQ_FILTER_ALLPASS, +} FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE; + + +typedef enum +{ + FMOD_DSP_PITCHSHIFT_PITCH, + FMOD_DSP_PITCHSHIFT_FFTSIZE, + FMOD_DSP_PITCHSHIFT_OVERLAP, + FMOD_DSP_PITCHSHIFT_MAXCHANNELS +} FMOD_DSP_PITCHSHIFT; + + +typedef enum +{ + FMOD_DSP_CHORUS_MIX, + FMOD_DSP_CHORUS_RATE, + FMOD_DSP_CHORUS_DEPTH, +} FMOD_DSP_CHORUS; + + +typedef enum +{ + FMOD_DSP_ITECHO_WETDRYMIX, + FMOD_DSP_ITECHO_FEEDBACK, + FMOD_DSP_ITECHO_LEFTDELAY, + FMOD_DSP_ITECHO_RIGHTDELAY, + FMOD_DSP_ITECHO_PANDELAY +} FMOD_DSP_ITECHO; + +typedef enum +{ + FMOD_DSP_COMPRESSOR_THRESHOLD, + FMOD_DSP_COMPRESSOR_RATIO, + FMOD_DSP_COMPRESSOR_ATTACK, + FMOD_DSP_COMPRESSOR_RELEASE, + FMOD_DSP_COMPRESSOR_GAINMAKEUP, + FMOD_DSP_COMPRESSOR_USESIDECHAIN, + FMOD_DSP_COMPRESSOR_LINKED +} FMOD_DSP_COMPRESSOR; + +typedef enum +{ + FMOD_DSP_SFXREVERB_DECAYTIME, + FMOD_DSP_SFXREVERB_EARLYDELAY, + FMOD_DSP_SFXREVERB_LATEDELAY, + FMOD_DSP_SFXREVERB_HFREFERENCE, + FMOD_DSP_SFXREVERB_HFDECAYRATIO, + FMOD_DSP_SFXREVERB_DIFFUSION, + FMOD_DSP_SFXREVERB_DENSITY, + FMOD_DSP_SFXREVERB_LOWSHELFFREQUENCY, + FMOD_DSP_SFXREVERB_LOWSHELFGAIN, + FMOD_DSP_SFXREVERB_HIGHCUT, + FMOD_DSP_SFXREVERB_EARLYLATEMIX, + FMOD_DSP_SFXREVERB_WETLEVEL, + FMOD_DSP_SFXREVERB_DRYLEVEL +} FMOD_DSP_SFXREVERB; + +typedef enum +{ + FMOD_DSP_LOWPASS_SIMPLE_CUTOFF +} FMOD_DSP_LOWPASS_SIMPLE; + + +typedef enum +{ + FMOD_DSP_DELAY_CH0, + FMOD_DSP_DELAY_CH1, + FMOD_DSP_DELAY_CH2, + FMOD_DSP_DELAY_CH3, + FMOD_DSP_DELAY_CH4, + FMOD_DSP_DELAY_CH5, + FMOD_DSP_DELAY_CH6, + FMOD_DSP_DELAY_CH7, + FMOD_DSP_DELAY_CH8, + FMOD_DSP_DELAY_CH9, + FMOD_DSP_DELAY_CH10, + FMOD_DSP_DELAY_CH11, + FMOD_DSP_DELAY_CH12, + FMOD_DSP_DELAY_CH13, + FMOD_DSP_DELAY_CH14, + FMOD_DSP_DELAY_CH15, + FMOD_DSP_DELAY_MAXDELAY +} FMOD_DSP_DELAY; + + +typedef enum +{ + FMOD_DSP_TREMOLO_FREQUENCY, + FMOD_DSP_TREMOLO_DEPTH, + FMOD_DSP_TREMOLO_SHAPE, + FMOD_DSP_TREMOLO_SKEW, + FMOD_DSP_TREMOLO_DUTY, + FMOD_DSP_TREMOLO_SQUARE, + FMOD_DSP_TREMOLO_PHASE, + FMOD_DSP_TREMOLO_SPREAD +} FMOD_DSP_TREMOLO; + + +typedef enum +{ + FMOD_DSP_SEND_RETURNID, + FMOD_DSP_SEND_LEVEL, +} FMOD_DSP_SEND; + + +typedef enum +{ + FMOD_DSP_RETURN_ID, + FMOD_DSP_RETURN_INPUT_SPEAKER_MODE +} FMOD_DSP_RETURN; + + +typedef enum +{ + FMOD_DSP_HIGHPASS_SIMPLE_CUTOFF +} FMOD_DSP_HIGHPASS_SIMPLE; + + +typedef enum +{ + FMOD_DSP_PAN_2D_STEREO_MODE_DISTRIBUTED, + FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE +} FMOD_DSP_PAN_2D_STEREO_MODE_TYPE; + + +typedef enum +{ + FMOD_DSP_PAN_MODE_MONO, + FMOD_DSP_PAN_MODE_STEREO, + FMOD_DSP_PAN_MODE_SURROUND +} FMOD_DSP_PAN_MODE_TYPE; + + +typedef enum +{ + FMOD_DSP_PAN_3D_ROLLOFF_LINEARSQUARED, + FMOD_DSP_PAN_3D_ROLLOFF_LINEAR, + FMOD_DSP_PAN_3D_ROLLOFF_INVERSE, + FMOD_DSP_PAN_3D_ROLLOFF_INVERSETAPERED, + FMOD_DSP_PAN_3D_ROLLOFF_CUSTOM +} FMOD_DSP_PAN_3D_ROLLOFF_TYPE; + + +typedef enum +{ + FMOD_DSP_PAN_3D_EXTENT_MODE_AUTO, + FMOD_DSP_PAN_3D_EXTENT_MODE_USER, + FMOD_DSP_PAN_3D_EXTENT_MODE_OFF +} FMOD_DSP_PAN_3D_EXTENT_MODE_TYPE; + + +typedef enum +{ + FMOD_DSP_PAN_MODE, + FMOD_DSP_PAN_2D_STEREO_POSITION, + FMOD_DSP_PAN_2D_DIRECTION, + FMOD_DSP_PAN_2D_EXTENT, + FMOD_DSP_PAN_2D_ROTATION, + FMOD_DSP_PAN_2D_LFE_LEVEL, + FMOD_DSP_PAN_2D_STEREO_MODE, + FMOD_DSP_PAN_2D_STEREO_SEPARATION, + FMOD_DSP_PAN_2D_STEREO_AXIS, + FMOD_DSP_PAN_ENABLED_SPEAKERS, + FMOD_DSP_PAN_3D_POSITION, + FMOD_DSP_PAN_3D_ROLLOFF, + FMOD_DSP_PAN_3D_MIN_DISTANCE, + FMOD_DSP_PAN_3D_MAX_DISTANCE, + FMOD_DSP_PAN_3D_EXTENT_MODE, + FMOD_DSP_PAN_3D_SOUND_SIZE, + FMOD_DSP_PAN_3D_MIN_EXTENT, + FMOD_DSP_PAN_3D_PAN_BLEND, + FMOD_DSP_PAN_LFE_UPMIX_ENABLED, + FMOD_DSP_PAN_OVERALL_GAIN, + FMOD_DSP_PAN_SURROUND_SPEAKER_MODE, + FMOD_DSP_PAN_2D_HEIGHT_BLEND, + FMOD_DSP_PAN_ATTENUATION_RANGE, + FMOD_DSP_PAN_OVERRIDE_RANGE +} FMOD_DSP_PAN; + + +typedef enum +{ + FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_12DB, + FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_24DB, + FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_48DB +} FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_TYPE; + + +typedef enum +{ + FMOD_DSP_THREE_EQ_LOWGAIN, + FMOD_DSP_THREE_EQ_MIDGAIN, + FMOD_DSP_THREE_EQ_HIGHGAIN, + FMOD_DSP_THREE_EQ_LOWCROSSOVER, + FMOD_DSP_THREE_EQ_HIGHCROSSOVER, + FMOD_DSP_THREE_EQ_CROSSOVERSLOPE +} FMOD_DSP_THREE_EQ; + + +typedef enum +{ + FMOD_DSP_FFT_WINDOW_RECT, + FMOD_DSP_FFT_WINDOW_TRIANGLE, + FMOD_DSP_FFT_WINDOW_HAMMING, + FMOD_DSP_FFT_WINDOW_HANNING, + FMOD_DSP_FFT_WINDOW_BLACKMAN, + FMOD_DSP_FFT_WINDOW_BLACKMANHARRIS +} FMOD_DSP_FFT_WINDOW; + + +typedef enum +{ + FMOD_DSP_FFT_WINDOWSIZE, + FMOD_DSP_FFT_WINDOWTYPE, + FMOD_DSP_FFT_SPECTRUMDATA, + FMOD_DSP_FFT_DOMINANT_FREQ +} FMOD_DSP_FFT; + +#define FMOD_DSP_LOUDNESS_METER_HISTOGRAM_SAMPLES 66 + +typedef enum +{ + FMOD_DSP_LOUDNESS_METER_STATE, + FMOD_DSP_LOUDNESS_METER_WEIGHTING, + FMOD_DSP_LOUDNESS_METER_INFO +} FMOD_DSP_LOUDNESS_METER; + + +typedef enum +{ + FMOD_DSP_LOUDNESS_METER_STATE_RESET_INTEGRATED = -3, + FMOD_DSP_LOUDNESS_METER_STATE_RESET_MAXPEAK = -2, + FMOD_DSP_LOUDNESS_METER_STATE_RESET_ALL = -1, + FMOD_DSP_LOUDNESS_METER_STATE_PAUSED = 0, + FMOD_DSP_LOUDNESS_METER_STATE_ANALYZING = 1 +} FMOD_DSP_LOUDNESS_METER_STATE_TYPE; + +typedef struct FMOD_DSP_LOUDNESS_METER_INFO_TYPE +{ + float momentaryloudness; + float shorttermloudness; + float integratedloudness; + float loudness10thpercentile; + float loudness95thpercentile; + float loudnesshistogram[FMOD_DSP_LOUDNESS_METER_HISTOGRAM_SAMPLES]; + float maxtruepeak; + float maxmomentaryloudness; +} FMOD_DSP_LOUDNESS_METER_INFO_TYPE; + +typedef struct FMOD_DSP_LOUDNESS_METER_WEIGHTING_TYPE +{ + float channelweight[32]; +} FMOD_DSP_LOUDNESS_METER_WEIGHTING_TYPE; + + +typedef enum +{ + FMOD_DSP_ENVELOPEFOLLOWER_ATTACK, + FMOD_DSP_ENVELOPEFOLLOWER_RELEASE, + FMOD_DSP_ENVELOPEFOLLOWER_ENVELOPE, + FMOD_DSP_ENVELOPEFOLLOWER_USESIDECHAIN +} FMOD_DSP_ENVELOPEFOLLOWER; + +typedef enum +{ + FMOD_DSP_CONVOLUTION_REVERB_PARAM_IR, + FMOD_DSP_CONVOLUTION_REVERB_PARAM_WET, + FMOD_DSP_CONVOLUTION_REVERB_PARAM_DRY, + FMOD_DSP_CONVOLUTION_REVERB_PARAM_LINKED +} FMOD_DSP_CONVOLUTION_REVERB; + +typedef enum +{ + FMOD_DSP_CHANNELMIX_OUTPUT_DEFAULT, + FMOD_DSP_CHANNELMIX_OUTPUT_ALLMONO, + FMOD_DSP_CHANNELMIX_OUTPUT_ALLSTEREO, + FMOD_DSP_CHANNELMIX_OUTPUT_ALLQUAD, + FMOD_DSP_CHANNELMIX_OUTPUT_ALL5POINT1, + FMOD_DSP_CHANNELMIX_OUTPUT_ALL7POINT1, + FMOD_DSP_CHANNELMIX_OUTPUT_ALLLFE, + FMOD_DSP_CHANNELMIX_OUTPUT_ALL7POINT1POINT4 +} FMOD_DSP_CHANNELMIX_OUTPUT; + +typedef enum +{ + FMOD_DSP_CHANNELMIX_OUTPUTGROUPING, + FMOD_DSP_CHANNELMIX_GAIN_CH0, + FMOD_DSP_CHANNELMIX_GAIN_CH1, + FMOD_DSP_CHANNELMIX_GAIN_CH2, + FMOD_DSP_CHANNELMIX_GAIN_CH3, + FMOD_DSP_CHANNELMIX_GAIN_CH4, + FMOD_DSP_CHANNELMIX_GAIN_CH5, + FMOD_DSP_CHANNELMIX_GAIN_CH6, + FMOD_DSP_CHANNELMIX_GAIN_CH7, + FMOD_DSP_CHANNELMIX_GAIN_CH8, + FMOD_DSP_CHANNELMIX_GAIN_CH9, + FMOD_DSP_CHANNELMIX_GAIN_CH10, + FMOD_DSP_CHANNELMIX_GAIN_CH11, + FMOD_DSP_CHANNELMIX_GAIN_CH12, + FMOD_DSP_CHANNELMIX_GAIN_CH13, + FMOD_DSP_CHANNELMIX_GAIN_CH14, + FMOD_DSP_CHANNELMIX_GAIN_CH15, + FMOD_DSP_CHANNELMIX_GAIN_CH16, + FMOD_DSP_CHANNELMIX_GAIN_CH17, + FMOD_DSP_CHANNELMIX_GAIN_CH18, + FMOD_DSP_CHANNELMIX_GAIN_CH19, + FMOD_DSP_CHANNELMIX_GAIN_CH20, + FMOD_DSP_CHANNELMIX_GAIN_CH21, + FMOD_DSP_CHANNELMIX_GAIN_CH22, + FMOD_DSP_CHANNELMIX_GAIN_CH23, + FMOD_DSP_CHANNELMIX_GAIN_CH24, + FMOD_DSP_CHANNELMIX_GAIN_CH25, + FMOD_DSP_CHANNELMIX_GAIN_CH26, + FMOD_DSP_CHANNELMIX_GAIN_CH27, + FMOD_DSP_CHANNELMIX_GAIN_CH28, + FMOD_DSP_CHANNELMIX_GAIN_CH29, + FMOD_DSP_CHANNELMIX_GAIN_CH30, + FMOD_DSP_CHANNELMIX_GAIN_CH31, + FMOD_DSP_CHANNELMIX_OUTPUT_CH0, + FMOD_DSP_CHANNELMIX_OUTPUT_CH1, + FMOD_DSP_CHANNELMIX_OUTPUT_CH2, + FMOD_DSP_CHANNELMIX_OUTPUT_CH3, + FMOD_DSP_CHANNELMIX_OUTPUT_CH4, + FMOD_DSP_CHANNELMIX_OUTPUT_CH5, + FMOD_DSP_CHANNELMIX_OUTPUT_CH6, + FMOD_DSP_CHANNELMIX_OUTPUT_CH7, + FMOD_DSP_CHANNELMIX_OUTPUT_CH8, + FMOD_DSP_CHANNELMIX_OUTPUT_CH9, + FMOD_DSP_CHANNELMIX_OUTPUT_CH10, + FMOD_DSP_CHANNELMIX_OUTPUT_CH11, + FMOD_DSP_CHANNELMIX_OUTPUT_CH12, + FMOD_DSP_CHANNELMIX_OUTPUT_CH13, + FMOD_DSP_CHANNELMIX_OUTPUT_CH14, + FMOD_DSP_CHANNELMIX_OUTPUT_CH15, + FMOD_DSP_CHANNELMIX_OUTPUT_CH16, + FMOD_DSP_CHANNELMIX_OUTPUT_CH17, + FMOD_DSP_CHANNELMIX_OUTPUT_CH18, + FMOD_DSP_CHANNELMIX_OUTPUT_CH19, + FMOD_DSP_CHANNELMIX_OUTPUT_CH20, + FMOD_DSP_CHANNELMIX_OUTPUT_CH21, + FMOD_DSP_CHANNELMIX_OUTPUT_CH22, + FMOD_DSP_CHANNELMIX_OUTPUT_CH23, + FMOD_DSP_CHANNELMIX_OUTPUT_CH24, + FMOD_DSP_CHANNELMIX_OUTPUT_CH25, + FMOD_DSP_CHANNELMIX_OUTPUT_CH26, + FMOD_DSP_CHANNELMIX_OUTPUT_CH27, + FMOD_DSP_CHANNELMIX_OUTPUT_CH28, + FMOD_DSP_CHANNELMIX_OUTPUT_CH29, + FMOD_DSP_CHANNELMIX_OUTPUT_CH30, + FMOD_DSP_CHANNELMIX_OUTPUT_CH31 +} FMOD_DSP_CHANNELMIX; + +typedef enum +{ + FMOD_DSP_TRANSCEIVER_SPEAKERMODE_AUTO = -1, + FMOD_DSP_TRANSCEIVER_SPEAKERMODE_MONO = 0, + FMOD_DSP_TRANSCEIVER_SPEAKERMODE_STEREO, + FMOD_DSP_TRANSCEIVER_SPEAKERMODE_SURROUND, +} FMOD_DSP_TRANSCEIVER_SPEAKERMODE; + + +typedef enum +{ + FMOD_DSP_TRANSCEIVER_TRANSMIT, + FMOD_DSP_TRANSCEIVER_GAIN, + FMOD_DSP_TRANSCEIVER_CHANNEL, + FMOD_DSP_TRANSCEIVER_TRANSMITSPEAKERMODE +} FMOD_DSP_TRANSCEIVER; + + +typedef enum +{ + FMOD_DSP_OBJECTPAN_3D_POSITION, + FMOD_DSP_OBJECTPAN_3D_ROLLOFF, + FMOD_DSP_OBJECTPAN_3D_MIN_DISTANCE, + FMOD_DSP_OBJECTPAN_3D_MAX_DISTANCE, + FMOD_DSP_OBJECTPAN_3D_EXTENT_MODE, + FMOD_DSP_OBJECTPAN_3D_SOUND_SIZE, + FMOD_DSP_OBJECTPAN_3D_MIN_EXTENT, + FMOD_DSP_OBJECTPAN_OVERALL_GAIN, + FMOD_DSP_OBJECTPAN_OUTPUTGAIN, + FMOD_DSP_OBJECTPAN_ATTENUATION_RANGE, + FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE +} FMOD_DSP_OBJECTPAN; + +#endif + diff --git a/lib/fmod/inc/fmod_errors.h b/lib/fmod/inc/fmod_errors.h new file mode 100644 index 00000000..e491ddf9 --- /dev/null +++ b/lib/fmod/inc/fmod_errors.h @@ -0,0 +1,110 @@ +/* ============================================================================================== */ +/* FMOD Core / Studio API - Error string header file. */ +/* Copyright (c), Firelight Technologies Pty, Ltd. 2004-2022. */ +/* */ +/* Use this header if you want to store or display a string version / english explanation */ +/* of the FMOD error codes. */ +/* */ +/* For more detail visit: */ +/* https://fmod.com/docs/2.02/api/core-api-common.html#fmod_result */ +/* =============================================================================================== */ +#ifndef _FMOD_ERRORS_H +#define _FMOD_ERRORS_H + +#include "fmod.h" + +#ifdef __GNUC__ +static const char *FMOD_ErrorString(FMOD_RESULT errcode) __attribute__((unused)); +#endif + +static const char *FMOD_ErrorString(FMOD_RESULT errcode) +{ + switch (errcode) + { + case FMOD_OK: return "No errors."; + case FMOD_ERR_BADCOMMAND: return "Tried to call a function on a data type that does not allow this type of functionality (ie calling Sound::lock on a streaming sound)."; + case FMOD_ERR_CHANNEL_ALLOC: return "Error trying to allocate a channel."; + case FMOD_ERR_CHANNEL_STOLEN: return "The specified channel has been reused to play another sound."; + case FMOD_ERR_DMA: return "DMA Failure. See debug output for more information."; + case FMOD_ERR_DSP_CONNECTION: return "DSP connection error. Connection possibly caused a cyclic dependency or connected dsps with incompatible buffer counts."; + case FMOD_ERR_DSP_DONTPROCESS: return "DSP return code from a DSP process query callback. Tells mixer not to call the process callback and therefore not consume CPU. Use this to optimize the DSP graph."; + case FMOD_ERR_DSP_FORMAT: return "DSP Format error. A DSP unit may have attempted to connect to this network with the wrong format, or a matrix may have been set with the wrong size if the target unit has a specified channel map."; + case FMOD_ERR_DSP_INUSE: return "DSP is already in the mixer's DSP network. It must be removed before being reinserted or released."; + case FMOD_ERR_DSP_NOTFOUND: return "DSP connection error. Couldn't find the DSP unit specified."; + case FMOD_ERR_DSP_RESERVED: return "DSP operation error. Cannot perform operation on this DSP as it is reserved by the system."; + case FMOD_ERR_DSP_SILENCE: return "DSP return code from a DSP process query callback. Tells mixer silence would be produced from read, so go idle and not consume CPU. Use this to optimize the DSP graph."; + case FMOD_ERR_DSP_TYPE: return "DSP operation cannot be performed on a DSP of this type."; + case FMOD_ERR_FILE_BAD: return "Error loading file."; + case FMOD_ERR_FILE_COULDNOTSEEK: return "Couldn't perform seek operation. This is a limitation of the medium (ie netstreams) or the file format."; + case FMOD_ERR_FILE_DISKEJECTED: return "Media was ejected while reading."; + case FMOD_ERR_FILE_EOF: return "End of file unexpectedly reached while trying to read essential data (truncated?)."; + case FMOD_ERR_FILE_ENDOFDATA: return "End of current chunk reached while trying to read data."; + case FMOD_ERR_FILE_NOTFOUND: return "File not found."; + case FMOD_ERR_FORMAT: return "Unsupported file or audio format."; + case FMOD_ERR_HEADER_MISMATCH: return "There is a version mismatch between the FMOD header and either the FMOD Studio library or the FMOD Low Level library."; + case FMOD_ERR_HTTP: return "A HTTP error occurred. This is a catch-all for HTTP errors not listed elsewhere."; + case FMOD_ERR_HTTP_ACCESS: return "The specified resource requires authentication or is forbidden."; + case FMOD_ERR_HTTP_PROXY_AUTH: return "Proxy authentication is required to access the specified resource."; + case FMOD_ERR_HTTP_SERVER_ERROR: return "A HTTP server error occurred."; + case FMOD_ERR_HTTP_TIMEOUT: return "The HTTP request timed out."; + case FMOD_ERR_INITIALIZATION: return "FMOD was not initialized correctly to support this function."; + case FMOD_ERR_INITIALIZED: return "Cannot call this command after System::init."; + case FMOD_ERR_INTERNAL: return "An error occurred that wasn't supposed to. Contact support."; + case FMOD_ERR_INVALID_FLOAT: return "Value passed in was a NaN, Inf or denormalized float."; + case FMOD_ERR_INVALID_HANDLE: return "An invalid object handle was used."; + case FMOD_ERR_INVALID_PARAM: return "An invalid parameter was passed to this function."; + case FMOD_ERR_INVALID_POSITION: return "An invalid seek position was passed to this function."; + case FMOD_ERR_INVALID_SPEAKER: return "An invalid speaker was passed to this function based on the current speaker mode."; + case FMOD_ERR_INVALID_SYNCPOINT: return "The syncpoint did not come from this sound handle."; + case FMOD_ERR_INVALID_THREAD: return "Tried to call a function on a thread that is not supported."; + case FMOD_ERR_INVALID_VECTOR: return "The vectors passed in are not unit length, or perpendicular."; + case FMOD_ERR_MAXAUDIBLE: return "Reached maximum audible playback count for this sound's soundgroup."; + case FMOD_ERR_MEMORY: return "Not enough memory or resources."; + case FMOD_ERR_MEMORY_CANTPOINT: return "Can't use FMOD_OPENMEMORY_POINT on non PCM source data, or non mp3/xma/adpcm data if FMOD_CREATECOMPRESSEDSAMPLE was used."; + case FMOD_ERR_NEEDS3D: return "Tried to call a command on a 2d sound when the command was meant for 3d sound."; + case FMOD_ERR_NEEDSHARDWARE: return "Tried to use a feature that requires hardware support."; + case FMOD_ERR_NET_CONNECT: return "Couldn't connect to the specified host."; + case FMOD_ERR_NET_SOCKET_ERROR: return "A socket error occurred. This is a catch-all for socket-related errors not listed elsewhere."; + case FMOD_ERR_NET_URL: return "The specified URL couldn't be resolved."; + case FMOD_ERR_NET_WOULD_BLOCK: return "Operation on a non-blocking socket could not complete immediately."; + case FMOD_ERR_NOTREADY: return "Operation could not be performed because specified sound/DSP connection is not ready."; + case FMOD_ERR_OUTPUT_ALLOCATED: return "Error initializing output device, but more specifically, the output device is already in use and cannot be reused."; + case FMOD_ERR_OUTPUT_CREATEBUFFER: return "Error creating hardware sound buffer."; + case FMOD_ERR_OUTPUT_DRIVERCALL: return "A call to a standard soundcard driver failed, which could possibly mean a bug in the driver or resources were missing or exhausted."; + case FMOD_ERR_OUTPUT_FORMAT: return "Soundcard does not support the specified format."; + case FMOD_ERR_OUTPUT_INIT: return "Error initializing output device."; + case FMOD_ERR_OUTPUT_NODRIVERS: return "The output device has no drivers installed. If pre-init, FMOD_OUTPUT_NOSOUND is selected as the output mode. If post-init, the function just fails."; + case FMOD_ERR_PLUGIN: return "An unspecified error has been returned from a plugin."; + case FMOD_ERR_PLUGIN_MISSING: return "A requested output, dsp unit type or codec was not available."; + case FMOD_ERR_PLUGIN_RESOURCE: return "A resource that the plugin requires cannot be allocated or found. (ie the DLS file for MIDI playback)"; + case FMOD_ERR_PLUGIN_VERSION: return "A plugin was built with an unsupported SDK version."; + case FMOD_ERR_RECORD: return "An error occurred trying to initialize the recording device."; + case FMOD_ERR_REVERB_CHANNELGROUP: return "Reverb properties cannot be set on this channel because a parent channelgroup owns the reverb connection."; + case FMOD_ERR_REVERB_INSTANCE: return "Specified instance in FMOD_REVERB_PROPERTIES couldn't be set. Most likely because it is an invalid instance number or the reverb doesn't exist."; + case FMOD_ERR_SUBSOUNDS: return "The error occurred because the sound referenced contains subsounds when it shouldn't have, or it doesn't contain subsounds when it should have. The operation may also not be able to be performed on a parent sound."; + case FMOD_ERR_SUBSOUND_ALLOCATED: return "This subsound is already being used by another sound, you cannot have more than one parent to a sound. Null out the other parent's entry first."; + case FMOD_ERR_SUBSOUND_CANTMOVE: return "Shared subsounds cannot be replaced or moved from their parent stream, such as when the parent stream is an FSB file."; + case FMOD_ERR_TAGNOTFOUND: return "The specified tag could not be found or there are no tags."; + case FMOD_ERR_TOOMANYCHANNELS: return "The sound created exceeds the allowable input channel count. This can be increased using the 'maxinputchannels' parameter in System::setSoftwareFormat."; + case FMOD_ERR_TRUNCATED: return "The retrieved string is too long to fit in the supplied buffer and has been truncated."; + case FMOD_ERR_UNIMPLEMENTED: return "Something in FMOD hasn't been implemented when it should be! contact support!"; + case FMOD_ERR_UNINITIALIZED: return "This command failed because System::init or System::setDriver was not called."; + case FMOD_ERR_UNSUPPORTED: return "A command issued was not supported by this object. Possibly a plugin without certain callbacks specified."; + case FMOD_ERR_VERSION: return "The version number of this file format is not supported."; + case FMOD_ERR_EVENT_ALREADY_LOADED: return "The specified bank has already been loaded."; + case FMOD_ERR_EVENT_LIVEUPDATE_BUSY: return "The live update connection failed due to the game already being connected."; + case FMOD_ERR_EVENT_LIVEUPDATE_MISMATCH: return "The live update connection failed due to the game data being out of sync with the tool."; + case FMOD_ERR_EVENT_LIVEUPDATE_TIMEOUT: return "The live update connection timed out."; + case FMOD_ERR_EVENT_NOTFOUND: return "The requested event, parameter, bus or vca could not be found."; + case FMOD_ERR_STUDIO_UNINITIALIZED: return "The Studio::System object is not yet initialized."; + case FMOD_ERR_STUDIO_NOT_LOADED: return "The specified resource is not loaded, so it can't be unloaded."; + case FMOD_ERR_INVALID_STRING: return "An invalid string was passed to this function."; + case FMOD_ERR_ALREADY_LOCKED: return "The specified resource is already locked."; + case FMOD_ERR_NOT_LOCKED: return "The specified resource is not locked, so it can't be unlocked."; + case FMOD_ERR_RECORD_DISCONNECTED: return "The specified recording driver has been disconnected."; + case FMOD_ERR_TOOMANYSAMPLES: return "The length provided exceeds the allowable limit."; + default : return "Unknown error."; + }; +} + +#endif diff --git a/lib/fmod/inc/fmod_output.h b/lib/fmod/inc/fmod_output.h new file mode 100644 index 00000000..cd49b965 --- /dev/null +++ b/lib/fmod/inc/fmod_output.h @@ -0,0 +1,122 @@ +/* ======================================================================================== */ +/* FMOD Core API - output development header file. */ +/* Copyright (c), Firelight Technologies Pty, Ltd. 2004-2022. */ +/* */ +/* Use this header if you are wanting to develop your own output plugin to use with */ +/* FMOD's output system. With this header you can make your own output plugin that FMOD */ +/* can register and use. See the documentation and examples on how to make a working */ +/* plugin. */ +/* */ +/* For more detail visit: */ +/* https://fmod.com/docs/2.02/api/plugin-api-output.html */ +/* ======================================================================================== */ +#ifndef _FMOD_OUTPUT_H +#define _FMOD_OUTPUT_H + +typedef struct FMOD_OUTPUT_STATE FMOD_OUTPUT_STATE; +typedef struct FMOD_OUTPUT_OBJECT3DINFO FMOD_OUTPUT_OBJECT3DINFO; + +/* + Output constants +*/ +#define FMOD_OUTPUT_PLUGIN_VERSION 5 + +typedef unsigned int FMOD_OUTPUT_METHOD; +#define FMOD_OUTPUT_METHOD_MIX_DIRECT 0 +#define FMOD_OUTPUT_METHOD_MIX_BUFFERED 1 + +/* + Output callbacks +*/ +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_GETNUMDRIVERS_CALLBACK) (FMOD_OUTPUT_STATE *output_state, int *numdrivers); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_GETDRIVERINFO_CALLBACK) (FMOD_OUTPUT_STATE *output_state, int id, char *name, int namelen, FMOD_GUID *guid, int *systemrate, FMOD_SPEAKERMODE *speakermode, int *speakermodechannels); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_INIT_CALLBACK) (FMOD_OUTPUT_STATE *output_state, int selecteddriver, FMOD_INITFLAGS flags, int *outputrate, FMOD_SPEAKERMODE *speakermode, int *speakermodechannels, FMOD_SOUND_FORMAT *outputformat, int dspbufferlength, int *dspnumbuffers, int *dspnumadditionalbuffers, void *extradriverdata); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_START_CALLBACK) (FMOD_OUTPUT_STATE *output_state); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_STOP_CALLBACK) (FMOD_OUTPUT_STATE *output_state); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_CLOSE_CALLBACK) (FMOD_OUTPUT_STATE *output_state); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_UPDATE_CALLBACK) (FMOD_OUTPUT_STATE *output_state); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_GETHANDLE_CALLBACK) (FMOD_OUTPUT_STATE *output_state, void **handle); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_MIXER_CALLBACK) (FMOD_OUTPUT_STATE *output_state); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_OBJECT3DGETINFO_CALLBACK) (FMOD_OUTPUT_STATE *output_state, int *maxhardwareobjects); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_OBJECT3DALLOC_CALLBACK) (FMOD_OUTPUT_STATE *output_state, void **object3d); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_OBJECT3DFREE_CALLBACK) (FMOD_OUTPUT_STATE *output_state, void *object3d); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_OBJECT3DUPDATE_CALLBACK) (FMOD_OUTPUT_STATE *output_state, void *object3d, const FMOD_OUTPUT_OBJECT3DINFO *info); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_OPENPORT_CALLBACK) (FMOD_OUTPUT_STATE *output_state, FMOD_PORT_TYPE portType, FMOD_PORT_INDEX portIndex, int *portId, int *portRate, int *portChannels, FMOD_SOUND_FORMAT *portFormat); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_CLOSEPORT_CALLBACK) (FMOD_OUTPUT_STATE *output_state, int portId); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_DEVICELISTCHANGED_CALLBACK)(FMOD_OUTPUT_STATE *output_state); + +/* + Output functions +*/ +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_READFROMMIXER_FUNC) (FMOD_OUTPUT_STATE *output_state, void *buffer, unsigned int length); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_COPYPORT_FUNC) (FMOD_OUTPUT_STATE *output_state, int portId, void *buffer, unsigned int length); +typedef FMOD_RESULT (F_CALL *FMOD_OUTPUT_REQUESTRESET_FUNC) (FMOD_OUTPUT_STATE *output_state); +typedef void * (F_CALL *FMOD_OUTPUT_ALLOC_FUNC) (unsigned int size, unsigned int align, const char *file, int line); +typedef void (F_CALL *FMOD_OUTPUT_FREE_FUNC) (void *ptr, const char *file, int line); +typedef void (F_CALL *FMOD_OUTPUT_LOG_FUNC) (FMOD_DEBUG_FLAGS level, const char *file, int line, const char *function, const char *string, ...); + +/* + Output structures +*/ +typedef struct FMOD_OUTPUT_DESCRIPTION +{ + unsigned int apiversion; + const char *name; + unsigned int version; + FMOD_OUTPUT_METHOD method; + FMOD_OUTPUT_GETNUMDRIVERS_CALLBACK getnumdrivers; + FMOD_OUTPUT_GETDRIVERINFO_CALLBACK getdriverinfo; + FMOD_OUTPUT_INIT_CALLBACK init; + FMOD_OUTPUT_START_CALLBACK start; + FMOD_OUTPUT_STOP_CALLBACK stop; + FMOD_OUTPUT_CLOSE_CALLBACK close; + FMOD_OUTPUT_UPDATE_CALLBACK update; + FMOD_OUTPUT_GETHANDLE_CALLBACK gethandle; + FMOD_OUTPUT_MIXER_CALLBACK mixer; + FMOD_OUTPUT_OBJECT3DGETINFO_CALLBACK object3dgetinfo; + FMOD_OUTPUT_OBJECT3DALLOC_CALLBACK object3dalloc; + FMOD_OUTPUT_OBJECT3DFREE_CALLBACK object3dfree; + FMOD_OUTPUT_OBJECT3DUPDATE_CALLBACK object3dupdate; + FMOD_OUTPUT_OPENPORT_CALLBACK openport; + FMOD_OUTPUT_CLOSEPORT_CALLBACK closeport; + FMOD_OUTPUT_DEVICELISTCHANGED_CALLBACK devicelistchanged; +} FMOD_OUTPUT_DESCRIPTION; + +struct FMOD_OUTPUT_STATE +{ + void *plugindata; + FMOD_OUTPUT_READFROMMIXER_FUNC readfrommixer; + FMOD_OUTPUT_ALLOC_FUNC alloc; + FMOD_OUTPUT_FREE_FUNC free; + FMOD_OUTPUT_LOG_FUNC log; + FMOD_OUTPUT_COPYPORT_FUNC copyport; + FMOD_OUTPUT_REQUESTRESET_FUNC requestreset; +}; + +struct FMOD_OUTPUT_OBJECT3DINFO +{ + float *buffer; + unsigned int bufferlength; + FMOD_VECTOR position; + float gain; + float spread; + float priority; +}; + +/* + Output macros +*/ +#define FMOD_OUTPUT_READFROMMIXER(_state, _buffer, _length) \ + (_state)->readfrommixer(_state, _buffer, _length) +#define FMOD_OUTPUT_ALLOC(_state, _size, _align) \ + (_state)->alloc(_size, _align, __FILE__, __LINE__) +#define FMOD_OUTPUT_FREE(_state, _ptr) \ + (_state)->free(_ptr, __FILE__, __LINE__) +#define FMOD_OUTPUT_LOG(_state, _level, _location, _format, ...) \ + (_state)->log(_level, __FILE__, __LINE__, _location, _format, ##__VA_ARGS__) +#define FMOD_OUTPUT_COPYPORT(_state, _id, _buffer, _length) \ + (_state)->copyport(_state, _id, _buffer, _length) +#define FMOD_OUTPUT_REQUESTRESET(_state) \ + (_state)->requestreset(_state) + +#endif /* _FMOD_OUTPUT_H */ diff --git a/lib/fmod/logo/FMOD_Logo.cpp b/lib/fmod/logo/FMOD_Logo.cpp new file mode 100644 index 00000000..893a7298 --- /dev/null +++ b/lib/fmod/logo/FMOD_Logo.cpp @@ -0,0 +1,502 @@ +/// @file FMOD_Logo.cpp +/// @brief Compressed version of the FMOD logo with code to create +/// a texture ID in X-Plane for display with Dear ImGui +/// @see [FMOD attribution requirements](https://www.fmod.com/attribution) +/// @see [FMOD Logo download](https://www.fmod.com/assets/FMOD_LOGOS.zip) +/// @details The FMOD logo is essential a single-color image, +/// either black (RGB 0x06 0x08 0x0b) or white (0xff 0xff 0xff), +/// with only the alpha value varying across the image. +/// The below array `ALPHA_RLE` is a run-length encoded dump +/// of these alpha values. +/// The provided functions recreate the full RGBA data, +/// so that it can be used with OpenGL functionality to be turned +/// into a texture. +/// @details **Usage**\n +/// +/// #include "FMOD_Logo.inc" +/// ... +/// int logoId = 0; +/// if (FMODLogo::GetTexture(logoId)) { +/// ImGui::Image((void*)(intptr_t)logoId, ImVec2(FMODLogo::IMG_WIDTH, FMODLogo::IMG_HEIGHT)); +/// } +/// +/// @copyright of the logo itself: Firelight Technologies Pty Ltd. +/// +/// @author of the code: Birger Hoppe +/// @copyright (c) 2022 Birger Hoppe +/// @copyright Permission is hereby granted, free of charge, to any person obtaining a +/// copy of this software and associated documentation files (the "Software"), +/// to deal in the Software without restriction, including without limitation +/// the rights to use, copy, modify, merge, publish, distribute, sublicense, +/// and/or sell copies of the Software, and to permit persons to whom the +/// Software is furnished to do so, subject to the following conditions:\n +/// The above copyright notice and this permission notice shall be included in +/// all copies or substantial portions of the Software.\n +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +/// THE SOFTWARE. + +#include "FMOD_Logo.h" + +// Standard C/C++ header +#include +#include + +// Include (Open)GL +#if _MSC_VER // compiling via MS Visual Studio +#include // need to make sure this is read first +#endif + +#ifdef __APPLE__ +#include +#else +#include +#include +#endif + +// X-Plane headers +#include "XPLMGraphics.h" + +namespace FMODLogo { + +/// number of array entries in the RLE array +constexpr size_t RLE_SIZE = 5527; +/// Run-length encoded data of the Alpha value of each pixel in the FMOD logo +const uint16_t ALPHA_RLE[RLE_SIZE] = +{ + 0x5f00, 0x0130, 0x0240, 0x0160, 0x2b80, 0x0120, 0xff00, 0xfe00, 0x0140, 0x2780, 0x0160, 0x7b00, 0x0120, 0x0140, 0x0180, 0x01b0, + 0x01c0, 0x31ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x7700, 0x0130, 0x0170, 0x01b0, 0x01e0, 0x36ff, 0x0140, 0xff00, + 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x7400, 0x0150, 0x0190, 0x01e0, 0x3aff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x7100, + 0x0140, 0x01a0, 0x01f0, 0x3dff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x6e00, 0x0110, 0x0170, 0x01e0, 0x40ff, 0x0140, + 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x6c00, 0x0120, 0x01a0, 0x43ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x6a00, + 0x0120, 0x01a0, 0x45ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x6800, 0x0120, 0x01a0, 0x47ff, 0x0140, 0xff00, 0xfe00, + 0x0180, 0x27ff, 0x01c0, 0x6600, 0x0110, 0x0180, 0x49ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x6500, 0x0150, 0x01f0, + 0x4aff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x6300, 0x0120, 0x01b0, 0x4cff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, + 0x01c0, 0x6200, 0x0160, 0x01f0, 0x4dff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x6000, 0x0110, 0x01b0, 0x4fff, 0x0140, + 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5f00, 0x0130, 0x01e0, 0x50ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5e00, + 0x0160, 0x01f0, 0x51ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5d00, 0x0180, 0x53ff, 0x0140, 0xff00, 0xfe00, 0x0180, + 0x27ff, 0x01c0, 0x5c00, 0x01a0, 0x54ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5a00, 0x0110, 0x01c0, 0x55ff, 0x0140, + 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5900, 0x0110, 0x01d0, 0x56ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5800, + 0x0110, 0x01d0, 0x57ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5700, 0x0110, 0x01d0, 0x58ff, 0x0140, 0xff00, 0xfe00, + 0x0180, 0x27ff, 0x01c0, 0x5700, 0x01c0, 0x59ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5600, 0x01a0, 0x5aff, 0x0140, + 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5500, 0x0180, 0x5bff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5400, 0x0160, + 0x5cff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5300, 0x0130, 0x01f0, 0x5cff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, + 0x01c0, 0x5200, 0x0110, 0x01d0, 0x5dff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5200, 0x01a0, 0x5eff, 0x0140, 0xff00, + 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5100, 0x0150, 0x5fff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5000, 0x0110, 0x01f0, + 0x5fff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x5000, 0x01b0, 0x60ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, + 0x4f00, 0x0150, 0x61ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x4e00, 0x0110, 0x01e0, 0x61ff, 0x0140, 0xff00, 0xfe00, + 0x0180, 0x27ff, 0x01c0, 0x4e00, 0x0180, 0x62ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x4d00, 0x0120, 0x01f0, 0x62ff, + 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x4d00, 0x01a0, 0x63ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x4c00, + 0x0120, 0x64ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x4c00, 0x01a0, 0x64ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, + 0x01c0, 0x4b00, 0x0120, 0x65ff, 0x0140, 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x4b00, 0x0190, 0x3cff, 0x01e0, 0x28c0, 0x0130, + 0xff00, 0xfe00, 0x0180, 0x27ff, 0x01c0, 0x4a00, 0x0110, 0x01f0, 0x36ff, 0x01c0, 0x0180, 0x0140, 0x0120, 0xff00, 0xff00, 0x2b00, + 0x0180, 0x27ff, 0x01c0, 0x4a00, 0x0160, 0x34ff, 0x01b0, 0x0150, 0xff00, 0xff00, 0x3000, 0x0180, 0x27ff, 0x01c0, 0x4a00, 0x01d0, + 0x31ff, 0x01f0, 0x0180, 0x0120, 0xff00, 0xff00, 0x3200, 0x0180, 0x27ff, 0x01c0, 0x4900, 0x0130, 0x31ff, 0x01a0, 0x0110, 0xff00, + 0xff00, 0x3400, 0x0180, 0x27ff, 0x01c0, 0x4900, 0x0190, 0x2fff, 0x01e0, 0x0140, 0xff00, 0xff00, 0x3600, 0x0180, 0x27ff, 0x01c0, + 0x4900, 0x01e0, 0x2eff, 0x01a0, 0x0110, 0xff00, 0xff00, 0x3700, 0x0180, 0x27ff, 0x01c0, 0x4800, 0x0130, 0x2eff, 0x0170, 0xff00, + 0xff00, 0x3900, 0x0180, 0x27ff, 0x01c0, 0x4800, 0x0190, 0x2dff, 0x0160, 0xff00, 0xff00, 0x3a00, 0x0180, 0x27ff, 0x01c0, 0x4800, + 0x01d0, 0x2cff, 0x0160, 0xff00, 0xff00, 0x3b00, 0x0180, 0x27ff, 0x01c0, 0x4700, 0x0120, 0x2cff, 0x0180, 0xff00, 0xff00, 0x3c00, + 0x0180, 0x27ff, 0x01c0, 0x4700, 0x0160, 0x2bff, 0x01b0, 0xff00, 0xff00, 0x3d00, 0x0180, 0x27ff, 0x01c0, 0x4700, 0x01a0, 0x2aff, + 0x01e0, 0x0110, 0xff00, 0xff00, 0x3d00, 0x0180, 0x27ff, 0x01c0, 0x4700, 0x01d0, 0x2aff, 0x0140, 0xff00, 0xff00, 0x3e00, 0x0180, + 0x27ff, 0x01c0, 0x4700, 0x2aff, 0x01a0, 0xff00, 0xff00, 0x3f00, 0x0180, 0x27ff, 0x01c0, 0x4600, 0x0140, 0x2aff, 0x0120, 0xff00, + 0xff00, 0x3f00, 0x0180, 0x27ff, 0x01c0, 0x4600, 0x0170, 0x29ff, 0x01a0, 0x6600, 0x0240, 0x0170, 0x0880, 0x0240, 0x0110, 0x7b00, + 0x0110, 0x0240, 0x0880, 0x0170, 0x0240, 0x8600, 0x0120, 0x0240, 0x0a80, 0x0160, 0x0240, 0x0110, 0x8100, 0x0240, 0x0150, 0x0b80, + 0x0240, 0x0110, 0x1800, 0x0180, 0x27ff, 0x01c0, 0x4600, 0x0190, 0x29ff, 0x0120, 0x6000, 0x0110, 0x0150, 0x0180, 0x01c0, 0x01f0, + 0x0fff, 0x01f0, 0x01c0, 0x0190, 0x0150, 0x0110, 0x7100, 0x0120, 0x0160, 0x0190, 0x01c0, 0x10ff, 0x01e0, 0x01b0, 0x0180, 0x0140, + 0x7b00, 0x0130, 0x0160, 0x0180, 0x01c0, 0x01e0, 0x13ff, 0x01c0, 0x01b0, 0x0180, 0x0140, 0x0110, 0x7400, 0x0110, 0x0140, 0x0180, + 0x01a0, 0x01c0, 0x14ff, 0x01d0, 0x01b0, 0x0180, 0x0140, 0x0110, 0x1200, 0x0180, 0x27ff, 0x01c0, 0x4600, 0x01c0, 0x28ff, 0x01c0, + 0x5e00, 0x0120, 0x0170, 0x01d0, 0x19ff, 0x01d0, 0x0190, 0x0130, 0x6b00, 0x0140, 0x0190, 0x01e0, 0x19ff, 0x01c0, 0x0170, 0x0120, + 0x7300, 0x0130, 0x0180, 0x01c0, 0x1eff, 0x01e0, 0x01a0, 0x0160, 0x0120, 0x6c00, 0x0110, 0x0150, 0x0190, 0x01d0, 0x1eff, 0x01e0, + 0x01a0, 0x0160, 0x0110, 0x0e00, 0x0180, 0x27ff, 0x01c0, 0x4600, 0x01d0, 0x28ff, 0x0160, 0x5b00, 0x0110, 0x0170, 0x01d0, 0x1fff, + 0x01e0, 0x0180, 0x0120, 0x6500, 0x0120, 0x0190, 0x01f0, 0x1fff, 0x01d0, 0x0160, 0x0110, 0x6c00, 0x0110, 0x0150, 0x01a0, 0x01f0, + 0x25ff, 0x01d0, 0x0190, 0x0130, 0x6600, 0x0120, 0x0170, 0x01d0, 0x26ff, 0x01d0, 0x0170, 0x0120, 0x0b00, 0x0180, 0x27ff, 0x01c0, + 0x4600, 0x29ff, 0x0110, 0x5900, 0x0120, 0x01a0, 0x25ff, 0x01b0, 0x0140, 0x6100, 0x0150, 0x01c0, 0x24ff, 0x01f0, 0x01a0, 0x0120, + 0x6800, 0x0150, 0x01a0, 0x2cff, 0x01e0, 0x0190, 0x0120, 0x6000, 0x0110, 0x0170, 0x01d0, 0x2cff, 0x01d0, 0x0170, 0x0120, 0x0800, + 0x0180, 0x27ff, 0x01c0, 0x4600, 0x28ff, 0x01d0, 0x5800, 0x0140, 0x01c0, 0x29ff, 0x01c0, 0x0140, 0x5d00, 0x0160, 0x01e0, 0x29ff, + 0x01a0, 0x0120, 0x6300, 0x0120, 0x0180, 0x01e0, 0x31ff, 0x01c0, 0x0160, 0x5c00, 0x0140, 0x01a0, 0x32ff, 0x01b0, 0x0140, 0x0600, + 0x0180, 0x27ff, 0x01c0, 0x4500, 0x0140, 0x28ff, 0x0190, 0x5600, 0x0120, 0x01a0, 0x2dff, 0x01c0, 0x0130, 0x5900, 0x0140, 0x01d0, + 0x2dff, 0x01a0, 0x0110, 0x5f00, 0x0120, 0x01a0, 0x36ff, 0x01e0, 0x0180, 0x0110, 0x5700, 0x0160, 0x01e0, 0x36ff, 0x01e0, 0x0160, + 0x0400, 0x0180, 0x27ff, 0x01c0, 0x4500, 0x0140, 0x28ff, 0x0160, 0x1a00, 0x0110, 0x0140, 0x0170, 0x0580, 0x0170, 0x0140, 0x3100, + 0x0180, 0x01f0, 0x30ff, 0x0190, 0x0110, 0x5500, 0x0110, 0x01b0, 0x30ff, 0x01f0, 0x0170, 0x5c00, 0x0140, 0x01c0, 0x3aff, 0x01f0, + 0x0180, 0x0110, 0x5300, 0x0160, 0x01e0, 0x3aff, 0x01e0, 0x0180, 0x0110, 0x0100, 0x0180, 0x27ff, 0x01c0, 0x4500, 0x0140, 0x28ff, + 0x0140, 0x1700, 0x0120, 0x0180, 0x01d0, 0x0bff, 0x01c0, 0x0170, 0x0110, 0x2b00, 0x0130, 0x01d0, 0x33ff, 0x01f0, 0x0150, 0x5300, + 0x0160, 0x01f0, 0x33ff, 0x01c0, 0x0120, 0x5800, 0x0120, 0x01a0, 0x3eff, 0x01f0, 0x0180, 0x0110, 0x4f00, 0x0160, 0x01e0, 0x3eff, + 0x01e0, 0x0160, 0x0180, 0x27ff, 0x01c0, 0x4500, 0x0140, 0x28ff, 0x0110, 0x1500, 0x0140, 0x01c0, 0x11ff, 0x01a0, 0x0120, 0x2800, + 0x0180, 0x37ff, 0x0190, 0x0110, 0x4f00, 0x0110, 0x01b0, 0x36ff, 0x01f0, 0x0160, 0x5500, 0x0110, 0x0190, 0x42ff, 0x01e0, 0x0150, + 0x4c00, 0x0140, 0x01d0, 0x6aff, 0x01c0, 0x2300, 0x0160, 0x21c0, 0x01d0, 0x28ff, 0x1400, 0x0120, 0x01b0, 0x15ff, 0x0190, 0x0110, + 0x2400, 0x0110, 0x01c0, 0x39ff, 0x01d0, 0x0130, 0x4d00, 0x0130, 0x01e0, 0x39ff, 0x01a0, 0x0110, 0x5200, 0x0160, 0x01f0, 0x45ff, + 0x01c0, 0x0120, 0x4800, 0x0110, 0x01a0, 0x6cff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x1300, 0x0160, 0x01f0, 0x17ff, 0x01e0, 0x0130, + 0x2200, 0x0130, 0x01e0, 0x3bff, 0x01f0, 0x0140, 0x4b00, 0x0160, 0x01f0, 0x3bff, 0x01d0, 0x0110, 0x4f00, 0x0120, 0x01c0, 0x49ff, + 0x0180, 0x4600, 0x0150, 0x01f0, 0x6dff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x1200, 0x0190, 0x1bff, 0x0160, 0x2000, 0x0130, 0x01f0, + 0x3eff, 0x0160, 0x4900, 0x0170, 0x3eff, 0x01f0, 0x0130, 0x4d00, 0x0160, 0x01f0, 0x4bff, 0x01d0, 0x0130, 0x4200, 0x0110, 0x01b0, + 0x6fff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x1100, 0x01a0, 0x1dff, 0x0160, 0x1e00, 0x0160, 0x01f0, 0x40ff, 0x0160, 0x4700, 0x01a0, + 0x40ff, 0x01f0, 0x0130, 0x4a00, 0x0110, 0x01b0, 0x4eff, 0x01f0, 0x0160, 0x4000, 0x0140, 0x01f0, 0x70ff, 0x01c0, 0x2300, 0x0180, + 0x4aff, 0x1000, 0x01a0, 0x1fff, 0x0160, 0x1c00, 0x0160, 0x43ff, 0x0160, 0x4500, 0x01a0, 0x42ff, 0x01f0, 0x0130, 0x4800, 0x0130, + 0x01e0, 0x51ff, 0x01a0, 0x0110, 0x3d00, 0x0180, 0x72ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0f00, 0x0170, 0x21ff, 0x0140, 0x1a00, + 0x0140, 0x45ff, 0x0160, 0x4300, 0x01a0, 0x44ff, 0x01f0, 0x0130, 0x4600, 0x0160, 0x01f0, 0x53ff, 0x01d0, 0x0120, 0x3a00, 0x0110, + 0x01b0, 0x73ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0e00, 0x0130, 0x22ff, 0x01f0, 0x0110, 0x1800, 0x0130, 0x01f0, 0x46ff, 0x0160, + 0x4100, 0x0160, 0x46ff, 0x01f0, 0x0130, 0x4400, 0x0180, 0x56ff, 0x01f0, 0x0130, 0x3800, 0x0110, 0x01d0, 0x74ff, 0x01c0, 0x2300, + 0x0180, 0x4aff, 0x0e00, 0x01d0, 0x23ff, 0x01b0, 0x1700, 0x0120, 0x01f0, 0x48ff, 0x0130, 0x3f00, 0x0150, 0x48ff, 0x01d0, 0x0110, + 0x4200, 0x01a0, 0x58ff, 0x01f0, 0x0160, 0x3600, 0x0130, 0x01f0, 0x75ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0d00, 0x0180, 0x25ff, + 0x0140, 0x1500, 0x0110, 0x01d0, 0x49ff, 0x01f0, 0x0110, 0x3d00, 0x0130, 0x01f0, 0x49ff, 0x01c0, 0x4000, 0x0110, 0x01c0, 0x5bff, + 0x0160, 0x3400, 0x0130, 0x01f0, 0x76ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0c00, 0x0110, 0x01f0, 0x25ff, 0x01c0, 0x1500, 0x01a0, + 0x4bff, 0x01d0, 0x3c00, 0x0110, 0x01d0, 0x4bff, 0x0180, 0x3e00, 0x0110, 0x01d0, 0x5dff, 0x0160, 0x3200, 0x0130, 0x01f0, 0x77ff, + 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0c00, 0x0160, 0x27ff, 0x0140, 0x1300, 0x0150, 0x4dff, 0x0180, 0x3b00, 0x01a0, 0x4dff, 0x0140, + 0x3c00, 0x0110, 0x01d0, 0x5fff, 0x0160, 0x3000, 0x0130, 0x01f0, 0x78ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0c00, 0x01d0, 0x27ff, + 0x01a0, 0x1200, 0x0110, 0x01f0, 0x4eff, 0x0130, 0x3900, 0x0150, 0x4eff, 0x01e0, 0x0110, 0x3a00, 0x0110, 0x01d0, 0x61ff, 0x0160, + 0x2e00, 0x0130, 0x01f0, 0x79ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0b00, 0x0120, 0x28ff, 0x01f0, 0x1200, 0x01b0, 0x4fff, 0x01d0, + 0x3800, 0x0110, 0x01f0, 0x4fff, 0x0190, 0x3a00, 0x01a0, 0x63ff, 0x0160, 0x2c00, 0x0130, 0x01f0, 0x7aff, 0x01c0, 0x2300, 0x0180, + 0x4aff, 0x0b00, 0x0170, 0x29ff, 0x0140, 0x1000, 0x0150, 0x51ff, 0x0180, 0x3700, 0x0190, 0x51ff, 0x0130, 0x3800, 0x01a0, 0x65ff, + 0x0130, 0x2a00, 0x0120, 0x01f0, 0x7bff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0b00, 0x01a0, 0x29ff, 0x0180, 0x1000, 0x01e0, 0x51ff, + 0x01f0, 0x0120, 0x3500, 0x0130, 0x52ff, 0x01c0, 0x3700, 0x0170, 0x66ff, 0x01f0, 0x0130, 0x2800, 0x0110, 0x01d0, 0x7cff, 0x01c0, + 0x2300, 0x0180, 0x4aff, 0x0b00, 0x01c0, 0x29ff, 0x01a0, 0x0f00, 0x0170, 0x53ff, 0x01a0, 0x3500, 0x01c0, 0x53ff, 0x0160, 0x3500, + 0x0150, 0x68ff, 0x01d0, 0x0110, 0x2700, 0x01b0, 0x7dff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0b00, 0x2aff, 0x01c0, 0x0e00, 0x0110, + 0x01f0, 0x54ff, 0x0120, 0x3300, 0x0140, 0x54ff, 0x01e0, 0x3400, 0x0120, 0x01f0, 0x69ff, 0x01b0, 0x2600, 0x0180, 0x7eff, 0x01c0, + 0x2300, 0x0180, 0x4aff, 0x0b00, 0x2aff, 0x01c0, 0x0e00, 0x0180, 0x55ff, 0x01a0, 0x3300, 0x01c0, 0x55ff, 0x0160, 0x3200, 0x0110, + 0x01d0, 0x6bff, 0x0180, 0x2400, 0x0140, 0x7fff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0b00, 0x2aff, 0x01e0, 0x0e00, 0x01e0, 0x56ff, + 0x0120, 0x3100, 0x0130, 0x56ff, 0x01d0, 0x3200, 0x0190, 0x6dff, 0x0130, 0x2200, 0x0110, 0x01f0, 0x7fff, 0x01c0, 0x2300, 0x0180, + 0x4aff, 0x0b00, 0x2aff, 0x01d0, 0x0d00, 0x0160, 0x57ff, 0x0180, 0x3100, 0x01a0, 0x57ff, 0x0140, 0x3000, 0x0140, 0x6eff, 0x01e0, + 0x0110, 0x2100, 0x01b0, 0x80ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0b00, 0x2aff, 0x01c0, 0x0d00, 0x01c0, 0x57ff, 0x01f0, 0x3000, + 0x0110, 0x58ff, 0x01a0, 0x2f00, 0x0110, 0x01f0, 0x6fff, 0x0190, 0x2000, 0x0170, 0x81ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0b00, + 0x01f0, 0x29ff, 0x01c0, 0x0c00, 0x0120, 0x59ff, 0x0150, 0x2f00, 0x0170, 0x59ff, 0x0110, 0x2e00, 0x01a0, 0x71ff, 0x0140, 0x1e00, + 0x0110, 0x01f0, 0x81ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0b00, 0x01c0, 0x29ff, 0x0190, 0x0c00, 0x0190, 0x59ff, 0x01b0, 0x2f00, + 0x01d0, 0x59ff, 0x0160, 0x2d00, 0x0140, 0x72ff, 0x01e0, 0x1e00, 0x01b0, 0x82ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0b00, 0x0190, + 0x29ff, 0x0160, 0x0c00, 0x01e0, 0x5aff, 0x0110, 0x2d00, 0x0120, 0x5aff, 0x01b0, 0x2d00, 0x01e0, 0x73ff, 0x0180, 0x1c00, 0x0140, + 0x83ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0b00, 0x0150, 0x29ff, 0x0130, 0x0b00, 0x0120, 0x5bff, 0x0150, 0x2d00, 0x0170, 0x5bff, + 0x0110, 0x2b00, 0x0170, 0x74ff, 0x01f0, 0x0120, 0x1b00, 0x01e0, 0x83ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0b00, 0x0110, 0x28ff, + 0x01e0, 0x0c00, 0x0170, 0x5bff, 0x01a0, 0x2d00, 0x01b0, 0x5bff, 0x0150, 0x2a00, 0x0110, 0x01f0, 0x75ff, 0x01a0, 0x1a00, 0x0160, + 0x84ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0c00, 0x01b0, 0x27ff, 0x0180, 0x0c00, 0x01b0, 0x5bff, 0x01e0, 0x2d00, 0x5cff, 0x01a0, + 0x2a00, 0x0180, 0x77ff, 0x0120, 0x1800, 0x0110, 0x01f0, 0x84ff, 0x01c0, 0x2300, 0x0180, 0x4aff, 0x0c00, 0x0150, 0x27ff, 0x0120, + 0x0c00, 0x5dff, 0x0130, 0x2b00, 0x0150, 0x5cff, 0x01f0, 0x2900, 0x0110, 0x01f0, 0x77ff, 0x01a0, 0x1800, 0x0180, 0x85ff, 0x01c0, + 0x2300, 0x0180, 0x4aff, 0x0d00, 0x01e0, 0x25ff, 0x01a0, 0x0c00, 0x0150, 0x5dff, 0x0170, 0x2b00, 0x0190, 0x5dff, 0x0130, 0x2800, + 0x0180, 0x79ff, 0x0120, 0x1600, 0x0110, 0x01f0, 0x85ff, 0x01b0, 0x2300, 0x0180, 0x4aff, 0x0d00, 0x0140, 0x25ff, 0x0120, 0x0c00, + 0x01a0, 0x5dff, 0x01c0, 0x2b00, 0x01e0, 0x5dff, 0x0180, 0x2700, 0x0110, 0x01f0, 0x79ff, 0x01a0, 0x1600, 0x0170, 0x86ff, 0x0180, + 0x2300, 0x0180, 0x4aff, 0x0e00, 0x01b0, 0x23ff, 0x0180, 0x0d00, 0x01e0, 0x2dff, 0x03c0, 0x01f0, 0x2dff, 0x0110, 0x2900, 0x0130, + 0x2dff, 0x01f0, 0x02c0, 0x01d0, 0x2dff, 0x01d0, 0x2700, 0x0180, 0x3bff, 0x01d0, 0x03c0, 0x01e0, 0x3bff, 0x0120, 0x1500, 0x01e0, + 0x3aff, 0x01f0, 0x07c0, 0x44ff, 0x0140, 0x2300, 0x0180, 0x4aff, 0x0e00, 0x0110, 0x01f0, 0x21ff, 0x01d0, 0x0d00, 0x0130, 0x2bff, + 0x01f0, 0x0160, 0x0110, 0x0400, 0x0160, 0x01e0, 0x2bff, 0x0160, 0x2900, 0x0170, 0x2bff, 0x01c0, 0x0150, 0x0400, 0x0110, 0x0180, + 0x01f0, 0x2bff, 0x0110, 0x2600, 0x01e0, 0x35ff, 0x01f0, 0x01b0, 0x0170, 0x0140, 0x0800, 0x0120, 0x0140, 0x0180, 0x01d0, 0x36ff, + 0x0190, 0x1400, 0x0160, 0x36ff, 0x01d0, 0x0190, 0x0150, 0x0130, 0x0b00, 0x0140, 0x0160, 0x01a0, 0x01e0, 0x3eff, 0x2400, 0x0180, + 0x4aff, 0x0f00, 0x0140, 0x20ff, 0x01f0, 0x0120, 0x0d00, 0x0170, 0x2aff, 0x01d0, 0x0110, 0x0800, 0x01a0, 0x2aff, 0x01a0, 0x2900, + 0x01c0, 0x2aff, 0x0180, 0x0800, 0x0120, 0x01d0, 0x2aff, 0x0160, 0x2500, 0x0160, 0x34ff, 0x01a0, 0x0150, 0x1000, 0x0110, 0x0160, + 0x01d0, 0x33ff, 0x01f0, 0x1400, 0x01c0, 0x33ff, 0x01e0, 0x0170, 0x0120, 0x1300, 0x0130, 0x01a0, 0x01f0, 0x3aff, 0x01b0, 0x2400, + 0x0180, 0x4aff, 0x1000, 0x0160, 0x1eff, 0x01f0, 0x0130, 0x0e00, 0x01c0, 0x29ff, 0x01d0, 0x0110, 0x0a00, 0x01a0, 0x29ff, 0x01f0, + 0x2800, 0x0110, 0x2aff, 0x0190, 0x0a00, 0x0110, 0x01e0, 0x29ff, 0x01a0, 0x2500, 0x01b0, 0x31ff, 0x01f0, 0x0180, 0x0110, 0x1500, + 0x0140, 0x01c0, 0x32ff, 0x0160, 0x1200, 0x0120, 0x32ff, 0x01c0, 0x0150, 0x1800, 0x0110, 0x0170, 0x01f0, 0x38ff, 0x0160, 0x2400, + 0x0180, 0x4aff, 0x1100, 0x0160, 0x1cff, 0x01f0, 0x0130, 0x0e00, 0x0110, 0x2aff, 0x0120, 0x0b00, 0x0110, 0x01f0, 0x29ff, 0x0130, + 0x2700, 0x0150, 0x29ff, 0x01e0, 0x0c00, 0x0140, 0x29ff, 0x01f0, 0x2400, 0x0120, 0x31ff, 0x0190, 0x0110, 0x1900, 0x0140, 0x01d0, + 0x30ff, 0x01b0, 0x1200, 0x0190, 0x30ff, 0x01e0, 0x0160, 0x1c00, 0x0110, 0x0180, 0x01f0, 0x35ff, 0x01e0, 0x2500, 0x0180, 0x4aff, + 0x1200, 0x0150, 0x01f0, 0x19ff, 0x01e0, 0x0130, 0x0f00, 0x0150, 0x29ff, 0x01a0, 0x0d00, 0x0180, 0x29ff, 0x0180, 0x2700, 0x01a0, + 0x29ff, 0x0160, 0x0d00, 0x01c0, 0x29ff, 0x0130, 0x2300, 0x0170, 0x2fff, 0x01e0, 0x0140, 0x1d00, 0x0180, 0x30ff, 0x0120, 0x1100, + 0x01e0, 0x2fff, 0x0190, 0x0110, 0x1f00, 0x0120, 0x01c0, 0x34ff, 0x0160, 0x2500, 0x0180, 0x4aff, 0x1300, 0x0120, 0x01c0, 0x17ff, + 0x01b0, 0x0110, 0x1000, 0x01a0, 0x29ff, 0x0150, 0x0d00, 0x0120, 0x29ff, 0x01d0, 0x2700, 0x01e0, 0x29ff, 0x0110, 0x0d00, 0x0170, + 0x29ff, 0x0190, 0x2300, 0x01d0, 0x2eff, 0x01a0, 0x0110, 0x1f00, 0x0130, 0x01e0, 0x2eff, 0x0170, 0x1000, 0x0130, 0x2eff, 0x01f0, + 0x0150, 0x2300, 0x0190, 0x32ff, 0x01e0, 0x2600, 0x0180, 0x4aff, 0x1500, 0x0170, 0x01f0, 0x13ff, 0x01e0, 0x0150, 0x1200, 0x01f0, + 0x29ff, 0x0110, 0x0e00, 0x01e0, 0x29ff, 0x0110, 0x2500, 0x0130, 0x29ff, 0x01c0, 0x0e00, 0x0120, 0x29ff, 0x01d0, 0x2200, 0x0120, + 0x2eff, 0x0170, 0x2200, 0x0110, 0x01d0, 0x2dff, 0x01d0, 0x1000, 0x0190, 0x2dff, 0x01f0, 0x0130, 0x2500, 0x0160, 0x01f0, 0x30ff, + 0x0140, 0x2600, 0x0180, 0x4aff, 0x1600, 0x0110, 0x0170, 0x01e0, 0x0fff, 0x01d0, 0x0160, 0x1300, 0x0130, 0x29ff, 0x01b0, 0x0f00, + 0x0190, 0x29ff, 0x0160, 0x2500, 0x0170, 0x29ff, 0x0170, 0x0f00, 0x01e0, 0x29ff, 0x0120, 0x2100, 0x0170, 0x2dff, 0x0160, 0x2400, + 0x0110, 0x01d0, 0x2dff, 0x0110, 0x0f00, 0x01e0, 0x2cff, 0x01d0, 0x0110, 0x2700, 0x0130, 0x01d0, 0x2eff, 0x0190, 0x2700, 0x0180, + 0x4aff, 0x1900, 0x0130, 0x0190, 0x01d0, 0x09ff, 0x01c0, 0x0180, 0x0130, 0x1500, 0x0180, 0x29ff, 0x0170, 0x0f00, 0x0150, 0x29ff, + 0x01b0, 0x2500, 0x01d0, 0x29ff, 0x0130, 0x0f00, 0x0190, 0x29ff, 0x0160, 0x2100, 0x01c0, 0x2cff, 0x0160, 0x2600, 0x0110, 0x01d0, + 0x2cff, 0x0160, 0x0e00, 0x0120, 0x2cff, 0x01e0, 0x0110, 0x2900, 0x0110, 0x0190, 0x2cff, 0x01d0, 0x0110, 0x2700, 0x0120, 0x2140, + 0x01a0, 0x28ff, 0x1d00, 0x0130, 0x0540, 0x0120, 0x1900, 0x01d0, 0x29ff, 0x0120, 0x1000, 0x29ff, 0x01f0, 0x2400, 0x0110, 0x29ff, + 0x01e0, 0x1000, 0x0150, 0x29ff, 0x01b0, 0x2100, 0x2cff, 0x0190, 0x2800, 0x0110, 0x01d0, 0x2bff, 0x01a0, 0x0e00, 0x0170, 0x2bff, + 0x01f0, 0x0130, 0x2c00, 0x0140, 0x01e0, 0x29ff, 0x01f0, 0x0120, 0x4a00, 0x0180, 0x28ff, 0x3c00, 0x0110, 0x29ff, 0x01e0, 0x1100, + 0x01b0, 0x29ff, 0x0140, 0x2300, 0x0160, 0x29ff, 0x01a0, 0x1100, 0x01f0, 0x28ff, 0x01f0, 0x2000, 0x0140, 0x2bff, 0x01b0, 0x2a00, + 0x0130, 0x01f0, 0x2aff, 0x01e0, 0x0e00, 0x01b0, 0x2bff, 0x0150, 0x2f00, 0x0180, 0x01f0, 0x26ff, 0x01f0, 0x0130, 0x4b00, 0x0180, + 0x28ff, 0x3c00, 0x0160, 0x29ff, 0x0190, 0x1100, 0x0160, 0x29ff, 0x0190, 0x2300, 0x01a0, 0x29ff, 0x0150, 0x1100, 0x01b0, 0x29ff, + 0x0140, 0x1f00, 0x0180, 0x2aff, 0x01f0, 0x0110, 0x2b00, 0x0160, 0x2bff, 0x0120, 0x0d00, 0x01f0, 0x2aff, 0x0190, 0x3100, 0x0110, + 0x01a0, 0x24ff, 0x01e0, 0x0130, 0x4c00, 0x0180, 0x28ff, 0x3c00, 0x01a0, 0x29ff, 0x0150, 0x1100, 0x0120, 0x29ff, 0x01d0, 0x2300, + 0x01f0, 0x29ff, 0x1200, 0x0160, 0x29ff, 0x0190, 0x1f00, 0x01c0, 0x2aff, 0x0150, 0x2d00, 0x01b0, 0x2aff, 0x0160, 0x0c00, 0x0120, + 0x2aff, 0x01e0, 0x0110, 0x3300, 0x0120, 0x0180, 0x01f0, 0x20ff, 0x01c0, 0x0110, 0x4d00, 0x0180, 0x28ff, 0x3c00, 0x01f0, 0x29ff, + 0x1300, 0x01d0, 0x29ff, 0x0120, 0x2100, 0x0130, 0x29ff, 0x01b0, 0x1200, 0x0120, 0x29ff, 0x01e0, 0x1f00, 0x01f0, 0x29ff, 0x01c0, + 0x2e00, 0x0120, 0x2aff, 0x0190, 0x0c00, 0x0160, 0x2aff, 0x0140, 0x3600, 0x0110, 0x0160, 0x01d0, 0x1cff, 0x01f0, 0x0170, 0x4f00, + 0x0180, 0x28ff, 0x3b00, 0x0130, 0x29ff, 0x01b0, 0x1300, 0x0190, 0x29ff, 0x0160, 0x2100, 0x0180, 0x29ff, 0x0170, 0x1300, 0x01d0, + 0x29ff, 0x0120, 0x1d00, 0x0120, 0x2aff, 0x0120, 0x2f00, 0x0180, 0x29ff, 0x01c0, 0x0c00, 0x0180, 0x29ff, 0x01c0, 0x3a00, 0x0120, + 0x0170, 0x01d0, 0x18ff, 0x01a0, 0x0120, 0x5000, 0x0180, 0x28ff, 0x3b00, 0x0190, 0x29ff, 0x0170, 0x1300, 0x0140, 0x29ff, 0x01b0, + 0x2100, 0x01d0, 0x29ff, 0x0120, 0x1300, 0x0190, 0x29ff, 0x0170, 0x1d00, 0x0150, 0x29ff, 0x01a0, 0x3000, 0x0110, 0x01f0, 0x28ff, + 0x01f0, 0x0c00, 0x01c0, 0x29ff, 0x0140, 0x3d00, 0x0110, 0x0150, 0x0190, 0x01c0, 0x11ff, 0x01e0, 0x0190, 0x0120, 0x5200, 0x0180, + 0x28ff, 0x3b00, 0x01d0, 0x29ff, 0x0120, 0x1400, 0x01f0, 0x28ff, 0x01f0, 0x2000, 0x0120, 0x29ff, 0x01e0, 0x1400, 0x0140, 0x29ff, + 0x01b0, 0x1d00, 0x0180, 0x29ff, 0x0130, 0x3100, 0x01a0, 0x29ff, 0x0110, 0x0b00, 0x01f0, 0x28ff, 0x01d0, 0x4300, 0x0130, 0x0140, + 0x0280, 0x03c0, 0x01e0, 0x03ff, 0x01e0, 0x01c0, 0x01b0, 0x0170, 0x0130, 0x5500, 0x0180, 0x28ff, 0x3a00, 0x0120, 0x29ff, 0x01d0, + 0x1500, 0x01b0, 0x29ff, 0x0150, 0x1f00, 0x0160, 0x29ff, 0x0190, 0x1500, 0x01f0, 0x29ff, 0x1d00, 0x01a0, 0x28ff, 0x01d0, 0x3200, + 0x0130, 0x29ff, 0x0140, 0x0b00, 0x29ff, 0x0160, 0xa800, 0x0180, 0x28ff, 0x3a00, 0x0160, 0x29ff, 0x0190, 0x1500, 0x0160, 0x29ff, + 0x0190, 0x1f00, 0x01b0, 0x29ff, 0x0150, 0x1500, 0x01a0, 0x29ff, 0x0150, 0x1c00, 0x01c0, 0x28ff, 0x0170, 0x3300, 0x01e0, 0x28ff, + 0x0160, 0x0a00, 0x0140, 0x29ff, 0x0110, 0xa800, 0x0180, 0x28ff, 0x3a00, 0x01b0, 0x29ff, 0x0140, 0x1500, 0x0120, 0x29ff, 0x01e0, + 0x1f00, 0x01f0, 0x28ff, 0x01f0, 0x1600, 0x0160, 0x29ff, 0x0190, 0x1c00, 0x01e0, 0x28ff, 0x0120, 0x3300, 0x0190, 0x28ff, 0x0180, + 0x0a00, 0x0140, 0x28ff, 0x01b0, 0xa900, 0x0180, 0x28ff, 0x3a00, 0x01f0, 0x28ff, 0x01f0, 0x1700, 0x01d0, 0x29ff, 0x0120, 0x1d00, + 0x0140, 0x29ff, 0x01b0, 0x1600, 0x0110, 0x29ff, 0x01e0, 0x1c00, 0x28ff, 0x01e0, 0x3400, 0x0140, 0x28ff, 0x0190, 0x0a00, 0x0170, + 0x28ff, 0x0170, 0xa900, 0x0180, 0x28ff, 0x3900, 0x0140, 0x29ff, 0x01b0, 0x1700, 0x0180, 0x29ff, 0x0170, 0x1d00, 0x0190, 0x29ff, + 0x0160, 0x1700, 0x01d0, 0x29ff, 0x0120, 0x1b00, 0x28ff, 0x01a0, 0x3500, 0x28ff, 0x01c0, 0x0a00, 0x0180, 0x28ff, 0x0140, 0xa900, + 0x0180, 0x28ff, 0x3900, 0x0190, 0x29ff, 0x0160, 0x1700, 0x0130, 0x29ff, 0x01b0, 0x1d00, 0x01d0, 0x29ff, 0x0120, 0x1700, 0x0180, + 0x29ff, 0x0170, 0x1a00, 0x0120, 0x28ff, 0x0180, 0x3500, 0x01d0, 0x27ff, 0x01c0, 0x0a00, 0x0180, 0x28ff, 0xaa00, 0x0180, 0x28ff, + 0x3900, 0x01e0, 0x29ff, 0x0120, 0x1800, 0x01f0, 0x29ff, 0x1c00, 0x0120, 0x29ff, 0x01d0, 0x1800, 0x0130, 0x29ff, 0x01c0, 0x1a00, + 0x0140, 0x28ff, 0x0140, 0x3500, 0x01c0, 0x27ff, 0x01c0, 0x0a00, 0x0190, 0x27ff, 0x01e0, 0xaa00, 0x0180, 0x28ff, 0x3800, 0x0120, + 0x29ff, 0x01d0, 0x1900, 0x01a0, 0x29ff, 0x0150, 0x1b00, 0x0160, 0x29ff, 0x0190, 0x1900, 0x01f0, 0x29ff, 0x0110, 0x1900, 0x0140, + 0x28ff, 0x0140, 0x3500, 0x0180, 0x27ff, 0x01c0, 0x0a00, 0x01c0, 0x27ff, 0x01c0, 0xaa00, 0x0180, 0x28ff, 0x3800, 0x0170, 0x29ff, + 0x0190, 0x1900, 0x0160, 0x29ff, 0x01a0, 0x1b00, 0x01b0, 0x29ff, 0x0140, 0x1900, 0x01a0, 0x29ff, 0x0150, 0x1900, 0x0140, 0x28ff, + 0x0110, 0x3500, 0x0180, 0x27ff, 0x01f0, 0x0a00, 0x01c0, 0x27ff, 0x01c0, 0xaa00, 0x0180, 0x28ff, 0x3800, 0x01b0, 0x29ff, 0x0130, + 0x1900, 0x0110, 0x29ff, 0x01e0, 0x1b00, 0x29ff, 0x01f0, 0x1a00, 0x0160, 0x29ff, 0x01a0, 0x1900, 0x0140, 0x28ff, 0x3600, 0x0180, + 0x28ff, 0x0a00, 0x01c0, 0x27ff, 0x01c0, 0x4100, 0x0120, 0x0160, 0x0180, 0x01b0, 0x03c0, 0x01b0, 0x0180, 0x0160, 0x0130, 0x5e00, + 0x0180, 0x28ff, 0x3800, 0x29ff, 0x01f0, 0x1b00, 0x01d0, 0x29ff, 0x0130, 0x1900, 0x0150, 0x29ff, 0x01b0, 0x1a00, 0x0110, 0x29ff, + 0x01e0, 0x1900, 0x0140, 0x28ff, 0x3600, 0x0180, 0x28ff, 0x0a00, 0x01c0, 0x27ff, 0x01c0, 0x3e00, 0x0120, 0x0190, 0x01e0, 0x0bff, + 0x01e0, 0x0190, 0x0120, 0x5b00, 0x0180, 0x28ff, 0x3700, 0x0150, 0x29ff, 0x01a0, 0x1b00, 0x0170, 0x29ff, 0x0170, 0x1900, 0x0190, + 0x29ff, 0x0160, 0x1b00, 0x01c0, 0x29ff, 0x0130, 0x1800, 0x0140, 0x28ff, 0x0110, 0x3500, 0x0180, 0x28ff, 0x0a00, 0x01c0, 0x27ff, + 0x01c0, 0x3c00, 0x0140, 0x01c0, 0x11ff, 0x01c0, 0x0140, 0x5900, 0x0180, 0x28ff, 0x3700, 0x0190, 0x29ff, 0x0160, 0x1b00, 0x0130, + 0x29ff, 0x01c0, 0x1900, 0x01e0, 0x29ff, 0x0110, 0x1b00, 0x0170, 0x29ff, 0x0170, 0x1800, 0x0140, 0x28ff, 0x0140, 0x3500, 0x0180, + 0x27ff, 0x01c0, 0x0a00, 0x01c0, 0x27ff, 0x01c0, 0x3a00, 0x0110, 0x01a0, 0x15ff, 0x0190, 0x0110, 0x5700, 0x0180, 0x28ff, 0x3700, + 0x01e0, 0x29ff, 0x0110, 0x1c00, 0x01e0, 0x29ff, 0x0110, 0x1700, 0x0120, 0x29ff, 0x01d0, 0x1c00, 0x0130, 0x29ff, 0x01d0, 0x1800, + 0x0140, 0x28ff, 0x0140, 0x3500, 0x01c0, 0x27ff, 0x01c0, 0x0a00, 0x0190, 0x27ff, 0x01e0, 0x3900, 0x0130, 0x01e0, 0x17ff, 0x01e0, + 0x0130, 0x5600, 0x0180, 0x28ff, 0x3600, 0x0120, 0x29ff, 0x01d0, 0x1d00, 0x01a0, 0x29ff, 0x0150, 0x1700, 0x0170, 0x29ff, 0x0180, + 0x1d00, 0x01e0, 0x29ff, 0x0110, 0x1700, 0x0130, 0x28ff, 0x0180, 0x3500, 0x01d0, 0x27ff, 0x01c0, 0x0a00, 0x0180, 0x28ff, 0x3800, + 0x0160, 0x1aff, 0x01f0, 0x0150, 0x5500, 0x0180, 0x28ff, 0x3600, 0x0170, 0x29ff, 0x0180, 0x1d00, 0x0150, 0x29ff, 0x01a0, 0x1700, + 0x01b0, 0x29ff, 0x0130, 0x1d00, 0x01a0, 0x29ff, 0x0160, 0x1800, 0x28ff, 0x01a0, 0x3500, 0x28ff, 0x01c0, 0x0a00, 0x0180, 0x28ff, + 0x0140, 0x3600, 0x0160, 0x1dff, 0x0160, 0x5400, 0x0180, 0x28ff, 0x3600, 0x01c0, 0x29ff, 0x0130, 0x1d00, 0x0110, 0x29ff, 0x01e0, + 0x1600, 0x0110, 0x29ff, 0x01f0, 0x1e00, 0x0150, 0x29ff, 0x01a0, 0x1800, 0x28ff, 0x01e0, 0x3400, 0x0140, 0x28ff, 0x0190, 0x0a00, + 0x0170, 0x28ff, 0x0170, 0x3500, 0x0140, 0x1eff, 0x01f0, 0x0130, 0x5300, 0x0180, 0x28ff, 0x3500, 0x0110, 0x29ff, 0x01e0, 0x1f00, + 0x01c0, 0x29ff, 0x0130, 0x1500, 0x0150, 0x29ff, 0x01a0, 0x1e00, 0x0110, 0x29ff, 0x01f0, 0x1800, 0x01e0, 0x28ff, 0x0120, 0x3300, + 0x0190, 0x28ff, 0x0180, 0x0a00, 0x0140, 0x28ff, 0x01b0, 0x3400, 0x0120, 0x01f0, 0x1fff, 0x01f0, 0x0110, 0x5200, 0x0180, 0x28ff, + 0x3500, 0x0150, 0x29ff, 0x01a0, 0x1f00, 0x0170, 0x29ff, 0x0180, 0x1500, 0x01a0, 0x29ff, 0x0160, 0x1f00, 0x01b0, 0x29ff, 0x0130, + 0x1700, 0x01c0, 0x28ff, 0x0170, 0x3300, 0x01d0, 0x28ff, 0x0160, 0x0a00, 0x0140, 0x29ff, 0x0110, 0x3300, 0x01c0, 0x21ff, 0x01b0, + 0x5200, 0x0180, 0x28ff, 0x3500, 0x01a0, 0x29ff, 0x0150, 0x1f00, 0x0130, 0x29ff, 0x01d0, 0x1500, 0x01e0, 0x29ff, 0x0110, 0x1f00, + 0x0170, 0x29ff, 0x0180, 0x1700, 0x01a0, 0x28ff, 0x01d0, 0x3200, 0x0130, 0x29ff, 0x0140, 0x0b00, 0x29ff, 0x0160, 0x3200, 0x0150, + 0x23ff, 0x0140, 0x5100, 0x0180, 0x28ff, 0x3500, 0x01e0, 0x29ff, 0x0110, 0x2000, 0x01e0, 0x29ff, 0x0110, 0x1300, 0x0130, 0x29ff, + 0x01c0, 0x2000, 0x0120, 0x29ff, 0x01d0, 0x1700, 0x0180, 0x29ff, 0x0130, 0x3100, 0x01a0, 0x29ff, 0x0120, 0x0b00, 0x01f0, 0x28ff, + 0x01c0, 0x3200, 0x01e0, 0x23ff, 0x01c0, 0x5100, 0x0180, 0x28ff, 0x3400, 0x0130, 0x29ff, 0x01c0, 0x2100, 0x0190, 0x29ff, 0x0160, + 0x1300, 0x0170, 0x29ff, 0x0170, 0x2100, 0x01e0, 0x29ff, 0x0110, 0x1600, 0x0150, 0x29ff, 0x01a0, 0x3000, 0x0110, 0x01f0, 0x29ff, + 0x0c00, 0x01c0, 0x29ff, 0x0140, 0x3000, 0x0160, 0x25ff, 0x0140, 0x5000, 0x0180, 0x28ff, 0x3400, 0x0170, 0x29ff, 0x0170, 0x2100, + 0x0150, 0x29ff, 0x01a0, 0x1300, 0x01c0, 0x29ff, 0x0130, 0x2100, 0x0190, 0x29ff, 0x0160, 0x1600, 0x0120, 0x2aff, 0x0120, 0x2f00, + 0x0180, 0x29ff, 0x01c0, 0x0c00, 0x0190, 0x29ff, 0x01c0, 0x3000, 0x01e0, 0x25ff, 0x01b0, 0x5000, 0x0180, 0x28ff, 0x3400, 0x01d0, + 0x29ff, 0x0130, 0x2200, 0x29ff, 0x01f0, 0x1200, 0x0110, 0x29ff, 0x01e0, 0x2200, 0x0150, 0x29ff, 0x01b0, 0x1700, 0x2aff, 0x01b0, + 0x2e00, 0x0120, 0x01f0, 0x29ff, 0x0190, 0x0c00, 0x0160, 0x2aff, 0x0140, 0x2e00, 0x0180, 0x27ff, 0x5000, 0x0180, 0x28ff, 0x3300, + 0x0110, 0x29ff, 0x01e0, 0x2300, 0x01b0, 0x29ff, 0x0130, 0x1100, 0x0150, 0x29ff, 0x01a0, 0x2300, 0x29ff, 0x01f0, 0x1700, 0x01c0, + 0x2aff, 0x0140, 0x2d00, 0x01b0, 0x2aff, 0x0160, 0x0c00, 0x0130, 0x2aff, 0x01e0, 0x2d00, 0x0120, 0x01f0, 0x27ff, 0x0150, 0x4f00, + 0x0180, 0x28ff, 0x3300, 0x0160, 0x29ff, 0x01a0, 0x2300, 0x0170, 0x29ff, 0x0190, 0x1100, 0x01a0, 0x29ff, 0x0150, 0x2300, 0x01b0, + 0x29ff, 0x0140, 0x1600, 0x0180, 0x2aff, 0x01e0, 0x0110, 0x2b00, 0x0150, 0x2bff, 0x0120, 0x0d00, 0x01f0, 0x2aff, 0x0180, 0x2c00, + 0x01c0, 0x28ff, 0x0180, 0x4f00, 0x0180, 0x28ff, 0x3300, 0x01a0, 0x29ff, 0x0150, 0x2300, 0x0120, 0x29ff, 0x01d0, 0x1100, 0x01f0, + 0x29ff, 0x0110, 0x2300, 0x0170, 0x29ff, 0x0190, 0x1600, 0x0140, 0x2bff, 0x01b0, 0x2a00, 0x0120, 0x01f0, 0x2aff, 0x01e0, 0x0e00, + 0x01b0, 0x2bff, 0x0140, 0x2a00, 0x0180, 0x29ff, 0x01c0, 0x4f00, 0x0180, 0x28ff, 0x3300, 0x01f0, 0x29ff, 0x2500, 0x01e0, 0x29ff, + 0x0120, 0x0f00, 0x0130, 0x29ff, 0x01b0, 0x2400, 0x0120, 0x29ff, 0x01d0, 0x1700, 0x2cff, 0x0170, 0x2800, 0x0110, 0x01d0, 0x2bff, + 0x01a0, 0x0e00, 0x0170, 0x2bff, 0x01f0, 0x0130, 0x2800, 0x0150, 0x2aff, 0x01c0, 0x4f00, 0x0180, 0x28ff, 0x3200, 0x0130, 0x29ff, + 0x01b0, 0x2500, 0x0190, 0x29ff, 0x0160, 0x0f00, 0x0180, 0x29ff, 0x0170, 0x2500, 0x01d0, 0x29ff, 0x0120, 0x1600, 0x01c0, 0x2cff, + 0x0160, 0x2700, 0x01c0, 0x2cff, 0x0160, 0x0e00, 0x0130, 0x2cff, 0x01d0, 0x0110, 0x2600, 0x0130, 0x01f0, 0x2aff, 0x01f0, 0x4f00, + 0x0180, 0x28ff, 0x3200, 0x0180, 0x29ff, 0x0170, 0x2500, 0x0140, 0x29ff, 0x01b0, 0x0f00, 0x01d0, 0x29ff, 0x0120, 0x2500, 0x0190, + 0x29ff, 0x0160, 0x1600, 0x0170, 0x2dff, 0x0160, 0x2500, 0x01a0, 0x2dff, 0x0110, 0x0f00, 0x01e0, 0x2cff, 0x01d0, 0x0110, 0x2400, + 0x0130, 0x01f0, 0x2cff, 0x4f00, 0x0180, 0x28ff, 0x3200, 0x01d0, 0x29ff, 0x0120, 0x2600, 0x01f0, 0x28ff, 0x01f0, 0x0e00, 0x0110, + 0x29ff, 0x01e0, 0x2600, 0x0140, 0x29ff, 0x01b0, 0x1600, 0x0120, 0x2eff, 0x0160, 0x2200, 0x0110, 0x01d0, 0x2dff, 0x01d0, 0x1000, + 0x0190, 0x2dff, 0x01d0, 0x0130, 0x2200, 0x0150, 0x01f0, 0x2dff, 0x4f00, 0x0180, 0x28ff, 0x3100, 0x0110, 0x29ff, 0x01e0, 0x2700, + 0x01b0, 0x29ff, 0x0140, 0x0d00, 0x0160, 0x29ff, 0x0190, 0x2700, 0x01f0, 0x29ff, 0x1700, 0x01d0, 0x2eff, 0x01a0, 0x2000, 0x0130, + 0x01d0, 0x2eff, 0x0170, 0x1000, 0x0130, 0x2eff, 0x01f0, 0x0140, 0x2000, 0x0170, 0x2eff, 0x01d0, 0x4f00, 0x0180, 0x28ff, 0x3100, + 0x0160, 0x29ff, 0x0190, 0x2700, 0x0160, 0x29ff, 0x0190, 0x0d00, 0x01b0, 0x29ff, 0x0150, 0x2700, 0x01b0, 0x29ff, 0x0150, 0x1600, + 0x0170, 0x2fff, 0x01d0, 0x0130, 0x1d00, 0x0170, 0x01f0, 0x2fff, 0x0120, 0x1100, 0x01e0, 0x2fff, 0x0190, 0x0110, 0x1c00, 0x0120, + 0x01c0, 0x2fff, 0x01c0, 0x4f00, 0x0180, 0x28ff, 0x3100, 0x01e0, 0x29ff, 0x0150, 0x2700, 0x0120, 0x29ff, 0x01f0, 0x0110, 0x0b00, + 0x0130, 0x2aff, 0x2800, 0x0160, 0x29ff, 0x01c0, 0x1600, 0x0120, 0x31ff, 0x0180, 0x0110, 0x1900, 0x0130, 0x01c0, 0x30ff, 0x01c0, + 0x1200, 0x0190, 0x30ff, 0x01e0, 0x0140, 0x1a00, 0x0170, 0x01f0, 0x30ff, 0x0190, 0x4f00, 0x0180, 0x28ff, 0x3000, 0x0190, 0x29ff, + 0x01f0, 0x2900, 0x01d0, 0x29ff, 0x01b0, 0x0a00, 0x0110, 0x01d0, 0x29ff, 0x01b0, 0x2800, 0x0120, 0x2aff, 0x0170, 0x1600, 0x01c0, + 0x31ff, 0x01f0, 0x0180, 0x0110, 0x1500, 0x0120, 0x01a0, 0x32ff, 0x0160, 0x1200, 0x0120, 0x32ff, 0x01c0, 0x0140, 0x1600, 0x0160, + 0x01e0, 0x32ff, 0x0160, 0x4f00, 0x0180, 0x28ff, 0x2f00, 0x0180, 0x2aff, 0x01b0, 0x2900, 0x0190, 0x2aff, 0x01a0, 0x0800, 0x0110, + 0x01b0, 0x2aff, 0x0170, 0x2900, 0x01d0, 0x2aff, 0x0160, 0x1500, 0x0160, 0x33ff, 0x01f0, 0x01a0, 0x0130, 0x1000, 0x0110, 0x0160, + 0x01c0, 0x33ff, 0x01f0, 0x1400, 0x01c0, 0x33ff, 0x01e0, 0x0170, 0x0110, 0x1000, 0x0120, 0x0190, 0x01e0, 0x34ff, 0x0110, 0x4f00, + 0x0180, 0x28ff, 0x2d00, 0x0140, 0x01c0, 0x2bff, 0x0160, 0x2900, 0x0130, 0x2bff, 0x01e0, 0x0150, 0x0500, 0x0160, 0x01e0, 0x2bff, + 0x0120, 0x2900, 0x0180, 0x2bff, 0x01b0, 0x0130, 0x1400, 0x01f0, 0x35ff, 0x01e0, 0x01a0, 0x0160, 0x0130, 0x0800, 0x0110, 0x0140, + 0x0180, 0x01b0, 0x36ff, 0x0190, 0x1400, 0x0160, 0x36ff, 0x01d0, 0x0180, 0x0140, 0x0120, 0x0800, 0x0120, 0x0150, 0x0190, 0x01e0, + 0x36ff, 0x01c0, 0x1300, 0x0110, 0x0150, 0x0180, 0x01a0, 0x04c0, 0x01b0, 0x0180, 0x0150, 0x0120, 0x3100, 0x0180, 0x28ff, 0x1f00, + 0x0190, 0x0cc0, 0x01e0, 0x2dff, 0x0120, 0x2a00, 0x01f0, 0x2cff, 0x01f0, 0x03c0, 0x01f0, 0x2cff, 0x01d0, 0x2a00, 0x0130, 0x2dff, + 0x01e0, 0x0cc0, 0x0160, 0x0600, 0x0180, 0x3aff, 0x01f0, 0x05c0, 0x3bff, 0x0120, 0x1500, 0x01e0, 0x3aff, 0x01d0, 0x04c0, 0x01e0, + 0x3bff, 0x0160, 0x1000, 0x0110, 0x0160, 0x01d0, 0x0cff, 0x01d0, 0x0170, 0x0120, 0x2e00, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x39ff, + 0x01d0, 0x2b00, 0x01a0, 0x5dff, 0x0190, 0x2b00, 0x01f0, 0x39ff, 0x0180, 0x0600, 0x0110, 0x01f0, 0x79ff, 0x01a0, 0x1600, 0x0180, + 0x7aff, 0x01e0, 0x0f00, 0x0110, 0x0180, 0x01f0, 0x11ff, 0x01a0, 0x0120, 0x2c00, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x39ff, 0x0190, + 0x2b00, 0x0160, 0x5dff, 0x0140, 0x2b00, 0x01a0, 0x39ff, 0x0180, 0x0700, 0x01a0, 0x79ff, 0x0130, 0x1600, 0x0110, 0x01f0, 0x79ff, + 0x0160, 0x0e00, 0x0170, 0x01f0, 0x06ff, 0x01e0, 0x01c0, 0x0480, 0x01c0, 0x01e0, 0x06ff, 0x01f0, 0x0180, 0x2b00, 0x0180, 0x28ff, + 0x1f00, 0x01c0, 0x39ff, 0x0140, 0x2b00, 0x0110, 0x5cff, 0x01f0, 0x2c00, 0x0160, 0x39ff, 0x0180, 0x0700, 0x0120, 0x78ff, 0x01c0, + 0x1800, 0x0180, 0x78ff, 0x01e0, 0x0d00, 0x0110, 0x01b0, 0x05ff, 0x01e0, 0x0170, 0x0120, 0x0800, 0x0120, 0x0160, 0x01d0, 0x05ff, + 0x01d0, 0x0120, 0x2900, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x38ff, 0x01f0, 0x2d00, 0x01d0, 0x5bff, 0x01b0, 0x2c00, 0x0110, 0x39ff, + 0x0180, 0x0800, 0x0190, 0x77ff, 0x0130, 0x1800, 0x0110, 0x01f0, 0x77ff, 0x0160, 0x0c00, 0x0120, 0x01d0, 0x04ff, 0x01e0, 0x0140, + 0x0e00, 0x0140, 0x01c0, 0x04ff, 0x01f0, 0x0130, 0x2800, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x38ff, 0x01b0, 0x2d00, 0x0180, 0x5bff, + 0x0160, 0x2d00, 0x01d0, 0x38ff, 0x0180, 0x0800, 0x0110, 0x01f0, 0x75ff, 0x01a0, 0x1a00, 0x0180, 0x76ff, 0x01d0, 0x0c00, 0x0130, + 0x01f0, 0x04ff, 0x0180, 0x1200, 0x0170, 0x01f0, 0x03ff, 0x01f0, 0x0130, 0x2700, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x38ff, 0x0160, + 0x2d00, 0x0130, 0x5bff, 0x0120, 0x2d00, 0x0170, 0x38ff, 0x0180, 0x0900, 0x0180, 0x75ff, 0x0120, 0x1b00, 0x01e0, 0x75ff, 0x0140, + 0x0b00, 0x0110, 0x01d0, 0x03ff, 0x01f0, 0x0140, 0x1400, 0x0130, 0x01f0, 0x03ff, 0x01f0, 0x0120, 0x2600, 0x0180, 0x28ff, 0x1f00, + 0x01c0, 0x38ff, 0x0110, 0x2e00, 0x01e0, 0x59ff, 0x01d0, 0x2e00, 0x0130, 0x38ff, 0x0180, 0x0a00, 0x01e0, 0x73ff, 0x0180, 0x1c00, + 0x0150, 0x74ff, 0x01b0, 0x0c00, 0x01c0, 0x03ff, 0x01f0, 0x0130, 0x0200, 0x0160, 0x0bc0, 0x01a0, 0x0170, 0x0120, 0x0500, 0x0130, + 0x01f0, 0x03ff, 0x01d0, 0x2600, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x37ff, 0x01b0, 0x2f00, 0x0190, 0x59ff, 0x0170, 0x2f00, 0x01e0, + 0x37ff, 0x0180, 0x0a00, 0x0140, 0x72ff, 0x01e0, 0x0110, 0x1d00, 0x01b0, 0x72ff, 0x01f0, 0x0120, 0x0b00, 0x0170, 0x04ff, 0x0140, + 0x0300, 0x0180, 0x0eff, 0x01c0, 0x0110, 0x0400, 0x0130, 0x01f0, 0x03ff, 0x0190, 0x2500, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x37ff, + 0x0160, 0x2f00, 0x0130, 0x59ff, 0x0120, 0x2f00, 0x0180, 0x37ff, 0x0180, 0x0b00, 0x01b0, 0x71ff, 0x0140, 0x1e00, 0x0120, 0x01f0, + 0x71ff, 0x0170, 0x0b00, 0x0110, 0x01f0, 0x03ff, 0x0180, 0x0400, 0x0180, 0x0fff, 0x01f0, 0x0120, 0x0400, 0x0160, 0x04ff, 0x0120, + 0x2400, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x36ff, 0x01f0, 0x0110, 0x3000, 0x01e0, 0x57ff, 0x01b0, 0x3000, 0x0120, 0x37ff, 0x0180, + 0x0b00, 0x0110, 0x01f0, 0x6fff, 0x0190, 0x2000, 0x0170, 0x70ff, 0x01c0, 0x0c00, 0x01a0, 0x03ff, 0x01d0, 0x0500, 0x0180, 0x03ff, + 0x01c0, 0x0680, 0x01b0, 0x01f0, 0x04ff, 0x01c0, 0x0500, 0x01c0, 0x03ff, 0x01c0, 0x2400, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x36ff, + 0x01a0, 0x3100, 0x0160, 0x57ff, 0x0150, 0x3100, 0x01b0, 0x36ff, 0x0180, 0x0c00, 0x0150, 0x6eff, 0x01e0, 0x0110, 0x2100, 0x01c0, + 0x6eff, 0x01f0, 0x0120, 0x0b00, 0x0110, 0x04ff, 0x0140, 0x0500, 0x0180, 0x03ff, 0x0180, 0x0700, 0x0110, 0x01a0, 0x04ff, 0x0120, + 0x0400, 0x0120, 0x04ff, 0x0120, 0x2300, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x36ff, 0x0120, 0x3100, 0x0110, 0x01f0, 0x55ff, 0x01e0, + 0x3200, 0x0140, 0x36ff, 0x0180, 0x0d00, 0x01a0, 0x6dff, 0x0140, 0x2200, 0x0110, 0x01f0, 0x6dff, 0x0150, 0x0c00, 0x0170, 0x03ff, + 0x01c0, 0x0600, 0x0180, 0x03ff, 0x0180, 0x0900, 0x01e0, 0x03ff, 0x0160, 0x0500, 0x01a0, 0x03ff, 0x0190, 0x2300, 0x0180, 0x28ff, + 0x1f00, 0x01c0, 0x35ff, 0x01b0, 0x3300, 0x0180, 0x55ff, 0x0160, 0x3300, 0x01c0, 0x35ff, 0x0180, 0x0d00, 0x0110, 0x01d0, 0x6bff, + 0x0180, 0x2400, 0x0150, 0x6cff, 0x0190, 0x0d00, 0x01d0, 0x03ff, 0x0160, 0x0600, 0x0180, 0x03ff, 0x0180, 0x0900, 0x0180, 0x03ff, + 0x0180, 0x0500, 0x0150, 0x03ff, 0x01f0, 0x2300, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x35ff, 0x0140, 0x3300, 0x0110, 0x01f0, 0x53ff, + 0x01e0, 0x3400, 0x0140, 0x35ff, 0x0180, 0x0e00, 0x0130, 0x01f0, 0x69ff, 0x01c0, 0x2600, 0x0190, 0x6aff, 0x01d0, 0x0d00, 0x0120, + 0x04ff, 0x0110, 0x0600, 0x0180, 0x03ff, 0x0180, 0x0900, 0x0180, 0x03ff, 0x0180, 0x0600, 0x01f0, 0x03ff, 0x0130, 0x2200, 0x0180, + 0x28ff, 0x1f00, 0x01c0, 0x34ff, 0x01a0, 0x3500, 0x0180, 0x53ff, 0x0160, 0x3500, 0x01c0, 0x34ff, 0x0180, 0x0f00, 0x0160, 0x68ff, + 0x01e0, 0x0110, 0x2700, 0x01c0, 0x68ff, 0x01f0, 0x0110, 0x0d00, 0x0150, 0x03ff, 0x01c0, 0x0700, 0x0180, 0x03ff, 0x0180, 0x0900, + 0x01c0, 0x03ff, 0x0170, 0x0600, 0x01a0, 0x03ff, 0x0170, 0x2200, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x34ff, 0x0120, 0x3500, 0x0110, + 0x01f0, 0x51ff, 0x01e0, 0x3600, 0x0140, 0x34ff, 0x0180, 0x1000, 0x0180, 0x66ff, 0x01f0, 0x0130, 0x2800, 0x0110, 0x01d0, 0x66ff, + 0x01f0, 0x0130, 0x0e00, 0x0180, 0x03ff, 0x0180, 0x0700, 0x0180, 0x03ff, 0x0180, 0x0800, 0x0160, 0x04ff, 0x0130, 0x0600, 0x0180, + 0x03ff, 0x01a0, 0x2200, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x33ff, 0x0180, 0x3700, 0x0160, 0x51ff, 0x0140, 0x3700, 0x01a0, 0x33ff, + 0x0180, 0x1100, 0x01a0, 0x65ff, 0x0150, 0x2a00, 0x0130, 0x01f0, 0x65ff, 0x0150, 0x0f00, 0x01b0, 0x03ff, 0x0160, 0x0700, 0x0180, + 0x03ff, 0x0180, 0x0400, 0x0240, 0x0150, 0x01a0, 0x04ff, 0x01e0, 0x0700, 0x0140, 0x03ff, 0x01c0, 0x2200, 0x0180, 0x28ff, 0x1f00, + 0x01c0, 0x32ff, 0x01e0, 0x0110, 0x3800, 0x01c0, 0x4fff, 0x01b0, 0x3800, 0x0110, 0x01f0, 0x32ff, 0x0180, 0x1200, 0x01c0, 0x63ff, + 0x0160, 0x2c00, 0x0130, 0x01f0, 0x63ff, 0x0160, 0x1000, 0x01c0, 0x03ff, 0x0140, 0x0700, 0x0180, 0x10ff, 0x0130, 0x0700, 0x0140, + 0x03ff, 0x01c0, 0x2200, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x32ff, 0x0140, 0x3900, 0x0120, 0x01f0, 0x4dff, 0x01f0, 0x0110, 0x3900, + 0x0160, 0x32ff, 0x0180, 0x1200, 0x0110, 0x01d0, 0x61ff, 0x0160, 0x2e00, 0x0140, 0x62ff, 0x0160, 0x1100, 0x01c0, 0x03ff, 0x0140, + 0x0700, 0x0180, 0x0eff, 0x01e0, 0x0140, 0x0800, 0x0140, 0x03ff, 0x01c0, 0x2200, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x31ff, 0x0190, + 0x3b00, 0x0170, 0x4dff, 0x0150, 0x3b00, 0x01b0, 0x31ff, 0x0180, 0x1300, 0x0110, 0x01d0, 0x5fff, 0x0160, 0x3000, 0x0160, 0x60ff, + 0x0160, 0x1200, 0x01c0, 0x03ff, 0x0140, 0x0700, 0x0180, 0x0bff, 0x01d0, 0x01b0, 0x0160, 0x0a00, 0x0140, 0x03ff, 0x01c0, 0x2200, + 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x30ff, 0x01d0, 0x0110, 0x3c00, 0x01b0, 0x4bff, 0x0190, 0x3c00, 0x0110, 0x01e0, 0x30ff, 0x0180, + 0x1400, 0x0110, 0x01d0, 0x5dff, 0x0160, 0x3200, 0x0160, 0x5eff, 0x0160, 0x1300, 0x01c0, 0x03ff, 0x0140, 0x0700, 0x0180, 0x03ff, + 0x01a0, 0x0340, 0x01a0, 0x03ff, 0x01c0, 0x0c00, 0x0140, 0x03ff, 0x01c0, 0x2200, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x2fff, 0x01f0, + 0x0120, 0x3d00, 0x0110, 0x01e0, 0x49ff, 0x01d0, 0x3e00, 0x0130, 0x30ff, 0x0180, 0x1500, 0x0110, 0x01d0, 0x5bff, 0x0160, 0x3400, + 0x0130, 0x01f0, 0x5bff, 0x0160, 0x1400, 0x0190, 0x03ff, 0x0180, 0x0700, 0x0180, 0x03ff, 0x0180, 0x0300, 0x0110, 0x01e0, 0x03ff, + 0x0160, 0x0b00, 0x0150, 0x03ff, 0x01c0, 0x2200, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x2fff, 0x0140, 0x3f00, 0x0130, 0x01f0, 0x47ff, + 0x01f0, 0x0110, 0x3f00, 0x0160, 0x2fff, 0x0180, 0x1600, 0x0110, 0x01a0, 0x59ff, 0x0160, 0x3600, 0x0130, 0x01f0, 0x58ff, 0x01f0, + 0x0150, 0x1500, 0x0180, 0x03ff, 0x01a0, 0x0700, 0x0180, 0x03ff, 0x0180, 0x0400, 0x0140, 0x03ff, 0x01f0, 0x0110, 0x0a00, 0x0180, + 0x03ff, 0x0180, 0x2200, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x2eff, 0x0160, 0x4100, 0x0150, 0x46ff, 0x01f0, 0x0130, 0x4100, 0x0190, + 0x2eff, 0x0180, 0x1800, 0x0190, 0x56ff, 0x01f0, 0x0130, 0x3800, 0x0130, 0x01d0, 0x56ff, 0x01f0, 0x0130, 0x1600, 0x0140, 0x03ff, + 0x01d0, 0x0700, 0x0180, 0x03ff, 0x0180, 0x0500, 0x01b0, 0x03ff, 0x01b0, 0x0a00, 0x01c0, 0x03ff, 0x0160, 0x2200, 0x0180, 0x28ff, + 0x1f00, 0x01c0, 0x2dff, 0x0180, 0x4300, 0x0160, 0x45ff, 0x0150, 0x4300, 0x01a0, 0x2dff, 0x0180, 0x1900, 0x0160, 0x54ff, 0x01d0, + 0x0130, 0x3a00, 0x0110, 0x01c0, 0x54ff, 0x01d0, 0x0110, 0x1800, 0x04ff, 0x0120, 0x0600, 0x0180, 0x03ff, 0x0180, 0x0500, 0x0110, + 0x01f0, 0x03ff, 0x0150, 0x0800, 0x0110, 0x04ff, 0x0120, 0x2200, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x2cff, 0x01a0, 0x4500, 0x0160, + 0x43ff, 0x0160, 0x4500, 0x01a0, 0x2cff, 0x0180, 0x1a00, 0x0130, 0x01e0, 0x51ff, 0x01b0, 0x0110, 0x3d00, 0x0180, 0x52ff, 0x0190, + 0x1a00, 0x01b0, 0x03ff, 0x0170, 0x0600, 0x0180, 0x03ff, 0x0180, 0x0600, 0x0170, 0x03ff, 0x01f0, 0x0110, 0x0700, 0x0160, 0x03ff, + 0x01d0, 0x2300, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x2bff, 0x0190, 0x4700, 0x0160, 0x41ff, 0x0160, 0x4700, 0x01a0, 0x2bff, 0x0180, + 0x1b00, 0x0110, 0x01b0, 0x4fff, 0x0170, 0x4000, 0x0140, 0x01f0, 0x4eff, 0x01f0, 0x0150, 0x1b00, 0x0160, 0x03ff, 0x01e0, 0x0600, + 0x0180, 0x03ff, 0x0180, 0x0700, 0x01c0, 0x03ff, 0x0190, 0x0700, 0x01c0, 0x03ff, 0x0170, 0x2300, 0x0180, 0x28ff, 0x1f00, 0x01c0, + 0x2aff, 0x0160, 0x4900, 0x0160, 0x3eff, 0x01f0, 0x0130, 0x4900, 0x0190, 0x2aff, 0x0180, 0x1d00, 0x0170, 0x01f0, 0x4bff, 0x01d0, + 0x0130, 0x4200, 0x0110, 0x01b0, 0x4cff, 0x01c0, 0x0120, 0x1d00, 0x01f0, 0x03ff, 0x0160, 0x0500, 0x0180, 0x03ff, 0x0180, 0x0700, + 0x0120, 0x04ff, 0x0140, 0x0500, 0x0140, 0x04ff, 0x0110, 0x2300, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x28ff, 0x01f0, 0x0150, 0x4b00, + 0x0130, 0x01f0, 0x3bff, 0x01e0, 0x0130, 0x4b00, 0x0160, 0x29ff, 0x0180, 0x1e00, 0x0120, 0x01c0, 0x49ff, 0x0180, 0x4600, 0x0170, + 0x01f0, 0x48ff, 0x01f0, 0x0170, 0x1f00, 0x0180, 0x03ff, 0x01f0, 0x0110, 0x0400, 0x0180, 0x03ff, 0x0180, 0x0800, 0x0180, 0x03ff, + 0x01e0, 0x0110, 0x0400, 0x01d0, 0x03ff, 0x01a0, 0x2400, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x27ff, 0x01e0, 0x0130, 0x4d00, 0x0120, + 0x01d0, 0x39ff, 0x01c0, 0x0110, 0x4d00, 0x0130, 0x01f0, 0x27ff, 0x0180, 0x2000, 0x0170, 0x01f0, 0x45ff, 0x01c0, 0x0130, 0x4800, + 0x0110, 0x01b0, 0x46ff, 0x01b0, 0x0110, 0x2000, 0x0110, 0x01e0, 0x03ff, 0x01a0, 0x0400, 0x0180, 0x03ff, 0x0180, 0x0900, 0x01d0, + 0x03ff, 0x0190, 0x0300, 0x0180, 0x03ff, 0x01f0, 0x0110, 0x2400, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x26ff, 0x01b0, 0x0110, 0x5000, + 0x0190, 0x37ff, 0x0180, 0x5000, 0x0110, 0x01c0, 0x26ff, 0x0180, 0x2100, 0x0110, 0x01a0, 0x42ff, 0x01f0, 0x0160, 0x4c00, 0x0140, + 0x01e0, 0x42ff, 0x01d0, 0x0140, 0x2300, 0x0140, 0x04ff, 0x0160, 0x0300, 0x0140, 0x0380, 0x0140, 0x0900, 0x0130, 0x0480, 0x0200, + 0x0160, 0x04ff, 0x0170, 0x2500, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x24ff, 0x01f0, 0x0150, 0x5300, 0x0150, 0x01f0, 0x33ff, 0x01e0, + 0x0140, 0x5300, 0x0170, 0x01f0, 0x24ff, 0x0180, 0x2300, 0x0130, 0x01c0, 0x3eff, 0x01f0, 0x0180, 0x0110, 0x4f00, 0x0160, 0x01e0, + 0x3eff, 0x01e0, 0x0160, 0x2600, 0x0190, 0x04ff, 0x0160, 0x1600, 0x0130, 0x01f0, 0x03ff, 0x01b0, 0x2600, 0x0180, 0x28ff, 0x1f00, + 0x01c0, 0x23ff, 0x01b0, 0x0110, 0x5500, 0x0110, 0x0190, 0x31ff, 0x0180, 0x0110, 0x5500, 0x0120, 0x01c0, 0x23ff, 0x0180, 0x2500, + 0x0140, 0x01c0, 0x3aff, 0x01f0, 0x0180, 0x0110, 0x5200, 0x0110, 0x0180, 0x01f0, 0x3aff, 0x01e0, 0x0160, 0x2900, 0x01c0, 0x04ff, + 0x0170, 0x1400, 0x0160, 0x04ff, 0x01d0, 0x0110, 0x2600, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x21ff, 0x01c0, 0x0140, 0x5900, 0x0130, + 0x01c0, 0x2dff, 0x01c0, 0x0120, 0x5900, 0x0150, 0x01e0, 0x21ff, 0x0180, 0x2700, 0x0140, 0x01a0, 0x36ff, 0x01f0, 0x0180, 0x0110, + 0x5700, 0x0160, 0x01e0, 0x36ff, 0x01e0, 0x0160, 0x2b00, 0x0110, 0x01d0, 0x04ff, 0x01b0, 0x0110, 0x1000, 0x0110, 0x0190, 0x04ff, + 0x01d0, 0x0110, 0x2700, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x1fff, 0x01e0, 0x0160, 0x5d00, 0x0140, 0x01c0, 0x29ff, 0x01c0, 0x0140, + 0x5d00, 0x0160, 0x01e0, 0x1fff, 0x0180, 0x2900, 0x0120, 0x0190, 0x01f0, 0x31ff, 0x01d0, 0x0160, 0x5c00, 0x0150, 0x01b0, 0x32ff, + 0x01a0, 0x0140, 0x2e00, 0x0110, 0x01b0, 0x04ff, 0x01f0, 0x0180, 0x0110, 0x0d00, 0x0160, 0x01f0, 0x04ff, 0x01d0, 0x0110, 0x2800, + 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x1dff, 0x01c0, 0x0150, 0x6100, 0x0140, 0x01c0, 0x25ff, 0x01a0, 0x0140, 0x6100, 0x0160, 0x01d0, + 0x1dff, 0x0180, 0x2c00, 0x0160, 0x01b0, 0x2cff, 0x01e0, 0x0190, 0x0130, 0x6000, 0x0120, 0x0170, 0x01e0, 0x2cff, 0x01d0, 0x0170, + 0x0110, 0x3200, 0x0180, 0x05ff, 0x01f0, 0x01a0, 0x0150, 0x0110, 0x0700, 0x0140, 0x0190, 0x01f0, 0x05ff, 0x01a0, 0x0110, 0x2900, + 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x1aff, 0x01f0, 0x0190, 0x0120, 0x6500, 0x0120, 0x0190, 0x01e0, 0x1fff, 0x01e0, 0x0180, 0x0120, + 0x6500, 0x0130, 0x01a0, 0x01f0, 0x1aff, 0x0180, 0x2e00, 0x0110, 0x0160, 0x01b0, 0x01f0, 0x25ff, 0x01e0, 0x0190, 0x0140, 0x6600, + 0x0130, 0x0180, 0x01d0, 0x26ff, 0x01d0, 0x0170, 0x0120, 0x3600, 0x0130, 0x01d0, 0x07ff, 0x01e0, 0x04c0, 0x01d0, 0x07ff, 0x01e0, + 0x0150, 0x2b00, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x17ff, 0x01e0, 0x0190, 0x0150, 0x6b00, 0x0130, 0x0190, 0x01e0, 0x19ff, 0x01d0, + 0x0190, 0x0130, 0x6b00, 0x0150, 0x01a0, 0x01e0, 0x17ff, 0x0180, 0x3200, 0x0140, 0x0180, 0x01c0, 0x1eff, 0x01f0, 0x01b0, 0x0170, + 0x0120, 0x6c00, 0x0120, 0x0160, 0x01a0, 0x01e0, 0x1eff, 0x01d0, 0x0190, 0x0150, 0x0110, 0x3b00, 0x0160, 0x01e0, 0x10ff, 0x01e0, + 0x0170, 0x2d00, 0x0180, 0x28ff, 0x1f00, 0x01c0, 0x13ff, 0x01c0, 0x0190, 0x0160, 0x0120, 0x7100, 0x0120, 0x0160, 0x0190, 0x01c0, + 0x11ff, 0x01c0, 0x0190, 0x0150, 0x0120, 0x7100, 0x0130, 0x0160, 0x01a0, 0x01d0, 0x13ff, 0x0180, 0x3600, 0x0140, 0x0170, 0x0190, + 0x01c0, 0x01f0, 0x13ff, 0x01e0, 0x01c0, 0x0180, 0x0150, 0x0120, 0x7400, 0x0110, 0x0140, 0x0180, 0x01b0, 0x01d0, 0x14ff, 0x01c0, + 0x01a0, 0x0180, 0x0140, 0x0110, 0x4100, 0x0140, 0x01a0, 0x01e0, 0x0aff, 0x01f0, 0x01a0, 0x0150, 0x2f00, 0x0140, 0x2880, 0x1f00, + 0x0160, 0x0f80, 0x0160, 0x0140, 0x0120, 0x7b00, 0x0120, 0x0140, 0x0150, 0x0980, 0x0150, 0x0140, 0x0110, 0x7b00, 0x0120, 0x0140, + 0x0160, 0x0f80, 0x0140, 0x3c00, 0x0240, 0x0160, 0x0b80, 0x0240, 0x0120, 0x8000, 0x0110, 0x0240, 0x0170, 0x0a80, 0x0160, 0x0240, + 0x4b00, 0x0120, 0x0150, 0x0680, 0x0150, 0x0130, 0x1000 +}; + +// Load the data of the above array, expand it into RGBA data +uint8_t* LoadRGBA (bool bBlack) +{ + // RGBA structure + typedef struct { + uint8_t r,g,b,a; + } RGBAty; + + // Black & White + const RGBAty BLACK = { 0x06, 0x08, 0x0b, 0xff }; + const RGBAty WHITE = { 0xff, 0xff, 0xff, 0xff }; + const RGBAty& col = bBlack ? BLACK : WHITE; // which color to use for visible pixels? + + // allocate the necessary memory: 4 bytes (RGBA) per pixel + RGBAty* pRGBA = new RGBAty[IMG_SIZE]; + if (!pRGBA) return nullptr; + RGBAty* p = pRGBA; + + // Loop the RLE alpha data + for (uint16_t rle: ALPHA_RLE) + { + uint8_t n = uint8_t(rle >> 8); // upper byte is the number of pixel to fill + uint8_t a = uint8_t(rle & 0x00ff); // lower byte is the alpha value + + // A visible pixel uses color `col`, but by convention an invisible pixel (alpha = 0) always uses color WHITE + RGBAty pixel = a > 0 ? col : WHITE; + pixel.a = a; // use the Alpha value from the RLE array + + // add as many pixels as stated by the run-length + for (;n > 0; --n) + *(p++) = pixel; + } + + // when we are done we expect to have _exactly_ filled the image + assert(p - pRGBA == IMG_SIZE); + + // return the loaded data + return (uint8_t*)pRGBA; +} + +// The one public function +bool GetTexture (int& id, bool bBlack) +{ + static bool doneBlack = false, doneWhite = false; // has texture been created already? + static int idBlack = 0, idWhite = 0; // texture id if already created + + // Already created the wanted id? + if (bBlack && doneBlack) { id = idBlack; return true; } + if (!bBlack && doneWhite) { id = idWhite; return true; } + + // Load the logo data as RGBA data into memory + uint8_t* pRGBA = LoadRGBA(bBlack); + if (!pRGBA) return false; + + // Load the logo as an OpenGL texture + int &texId = bBlack ? idBlack : idWhite; + XPLMGenerateTextureNumbers(&texId, 1); + XPLMBindTexture2d(texId, 0); + +// Apple has deprecated OpenGL...but let's not get talkative about it +#if defined(__clang__) +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wdeprecated-declarations" +#endif + glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR); + glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR); + glPixelStorei(GL_UNPACK_ROW_LENGTH, 0); + glTexImage2D(GL_TEXTURE_2D, 0, + GL_RGBA, IMG_WIDTH, IMG_HEIGHT, 0, + GL_RGBA, GL_UNSIGNED_BYTE, pRGBA); +#if defined(__clang__) +#pragma clang diagnostic pop +#endif + // free our own RGBA data + delete[] pRGBA; + + // return the texture id to the caller + if (bBlack) doneBlack = true; + else doneWhite = true; + id = texId; + return true; +} + +}; // namespace FMODLogo diff --git a/lib/fmod/logo/FMOD_Logo.h b/lib/fmod/logo/FMOD_Logo.h new file mode 100644 index 00000000..1db30d8c --- /dev/null +++ b/lib/fmod/logo/FMOD_Logo.h @@ -0,0 +1,72 @@ +/// @file FMOD_Logo.h +/// @brief Compressed version of the FMOD logo with code to create +/// a texture ID in X-Plane for display with Dear ImGui +/// @see [FMOD attribution requirements](https://www.fmod.com/attribution) +/// @see [FMOD Logo download](https://www.fmod.com/assets/FMOD_LOGOS.zip) +/// @details The FMOD logo is essential a single-color image, +/// either black (RGB 0x06 0x08 0x0b) or white (0xff 0xff 0xff), +/// with only the alpha value varying across the image. +/// The below array `ALPHA_RLE` is a run-length encoded dump +/// of these alpha values. +/// The provided functions recreate the full RGBA data, +/// so that it can be used with OpenGL functionality to be turned +/// into a texture. +/// @details **Usage**\n +/// +/// #include "FMOD_Logo.h" +/// ... +/// int logoId = 0; +/// if (FMODLogo::GetTexture(logoId)) { +/// ImGui::Image((void*)(intptr_t)logoId, ImVec2(FMODLogo::IMG_WIDTH, FMODLogo::IMG_HEIGHT)); +/// } +/// +/// @copyright of the logo itself: Firelight Technologies Pty Ltd. +/// +/// @author of the code: Birger Hoppe +/// @copyright (c) 2022 Birger Hoppe +/// @copyright Permission is hereby granted, free of charge, to any person obtaining a +/// copy of this software and associated documentation files (the "Software"), +/// to deal in the Software without restriction, including without limitation +/// the rights to use, copy, modify, merge, publish, distribute, sublicense, +/// and/or sell copies of the Software, and to permit persons to whom the +/// Software is furnished to do so, subject to the following conditions:\n +/// The above copyright notice and this permission notice shall be included in +/// all copies or substantial portions of the Software.\n +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +/// THE SOFTWARE. + +#pragma once + +#include + +namespace FMODLogo { + +// Dimensions of the FMOD logo +constexpr int IMG_WIDTH = 728; ///< Logo image width +constexpr int IMG_HEIGHT = 192; ///< Logo image height +constexpr int IMG_SIZE = IMG_WIDTH * IMG_HEIGHT; ///< Logo image size in number of pixels + +/// @brief The one "public" function to return a texture id for the logo +/// @details On first call will load the logo and create a texture from it, +/// on subsequent calls will return the already loaded id. +/// @param[out] texId receives the texture id for the (black or white) FMOD logo +/// @param bBlack [opt] Black or White logo? (Will return different texture ids) +/// @returns `true` if successful +bool GetTexture (int& texId, bool bBlack = true); + +/// @brief Load the data of the FMOD logo, expanded into RGBA data +/// @details This function is internally used by GetTexture(). +/// It is _not_ typically used publicly but provided just in case +/// what you need is not an OpenGL texture but the raw RGBA data. +/// Data is provided in 4-byte blocks, one byte per RGBA value. +/// The returned array has size `IMG_SIZE * 4`. +/// Caller has to free the data using `delete[]`. +/// @returns pointer to raw RGBA data, 4 bytes per pixel. +uint8_t* LoadRGBA (bool bBlack = true); + +}; // namespace FMODLogo diff --git a/XPMP2-Sample/mingw-std-threads/CMakeLists.txt b/lib/mingw-std-threads/CMakeLists.txt similarity index 100% rename from XPMP2-Sample/mingw-std-threads/CMakeLists.txt rename to lib/mingw-std-threads/CMakeLists.txt diff --git a/XPMP2-Sample/mingw-std-threads/LICENSE b/lib/mingw-std-threads/LICENSE similarity index 100% rename from XPMP2-Sample/mingw-std-threads/LICENSE rename to lib/mingw-std-threads/LICENSE diff --git a/XPMP2-Sample/mingw-std-threads/README.md b/lib/mingw-std-threads/README.md similarity index 100% rename from XPMP2-Sample/mingw-std-threads/README.md rename to lib/mingw-std-threads/README.md diff --git a/XPMP2-Sample/mingw-std-threads/cmake_stdheaders_generator/CMakeLists.txt b/lib/mingw-std-threads/cmake_stdheaders_generator/CMakeLists.txt similarity index 100% rename from XPMP2-Sample/mingw-std-threads/cmake_stdheaders_generator/CMakeLists.txt rename to lib/mingw-std-threads/cmake_stdheaders_generator/CMakeLists.txt diff --git a/XPMP2-Sample/mingw-std-threads/cmake_stdheaders_generator/template.cpp b/lib/mingw-std-threads/cmake_stdheaders_generator/template.cpp similarity index 100% rename from XPMP2-Sample/mingw-std-threads/cmake_stdheaders_generator/template.cpp rename to lib/mingw-std-threads/cmake_stdheaders_generator/template.cpp diff --git a/XPMP2-Sample/mingw-std-threads/mingw.condition_variable.h b/lib/mingw-std-threads/mingw.condition_variable.h similarity index 100% rename from XPMP2-Sample/mingw-std-threads/mingw.condition_variable.h rename to lib/mingw-std-threads/mingw.condition_variable.h diff --git a/XPMP2-Sample/mingw-std-threads/mingw.future.h b/lib/mingw-std-threads/mingw.future.h similarity index 100% rename from XPMP2-Sample/mingw-std-threads/mingw.future.h rename to lib/mingw-std-threads/mingw.future.h diff --git a/XPMP2-Sample/mingw-std-threads/mingw.invoke.h b/lib/mingw-std-threads/mingw.invoke.h similarity index 100% rename from XPMP2-Sample/mingw-std-threads/mingw.invoke.h rename to lib/mingw-std-threads/mingw.invoke.h diff --git a/XPMP2-Sample/mingw-std-threads/mingw.mutex.h b/lib/mingw-std-threads/mingw.mutex.h similarity index 100% rename from XPMP2-Sample/mingw-std-threads/mingw.mutex.h rename to lib/mingw-std-threads/mingw.mutex.h diff --git a/XPMP2-Sample/mingw-std-threads/mingw.shared_mutex.h b/lib/mingw-std-threads/mingw.shared_mutex.h similarity index 100% rename from XPMP2-Sample/mingw-std-threads/mingw.shared_mutex.h rename to lib/mingw-std-threads/mingw.shared_mutex.h diff --git a/XPMP2-Sample/mingw-std-threads/mingw.thread.h b/lib/mingw-std-threads/mingw.thread.h similarity index 100% rename from XPMP2-Sample/mingw-std-threads/mingw.thread.h rename to lib/mingw-std-threads/mingw.thread.h diff --git a/XPMP2-Sample/mingw-std-threads/tests/CMakeLists.txt b/lib/mingw-std-threads/tests/CMakeLists.txt similarity index 100% rename from XPMP2-Sample/mingw-std-threads/tests/CMakeLists.txt rename to lib/mingw-std-threads/tests/CMakeLists.txt diff --git a/XPMP2-Sample/mingw-std-threads/tests/tests.cpp b/lib/mingw-std-threads/tests/tests.cpp similarity index 100% rename from XPMP2-Sample/mingw-std-threads/tests/tests.cpp rename to lib/mingw-std-threads/tests/tests.cpp diff --git a/XPMP2-Sample/mingw-std-threads/utility_scripts/Generate-StdLikeHeaders.ps1 b/lib/mingw-std-threads/utility_scripts/Generate-StdLikeHeaders.ps1 similarity index 100% rename from XPMP2-Sample/mingw-std-threads/utility_scripts/Generate-StdLikeHeaders.ps1 rename to lib/mingw-std-threads/utility_scripts/Generate-StdLikeHeaders.ps1 diff --git a/XPMP2-Sample/mingw-std-threads/utility_scripts/generate_std_like_headers.bat b/lib/mingw-std-threads/utility_scripts/generate_std_like_headers.bat similarity index 100% rename from XPMP2-Sample/mingw-std-threads/utility_scripts/generate_std_like_headers.bat rename to lib/mingw-std-threads/utility_scripts/generate_std_like_headers.bat diff --git a/XPMP2-Sample/mingw-std-threads/utility_scripts/generate_std_like_headers_interactive.bat b/lib/mingw-std-threads/utility_scripts/generate_std_like_headers_interactive.bat similarity index 100% rename from XPMP2-Sample/mingw-std-threads/utility_scripts/generate_std_like_headers_interactive.bat rename to lib/mingw-std-threads/utility_scripts/generate_std_like_headers_interactive.bat diff --git a/src/2D.cpp b/src/2D.cpp index ba3bc293..f80a40b5 100755 --- a/src/2D.cpp +++ b/src/2D.cpp @@ -194,7 +194,6 @@ int CPLabelDrawing (XPLMDrawingPhase /*inPhase*/, int /*inIsBefore*/, void * /*inRefcon*/) { - UPDATE_CYCLE_NUM; // DEBUG only: Store current cycle number in glob.xpCycleNum TwoDDrawLabels(); return 1; } diff --git a/src/AIMultiplayer.cpp b/src/AIMultiplayer.cpp index e30ec81c..937cd90c 100755 --- a/src/AIMultiplayer.cpp +++ b/src/AIMultiplayer.cpp @@ -289,9 +289,11 @@ size_t AIUpdateMultiplayerDataRefs() if (ac.prev_ts > 0.0001f) { // yes, so we can calculate velocity const float d_s = now - ac.prev_ts; // time that had passed in seconds - XPLMSetDataf(mdr.v_x, (ac.drawInfo.x - ac.prev_x) / d_s); - XPLMSetDataf(mdr.v_y, (ac.drawInfo.y - ac.prev_y) / d_s); - XPLMSetDataf(mdr.v_z, (ac.drawInfo.z - ac.prev_z) / d_s); + XPLMSetDataf(mdr.v_x, ac.v_x = (ac.drawInfo.x - ac.prev_x) / d_s); + XPLMSetDataf(mdr.v_y, ac.v_y = (ac.drawInfo.y - ac.prev_y) / d_s); + XPLMSetDataf(mdr.v_z, ac.v_z = (ac.drawInfo.z - ac.prev_z) / d_s); + // based on horizontal coordinates calculate a (rough) ground speed + ac.gs_kn = std::sqrt(ac.v_x*ac.v_x + ac.v_z*ac.v_z) * float(KT_per_M_per_S); } ac.prev_x = ac.drawInfo.x; ac.prev_y = ac.drawInfo.y; diff --git a/src/Aircraft.cpp b/src/Aircraft.cpp index b35c5dd7..54fc4681 100755 --- a/src/Aircraft.cpp +++ b/src/Aircraft.cpp @@ -215,6 +215,11 @@ Aircraft::~Aircraft () XPMPSendNotification(*this, xpmp_PlaneNotification_Destroyed); RemoteAcRemove(*this); +#ifdef INCLUDE_FMOD_SOUND + // Remove all sound + SoundRemoveAll(); +#endif + // Remove the instance DestroyInstances(); @@ -290,6 +295,11 @@ void Aircraft::Create (const std::string& _icaoType, ChangeModel(_icaoType, _icaoAirline, _livery); LOG_ASSERT(pCSLMdl); +#ifdef INCLUDE_FMOD_SOUND + // Setup sound for this aircraft + SoundSetup(); +#endif + // add the aircraft to our global map and inform observers glob.mapAc.emplace(modeS_id,this); XPMPSendNotification(*this, xpmp_PlaneNotification_Created); @@ -398,8 +408,12 @@ int Aircraft::ChangeModel (const std::string& _icaoType, WakeApplyDefaults(bChangeExisting); // inform observers in case this was an actual replacement change - if (bChangeExisting) + if (bChangeExisting) { +#ifdef INCLUDE_FMOD_SOUND + SoundSetup(); +#endif XPMPSendNotification(*this, xpmp_PlaneNotification_ModelChanged); + } return q; } @@ -493,14 +507,13 @@ float Aircraft::FlightLoopCB(float _elapsedSinceLastCall, float, int _flCounter, { // This is a plugin entry function, so we try to catch all exceptions try { - UPDATE_CYCLE_NUM; // DEBUG only: Store current cycle number in glob.xpCycleNum + glob.xpCycleNum=XPLMGetCycleNumber(); // Store current cycle number in glob.xpCycleNum // Update configuration glob.UpdateCfgVals(); // Need the camera's position to calculate the a/c's distance to it - XPLMCameraPosition_t posCamera; - XPLMReadCameraPosition(&posCamera); + glob.UpdateCameraPos(); // As we need the current timestamp more often we read it here once const float now = GetMiscNetwTime(); @@ -525,7 +538,7 @@ float Aircraft::FlightLoopCB(float _elapsedSinceLastCall, float, int _flCounter, ac.ClampToGround(); // Update plane's distance/bearing every second only if (CheckEverySoOften(ac.camTimLstUpd, 1.0f, now)) { - ac.UpdateDistBearingCamera(posCamera); + ac.UpdateDistBearingCamera(glob.posCamera); ac.ComputeMapLabel(); } // If required reset touch down animation @@ -537,6 +550,10 @@ float Aircraft::FlightLoopCB(float _elapsedSinceLastCall, float, int _flCounter, ac.DoMove(); // Feed remote connections RemoteAcEnqueue(ac); +#ifdef INCLUDE_FMOD_SOUND + // Update Sound + ac.SoundUpdate(); +#endif } } CATCH_AC(ac) @@ -545,12 +562,20 @@ float Aircraft::FlightLoopCB(float _elapsedSinceLastCall, float, int _flCounter, // Tell remote module that we are done updated a/c so it can send out last pending messages RemoteAcEnqueueDone(); +#ifdef INCLUDE_FMOD_SOUND + // Tell Sound module that we are done updating + SoundUpdatesDone(); +#endif + // Publish aircraft data on the AI/multiplayer dataRefs AIMultiUpdate(); } catch (const std::exception& e) { LOG_MSG(logFATAL, ERR_EXCEPTION, e.what()); RemoteAcEnqueueDone(); // must make sure to release a lock +#ifdef INCLUDE_FMOD_SOUND + SoundUpdatesDone(); +#endif } // Don't call me again if there are no more aircraft, @@ -842,6 +867,11 @@ void Aircraft::SetVisible (bool _bVisible) ResetTcasTargetIdx(); DestroyInstances(); } + +#ifdef INCLUDE_FMOD_SOUND + // (Un)mute Sound + SoundMuteAll(!bVisible); +#endif } // Switch rendering of the CSL model on or off diff --git a/src/CSLModels.cpp b/src/CSLModels.cpp index 33d6e088..31009b8e 100755 --- a/src/CSLModels.cpp +++ b/src/CSLModels.cpp @@ -496,7 +496,6 @@ void CSLModel::DecRefCnt () // Static functions: Unload all objects which haven't been used for a while float CSLModel::GarbageCollection (float, float, int, void*) { - UPDATE_CYCLE_NUM; // DEBUG only: Store current cycle number in glob.xpCycleNum const float now = GetMiscNetwTime(); // loop all models for (auto& p: glob.mapCSLModels) { diff --git a/src/CSLModels.h b/src/CSLModels.h index c52fba1e..7220bbec 100644 --- a/src/CSLModels.h +++ b/src/CSLModels.h @@ -200,6 +200,7 @@ class CSLModel const char* GetWTC () const { return doc8643->wtc; }///< Wake turbulence category char GetClassType () const { return doc8643->GetClassType(); } char GetClassNumEng () const { return doc8643->GetClassNumEng(); } + int GetNumEngines() const { return doc8643->GetNumEngines(); } char GetClassEngType () const { return doc8643->GetClassEngType(); } bool HasRotor () const { return doc8643->HasRotor(); } diff --git a/src/RelatedDoc8643.h b/src/RelatedDoc8643.h index b6b8b1c6..9b884b88 100644 --- a/src/RelatedDoc8643.h +++ b/src/RelatedDoc8643.h @@ -73,6 +73,7 @@ struct Doc8643 { char GetClassType () const { return classification[0]; } char GetClassNumEng () const { return classification[1]; } + int GetNumEngines () const { return ('0' <= classification[1] && classification[1] <= '9') ? classification[1] - '0' : 0; } char GetClassEngType () const { return classification[2]; } bool HasRotor () const { return (classification[0] == 'H' || classification[0] == 'G'); } diff --git a/src/Sound.cpp b/src/Sound.cpp new file mode 100644 index 00000000..8b6ed314 --- /dev/null +++ b/src/Sound.cpp @@ -0,0 +1,961 @@ +/// @file Sound.cpp +/// @brief Sound for aircraft, based on the FMOD library +/// +/// @note Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. +/// Understand FMOD [licensing](https://www.fmod.com/licensing) and +/// [attribution requirements](https://www.fmod.com/attribution) first!\n +/// Sound support is only included if built with CMake cache entry `INCLUDE_FMOD_SOUND`.\n +/// +/// @see FMOD Core API Guide +/// https://fmod.com/docs/2.02/api/core-guide.html +/// @details FMOD's C interface is used exclusively (and not the C++ ABI). +/// This is to ease handling of dynamic libaries between versions +/// (XP11 is using FMOD 1.x while XP12 has upgraded to 2.x) +/// and allows compiling with MingW. +/// @details Some functionality looks like immitating FMOD's SoundGroup, +/// but 3D positioning was unstable when used via SoundGroup, +/// and the cone functionality did not work at all, +/// so this file handles all sound channels individually. +/// @note If linking to the logging version of the FMOD API library +/// (the one ending in `L`) and specifying a +/// config item `log_level` of `0 = Debug` +/// (see ::XPMPIntPrefsFuncTy) while initializing sound, +/// ie. typically during the first call to XPMPMultiplayerInit(), +/// then FMOD logging output is added to X-Plane's `Log.txt`. +/// @author Birger Hoppe +/// @copyright (c) 2022 Birger Hoppe +/// @copyright Permission is hereby granted, free of charge, to any person obtaining a +/// copy of this software and associated documentation files (the "Software"), +/// to deal in the Software without restriction, including without limitation +/// the rights to use, copy, modify, merge, publish, distribute, sublicense, +/// and/or sell copies of the Software, and to permit persons to whom the +/// Software is furnished to do so, subject to the following conditions:\n +/// The above copyright notice and this permission notice shall be included in +/// all copies or substantial portions of the Software.\n +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +/// THE SOFTWARE. + +#include "XPMP2.h" + +// FMOD header files only here in this module! +// This one includes everything +#include "fmod_errors.h" + +namespace XPMP2 { + +FMOD_VECTOR HeadPitch2Vec (const float head, const float pitch); + +// +// MARK: FMOD Old version Structures +// + +/// FMOD 1.08.30 version of FMOD_ADVANCEDSETTINGS +struct FMOD_10830_ADVANCEDSETTINGS +{ + int cbSize; /* [w] Size of this structure. Use sizeof(FMOD_ADVANCEDSETTINGS) NOTE: This must be set before calling System::getAdvancedSettings or System::setAdvancedSettings! */ + int maxMPEGCodecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. MPEG codecs consume 22,216 bytes per instance and this number will determine how many MPEG channels can be played simultaneously. Default = 32. */ + int maxADPCMCodecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. ADPCM codecs consume 2,480 bytes per instance and this number will determine how many ADPCM channels can be played simultaneously. Default = 32. */ + int maxXMACodecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. XMA codecs consume 6,263 bytes per instance and this number will determine how many XMA channels can be played simultaneously. Default = 32. */ + int maxVorbisCodecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. Vorbis codecs consume 16,512 bytes per instance and this number will determine how many Vorbis channels can be played simultaneously. Default = 32. */ + int maxAT9Codecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. AT9 codecs consume 20,664 bytes per instance and this number will determine how many AT9 channels can be played simultaneously. Default = 32. */ + int maxFADPCMCodecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. FADPCM codecs consume 2,232 bytes per instance and this number will determine how many FADPCM channels can be played simultaneously. Default = 32. */ + int maxPCMCodecs; /* [r/w] Optional. Specify 0 to ignore. For use with PS3 only. PCM codecs consume 2,536 bytes per instance and this number will determine how many streams and PCM voices can be played simultaneously. Default = 32. */ + int ASIONumChannels; /* [r/w] Optional. Specify 0 to ignore. Number of channels available on the ASIO device. */ + char **ASIOChannelList; /* [r/w] Optional. Specify 0 to ignore. Pointer to an array of strings (number of entries defined by ASIONumChannels) with ASIO channel names. */ + FMOD_SPEAKER *ASIOSpeakerList; /* [r/w] Optional. Specify 0 to ignore. Pointer to a list of speakers that the ASIO channels map to. This can be called after System::init to remap ASIO output. */ + float HRTFMinAngle; /* [r/w] Optional. For use with FMOD_INIT_HRTF_LOWPASS. The angle range (0-360) of a 3D sound in relation to the listener, at which the HRTF function begins to have an effect. 0 = in front of the listener. 180 = from 90 degrees to the left of the listener to 90 degrees to the right. 360 = behind the listener. Default = 180.0. */ + float HRTFMaxAngle; /* [r/w] Optional. For use with FMOD_INIT_HRTF_LOWPASS. The angle range (0-360) of a 3D sound in relation to the listener, at which the HRTF function has maximum effect. 0 = front of the listener. 180 = from 90 degrees to the left of the listener to 90 degrees to the right. 360 = behind the listener. Default = 360.0. */ + float HRTFFreq; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_HRTF_LOWPASS. The cutoff frequency of the HRTF's lowpass filter function when at maximum effect. (i.e. at HRTFMaxAngle). Default = 4000.0. */ + float vol0virtualvol; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_VOL0_BECOMES_VIRTUAL. If this flag is used, and the volume is below this, then the sound will become virtual. Use this value to raise the threshold to a different point where a sound goes virtual. */ + unsigned int defaultDecodeBufferSize; /* [r/w] Optional. Specify 0 to ignore. For streams. This determines the default size of the double buffer (in milliseconds) that a stream uses. Default = 400ms */ + unsigned short profilePort; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_PROFILE_ENABLE. Specify the port to listen on for connections by the profiler application. */ + unsigned int geometryMaxFadeTime; /* [r/w] Optional. Specify 0 to ignore. The maximum time in miliseconds it takes for a channel to fade to the new level when its occlusion changes. */ + float distanceFilterCenterFreq; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_DISTANCE_FILTERING. The default center frequency in Hz for the distance filtering effect. Default = 1500.0. */ + int reverb3Dinstance; /* [r/w] Optional. Specify 0 to ignore. Out of 0 to 3, 3d reverb spheres will create a phyical reverb unit on this instance slot. See FMOD_REVERB_PROPERTIES. */ + int DSPBufferPoolSize; /* [r/w] Optional. Specify 0 to ignore. Number of buffers in DSP buffer pool. Each buffer will be DSPBlockSize * sizeof(float) * SpeakerModeChannelCount. ie 7.1 @ 1024 DSP block size = 8 * 1024 * 4 = 32kb. Default = 8. */ + unsigned int stackSizeStream; /* [r/w] Optional. Specify 0 to ignore. Specify the stack size for the FMOD Stream thread in bytes. Useful for custom codecs that use excess stack. Default 49,152 (48kb) */ + unsigned int stackSizeNonBlocking; /* [r/w] Optional. Specify 0 to ignore. Specify the stack size for the FMOD_NONBLOCKING loading thread. Useful for custom codecs that use excess stack. Default 65,536 (64kb) */ + unsigned int stackSizeMixer; /* [r/w] Optional. Specify 0 to ignore. Specify the stack size for the FMOD mixer thread. Useful for custom dsps that use excess stack. Default 49,152 (48kb) */ + FMOD_DSP_RESAMPLER resamplerMethod; /* [r/w] Optional. Specify 0 to ignore. Resampling method used with fmod's software mixer. See FMOD_DSP_RESAMPLER for details on methods. */ + unsigned int commandQueueSize; /* [r/w] Optional. Specify 0 to ignore. Specify the command queue size for thread safe processing. Default 2048 (2kb) */ + unsigned int randomSeed; /* [r/w] Optional. Specify 0 to ignore. Seed value that FMOD will use to initialize its internal random number generators. */ +}; + + +// +// MARK: Global Variables and Types +// + +constexpr int EXP_COMP_SKIP_CYCLES = 10; ///< In how many cycles to skip expensive computations? +constexpr int FMOD_NUM_VIRT_CHANNELS = 1000; ///< Number of virtual channels during initialization +constexpr float FMOD_3D_MAX_DIST = 10000.0f; ///< Value used for 3D max distance, which doesn't have much of a function for the inverse roll-off model used here +constexpr float FMOD_LOW_PASS_GAIN = 0.2f; ///< Gain used when activating Low Pass filter + +static FMOD_SYSTEM* gpFmodSystem = nullptr; ///< FMOD system +static unsigned int gFmodVer = 0; ///< FMOD version + +/// Use pre-v2 FMOD version structures? +inline bool UseOldFmod() { return gFmodVer < 0x00020000; } + +/// Definition of how sound is handled based on dataRef values (type) +struct SoundDefTy { + float (Aircraft::* pVal)() const = nullptr; ///< Function return the value to observe, typically a dataRef value + bool bSndLoop = true; ///< Sound to be played in a loop while value is large than `valMin`? Otherwise a single sound upon detection of a change of value + float valMin = NAN; ///< Sound to be played if `*pVal > valMin` + float valMax = NAN; ///< Only used to control volume, which raises for `*pVal` between `valMin` and `valMax` +}; + +/// Definition of how sound is handled based on dataRef values +static SoundDefTy gaSoundDef[Aircraft::SND_NUM_EVENTS] = { + { &Aircraft::GetThrustRatio, true, 0.0f, 1.0f }, // SND_ENG + { &Aircraft::GetThrustReversRatio, true, 0.0f, 1.0f }, // SND_REVERSE_THRUST + { &Aircraft::GetTireRotRpm, true, 60.0f, 1000.0f }, // SND_TIRE + { &Aircraft::GetGearRatio, false, NAN, NAN }, // SND_GEAR + { &Aircraft::GetFlapRatio, false, NAN, NAN }, // SND_FLAPS +}; + + +// +// MARK: FMOD Error Handling +// + +/// Exception class to pass on error information +class FmodError : public std::runtime_error +{ +public: + FMOD_RESULT fmodRes; ///< the actual FMOD result code + int ln; ///< line number here in the code + std::string sFunc; ///< name of the function the error occurred in +public: + /// Constructor taking on a descriptive string and the `FMOD_RESULT` + FmodError (const std::string& _what, FMOD_RESULT _r, + int _ln, const std::string& _sFunc) : + std::runtime_error(leftOf(_what,"( ")), // takes over the name of the function called, but not all the parameter string + fmodRes(_r), ln(_ln), sFunc(_sFunc) + {} + + /// Log myself to Log.txt as an error + void LogErr () const { + LogMsg(__FILE__, ln, sFunc.c_str(), logERR, + "FMOD Error %d - '%s' in %s", fmodRes, + FMOD_ErrorString(fmodRes), + what()); + } +}; + +/// last FMOD result code, needed by the following macro, better don't rely on anywhere else +static FMOD_RESULT gFmodRes = FMOD_OK; + +/// @brief Log an error if `fmodRes` is not `FMOD_OK` +#define FMOD_TEST(fmodCall) { \ + if ((gFmodRes = (fmodCall)) != FMOD_OK) \ + throw FmodError(#fmodCall, gFmodRes, __LINE__, __func__); \ +} + +/// @brief Standard catch clause to handle FmodError exceptions by just logging them +#define FMOD_CATCH catch (const FmodError& e) { e.LogErr(); } + +/// Just log an error without raising an exception +#define FMOD_LOG(fmodCall) { \ + if ((XPMP2::gFmodRes = (fmodCall)) != FMOD_OK) \ + XPMP2::FmodError(#fmodCall, XPMP2::gFmodRes, __LINE__, __func__).LogErr(); \ +} + +// +// MARK: FMOD Logging +// + +/// @brief Callback function called by FMOD for logging purposes +/// @note FMOD warns this can be called from any thread, +/// so strictly speaking we must not call `XPLMDebugString()`, +/// but so far it didn't hurt, and it should be debug builds only anyway. +FMOD_RESULT F_CALLBACK SoundLogCB(FMOD_DEBUG_FLAGS flags, + const char * file, + int line, + const char * func, + const char *message) +{ + // Basically convert it to our standard log output + LogMsg(file, line, func, + flags & FMOD_DEBUG_LEVEL_ERROR ? logERR : + flags & FMOD_DEBUG_LEVEL_WARNING ? logWARN : logINFO, + "FMOD_LOG: %s", message); + return FMOD_OK; +} + +/// @brief Enables/disables FMOD logging +/// @note FMOD Logging only works if linked to the `L` versions of the FMOD library +void SoundLogEnable (bool bEnable = true) +{ + gFmodRes = FMOD_Debug_Initialize(bEnable ? FMOD_DEBUG_LEVEL_LOG : FMOD_DEBUG_LEVEL_NONE, + FMOD_DEBUG_MODE_CALLBACK, SoundLogCB, nullptr); + if (gFmodRes == FMOD_OK) { + LOG_MSG(logDEBUG, "FMOD logging has been %s.", bEnable ? "enabled" : "disabled"); + } + // FMOD_ERR_UNSUPPORTED just means: not linked to fmodL, ie. "normal" + else if (gFmodRes != FMOD_ERR_UNSUPPORTED) + { + FmodError("FMOD_Debug_Initialize", gFmodRes, __LINE__, __func__); + } +} + +// +// MARK: Sound Files +// + +/// @brief Represents a sound file +/// @see For 3D cones also see https://www.fmod.com/docs/2.01/api/core-api-channelcontrol.html#channelcontrol_set3dconesettings +class SoundFile { +public: + std::string filePath; ///< File path to sound file + bool bLoop = true; ///< sound to be played in a loop? + + // 3D Cone information, to be applied to the channel later when playing the sound + float coneDir = NAN; ///< Which direction relative to plane's heading does the cone point to? (180 would be typical for jet engines) + float conePitch = NAN; ///< Which pitch does the cone point to (up/down)? (0 would be typical, ie. level with the plane) + float coneInAngle = NAN; ///< Inside cone angle. This is the angle spread within which the sound is unattenuated. + float coneOutAngle = NAN; ///< Outside cone angle. This is the angle spread outside of which the sound is attenuated to its SoundFile::coneOutVol. + float coneOutVol = NAN; ///< Cone outside volume. + +protected: + unsigned len_ms = 0; ///< Sound length in ms + FMOD_SOUND* pSound = nullptr; ///< FMOD sound object + bool bLoaded = false; ///< cached version of the sound's `openstate` + +public: + /// @brief Construct a sound object from a file name and have it loaded asynchonously + /// @throws FmodError in case of errors during `CreateSound` + SoundFile (const std::string& _filePath, bool _bLoop, + float _coneDir, float _conePitch, + float _coneInAngle, float _coneOutAngle, float _coneOutVol) : + filePath(_filePath), bLoop(_bLoop), + coneDir(_coneDir), conePitch(_conePitch), + coneInAngle(_coneInAngle), coneOutAngle(_coneOutAngle), coneOutVol(_coneOutVol) + { + FMOD_TEST(FMOD_System_CreateSound(gpFmodSystem, filePath.c_str(), + (bLoop ? FMOD_LOOP_NORMAL : FMOD_LOOP_OFF) | + FMOD_3D | FMOD_3D_WORLDRELATIVE | FMOD_3D_INVERSEROLLOFF | + FMOD_CREATECOMPRESSEDSAMPLE | FMOD_NONBLOCKING, + nullptr, &pSound)); + LOG_ASSERT(pSound); + } + + /// Copying is not permitted + SoundFile (const SoundFile& o) = delete; + + /// Destructor removes the sound object + ~SoundFile() + { + if (pSound) + FMOD_Sound_Release(pSound); + pSound = nullptr; + bLoaded = false; + } + + /// Called the first time the sound is played after loading has finished + void firstTimeInit () + { + FMOD_LOG(FMOD_Sound_GetLength(pSound, &len_ms, FMOD_TIMEUNIT_MS)); + } + + /// Has loading the sound sample finished? + bool isReady () + { + // Cached values + if (!pSound) return false; + if (bLoaded) return true; + // Otherwise query FMOD + FMOD_OPENSTATE state = FMOD_OPENSTATE_LOADING; + if ((FMOD_Sound_GetOpenState(pSound, &state, nullptr, nullptr, nullptr) == FMOD_OK) && + (state == FMOD_OPENSTATE_READY)) + { + firstTimeInit(); + return bLoaded = true; + } + return false; + } + + /// Has full cone information? + bool hasConeInfo () const + { + return + !std::isnan(coneDir) && + !std::isnan(conePitch) && + !std::isnan(coneInAngle) && + !std::isnan(coneOutAngle) && + !std::isnan(coneOutVol); + } + + /// @brief Play the sound + /// @param pChGrp [opt] The channel group this sound is to be added to, can be `nullptr` + /// @param bPaused [opt] Shall channel stay paused after creation? + /// @return `nullptr` in case of failure + FMOD_CHANNEL* play (FMOD_CHANNELGROUP* pChGrp = nullptr, + bool bPaused = false) + { + FMOD_CHANNEL* pChn = nullptr; + if (isReady()) { + FMOD_LOG(FMOD_System_PlaySound(gpFmodSystem, pSound, pChGrp, bPaused, &pChn)); + if (!pChn) return nullptr; + FMOD_LOG(FMOD_Channel_SetUserData(pChn, this)); // save pointer to this SoundFile as user data to the channel + if (hasConeInfo()) { + FMOD_LOG(FMOD_Channel_Set3DConeSettings(pChn, coneInAngle, coneOutAngle, coneOutVol)); + } + } else { + LOG_MSG(logDEBUG, "Sound '%s' isn't ready yet, won't play now", filePath.c_str()); + } + return pChn; + } + + /// @brief Set the channel's sound cone relative to the aircraft's orientation in space and the cone configuration of the SoundFile + /// @param pChn The channel, which is to be modified + /// @param ac Aircraft + void setConeOrientation (FMOD_CHANNEL* pChn, const Aircraft& ac) + { + if (!hasConeInfo()) return; + const float coneDirRad = deg2rad(coneDir); + FMOD_VECTOR coneVec = HeadPitch2Vec(ac.GetHeading() + coneDir, + std::cos(coneDirRad)*ac.GetPitch() - std::sin(coneDirRad)*ac.GetRoll() + conePitch); + FMOD_LOG(FMOD_Channel_Set3DConeOrientation(pChn, &coneVec)); + } + + /// @brief Load fixed set of X-Plane-internal sounds + /// @returns Number of loaded sounds + static int LoadXPSounds () + { + int n = 0; +#define ADD_SND(s,f,l) if (!XPMPSoundAdd(s,f,l)[0]) ++n; +#define ADD_CONE(s,f,l,cd,cp,cia,coa,cov) if (!XPMPSoundAdd(s,f,l,cd,cp,cia,coa,cov)[0]) ++n; + // Engine sounds + ADD_SND(XP_SOUND_ELECTRIC, "Resources/sounds/engine/ENGINE_ELECTRIC_out.wav", true); + // The two jet sounds define a sound cone: 180 degrees heading (ie. backwards), no pitch, with 30 degree inner angle (full sound), and 60 degree outer angle (reduced sound), with sound reduction to 50% outside the outer angle: + ADD_CONE(XP_SOUND_HIBYPASSJET, "Resources/sounds/engine/ENGINE_HI_BYPASS_JET_out.wav", true, 180.0f, 0.0f, 30.0f, 60.0f, 0.5f); + ADD_CONE(XP_SOUND_LOBYPASSJET, "Resources/sounds/engine/ENGINE_LO_BYPASS_JET_out.wav", true, 180.0f, 0.0f, 30.0f, 60.0f, 0.5f); + ADD_SND(XP_SOUND_TURBOPROP, "Resources/sounds/engine/ENGINE_TURBOPROP_out.wav", true); + ADD_SND(XP_SOUND_PROP_AIRPLANE, "Resources/sounds/engine/PROPELLER_OF_AIRPLANE_out.wav", true); + ADD_SND(XP_SOUND_PROP_HELI, "Resources/sounds/engine/PROPELLER_OF_HELO_out.wav", true); + ADD_SND(XP_SOUND_REVERSE_THRUST, "Resources/sounds/engine/REVERSE_THRUST_out.wav", true); + + // Rolling on the ground + ADD_SND(XP_SOUND_ROLL_RUNWAY, "Resources/sounds/contact/roll_runway.wav", true); + + // One-time sounds + ADD_SND(XP_SOUND_FLAP, "Resources/sounds/systems/flap.wav", false); + ADD_SND(XP_SOUND_GEAR, "Resources/sounds/systems/gear.wav", false); + return n; + } +}; + +/// Map of all sounds, indexed by a sound name (type) +typedef std::map mapSoundTy; + +/// Map of all sounds, indexed by a sound name +static mapSoundTy mapSound; + +// +// MARK: Local Functions +// + +/// Get the FMOD system's master channel group, or `nullptr` +FMOD_CHANNELGROUP* SoundGetMasterChn() +{ + FMOD_CHANNELGROUP* pMstChnGrp = nullptr; + if (!gpFmodSystem) return nullptr; + FMOD_LOG(FMOD_System_GetMasterChannelGroup(gpFmodSystem, &pMstChnGrp)); + return pMstChnGrp; +} + +/// Get pointer to Sound File that created the channel +SoundFile* SoundGetSoundFile (FMOD_CHANNEL* pChn) +{ + if (!pChn) return nullptr; + SoundFile* pSnd = nullptr; + FMOD_Channel_GetUserData(pChn, (void**)&pSnd); + return pSnd; +} + +/// Is the channel still payling / is it valid? +bool SoundIsChnValid (FMOD_CHANNEL* pChn) +{ + if (!pChn) return false; + try { + FMOD_BOOL bPlaying = false; + FMOD_TEST(FMOD_Channel_IsPlaying(pChn, &bPlaying)); + return bPlaying; + } + catch (...) { + return false; + } +} + +/// @brief Helper functon to set FMOD settings +/// @details Implement as template function so it works with both +/// `FMOD_ADVANCEDSETTINGS` and `FMOD_10830_ADVANCEDSETTINGS` +/// for backwards compatibility with v1.8 of FMOD as used in XP11. +template +void SoundSetFmodSettings(T_ADVSET& advSet) +{ + memset(&advSet, 0, sizeof(advSet)); + advSet.cbSize = sizeof(advSet); + advSet.vol0virtualvol = 0.01f; // set some low volume for fading to 0 + FMOD_TEST(FMOD_System_SetAdvancedSettings(gpFmodSystem, (FMOD_ADVANCEDSETTINGS*)&advSet)); +} + +/// Return a text for the values of Aircraft::SoundEventsTy +const char* SoundEventTxt (Aircraft::SoundEventsTy e) +{ + switch (e) { + case Aircraft::SND_ENG: return "Engine"; + case Aircraft::SND_REVERSE_THRUST: return "Reverse Thrust"; + case Aircraft::SND_TIRE: return "Tires"; + case Aircraft::SND_GEAR: return "Gear"; + case Aircraft::SND_FLAPS: return "Flaps"; + default: + return ""; + } +} + +/// @brief Convert heading/pitch to normalized x/y/z vector +/// @note Given all the trigonometric functions this is probably expensive, +/// so use with care and avoid in flight loop callback when unnecessary. +FMOD_VECTOR HeadPitch2Vec (const float head, const float pitch) +{ + // Subtracting 90 degress is because x coordinate is heading east, + // so 90 degrees is equivalent to x = 0 + const float radHead = deg2rad(head - 90.0f); + const float radPitch = deg2rad(pitch); + // Have sinus/cosinus pre-computed and let the optimizer deal with reducing local variables + const float sinHead = std::sin(radHead); + const float cosHead = std::cos(radHead); + const float sinPitch = std::sin(radPitch); + const float cosPitch = std::cos(radPitch); + return FMOD_VECTOR { + cosHead * cosPitch, // x + sinPitch, // y + sinHead * cosPitch // z + }; +} + +// +// MARK: Public Aircraft member functions +// + +// Play a sound; a looping sound plays until explicitely stopped +FMOD_CHANNEL* Aircraft::SoundPlay (const std::string& sndName, float vol) +{ + // Have FMOD create the sound + try { + SoundFile& snd = mapSound.at(sndName); + FMOD_CHANNEL* pChn = snd.play(); + if (pChn) { + chnList.push_back(pChn); // add to managed list of sounds + FMOD_LOG(FMOD_Channel_Set3DMinMaxDistance(pChn, (float)sndMinDist, FMOD_3D_MAX_DIST)); + snd.setConeOrientation(pChn, *this); // set cone orientation if there is one defined + SoundVolume(pChn, vol); // Set volume + if (bChnLowPass) { // if currently active, also activate low pass filter on this new channel + FMOD_LOG(FMOD_Channel_SetLowPassGain(pChn, FMOD_LOW_PASS_GAIN)); + } + if (bChnMuted) { // if currently muted, then mute + FMOD_LOG(FMOD_Channel_SetMute(pChn, true)); + } + FMOD_LOG(FMOD_Channel_SetPaused(pChn, false)); // un-pause + } + return pChn; + } + // Raised by map.at if not finding the key + catch (const std::out_of_range& e) { + LOG_MSG(logERR, "Didn't find a sound named '%s': %s", sndName.c_str(), e.what()); + return nullptr; + } +} + +// Stop a continuously playing sound +void Aircraft::SoundStop (FMOD_CHANNEL* pChn) +{ + FMOD_Channel_Stop(pChn); + chnList.remove(pChn); +} + +// Sets the sound's volume +void Aircraft::SoundVolume (FMOD_CHANNEL* pChn, float vol) +{ + // Just set the volume + FMOD_LOG(FMOD_Channel_SetVolume(pChn, vol)); +} + +// Mute/Unmute all sounds of the airplane temporarily +void Aircraft::SoundMuteAll (bool bMute) +{ + for (FMOD_CHANNEL* pChn: chnList) + FMOD_Channel_SetMute(pChn, bMute); + bChnMuted = bMute; + if (!chnList.empty()) { + LOG_MATCHING(logDEBUG, "Aircraft %08X (%s): Sound %s", + modeS_id, GetFlightId().c_str(), + bMute ? "muted" : "unmuted"); + } +} + +// Returns the name of the sound to play per event +std::string Aircraft::SoundGetName (SoundEventsTy sndEvent, float& volAdj) const +{ + // The default is: The more engines, the louder; + // that not ownly goes for engine sounds, but also the rest will be bigger the bigger the plane + volAdj = float(pCSLMdl->GetNumEngines()); + // Now go by event type: + switch (sndEvent) { + // Engine Sound is based on aircraft classification + case SND_ENG: + // Sanity check: need a CSL model to derive details + if (!pCSLMdl) { + LOG_MSG(logWARN, "Aircraft %08X (%s): No CSL model info, using default engine sound", + modeS_id, GetFlightId().c_str()); + return XP_SOUND_PROP_AIRPLANE; + } + // Now check out engine type and return proper sound name + if (IsGroundVehicle()) { // We assume all ground vehicles are electric cars by now...they should be at least ;-) + return XP_SOUND_ELECTRIC; + } + if (pCSLMdl->HasRotor()) { + volAdj += 1.0f; // Helis are loud anyway, but louder with more engines + return XP_SOUND_PROP_HELI; + } + switch (pCSLMdl->GetClassEngType()) { + case 'E': return XP_SOUND_ELECTRIC; + case 'J': return pCSLMdl->GetClassNumEng() == '1' ? XP_SOUND_HIBYPASSJET : XP_SOUND_LOBYPASSJET; + case 'P': return XP_SOUND_PROP_AIRPLANE; + case 'T': return XP_SOUND_TURBOPROP; + default: + LOG_MSG(logWARN, "Aircraft %08X (%s): Unknown engine type '%c', using default engine sound", + modeS_id, GetFlightId().c_str(), pCSLMdl->GetClassEngType()); + return XP_SOUND_PROP_AIRPLANE; + } + + // All other sound types have constant sounds assigned + case SND_REVERSE_THRUST: return XP_SOUND_REVERSE_THRUST; + case SND_TIRE: volAdj *= 0.50f; return XP_SOUND_ROLL_RUNWAY; + case SND_GEAR: volAdj *= 0.25f; return XP_SOUND_GEAR; // that sound is too loud compared to engines, make it more quiet + case SND_FLAPS: volAdj *= 0.25f; return XP_SOUND_FLAP; // that sound is too loud compared to engines, make it more quiet + + default: + LOG_MSG(logERR, "Aircraft %08X (%s): Unknown Sound Event type %d, no sound name returned", + modeS_id, GetFlightId().c_str(), int(sndEvent)); + return ""; + } +} + +// +// MARK: Protected Aircraft member functions +// + +// Sound-related initializations, called by Create() and ChangeModel() +void Aircraft::SoundSetup () +{ + // Just to be sure: remove everything + // In case of a model-rematch this may in fact change the aircraft's sound! + SoundRemoveAll(); + + // Find a default "sound size" depending on engine type and number of engines + if (pCSLMdl->HasRotor()) sndMinDist = 25; // Helis are loud, even with a single engine! + else if (pCSLMdl->GetClassEngType() == 'J') sndMinDist = 20; // each jet engine, too + else if (pCSLMdl->GetClassEngType() == 'T') sndMinDist = 15; // Turboprops are nearly as loud + else sndMinDist = 10; // everything else falls behind + sndMinDist *= pCSLMdl->GetNumEngines(); + + // For gliders there's no engine sound, otherwise there is + aSndCh[SND_ENG].bAuto = !IsGlider(); +} + +// Update sound, like position and volume, called once per frame +void Aircraft::SoundUpdate () +{ + // If we don't want sound we don't get sound + if (!gpFmodSystem) return; + + try { + // Decide here already if we need to activate or inactivate the Low Pass filter + enum { LP_NoAction = 0, LP_Enable, LP_Disable } eLP = LP_NoAction; + if (IsViewExternal()) { + if (bChnLowPass) { eLP = LP_Disable; bChnLowPass = false; } + } else { + if (!bChnLowPass) { eLP = LP_Enable; bChnLowPass = true; } + } + + // --- Loop all Sound Definitions --- + for (SoundEventsTy eSndEvent = SoundEventsTy(0); + eSndEvent < SND_NUM_EVENTS; + eSndEvent = SoundEventsTy(eSndEvent + 1)) + { + // Simpler access to values indexed by the sound event: + const SoundDefTy &def = gaSoundDef[eSndEvent]; + SndChTy &sndCh = aSndCh[eSndEvent]; + + // Channel is no longer playing? + if (!SoundIsChnValid(sndCh.pChn)) + sndCh.pChn = nullptr; + + // Automatic Handling of this event? + if (sndCh.bAuto) + { + assert(def.pVal); + const float fVal = (this->*def.pVal)(); // get the current (dataRef) value + // --- Looping sound? --- + if (def.bSndLoop) + { + assert(def.valMax > def.valMin); + + // Looping sound: Should there be sound? + if (fVal > def.valMin) { + // Set volume based on val (between min and max) + float vol = std::clamp((fVal - def.valMin) / (def.valMax - def.valMin), 0.0f, 1.0f); + // If there hasn't been a sound triggered do so now + if (!sndCh.pChn) { + // Get Sound's name and volume adjustment + const std::string sndName = SoundGetName(eSndEvent, sndCh.volAdj); + if (!sndName.empty()) { + vol *= sndCh.volAdj; + sndCh.pChn = SoundPlay(sndName, vol); + if (sndCh.pChn) { + LOG_MATCHING(logINFO, "Aircraft %08X (%s): Looping sound '%s' at volume %.2f for '%s'", + modeS_id, GetFlightId().c_str(), + sndName.c_str(), vol, SoundEventTxt(eSndEvent)); + } + } + } else { + // Update the volume as it can change any time + SoundVolume(sndCh.pChn, vol * sndCh.volAdj); + } + } else { + // There should be no sound, remove it if there was one + if (sndCh.pChn) { + SoundStop(sndCh.pChn); + LOG_MATCHING(logINFO, "Aircraft %08X (%s): Stopped sound for '%s'", + modeS_id, GetFlightId().c_str(), + SoundEventTxt(eSndEvent)); + sndCh.pChn = nullptr; + } + } + } + // --- One-time event --- + else + { + // Should there be sound because the value changed? + if (!std::isnan(sndCh.lastDRVal) && (sndCh.lastDRVal != fVal)) { + // If there hasn't been a sound triggered do so now + if (!sndCh.pChn) { + const std::string sndName = SoundGetName(eSndEvent, sndCh.volAdj); + if (!sndName.empty()) { + sndCh.pChn = SoundPlay(sndName, sndCh.volAdj); + LOG_MATCHING(logINFO, "Aircraft %08X (%s): Playing sound '%s' once for '%s'", + modeS_id, GetFlightId().c_str(), + sndName.c_str(), SoundEventTxt(eSndEvent)); + } + } + } else { + // Now (more) value change, stop and remove the sound + if (sndCh.pChn) { + SoundStop(sndCh.pChn); + sndCh.pChn = nullptr; + } + } + // Remember the last value we've seen + sndCh.lastDRVal = fVal; + } + + // --- Low pass filter in case we're inside a cockpit --- + if (sndCh.pChn && eLP) { + FMOD_LOG(FMOD_Channel_SetLowPassGain(sndCh.pChn, + eLP == LP_Enable ? FMOD_LOW_PASS_GAIN : 1.0f)); + } + } + // No automatic handling of this event + else + { + // So if there currently is a channel, remove it + if (sndCh.pChn) { + SoundStop(sndCh.pChn); + sndCh.pChn = nullptr; + } + } + } + + // --- Update all channels' 3D position + { + // Decide here already if this time we do expensive computations (like sound cone orientation) + bool bDoExpensiveComp = false; + if (++skipCounter > EXP_COMP_SKIP_CYCLES) { + skipCounter = 0; + bDoExpensiveComp = true; + } + + // Aircraft position and velocity + FMOD_VECTOR fmodPos { // Copy of the aircraft's 3D location + drawInfo.x, + drawInfo.y, + drawInfo.z, + }; + FMOD_VECTOR fmodVel { v_x, v_y, v_z }; // Copy of the aircraft's relative speed + + for (auto iter = chnList.begin(); iter != chnList.end(); ) + { + // Set location + gFmodRes = FMOD_Channel_Set3DAttributes(*iter, &fmodPos, &fmodVel); + if (gFmodRes == FMOD_OK) { + // --- Expensive Compuations: Cone Orientation --- + if (bDoExpensiveComp) + { + SoundFile* pSnd = SoundGetSoundFile(*iter); + if (pSnd && pSnd->hasConeInfo()) + pSnd->setConeOrientation(*iter, *this); + } + // Next sound channel + iter++; + } + else + // Channels might have become invalid along the way, e.g. if a non-looping sound has ended + iter = chnList.erase(iter); + } + } + } + FMOD_CATCH; +} + +// Remove all sound, e.g. during destruction +void Aircraft::SoundRemoveAll () +{ + // Log a message only if there actually is anything to stop + if (!chnList.empty()) { + LOG_MATCHING(logDEBUG, "Aircraft %08X (%s): Removed all sounds", + modeS_id, GetFlightId().c_str()); + } + // All channels now to be stopped + for (FMOD_CHANNEL* pChn: chnList) + FMOD_Channel_Stop(pChn); + for (SndChTy &sndChn: aSndCh) + sndChn.pChn = nullptr; +} + + +// +// MARK: Global Functions +// + +// Initialize the sound module and load the sounds +bool SoundInit () +{ + try { + if (!gpFmodSystem) { + // Enable FMOD logging + if (glob.logLvl == logDEBUG) + SoundLogEnable(true); + + // Create FMOD system and first of all determine its version, + // which depends a bit if run under XP11 or XP12 and the OS we are on. + // There are subtle difference in settings. + FMOD_TEST(FMOD_System_Create(&gpFmodSystem, FMOD_VERSION)); + FMOD_TEST(FMOD_System_GetVersion(gpFmodSystem, &gFmodVer)); + LOG_MSG(logINFO, "Initializing FMOD version %u.%u.%u", + gFmodVer >> 16, (gFmodVer & 0x0000ff00) >> 8, + gFmodVer & 0x000000ff); + FMOD_TEST(FMOD_System_Init(gpFmodSystem, FMOD_NUM_VIRT_CHANNELS, + FMOD_INIT_3D_RIGHTHANDED | FMOD_INIT_CHANNEL_LOWPASS | FMOD_INIT_VOL0_BECOMES_VIRTUAL, nullptr)); + + // Set advanced settings, which are version-dependend + if (UseOldFmod()) { + FMOD_10830_ADVANCEDSETTINGS oldAdvSet; + SoundSetFmodSettings(oldAdvSet); + } else { + FMOD_ADVANCEDSETTINGS advSet; + SoundSetFmodSettings(advSet); + } + + // Load the default sounds + if (!SoundFile::LoadXPSounds()) { + LOG_MSG(logERR, "No standard sounds successfully loaded, sound system currently inactive!"); + return false; + } + + // Set master volume + XPMPSoundSetMasterVolume(glob.sndMasterVol); + + // Ensure updates are done once and a proper listener location is set + SoundUpdatesDone(); + } + glob.bSoundAvail = true; + return true; + } + catch (const FmodError& e) { + e.LogErr(); // log the error + SoundCleanup(); // cleanup + return false; + } +} + +// Tell FMOD that all updates are done +void SoundUpdatesDone () +{ + if (gpFmodSystem) try { + // Update the listener position and orientation + const FMOD_VECTOR posCam = { + glob.posCamera.x, + glob.posCamera.y, + glob.posCamera.z + }; + const FMOD_VECTOR velocity = { glob.vCam_x, glob.vCam_y, glob.vCam_z }; + // The forward direction takes heading, pitch, and roll into account + const float camRollRad = deg2rad(glob.posCamera.roll); + const FMOD_VECTOR normForw = HeadPitch2Vec(glob.posCamera.heading, glob.posCamera.pitch); + const FMOD_VECTOR normUpw = HeadPitch2Vec(glob.posCamera.heading + 90.0f * std::sin(camRollRad), + glob.posCamera.pitch + 90.0f * std::cos(camRollRad)); + FMOD_TEST(FMOD_System_Set3DListenerAttributes(gpFmodSystem, 0, &posCam, &velocity, &normForw, &normUpw)); + + // Mute-on-Pause + if (glob.bSoundMuteOnPause) { // shall act automatically on Pause? + if (IsPaused()) { // XP is paused? + if (!glob.bSoundAutoMuted) { // ...but not yet muted? + XPMPSoundMute(true); // -> do mute + glob.bSoundAutoMuted = true; + } + } else { // XP is not paused + if (glob.bSoundAutoMuted) { // ...but sound is auto-muted? + XPMPSoundMute(false); // -> unmute + glob.bSoundAutoMuted = false; + } + } + } + + // Tell FMOD we're done + FMOD_TEST(FMOD_System_Update(gpFmodSystem)); + } + catch (const FmodError& e) { + e.LogErr(); // log the error + SoundCleanup(); // in case of errors here disable the sound system + } +} + +// Graceful shoutdown +void SoundCleanup () +{ + mapSound.clear(); // cleanup the sounds + + if (gpFmodSystem) + FMOD_System_Release(gpFmodSystem); + gpFmodSystem = nullptr; + gFmodVer = 0; + glob.bSoundAvail = false; + LOG_MSG(logDEBUG, "Sound system shut down"); + // Disable FMOD logging + SoundLogEnable(false); +} + +} + +// +// MARK: Public functions outside XPMP2 namespace +// + +// Enable/Disable Sound +bool XPMPSoundEnable (bool bEnable) +{ + // Any change? + if (bEnable != XPMP2::glob.bSoundAvail) + { + // Enable or disable? + if (bEnable) + XPMP2::SoundInit(); + else + XPMP2::SoundCleanup(); + } + return XPMPSoundIsEnabled(); +} + +// Is Sound enabled? +bool XPMPSoundIsEnabled () +{ + return XPMP2::glob.bSoundAvail; +} + +// Set Master Volume +void XPMPSoundSetMasterVolume (float fVol) +{ + XPMP2::glob.sndMasterVol = fVol; + FMOD_CHANNELGROUP* pMstChnGrp = XPMP2::SoundGetMasterChn(); + if (!pMstChnGrp) return; + FMOD_LOG(FMOD_ChannelGroup_SetVolume(pMstChnGrp, XPMP2::glob.sndMasterVol)); +} + +// Mute all sounds (temporarily) +void XPMPSoundMute(bool bMute) +{ + FMOD_CHANNELGROUP* pMstChnGrp = XPMP2::SoundGetMasterChn(); + if (!pMstChnGrp) return; + FMOD_LOG(FMOD_ChannelGroup_SetMute(pMstChnGrp, bMute)); + LOG_MSG(XPMP2::logDEBUG, "All sounds %s", bMute ? "muted" : "unmuted"); +} + +// Add a sound that can later be referenced from an XPMP2::Aircraft +const char* XPMPSoundAdd (const char* sName, + const char* filePath, + bool bLoop, + float coneDir, float conePitch, + float coneInAngle, float coneOutAngle, + float coneOutVol) +{ + // Test file existence first before bothering + if (!XPMP2::ExistsFile(filePath)) { + LOG_MSG(XPMP2::logERR, "Sound file not found: %s", filePath) + return "Sound File not found"; + } + // Load the sound and add it to the map + try { + XPMP2::mapSound.emplace(std::piecewise_construct, + std::forward_as_tuple(sName), + std::forward_as_tuple(filePath,bLoop, + coneDir, conePitch, + coneInAngle, coneOutAngle, + coneOutVol)); + LOG_MSG(XPMP2::logDEBUG, "Added%ssound '%s' from file '%s'", + bLoop ? " looping " : " ", sName, filePath); + } + catch (const XPMP2::FmodError& e) { + e.LogErr(); // log the error + return FMOD_ErrorString(e.fmodRes); // return the text + } + + // All good + return ""; +} + +// Enumerate all sounds, including the internal ones +const char* XPMPSoundEnumerate (const char* prevName, const char** ppFilePath) +{ + // No sounds available at all? + if (XPMP2::mapSound.empty()) + return nullptr; + + auto sndIter = XPMP2::mapSound.end(); + // Return first sound? + if (!prevName || !prevName[0]) + sndIter = XPMP2::mapSound.begin(); + else { + // Try finding the given `prevName` sound, then return next + sndIter = XPMP2::mapSound.find(prevName); + if (sndIter != XPMP2::mapSound.end()) + sndIter++; + } + + // Not found anything anymore? + if (sndIter == XPMP2::mapSound.end()) { + if (ppFilePath) *ppFilePath = nullptr; + return nullptr; + } else { + // Return the found element + if (ppFilePath) *ppFilePath = sndIter->second.filePath.c_str(); + return sndIter->first.c_str(); + } +} diff --git a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPPlaneRenderer.h b/src/Sound.h similarity index 50% rename from XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPPlaneRenderer.h rename to src/Sound.h index 59a0da71..e188849c 100644 --- a/XPMP2-Sample/lib/XPMP2.framework/Versions/2.50/Headers/XPMPPlaneRenderer.h +++ b/src/Sound.h @@ -1,12 +1,13 @@ -/// @file XPMPPlaneRenderer.h -/// @brief Rendering functions. -/// @note This file bases on and is compatible to the header -/// provided with the original libxplanemp. -/// @deprecated None of these functions are supported any longer, -/// their definitions are only provided for backward compatibility. +/// @file Sound.h +/// @brief Sound for aircraft, based on the FMOD library +/// +/// @note Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. +/// Understand FMOD [licensing](https://www.fmod.com/licensing) and +/// [attribution requirements](https://www.fmod.com/attribution) first!\n +/// Sound support is only included if built with CMake cache entry `INCLUDE_FMOD_SOUND`.\n +/// /// @author Birger Hoppe -/// @copyright Copyright (c) 2005, Ben Supnik and Chris Serio. -/// @copyright (c) 2020 Birger Hoppe +/// @copyright (c) 2022 Birger Hoppe /// @copyright Permission is hereby granted, free of charge, to any person obtaining a /// copy of this software and associated documentation files (the "Software"), /// to deal in the Software without restriction, including without limitation @@ -23,26 +24,27 @@ /// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN /// THE SOFTWARE. -#ifndef XPLMPLANERENDERER_H -#define XPLMPLANERENDERER_H +#pragma once -// Theoretically you can plug in your own plane-rendering -// function (although in practice this isn't real useful. -// These functions do "the drawing" once per frame. +// Only included if specified. Understand FMOD licensing and attribution first! +#ifdef INCLUDE_FMOD_SOUND -/// @brief Was an internal libxplanemp functions -/// @deprecated No longer supported. -[[deprecated("Internal function no longer supported")]] -void XPMPInitDefaultPlaneRenderer(void); +namespace XPMP2 { -/// @brief Was an internal libxplanemp functions -/// @deprecated No longer supported. -[[deprecated("Internal function no longer supported")]] -void XPMPDefaultPlaneRenderer(int is_blend); -/// @brief Was an internal libxplanemp functions -/// @deprecated No longer supported. -[[deprecated("Internal function no longer supported")]] -void XPMPDeinitDefaultPlaneRenderer(void); +// +// MARK: Global Functions +// -#endif +/// Initialize the sound module and load the sounds +bool SoundInit (); + +/// Tell FMOD that all updates are done +void SoundUpdatesDone (); + +/// Graceful shoutdown +void SoundCleanup (); + +} + +#endif // INCLUDE_FMOD_SOUND diff --git a/src/Utilities.cpp b/src/Utilities.cpp index 9dc36eee..29804fea 100755 --- a/src/Utilities.cpp +++ b/src/Utilities.cpp @@ -197,6 +197,15 @@ void GlobVars::UpdateCfgVals () else if (i < 0) remoteCfg = REMOTE_CFG_OFF; else remoteCfg = REMOTE_CFG_ON; +#ifdef INCLUDE_FMOD_SOUND + // Ask for enabling sound and mute-on-pause + bSoundOnStartup = prefsFuncInt(XPMP_CFG_SEC_SOUND, XPMP_CFG_ITM_ACTIVATE_SOUND, bSoundOnStartup) != 0; + bSoundMuteOnPause = prefsFuncInt(XPMP_CFG_SEC_SOUND, XPMP_CFG_ITM_MUTE_ON_PAUSE, bSoundMuteOnPause) != 0; +#else + bSoundOnStartup = false; + bSoundMuteOnPause = false; +#endif + // Ask for model matching logging bLogMdlMatch = prefsFuncInt(XPMP_CFG_SEC_DEBUG, XPMP_CFG_ITM_MODELMATCHING, bLogMdlMatch) != 0; @@ -261,6 +270,39 @@ void GlobVars::ReadVersions () bXPUsingModernGraphicsDriver = false; } + +// Update the stored camera position and velocity values +void GlobVars::UpdateCameraPos () +{ + // Always update current camera position + XPLMReadCameraPosition(&posCamera); + + // Compare to previous position: If we moved more than 100m + // (in a flight loop, so at max 1/20s) then camera position was changed manually + const float prev_ts = prevCamera_ts; + const float dx = posCamera.x - prevCamera.x; + const float dy = posCamera.y - prevCamera.y; + const float dz = posCamera.z - prevCamera.z; + if (sqr(dx) + sqr(dy) + sqr(dz) > 10000.0f) + { + vCam_x = 0.0f; // velocity is invalid, avoid too high values causing too high Doppler effects + vCam_y = 0.0f; + vCam_z = 0.0f; + prevCamera_ts = 0.0f; // ensure new velocity is calculated next time round + prevCamera = posCamera; + } + // Update velocity only every second + else if (CheckEverySoOften(prevCamera_ts, 1.0f)) + { + const float dt = prevCamera_ts - prev_ts; // delta time (about 1s) + vCam_x = dx / dt; + vCam_y = dy / dt; + vCam_z = dz / dt; + prevCamera = posCamera; + } +} + + // // MARK: File access helpers // @@ -651,6 +693,19 @@ const char* GetGraphicsDriverTxt () return "OpenGL"; } +// X-Plane in a Pause state? +bool IsPaused() +{ + static XPLMDataRef drPause = XPLMFindDataRef("sim/time/paused"); + return XPLMGetDatai(drPause) != 0; +} + +// Is current X-Plane view an external view (outside a cockpit)? +bool IsViewExternal() +{ + static XPLMDataRef drExternalView = XPLMFindDataRef("sim/graphics/view/view_is_external"); + return XPLMGetDatai(drExternalView) != 0; +} // Convenience function to check on something at most every x seconds bool CheckEverySoOften (float& _lastCheck, float _interval, float _now) diff --git a/src/Utilities.h b/src/Utilities.h index 147ea6ea..8ee236a1 100644 --- a/src/Utilities.h +++ b/src/Utilities.h @@ -114,6 +114,12 @@ inline std::string& trim(std::string& s, const char* t = WHITESPACE) return ltrim(rtrim(s, t), t); } +/// @brief Returns everything left of any of terminators +inline std::string leftOf(const std::string& s, const std::string& terminators) +{ + return s.substr(0, std::min(s.find_first_of(terminators), s.size())); +} + /// separates string into tokens std::vector str_tokenize (const std::string s, const std::string tokens, @@ -190,6 +196,12 @@ std::string GetMiscNetwTimeStr (float _time = NAN); /// Text string for current graphics driver in use const char* GetGraphicsDriverTxt (); +/// X-Plane in a Pause state? +bool IsPaused (); + +/// Is current X-Plane view an external view (outside a cockpit)? +bool IsViewExternal (); + /// @brief Convenience function to check on something at most every x seconds /// @param _lastCheck Provide a float which holds the time of last check (init with `0.0f`) /// @param _interval [seconds] How often to perform the check? @@ -240,7 +252,7 @@ void LogMsg ( const char* szFile, int ln, const char* szFunc, logLevelTy lvl, co /// @note First parameter after lvl must be the message text, /// which can be a format string with its parameters following like in sprintf #define LOG_MSG(lvl,...) { \ - if (lvl >= glob.logLvl) \ + if (lvl >= XPMP2::glob.logLvl) \ {LogMsg(__FILE__, __LINE__, __func__, lvl, __VA_ARGS__);} \ } @@ -248,7 +260,7 @@ void LogMsg ( const char* szFile, int ln, const char* szFunc, logLevelTy lvl, co /// @note First parameter after lvl must be the message text, /// which can be a format string with its parameters following like in sprintf #define LOG_MATCHING(lvl,...) { \ - if (glob.bLogMdlMatch && lvl >= glob.logLvl) \ + if (XPMP2::glob.bLogMdlMatch && lvl >= glob.logLvl) \ {LogMsg(__FILE__, __LINE__, __func__, lvl, __VA_ARGS__);} \ } diff --git a/src/XPMP2.h b/src/XPMP2.h index c20e2c1b..0a440120 100644 --- a/src/XPMP2.h +++ b/src/XPMP2.h @@ -27,6 +27,10 @@ #include // required for sockaddr_in6 (?) #include // for GetAdaptersAddresses #include +// On Windows, 'max' and 'min' are defined macros in conflict with C++ library. Let's undefine them! +#include +#undef max +#undef min #endif // XPlaneMP 2 - Public Header Files @@ -81,13 +85,7 @@ #include "Map.h" #include "Network.h" #include "Remote.h" - -// On Windows, 'max' and 'min' are defined macros in conflict with C++ library. Let's undefine them! -#if IBM -#include -#undef max -#undef min -#endif +#include "Sound.h" // // MARK: Global Configurations and variables @@ -214,6 +212,17 @@ struct GlobVars { /// Are we a sender? bool RemoteIsSender() const { return remoteStatus == REMOTE_SENDING || remoteStatus == REMOTE_SEND_WAITING; } + /// Config: Start Sound on startup? + bool bSoundOnStartup = true; + /// Config: Mute on Pause? + bool bSoundMuteOnPause = true; + /// Is the sound system available? + bool bSoundAvail = false; + /// Sound master volume + float sndMasterVol = 1.0f; + /// Is sound currently being auto-muted? + bool bSoundAutoMuted = false; + /// X-Plane's version number (XPLMGetVersions) int verXPlane = -1; /// XPLM's SDK version number (XPLMGetVersions) @@ -227,13 +236,17 @@ struct GlobVars { /// id of X-Plane's thread (when it is OK to use XP API calls) std::thread::id xpThread; -#ifdef DEBUG + /// Current camera location, updated every flight loop + XPLMCameraPosition_t posCamera = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f }; + /// Previous camera location of about a second ago + XPLMCameraPosition_t prevCamera = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f }; + /// Camera velocity + float vCam_x = 0.0f, vCam_y = 0.0f, vCam_z = 0.0f; + /// When has `prevCamera` been updated last? + float prevCamera_ts = 0.0f; + /// Current XP cycle number (see XPLMGetCycleNumber()) int xpCycleNum = 0; -#define UPDATE_CYCLE_NUM glob.xpCycleNum=XPLMGetCycleNumber(); -#else -#define UPDATE_CYCLE_NUM -#endif protected: /// Current plane ID counter @@ -260,6 +273,8 @@ struct GlobVars { /// Is this thread XP's main thread? bool IsXPThread() const { return std::this_thread::get_id() == xpThread; } + /// Update the stored camera position and velocity values + void UpdateCameraPos (); }; /// The one and only global variable structure diff --git a/src/XPMPMultiplayer.cpp b/src/XPMPMultiplayer.cpp index 5c1fc364..3e401372 100644 --- a/src/XPMPMultiplayer.cpp +++ b/src/XPMPMultiplayer.cpp @@ -150,8 +150,13 @@ const char * XPMPMultiplayerInit(const char* inPluginName, // Get X-Plane's version numbers glob.ReadVersions(); +#ifdef INCLUDE_FMOD_SOUND + LOG_MSG(logINFO, "XPMP2 %.2f with FMOD support initializing under X-Plane version %d/%s and XPLM version %d", + XPMP2_VER, glob.verXPlane, GetGraphicsDriverTxt(), glob.verXPLM); +#else LOG_MSG(logINFO, "XPMP2 %.2f initializing under X-Plane version %d/%s and XPLM version %d", XPMP2_VER, glob.verXPlane, GetGraphicsDriverTxt(), glob.verXPLM); +#endif // Read a potential global XPMP2-specific config file glob.ReadConfigFile(); @@ -173,6 +178,10 @@ const char * XPMPMultiplayerInit(const char* inPluginName, AIMultiInit(); MapInit(); RemoteInit(); +#ifdef INCLUDE_FMOD_SOUND + if (glob.bSoundOnStartup) + XPMPSoundEnable(true); +#endif // Load related.txt ret = RelatedLoad(glob.pathRelated); @@ -207,6 +216,9 @@ void XPMPMultiplayerCleanup() LOG_MSG(logINFO, "XPMP2 cleaning up...") // Cleanup all modules in revers order of initialization +#ifdef INCLUDE_FMOD_SOUND + SoundCleanup(); +#endif RemoteCleanup(); MapCleanup(); AIMultiCleanup();