Initial Version
This commit is contained in:
197
C/User Guide (C).txt
Normal file
197
C/User Guide (C).txt
Normal file
@@ -0,0 +1,197 @@
|
||||
X-Plane Connect-C (XPC-C) Readme
|
||||
XPC-C V0.22 May 21, 2014
|
||||
|
||||
DESCRIPTION
|
||||
XPC-C is a series of C functions that facilitate communication with X-Plane.
|
||||
|
||||
-----------------------------------
|
||||
SETUP
|
||||
Before using XPC Functions you must
|
||||
1. Copy the file XPCPlugin.xpl to the "[X-Plane Directory]/Resources/plugins" directory.
|
||||
2. Put in X-Plane CD 1 or X-Plane USB Key.
|
||||
3. Start X-Plane.
|
||||
4. #include "xplaneConnect.h"
|
||||
|
||||
-----------------------------------
|
||||
BASIC FUNCTIONS
|
||||
1. openUDP opens a UDP Socket for communication. This is used to send data or receive.
|
||||
INPUT:
|
||||
port (unsigned short): Port Number (ex:49067)
|
||||
xpIP (char *): IP Address of the computer running x-plane
|
||||
xpPort (unsigned short): Port number that the X-Plane/ xpcPlugin Receives on (send -1 for default (49009), Typically xpcPlugin is 49009)
|
||||
|
||||
OUTPUT:
|
||||
socket (xpcSocket): The Opened Socket
|
||||
|
||||
USE:
|
||||
unsigned short portNumber = 49067;
|
||||
struct xpcSocket theSocket = openUDP(portNumber);
|
||||
|
||||
2. closeUDP closes an opened UDP Socket for communication. This is to be done after the program has finished using that socket. Use opedUDP to open socket.
|
||||
INPUT:
|
||||
socket (xpcSocket): The Opened Socket
|
||||
|
||||
USE:
|
||||
closeUDP(theSocket);
|
||||
|
||||
3. setCONN sets the return port for requested datarefs.
|
||||
INPUT:
|
||||
socket (xpcSocket): Socket to use to send the command
|
||||
recPort (unsigned Short): Port number for requested dataref values to be sent to
|
||||
|
||||
OUTPUT:
|
||||
status (short): 0 if successful
|
||||
|
||||
USE:
|
||||
char IP[16] = "127.0.0.1";
|
||||
struct xpcSocket theSocket = openUDP(49067);
|
||||
setCONN(theSocket,IP,49009,49022); // Sets receive address to 49022;
|
||||
|
||||
4. pauseSim pauses/resumes the x-plane simulation
|
||||
INPUT:
|
||||
socket (xpcSocket): Socket to use to send the command
|
||||
pause (short): 1=Pause, 0=Resume
|
||||
|
||||
OUTPUT:
|
||||
status (short): 0 if successful
|
||||
|
||||
USE:
|
||||
char IP[16] = "127.0.0.1";
|
||||
struct xpcSocket theSocket = openUDP(49067);
|
||||
pauseSim(theSocket, IP, 49009, 1);
|
||||
|
||||
5. sendDATA set the value of a state in the "DATA Input & Output" Table
|
||||
INPUT:
|
||||
socket (xpcSocket): Socket to use to send the command
|
||||
dataArray (float[][9]): Array of data to be sent. The first element of each row is the item # (corresponding to the number on the X-Plane "DATA Input & Output" Screen). Send -999 to leave the value unchanged.
|
||||
rows (unsigned short): Number of rows of data being sent
|
||||
|
||||
OUTPUT:
|
||||
status (short): 0 if successful
|
||||
|
||||
USE:
|
||||
char IP[16] = "127.0.0.1";
|
||||
struct xpcSocket theSocket = openUDP(49067);
|
||||
float data[] = {{14, 1, -999, -999, -999, -999, -999, -999, -999},{25, 0.8, 0.8, -999, -999, -999, -999, -999, -999}}; // Gear and Throttle
|
||||
sendDATA(theSocket,IP,49009,data,2);
|
||||
|
||||
6. sendPOSI set the position of an aircraft
|
||||
INPUT:
|
||||
socket (xpcSocket): Socket to use to send the command
|
||||
ACNum (short): Number of aircraft to be moved, use 0 for main aircraft (ownPlane).
|
||||
numArgs (short): Number of Arguments to be sent (size of position array)
|
||||
position (float []): Arguments corresponding to aircrafts position
|
||||
position[0] = Latitude
|
||||
position[1] = Longitude
|
||||
position[2] = Altitude (m MSL)
|
||||
position[3] = Roll (deg)
|
||||
position[4] = Pitch (deg)
|
||||
position[5] = True Heading (deg)
|
||||
position[6] = Gear (0=up, 1=down)
|
||||
|
||||
OUTPUT:
|
||||
status (short): 0 if successful
|
||||
|
||||
USE:
|
||||
char IP[16] = "127.0.0.1";
|
||||
struct xpcSocket theSocket = openUDP(49067);
|
||||
float posit[] = {37.5242422, -122.06899, 2500, 0, 0, 0, 1};
|
||||
sendPOSI(theSocket, IP, 49009, 7, posit);
|
||||
|
||||
7. sendCTRL send control commands to the aircraft
|
||||
INPUT:
|
||||
socket (xpcSocket): Socket to use to send the command
|
||||
numArgs (short): Number of Arguments to be sent (size of control array)
|
||||
control (float []): Arguments corresponding to aircraft control command
|
||||
control[0] = Latitudinal Stick [-1,1]
|
||||
control[1] = Longitudinal Stick [-1,1]
|
||||
control[2] = Pedal [-1, 1]
|
||||
control[3] = Throttle [-1, 1]
|
||||
control[4] = Gear (0=up, 1=down)
|
||||
control[5] = Flaps [0, 1]
|
||||
|
||||
OUTPUT:
|
||||
status (short): 0 if successful
|
||||
|
||||
USE:
|
||||
char IP[16] = "127.0.0.1";
|
||||
struct xpcSocket theSocket = openUDP(49067);
|
||||
float ctrl[] = {0, 0, 0, 0.8, 0, 1};
|
||||
sendCTRL(theSocket, IP, 49009, 6, ctrl);
|
||||
|
||||
8. sendDREF set the value of a specific dataref. Dataref list found at http://www.xsquawkbox.net/xpsdk/docs/DataRefs.html
|
||||
INPUT:
|
||||
socket (xpcSocket): Socket to use to send the command
|
||||
dataRef (char *): Dataref to be set (with or without "sim/" preceeding it)
|
||||
length (short): length of dataref string
|
||||
values (float *): Array of values to be sent
|
||||
length2 (short): Number of values in values array
|
||||
|
||||
OUTPUT:
|
||||
status (short): 0 if successful
|
||||
|
||||
USE:
|
||||
char IP[16] = "127.0.0.1";
|
||||
struct xpcSocket theSocket = openUDP(49067);
|
||||
char theDREF[] = "cockpit/switches/gear_handle_status";
|
||||
float value = 1;
|
||||
sendDREF(theSocket, IP, 49009, theDREF, strlen(theDREF), &value, 1);
|
||||
|
||||
9. requestDREF Request the value of specific dref(s). Dataref list found at http://www.xsquawkbox.net/xpsdk/docs/DataRefs.html
|
||||
INPUT:
|
||||
outSocket (xpcSocket): Socket to use to send the command
|
||||
inSocket (xpcSocket): Socket to use to send the command
|
||||
DREFArray (char[][100]): Array of DataRefs to be requested
|
||||
DREFSizes (int[]): Array of string lengths for each DataRef in DREFArray
|
||||
listLength (short): Number of DataRefs in DREFArray
|
||||
result (*float[]): Array of pointers to the values returned
|
||||
arrayLen (short[]): Array where each element corresponds to the number of elements in the float array.
|
||||
|
||||
OUTPUT:
|
||||
length (short): Number of Values Returned
|
||||
|
||||
USE:
|
||||
char IP[16] = "127.0.0.1";
|
||||
struct xpcSocket theSocket = openUDP(49067);
|
||||
char DREFArray[][100] = {"sim/cockpit/switches/gear_handle_status"};
|
||||
requestDREF(theSocket, IP, 49009, DREFArray, strlen(DREFArray[0]),1);
|
||||
|
||||
-----------------------------------
|
||||
ADVANCED FUNCTIONS (These are mostly used by the xpcPlugin to read requests)
|
||||
1. sendUDP
|
||||
2. readUDP
|
||||
3. readDATA
|
||||
4. parseDATA
|
||||
5. readPOSI
|
||||
6. parsePOSI
|
||||
7. readCTRL
|
||||
8. parseCTRL
|
||||
9. readRequest
|
||||
10. parseRequest
|
||||
11. parseDREF
|
||||
12. readDREF
|
||||
|
||||
-----------------------------------
|
||||
PLANNED FUNCTIONS
|
||||
1. sendVIEW
|
||||
2. parseVIEW
|
||||
3. readVIEW
|
||||
4. sendWYPT
|
||||
5. parseWYPT
|
||||
6. readWYPT
|
||||
7. selectDATA
|
||||
8. sendTEXT
|
||||
9. readTEXT
|
||||
10. parseTEXT
|
||||
|
||||
-----------------------------------
|
||||
CONTACT
|
||||
Email Christopher Teubert (christopher.a.teubert@nasa.gov) with any questions.
|
||||
|
||||
-----------------------------------
|
||||
VERSION HISTORY
|
||||
2014.05.23 (V0.22): (CT) Combined request/readDREF
|
||||
2014.05.21 (V0.21): (CT) Initial Version
|
||||
|
||||
CONTRIBUTORS
|
||||
CT: Christopher Teubert (christopher.a.teubert@nasa.gov)
|
||||
644
C/src/xplaneConnect.c
Normal file
644
C/src/xplaneConnect.c
Normal file
@@ -0,0 +1,644 @@
|
||||
//
|
||||
// xPlaneConnect.c Version 0.25 Beta
|
||||
//
|
||||
// DESCRIPTION
|
||||
// XPLANECONNECT (XPC) Facilitates Communication to and from the XPCPlugin
|
||||
//
|
||||
// REQUIREMENTS
|
||||
// 1. X-Plane Version 9.0 or newer (untested on previous versions)
|
||||
// 2. XPCPlugin.xpl-must be placed in [X-Plane Directory]/Resources/plugins
|
||||
// 3. OS X 10.8 or newer (untested on previous versions)
|
||||
//
|
||||
// INSTRUCTIONS
|
||||
// 1. Include the header "xplaneConnect.h"
|
||||
// EXAMPLE: #include "xplaneConnect.h"
|
||||
// 2. Open UDP Socket using openUDP
|
||||
// EXAMPLE: struct xpcSocket theSocket = openUDP(port_number);
|
||||
// NOTE: Do not send/receive on the same socket
|
||||
// 3. Use functions described below
|
||||
// 4. Close UDP Socket using closeUDP
|
||||
//
|
||||
// NOTICES:
|
||||
// Copyright ã 2013-2014 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.
|
||||
//
|
||||
// DISCLAIMERS
|
||||
// No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER, CONSTITUTE AN ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT OF ANY RESULTS, RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY OTHER APPLICATIONS RESULTING FROM USE OF THE SUBJECT SOFTWARE. FURTHER, GOVERNMENT AGENCY DISCLAIMS ALL WARRANTIES AND LIABILITIES REGARDING THIRD-PARTY SOFTWARE, IF PRESENT IN THE ORIGINAL SOFTWARE, AND DISTRIBUTES IT "AS IS."
|
||||
//
|
||||
// Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT. IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS IN ANY LIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH USE, INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S USE OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW. RECIPIENT'S SOLE REMEDY FOR ANY SUCH MATTER SHALL BE THE IMMEDIATE, UNILATERAL TERMINATION OF THIS AGREEMENT.
|
||||
//
|
||||
// X-Plane API
|
||||
// Copyright (c) 2008, Sandy Barbour and Ben Supnik All rights reserved.
|
||||
// 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:
|
||||
// * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
// * Neither the names of the authors nor that of X-Plane or Laminar Research may be used to endorse or promote products derived from this software without specific prior written permission from the authors or Laminar Research, respectively.
|
||||
//
|
||||
// X-Plane API SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
//
|
||||
// CONTACT
|
||||
// For questions email Christopher Teubert (christopher.a.teubert@nasa.gov)
|
||||
//
|
||||
// VERSION HISTORY
|
||||
// 06.24.14 (V0.23): (CT) General Fixes for Windows compatability
|
||||
// 05.23.14 (V0.22): (CT) Combined request/readDREF
|
||||
// -fixed readPOSI (gear issue)
|
||||
// 05.21.14 (V0.2175): (CT) Added Throttle to CTRL
|
||||
// 05.12.14 (V0.215): (CT) Read/Parse/Send Control
|
||||
// 05.07.14 (V0.21): (CT) Read/Parse/Send Position
|
||||
// 04.29.14 (V0.205): (CT) Added check that data was received in read functions
|
||||
// 03.15.14 (V0.2): (CT) General performance updates, added preconditions
|
||||
// 02.04.14 (V0.11): (CT) Fixed problem that caused for loops not to work with some compilers. General Stability Improvements, added readRequest, readDREF
|
||||
// 01.27.14 (V0.1): (CT) First Beta: sendDATA, sendDREF, requestDREF, pauseSim, readDATA
|
||||
// 11.10.13 (V0.0): (CT) First Version
|
||||
//
|
||||
// CONTRIBUTORS
|
||||
// CT: Christopher Teubert (christopher.a.teubert@nasa.gov)
|
||||
//
|
||||
// TO DO
|
||||
// 1. Update SelectData
|
||||
// 2. RequestDREF: look into removing DREFSizes
|
||||
//
|
||||
// BEGIN CODE
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <stdarg.h>
|
||||
#include <string.h>
|
||||
#include <sys/types.h>
|
||||
#include <time.h>
|
||||
#include <math.h>
|
||||
#include "xplaneConnect.h"
|
||||
|
||||
#ifdef _WIN32 /* WIN32 SYSTEM */
|
||||
#include <WS2tcpip.h>
|
||||
#define strcasecmp _stricmp
|
||||
#define strncasecmp _strnicmp
|
||||
#define snprintf sprintf_s
|
||||
#define socklen_t int
|
||||
|
||||
void usleep(__int64 usec)
|
||||
{ // From http://www.c-plusplus.de/forum/109539-full
|
||||
HANDLE timer;
|
||||
LARGE_INTEGER ft;
|
||||
|
||||
ft.QuadPart = -(10*usec); // Convert to 100 nanosecond interval, negative value indicates relative time
|
||||
|
||||
timer = CreateWaitableTimer(NULL, TRUE, NULL);
|
||||
SetWaitableTimer(timer, &ft, 0, NULL, NULL, 0);
|
||||
WaitForSingleObject(timer, INFINITE);
|
||||
CloseHandle(timer);
|
||||
}
|
||||
#endif
|
||||
|
||||
short errorReport(char *functionName, char *errorMessage);
|
||||
short sendRequest(struct xpcSocket recfd, char DREFArray[][100], short DREFSizes[], short listLength);
|
||||
|
||||
short errorReport(char *functionName, char *errorMessage)
|
||||
{
|
||||
printf("ERROR: %s-%s\n", functionName, errorMessage);
|
||||
return -1;
|
||||
}
|
||||
|
||||
struct xpcSocket openUDP(unsigned short port_number, const char *xpIP, unsigned short xpPort)
|
||||
{
|
||||
struct xpcSocket theSocket;
|
||||
struct sockaddr_in server;
|
||||
|
||||
#if (__APPLE__ || __linux)
|
||||
struct timeval tv;
|
||||
#endif
|
||||
|
||||
// Setup Port
|
||||
server.sin_family = AF_INET;
|
||||
server.sin_addr.s_addr = INADDR_ANY;
|
||||
server.sin_port = htons(port_number);
|
||||
|
||||
// Set X-Plane Port and IP
|
||||
if (strcasecmp(xpIP,"localhost") == 0) // IP
|
||||
{
|
||||
strncpy(theSocket.xpIP,"127.0.0.1",9); // Default
|
||||
}
|
||||
else
|
||||
{
|
||||
memcpy(theSocket.xpIP,xpIP,(size_t) fminl(strlen(xpIP),16));
|
||||
}
|
||||
|
||||
if (xpPort <= 0) // Default Port
|
||||
{
|
||||
theSocket.xpPort = 49009; // Default
|
||||
}
|
||||
else
|
||||
{
|
||||
theSocket.xpPort = xpPort;
|
||||
}
|
||||
|
||||
#ifdef _WIN32
|
||||
WSADATA wsa;
|
||||
if (WSAStartup(MAKEWORD(2,2),&wsa) != 0)
|
||||
{
|
||||
perror("ERROR: openUDP- ");
|
||||
return theSocket;
|
||||
//ERROR IN Socket Message
|
||||
}
|
||||
|
||||
if ((theSocket.sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP)) == INVALID_SOCKET)
|
||||
{
|
||||
perror("ERROR: openUDP- ");
|
||||
return theSocket;
|
||||
//ERROR IN Socket Message
|
||||
}
|
||||
|
||||
if (bind(theSocket.sock, (struct sockaddr *)&server, sizeof(server)) == SOCKET_ERROR)
|
||||
{
|
||||
perror("ERROR: openUDP- ");
|
||||
return theSocket;
|
||||
//ERROR IN Socket Message
|
||||
}
|
||||
#elif (__APPLE__ || __linux)
|
||||
// Create a SOCKET
|
||||
theSocket.sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
|
||||
|
||||
if ((theSocket.sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP)) == -1)
|
||||
{
|
||||
perror((char*) "ERROR: openUDP- ");
|
||||
return theSocket;
|
||||
}
|
||||
|
||||
//Bind
|
||||
if ( bind(theSocket.sock, (struct sockaddr *) &server, sizeof(server)) == -1)
|
||||
{
|
||||
perror( (char*) "ERROR: openUDP- ");
|
||||
return theSocket;
|
||||
}
|
||||
#endif
|
||||
|
||||
//Set Timout
|
||||
int msTimeOut = 500;
|
||||
|
||||
#ifdef _WIN32
|
||||
DWORD msTimeOutWin = 1;
|
||||
setsockopt(theSocket.sock, SOL_SOCKET, SO_RCVTIMEO, (char *)&msTimeOutWin, sizeof(msTimeOutWin));
|
||||
#else
|
||||
tv.tv_sec = 0; /* Sec Timeout */
|
||||
tv.tv_usec = msTimeOut; // Microsec Timeout
|
||||
setsockopt(theSocket.sock, SOL_SOCKET, SO_RCVTIMEO, (char *) &tv, sizeof(struct timeval));
|
||||
#endif
|
||||
|
||||
return theSocket;
|
||||
}
|
||||
|
||||
void closeUDP(struct xpcSocket socketNumber)
|
||||
{
|
||||
#ifdef _WIN32
|
||||
closesocket(socketNumber.sock);
|
||||
#elif (__APPLE__ || __linux)
|
||||
close(socketNumber.sock);
|
||||
#endif
|
||||
}
|
||||
|
||||
short sendUDP(struct xpcSocket recfd, char my_message[], short messageLength)
|
||||
{
|
||||
struct sockaddr_in servaddr;
|
||||
|
||||
my_message[4] = (char) messageLength;
|
||||
|
||||
// Preconditions
|
||||
if (messageLength <= 0)// Positive Message Length
|
||||
{
|
||||
return errorReport("sendUDP", "message length must be positive >0");
|
||||
}
|
||||
|
||||
// Code
|
||||
servaddr.sin_family = AF_INET;
|
||||
servaddr.sin_port = htons(recfd.xpPort);
|
||||
servaddr.sin_addr.s_addr = inet_addr(recfd.xpIP);
|
||||
|
||||
#ifdef _WIN32
|
||||
const char on = 1;
|
||||
#else
|
||||
int on=1;
|
||||
#endif
|
||||
|
||||
setsockopt(recfd.sock, SOL_SOCKET, SO_BROADCAST, &on, sizeof(on));
|
||||
|
||||
if (sendto(recfd.sock, my_message, (int) messageLength, 0, (const struct sockaddr *) &servaddr, sizeof(servaddr))<0)
|
||||
{
|
||||
perror("ERROR: sendUDP-");
|
||||
exit(EXIT_FAILURE);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
short sendDATA(struct xpcSocket recfd, float dataRef[][9], unsigned short rows)
|
||||
{
|
||||
int i;
|
||||
unsigned short length = rows*9*sizeof(float) + 5;
|
||||
char message[5000];
|
||||
unsigned short step = 9*sizeof(float);
|
||||
|
||||
strncpy(message,"DATA",4);
|
||||
|
||||
for (i=0;i<rows;i++)
|
||||
{
|
||||
message[5+i*step] = (char) dataRef[i][0];
|
||||
message[6+i*step] = (char) 0;
|
||||
message[7+i*step] = (char) 0;
|
||||
message[8+i*step] = (char) 0;
|
||||
memcpy(&message[9+i*step], &dataRef[i][1], 8*sizeof(float));
|
||||
}
|
||||
|
||||
sendUDP(recfd, message, length);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
short sendDREF(struct xpcSocket recfd, const char *dataRef, unsigned short length_of_DREF, float *values, unsigned short number_of_values) {
|
||||
char message[5000];
|
||||
int length = 6+length_of_DREF+number_of_values*sizeof(float);
|
||||
|
||||
//HEADER
|
||||
strncpy(message,"DREF",4);
|
||||
|
||||
//DREF
|
||||
message[5] = (char) length_of_DREF;
|
||||
memcpy(&message[6],dataRef,length_of_DREF);
|
||||
|
||||
//VALUES
|
||||
message[length_of_DREF+6] = (char) number_of_values;
|
||||
memcpy(&message[length_of_DREF+7],&values[0],sizeof(float)*number_of_values);
|
||||
|
||||
sendUDP(recfd, message, length);
|
||||
return 0;
|
||||
}
|
||||
|
||||
short sendRequest(struct xpcSocket recfd, char DREFArray[][100], short DREFSizes[], short listLength)
|
||||
{
|
||||
int i;
|
||||
char message[5000]={0};
|
||||
int length = 6;
|
||||
|
||||
//HEADER
|
||||
strncpy(message,"GETD",4);
|
||||
|
||||
message[5] = (char) listLength; //Number of Values
|
||||
|
||||
//The rest
|
||||
for (i=0; i < listLength; i++)
|
||||
{
|
||||
message[length] = (char) DREFSizes[i];
|
||||
memcpy(&message[length+1],DREFArray[i],message[length]);
|
||||
length += message[length] + 1;
|
||||
}
|
||||
|
||||
sendUDP(recfd, message, length);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
short requestDREF(struct xpcSocket sendfd, struct xpcSocket recfd, char DREFArray[][100], short DREFSizes[], short listLength, float *resultArray[], short arraySizes[])
|
||||
{
|
||||
int i;
|
||||
|
||||
sendRequest(sendfd, DREFArray, DREFSizes, listLength);
|
||||
|
||||
for (i=0; i<40; i++)
|
||||
{
|
||||
int size = readDREF(recfd, resultArray, arraySizes);
|
||||
if (size != -1) // Received input
|
||||
{
|
||||
return size;
|
||||
}
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
short pauseSim(struct xpcSocket recfd, short pause)
|
||||
{
|
||||
char message[7];
|
||||
|
||||
//Preconditions
|
||||
if (pause != 0 && pause != 1)
|
||||
{
|
||||
return errorReport("pauseSim", "Please set pause to 0 or 1");
|
||||
}
|
||||
|
||||
strncpy(message,"SIMU",4);
|
||||
message[5] = (char) pause;
|
||||
message[6] = 0;
|
||||
|
||||
sendUDP(recfd, message,6);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
short setCONN(struct xpcSocket recfd, unsigned short recPort)
|
||||
{
|
||||
char message[10] = {0};
|
||||
int length;
|
||||
strncpy(message,"CONN",4);
|
||||
|
||||
memcpy(&message[5],&recPort,sizeof(recPort));
|
||||
|
||||
length = 5 + sizeof(recPort);
|
||||
|
||||
sendUDP(recfd,message, length);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
short sendPOSI(struct xpcSocket recfd, short ACNum, short numArgs, float valueArray[])
|
||||
{
|
||||
char message[40] = {0};
|
||||
int i;
|
||||
short position = 6;
|
||||
|
||||
// Input Verification
|
||||
if (numArgs < 1)
|
||||
{
|
||||
return errorReport("POSI", "Must have atleast one argument");
|
||||
}
|
||||
|
||||
// Header
|
||||
strncpy(message,"POSI",4);
|
||||
|
||||
// Aircraft
|
||||
message[5] = (char) ACNum;
|
||||
|
||||
// States
|
||||
|
||||
for (i=0; i<7; i++)
|
||||
{
|
||||
float val = -998.5;
|
||||
|
||||
if ( i < numArgs )
|
||||
{
|
||||
val = valueArray[i];
|
||||
}
|
||||
|
||||
memcpy(&message[position],&val,sizeof(float));
|
||||
position += sizeof(float);
|
||||
}
|
||||
|
||||
sendUDP(recfd, message, position);
|
||||
return 0;
|
||||
}
|
||||
|
||||
short sendCTRL(struct xpcSocket recfd, short numArgs, float valueArray[])
|
||||
{
|
||||
char message[22] = {0};
|
||||
int i;
|
||||
short position = 5;
|
||||
|
||||
// Input Verification
|
||||
if (numArgs < 1)
|
||||
{
|
||||
return errorReport("CTRL", "Must have atleast one argument");
|
||||
}
|
||||
|
||||
// Header
|
||||
strncpy(message,"CTRL",4);
|
||||
|
||||
// States
|
||||
for (i=0;i<6;i++)
|
||||
{
|
||||
float val = -998.5;
|
||||
|
||||
if (i<numArgs)
|
||||
{
|
||||
val = valueArray[i];
|
||||
}
|
||||
|
||||
// Float Values
|
||||
memcpy(&message[position],&val,sizeof(float));
|
||||
position += sizeof(float);
|
||||
}
|
||||
|
||||
sendUDP(recfd, message, 22);
|
||||
return 0;
|
||||
}
|
||||
|
||||
//READ
|
||||
//----------------------------------------
|
||||
int readUDP(struct xpcSocket recfd, char *dataRef, struct sockaddr *recvaddr)
|
||||
{
|
||||
socklen_t recvaddrlen = sizeof(*recvaddr);
|
||||
int status = 0;
|
||||
|
||||
#ifdef _WIN32
|
||||
// Windows readUDP needs the select command- minimum timeout is 1ms.
|
||||
// Without this playback becomes choppy
|
||||
|
||||
// Definitions
|
||||
FD_SET stReadFDS;
|
||||
FD_SET stExceptFDS;
|
||||
struct timeval tv;
|
||||
struct sockaddr_in testaddr;
|
||||
int error = 0;
|
||||
|
||||
// Setup for Select
|
||||
FD_ZERO(&stReadFDS);
|
||||
FD_SET(recfd.sock, &stReadFDS);
|
||||
FD_ZERO(&stExceptFDS);
|
||||
FD_SET(recfd.sock, &stExceptFDS);
|
||||
tv.tv_sec = 0; /* Sec Timeout */
|
||||
tv.tv_usec = 250; // Microsec Timeout
|
||||
|
||||
// Select Command
|
||||
int tmp = select(-1, &stReadFDS, (FD_SET *)0, &stExceptFDS, &tv);
|
||||
if (tmp <= 0) // No Data or error
|
||||
{
|
||||
return -1;
|
||||
}
|
||||
|
||||
// If no error: Read Data
|
||||
recvaddrlen = sizeof(testaddr);
|
||||
status = (int) recvfrom(recfd.sock,dataRef,5000,0,(SOCKADDR *) &testaddr,&recvaddrlen);
|
||||
if (status == SOCKET_ERROR)
|
||||
{
|
||||
error = WSAGetLastError();
|
||||
}
|
||||
#else
|
||||
// For apple or linux-just read - will timeout in 0.5 ms
|
||||
status = (int) recvfrom(recfd.sock,dataRef,5000,0,recvaddr,&recvaddrlen);
|
||||
#endif
|
||||
|
||||
return status;
|
||||
}
|
||||
|
||||
short readDATA(struct xpcSocket recfd, float dataRef[][9])
|
||||
{
|
||||
char buf[5000];
|
||||
int buflen = readUDP(recfd,buf, NULL);
|
||||
|
||||
if (buf[0]!= '\0')
|
||||
{
|
||||
return parseDATA(buf, buflen, dataRef);
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
|
||||
short readRequest(struct xpcSocket recfd, float *dataRef[], short arraySizes[], struct sockaddr *recvaddr)
|
||||
{
|
||||
char buf[5000];
|
||||
readUDP(recfd,buf, recvaddr);
|
||||
if (buf[0]!= '\0')
|
||||
{
|
||||
return parseRequest(buf, dataRef, arraySizes);
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
|
||||
short readDREF(struct xpcSocket recfd, float *resultArray[], short arraySizes[])
|
||||
{
|
||||
char buf[5000] = {0};
|
||||
readUDP(recfd,buf, NULL);
|
||||
|
||||
if (buf[0]!= '\0')
|
||||
{
|
||||
return parseRequest(buf, resultArray, arraySizes);
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
|
||||
short readPOSI(struct xpcSocket recfd, float resultArray[], int arraySize, float *gear)
|
||||
{
|
||||
char buf[5000] = {0};
|
||||
readUDP(recfd,buf, NULL);
|
||||
|
||||
if (buf[0]!= '\0') // Buffer is not empty
|
||||
{
|
||||
return parsePOSI(buf, resultArray, arraySize, gear);
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
|
||||
float readCTRL(struct xpcSocket recfd, float resultArray[4], short *gear)
|
||||
{
|
||||
char buf[5000] = {0};
|
||||
readUDP(recfd,buf, NULL);
|
||||
|
||||
if (buf[0] != '\0') // Buffer is not empty
|
||||
{
|
||||
return parseCTRL(buf, resultArray, gear);
|
||||
}
|
||||
|
||||
return NAN;
|
||||
}
|
||||
|
||||
//PARSE
|
||||
//---------------------
|
||||
short parseDATA(const char my_message[], short messageLength, float dataRef[][9])
|
||||
{
|
||||
int i, j;
|
||||
unsigned short totalColumns = ((messageLength-5)/36);
|
||||
float *tmp;
|
||||
float data[20][9];
|
||||
tmp = malloc(sizeof(float));
|
||||
|
||||
// Input Validation
|
||||
|
||||
for (i=0;i<totalColumns;i++)
|
||||
{
|
||||
data[i][0] = my_message[5+36*i];
|
||||
for (j=1;j<9;j++)
|
||||
{
|
||||
memcpy(tmp,&my_message[5]+4*j+36*i,4);
|
||||
data[i][j] = *tmp;
|
||||
}
|
||||
}
|
||||
free(tmp);
|
||||
memcpy(dataRef,data,sizeof(data));
|
||||
return totalColumns;
|
||||
}
|
||||
|
||||
short parseDREF(const char my_message[], char *dataRef, unsigned short *length_of_DREF, float *values, unsigned short *number_of_values)
|
||||
{
|
||||
*length_of_DREF = (unsigned short) my_message[5];
|
||||
memcpy(dataRef,&(my_message[6]),*length_of_DREF);
|
||||
*number_of_values = (unsigned short) my_message[6+*length_of_DREF];
|
||||
memcpy(values,&my_message[*length_of_DREF+7],*number_of_values*sizeof(float));
|
||||
return 0;
|
||||
}
|
||||
|
||||
int parseGETD(const char my_message[], char *DREFArray[], int DREFSizes[])
|
||||
{
|
||||
int i;
|
||||
int listLength = my_message[5];
|
||||
int counter = 6;
|
||||
|
||||
for (i=0; i<listLength;i++)
|
||||
{
|
||||
DREFSizes[i] = my_message[counter];
|
||||
memcpy(DREFArray[i],&my_message[counter+1],DREFSizes[i]);
|
||||
counter += DREFSizes[i]+1;
|
||||
}
|
||||
|
||||
return listLength;
|
||||
}
|
||||
|
||||
short parseRequest(const char my_message[], float *resultArray[], short arraySizes[])
|
||||
{
|
||||
int i, j;
|
||||
short count = my_message[5];
|
||||
short place = 6;
|
||||
float *tmp;
|
||||
float data[10];
|
||||
tmp = malloc(sizeof(float));
|
||||
|
||||
for (i=0; i<count; i++)
|
||||
{
|
||||
arraySizes[i] = my_message[place];
|
||||
if (arraySizes[i] > 1) realloc(resultArray[i],arraySizes[i]);
|
||||
|
||||
for (j=0; j< arraySizes[i]; j++)
|
||||
{
|
||||
memcpy(tmp,&my_message[place+1],sizeof(float));
|
||||
data[j] = *tmp;
|
||||
}
|
||||
|
||||
resultArray[i] = malloc(arraySizes[i]*sizeof(float));
|
||||
|
||||
memcpy(resultArray[i],&data,arraySizes[i]*sizeof(float));
|
||||
place += 1 + arraySizes[i]*sizeof(float);
|
||||
}
|
||||
|
||||
free(tmp);
|
||||
return count;
|
||||
}
|
||||
|
||||
short parsePOSI(const char my_message[], float resultArray[], int arraySize, float *gear)
|
||||
{
|
||||
int i;
|
||||
|
||||
// Input Validation
|
||||
if (arraySize < 1) return -1;
|
||||
|
||||
memcpy(gear,&my_message[30],4);
|
||||
|
||||
for (i=0; (i<arraySize && i < 6); i++)
|
||||
{
|
||||
memcpy(&resultArray[i],&my_message[i*4+6],4);
|
||||
}
|
||||
|
||||
return my_message[5]; // Aircraft
|
||||
}
|
||||
|
||||
float parseCTRL(const char my_message[], float resultArray[], short *gear)
|
||||
{
|
||||
int i;
|
||||
float flaps = 0;
|
||||
|
||||
// Controls
|
||||
for (i = 0; i < 4; i++)
|
||||
{
|
||||
memcpy(&resultArray[i],&my_message[5+4*i],4);
|
||||
}
|
||||
|
||||
// Gear, Flaps
|
||||
*gear = (short) my_message[21];
|
||||
|
||||
memcpy(&flaps,&my_message[22],4);
|
||||
|
||||
return flaps;
|
||||
}
|
||||
78
C/src/xplaneConnect.h
Normal file
78
C/src/xplaneConnect.h
Normal file
@@ -0,0 +1,78 @@
|
||||
//
|
||||
// xplaneConnect.h
|
||||
//
|
||||
// Created by Chris Teubert on 12/2/13.
|
||||
//
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#ifndef xplaneConnect_h
|
||||
#define xplaneConnect_h
|
||||
|
||||
#ifdef _WIN32 /* WIN32 SYSTEM */
|
||||
#include <winsock2.h>
|
||||
#include <ws2tcpip.h>
|
||||
#pragma comment(lib,"ws2_32.lib") //Winsock Library
|
||||
#elif (__APPLE__ || __linux)
|
||||
#include <sys/socket.h>
|
||||
#include <netinet/in.h>
|
||||
#include <arpa/inet.h>
|
||||
#include <unistd.h>
|
||||
#endif
|
||||
|
||||
struct xpcSocket {
|
||||
short open;
|
||||
unsigned short port;
|
||||
|
||||
// X-Plane IP and Port
|
||||
char xpIP[16];
|
||||
unsigned short xpPort;
|
||||
|
||||
#ifdef _WIN32 /* WIN32 SYSTEM */
|
||||
SOCKET sock;
|
||||
#elif (__APPLE__ || __linux) //OS X/Linux
|
||||
int sock;
|
||||
#endif
|
||||
};
|
||||
|
||||
// Basic Functions
|
||||
struct xpcSocket openUDP(unsigned short port, const char *xpIP, unsigned short xpPort);
|
||||
void closeUDP(struct xpcSocket);
|
||||
short sendUDP(struct xpcSocket recfd, char my_message[], short messageLength);
|
||||
int readUDP(struct xpcSocket recfd, char *dataRef, struct sockaddr *recvaddr);
|
||||
|
||||
// Configuration
|
||||
short setCONN(struct xpcSocket recfd, unsigned short recPort);
|
||||
short pauseSim(struct xpcSocket recfd, short);
|
||||
|
||||
// UDP DATA
|
||||
short parseDATA(const char my_message[], short messageLength, float dataRef[][9]);
|
||||
short readDATA(struct xpcSocket recfd, float dataRef[][9]);
|
||||
short sendDATA(struct xpcSocket recfd, float dataRef[][9], unsigned short rows);
|
||||
|
||||
// Position
|
||||
short parsePOSI(const char my_message[], float resultArray[], int arraySize, float *gear);
|
||||
short readPOSI(struct xpcSocket recfd, float resultArray[], int arraySize, float *gear);
|
||||
short sendPOSI(struct xpcSocket recfd, short ACNum, short numArgs, float valueArray[]);
|
||||
|
||||
// Controls
|
||||
float parseCTRL(const char my_message[], float resultArray[4], short *gear);
|
||||
float readCTRL(struct xpcSocket recfd, float resultArray[4], short *gear);
|
||||
short sendCTRL(struct xpcSocket recfd, short numArgs, float valueArray[]);
|
||||
|
||||
// DREF Manipulation
|
||||
short readDREF(struct xpcSocket recfd, float *resultArray[], short arraySizes[]);
|
||||
short parseDREF(const char my_message[], char *dataRef, unsigned short *length_of_DREF, float *values, unsigned short *number_of_values);
|
||||
short sendDREF(struct xpcSocket recfd, const char *dataRef, unsigned short length_of_DREF, float *values, unsigned short number_of_values);
|
||||
short requestDREF(struct xpcSocket sendfd, struct xpcSocket recfd, char DREFArray[][100], short DREFSizes[], short listLength, float *resultArray[], short arraySizes[]);
|
||||
int parseGETD(const char my_message[], char *DREFArray[], int DREFSizes[]);
|
||||
short parseRequest(const char my_message[], float *resultArray[], short arraySizes[]);
|
||||
short readRequest(struct xpcSocket recfd, float *dataRef[], short arraySizes[], struct sockaddr *recvaddr);
|
||||
|
||||
#endif //ifdef _h
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
259
C/xpcExample/xpcExample.xcodeproj/project.pbxproj
Normal file
259
C/xpcExample/xpcExample.xcodeproj/project.pbxproj
Normal file
@@ -0,0 +1,259 @@
|
||||
// !$*UTF8*$!
|
||||
{
|
||||
archiveVersion = 1;
|
||||
classes = {
|
||||
};
|
||||
objectVersion = 46;
|
||||
objects = {
|
||||
|
||||
/* Begin PBXBuildFile section */
|
||||
BEDC620118EDF0F5005DB364 /* xplaneConnect.c in Sources */ = {isa = PBXBuildFile; fileRef = BEDC61FF18EDF0F5005DB364 /* xplaneConnect.c */; };
|
||||
BEDC620818EDF254005DB364 /* xplaneConnect.c in CopyFiles */ = {isa = PBXBuildFile; fileRef = BEDC61FF18EDF0F5005DB364 /* xplaneConnect.c */; };
|
||||
BEDC620918EDF257005DB364 /* xplaneConnect.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = BEDC620018EDF0F5005DB364 /* xplaneConnect.h */; };
|
||||
BEF9890F18E4E7F7005554D1 /* main.cpp in Sources */ = {isa = PBXBuildFile; fileRef = BEF9890E18E4E7F7005554D1 /* main.cpp */; };
|
||||
/* End PBXBuildFile section */
|
||||
|
||||
/* Begin PBXCopyFilesBuildPhase section */
|
||||
BE60308318E5F7A5004B5E1D /* CopyFiles */ = {
|
||||
isa = PBXCopyFilesBuildPhase;
|
||||
buildActionMask = 12;
|
||||
dstPath = /Users/cteubert/Documents/flightdeckz/connections/src/xplaneconnect;
|
||||
dstSubfolderSpec = 0;
|
||||
files = (
|
||||
BEDC620818EDF254005DB364 /* xplaneConnect.c in CopyFiles */,
|
||||
BEDC620918EDF257005DB364 /* xplaneConnect.h in CopyFiles */,
|
||||
);
|
||||
runOnlyForDeploymentPostprocessing = 0;
|
||||
};
|
||||
/* End PBXCopyFilesBuildPhase section */
|
||||
|
||||
/* Begin PBXFileReference section */
|
||||
BEDC61FF18EDF0F5005DB364 /* xplaneConnect.c */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.c; name = xplaneConnect.c; path = ../src/xplaneConnect.c; sourceTree = "<group>"; };
|
||||
BEDC620018EDF0F5005DB364 /* xplaneConnect.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = xplaneConnect.h; path = ../src/xplaneConnect.h; sourceTree = "<group>"; };
|
||||
BEF9890B18E4E7F7005554D1 /* xpcExample */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = xpcExample; sourceTree = BUILT_PRODUCTS_DIR; };
|
||||
BEF9890E18E4E7F7005554D1 /* main.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; path = main.cpp; sourceTree = "<group>"; };
|
||||
/* End PBXFileReference section */
|
||||
|
||||
/* Begin PBXFrameworksBuildPhase section */
|
||||
BEF9890818E4E7F7005554D1 /* Frameworks */ = {
|
||||
isa = PBXFrameworksBuildPhase;
|
||||
buildActionMask = 2147483647;
|
||||
files = (
|
||||
);
|
||||
runOnlyForDeploymentPostprocessing = 0;
|
||||
};
|
||||
/* End PBXFrameworksBuildPhase section */
|
||||
|
||||
/* Begin PBXGroup section */
|
||||
BE60308618E5F980004B5E1D /* xplaneConnect */ = {
|
||||
isa = PBXGroup;
|
||||
children = (
|
||||
BEDC61FF18EDF0F5005DB364 /* xplaneConnect.c */,
|
||||
BEDC620018EDF0F5005DB364 /* xplaneConnect.h */,
|
||||
);
|
||||
name = xplaneConnect;
|
||||
sourceTree = "<group>";
|
||||
};
|
||||
BEF9890218E4E7F7005554D1 = {
|
||||
isa = PBXGroup;
|
||||
children = (
|
||||
BEF9890D18E4E7F7005554D1 /* xpcExample */,
|
||||
BE60308618E5F980004B5E1D /* xplaneConnect */,
|
||||
BEF9890C18E4E7F7005554D1 /* Products */,
|
||||
);
|
||||
sourceTree = "<group>";
|
||||
};
|
||||
BEF9890C18E4E7F7005554D1 /* Products */ = {
|
||||
isa = PBXGroup;
|
||||
children = (
|
||||
BEF9890B18E4E7F7005554D1 /* xpcExample */,
|
||||
);
|
||||
name = Products;
|
||||
sourceTree = "<group>";
|
||||
};
|
||||
BEF9890D18E4E7F7005554D1 /* xpcExample */ = {
|
||||
isa = PBXGroup;
|
||||
children = (
|
||||
BEF9890E18E4E7F7005554D1 /* main.cpp */,
|
||||
);
|
||||
path = xpcExample;
|
||||
sourceTree = "<group>";
|
||||
};
|
||||
/* End PBXGroup section */
|
||||
|
||||
/* Begin PBXNativeTarget section */
|
||||
BEF9890A18E4E7F7005554D1 /* xpcExample */ = {
|
||||
isa = PBXNativeTarget;
|
||||
buildConfigurationList = BEF9891418E4E7F7005554D1 /* Build configuration list for PBXNativeTarget "xpcExample" */;
|
||||
buildPhases = (
|
||||
BEF9890718E4E7F7005554D1 /* Sources */,
|
||||
BEF9890818E4E7F7005554D1 /* Frameworks */,
|
||||
BE60308318E5F7A5004B5E1D /* CopyFiles */,
|
||||
);
|
||||
buildRules = (
|
||||
);
|
||||
dependencies = (
|
||||
);
|
||||
name = xpcExample;
|
||||
productName = xpcExample;
|
||||
productReference = BEF9890B18E4E7F7005554D1 /* xpcExample */;
|
||||
productType = "com.apple.product-type.tool";
|
||||
};
|
||||
/* End PBXNativeTarget section */
|
||||
|
||||
/* Begin PBXProject section */
|
||||
BEF9890318E4E7F7005554D1 /* Project object */ = {
|
||||
isa = PBXProject;
|
||||
attributes = {
|
||||
LastUpgradeCheck = 0500;
|
||||
ORGANIZATIONNAME = "Chris Teubert";
|
||||
};
|
||||
buildConfigurationList = BEF9890618E4E7F7005554D1 /* Build configuration list for PBXProject "xpcExample" */;
|
||||
compatibilityVersion = "Xcode 3.2";
|
||||
developmentRegion = English;
|
||||
hasScannedForEncodings = 0;
|
||||
knownRegions = (
|
||||
en,
|
||||
);
|
||||
mainGroup = BEF9890218E4E7F7005554D1;
|
||||
productRefGroup = BEF9890C18E4E7F7005554D1 /* Products */;
|
||||
projectDirPath = "";
|
||||
projectRoot = "";
|
||||
targets = (
|
||||
BEF9890A18E4E7F7005554D1 /* xpcExample */,
|
||||
);
|
||||
};
|
||||
/* End PBXProject section */
|
||||
|
||||
/* Begin PBXSourcesBuildPhase section */
|
||||
BEF9890718E4E7F7005554D1 /* Sources */ = {
|
||||
isa = PBXSourcesBuildPhase;
|
||||
buildActionMask = 2147483647;
|
||||
files = (
|
||||
BEDC620118EDF0F5005DB364 /* xplaneConnect.c in Sources */,
|
||||
BEF9890F18E4E7F7005554D1 /* main.cpp in Sources */,
|
||||
);
|
||||
runOnlyForDeploymentPostprocessing = 0;
|
||||
};
|
||||
/* End PBXSourcesBuildPhase section */
|
||||
|
||||
/* Begin XCBuildConfiguration section */
|
||||
BEF9891218E4E7F7005554D1 /* Debug */ = {
|
||||
isa = XCBuildConfiguration;
|
||||
buildSettings = {
|
||||
ALWAYS_SEARCH_USER_PATHS = NO;
|
||||
CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
|
||||
CLANG_CXX_LIBRARY = "libc++";
|
||||
CLANG_ENABLE_OBJC_ARC = YES;
|
||||
CLANG_WARN_BOOL_CONVERSION = YES;
|
||||
CLANG_WARN_CONSTANT_CONVERSION = YES;
|
||||
CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
|
||||
CLANG_WARN_EMPTY_BODY = YES;
|
||||
CLANG_WARN_ENUM_CONVERSION = YES;
|
||||
CLANG_WARN_INT_CONVERSION = YES;
|
||||
CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
|
||||
CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
|
||||
COPY_PHASE_STRIP = NO;
|
||||
GCC_C_LANGUAGE_STANDARD = gnu99;
|
||||
GCC_DYNAMIC_NO_PIC = NO;
|
||||
GCC_ENABLE_OBJC_EXCEPTIONS = YES;
|
||||
GCC_OPTIMIZATION_LEVEL = 0;
|
||||
GCC_PREPROCESSOR_DEFINITIONS = (
|
||||
"DEBUG=1",
|
||||
"$(inherited)",
|
||||
);
|
||||
GCC_SYMBOLS_PRIVATE_EXTERN = NO;
|
||||
GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
|
||||
GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
|
||||
GCC_WARN_UNDECLARED_SELECTOR = YES;
|
||||
GCC_WARN_UNINITIALIZED_AUTOS = YES;
|
||||
GCC_WARN_UNUSED_FUNCTION = YES;
|
||||
GCC_WARN_UNUSED_VARIABLE = YES;
|
||||
MACOSX_DEPLOYMENT_TARGET = 10.8;
|
||||
ONLY_ACTIVE_ARCH = YES;
|
||||
SDKROOT = macosx;
|
||||
};
|
||||
name = Debug;
|
||||
};
|
||||
BEF9891318E4E7F7005554D1 /* Release */ = {
|
||||
isa = XCBuildConfiguration;
|
||||
buildSettings = {
|
||||
ALWAYS_SEARCH_USER_PATHS = NO;
|
||||
CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
|
||||
CLANG_CXX_LIBRARY = "libc++";
|
||||
CLANG_ENABLE_OBJC_ARC = YES;
|
||||
CLANG_WARN_BOOL_CONVERSION = YES;
|
||||
CLANG_WARN_CONSTANT_CONVERSION = YES;
|
||||
CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
|
||||
CLANG_WARN_EMPTY_BODY = YES;
|
||||
CLANG_WARN_ENUM_CONVERSION = YES;
|
||||
CLANG_WARN_INT_CONVERSION = YES;
|
||||
CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
|
||||
CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
|
||||
COPY_PHASE_STRIP = YES;
|
||||
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
|
||||
ENABLE_NS_ASSERTIONS = NO;
|
||||
GCC_C_LANGUAGE_STANDARD = gnu99;
|
||||
GCC_ENABLE_OBJC_EXCEPTIONS = YES;
|
||||
GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
|
||||
GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
|
||||
GCC_WARN_UNDECLARED_SELECTOR = YES;
|
||||
GCC_WARN_UNINITIALIZED_AUTOS = YES;
|
||||
GCC_WARN_UNUSED_FUNCTION = YES;
|
||||
GCC_WARN_UNUSED_VARIABLE = YES;
|
||||
MACOSX_DEPLOYMENT_TARGET = 10.8;
|
||||
SDKROOT = macosx;
|
||||
};
|
||||
name = Release;
|
||||
};
|
||||
BEF9891518E4E7F7005554D1 /* Debug */ = {
|
||||
isa = XCBuildConfiguration;
|
||||
buildSettings = {
|
||||
ARCHS = "$(ARCHS_STANDARD_32_64_BIT)";
|
||||
HEADER_SEARCH_PATHS = (
|
||||
"$(inherited)",
|
||||
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include,
|
||||
/Users/cteubert/Documents/xplaneconnect/xpcPlugin,
|
||||
);
|
||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||
};
|
||||
name = Debug;
|
||||
};
|
||||
BEF9891618E4E7F7005554D1 /* Release */ = {
|
||||
isa = XCBuildConfiguration;
|
||||
buildSettings = {
|
||||
ARCHS = "$(ARCHS_STANDARD_32_64_BIT)";
|
||||
HEADER_SEARCH_PATHS = (
|
||||
"$(inherited)",
|
||||
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include,
|
||||
/Users/cteubert/Documents/xplaneconnect/xpcPlugin,
|
||||
);
|
||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||
};
|
||||
name = Release;
|
||||
};
|
||||
/* End XCBuildConfiguration section */
|
||||
|
||||
/* Begin XCConfigurationList section */
|
||||
BEF9890618E4E7F7005554D1 /* Build configuration list for PBXProject "xpcExample" */ = {
|
||||
isa = XCConfigurationList;
|
||||
buildConfigurations = (
|
||||
BEF9891218E4E7F7005554D1 /* Debug */,
|
||||
BEF9891318E4E7F7005554D1 /* Release */,
|
||||
);
|
||||
defaultConfigurationIsVisible = 0;
|
||||
defaultConfigurationName = Release;
|
||||
};
|
||||
BEF9891418E4E7F7005554D1 /* Build configuration list for PBXNativeTarget "xpcExample" */ = {
|
||||
isa = XCConfigurationList;
|
||||
buildConfigurations = (
|
||||
BEF9891518E4E7F7005554D1 /* Debug */,
|
||||
BEF9891618E4E7F7005554D1 /* Release */,
|
||||
);
|
||||
defaultConfigurationIsVisible = 0;
|
||||
defaultConfigurationName = Release;
|
||||
};
|
||||
/* End XCConfigurationList section */
|
||||
};
|
||||
rootObject = BEF9890318E4E7F7005554D1 /* Project object */;
|
||||
}
|
||||
7
C/xpcExample/xpcExample.xcodeproj/project.xcworkspace/contents.xcworkspacedata
generated
Normal file
7
C/xpcExample/xpcExample.xcodeproj/project.xcworkspace/contents.xcworkspacedata
generated
Normal file
@@ -0,0 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<Workspace
|
||||
version = "1.0">
|
||||
<FileRef
|
||||
location = "self:xpcExample.xcodeproj">
|
||||
</FileRef>
|
||||
</Workspace>
|
||||
@@ -0,0 +1,46 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>IDESourceControlProjectFavoriteDictionaryKey</key>
|
||||
<false/>
|
||||
<key>IDESourceControlProjectIdentifier</key>
|
||||
<string>2D8FADF5-8504-4A76-A99F-91CA115CE4E3</string>
|
||||
<key>IDESourceControlProjectName</key>
|
||||
<string>xpcExample</string>
|
||||
<key>IDESourceControlProjectOriginsDictionary</key>
|
||||
<dict>
|
||||
<key>D7B4D224-FE26-406E-A48F-C604A5BE6975</key>
|
||||
<string>https://babelfish.arc.nasa.gov/svn/pcoe/cteubert/xplaneconnect</string>
|
||||
</dict>
|
||||
<key>IDESourceControlProjectPath</key>
|
||||
<string>C/xpcExample/xpcExample.xcodeproj/project.xcworkspace</string>
|
||||
<key>IDESourceControlProjectRelativeInstallPathDictionary</key>
|
||||
<dict>
|
||||
<key>D7B4D224-FE26-406E-A48F-C604A5BE6975</key>
|
||||
<string>../../../..</string>
|
||||
</dict>
|
||||
<key>IDESourceControlProjectRepositoryRootDictionary</key>
|
||||
<dict>
|
||||
<key>D7B4D224-FE26-406E-A48F-C604A5BE6975</key>
|
||||
<string>https://babelfish.arc.nasa.gov/svn/pcoe</string>
|
||||
</dict>
|
||||
<key>IDESourceControlProjectURL</key>
|
||||
<string>https://babelfish.arc.nasa.gov/svn/pcoe/cteubert/xplaneconnect/C/xpcExample/xpcExample.xcodeproj</string>
|
||||
<key>IDESourceControlProjectVersion</key>
|
||||
<integer>110</integer>
|
||||
<key>IDESourceControlProjectWCCIdentifier</key>
|
||||
<string>D7B4D224-FE26-406E-A48F-C604A5BE6975</string>
|
||||
<key>IDESourceControlProjectWCConfigurations</key>
|
||||
<array>
|
||||
<dict>
|
||||
<key>IDESourceControlRepositoryExtensionIdentifierKey</key>
|
||||
<string>public.vcs.subversion</string>
|
||||
<key>IDESourceControlWCCIdentifierKey</key>
|
||||
<string>D7B4D224-FE26-406E-A48F-C604A5BE6975</string>
|
||||
<key>IDESourceControlWCCName</key>
|
||||
<string>xplaneconnect</string>
|
||||
</dict>
|
||||
</array>
|
||||
</dict>
|
||||
</plist>
|
||||
Binary file not shown.
@@ -0,0 +1,23 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<Bucket
|
||||
type = "1"
|
||||
version = "2.0">
|
||||
<Breakpoints>
|
||||
<BreakpointProxy
|
||||
BreakpointExtensionID = "Xcode.Breakpoint.FileBreakpoint">
|
||||
<BreakpointContent
|
||||
shouldBeEnabled = "No"
|
||||
ignoreCount = "0"
|
||||
continueAfterRunningActions = "No"
|
||||
filePath = "../src/xplaneConnect.c"
|
||||
timestampString = "433458275.8587"
|
||||
startingColumnNumber = "9223372036854775807"
|
||||
endingColumnNumber = "9223372036854775807"
|
||||
startingLineNumber = "342"
|
||||
endingLineNumber = "342"
|
||||
landmarkName = "setCONN()"
|
||||
landmarkType = "7">
|
||||
</BreakpointContent>
|
||||
</BreakpointProxy>
|
||||
</Breakpoints>
|
||||
</Bucket>
|
||||
@@ -0,0 +1,22 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>SchemeUserState</key>
|
||||
<dict>
|
||||
<key>xpcExample.xcscheme</key>
|
||||
<dict>
|
||||
<key>orderHint</key>
|
||||
<integer>0</integer>
|
||||
</dict>
|
||||
</dict>
|
||||
<key>SuppressBuildableAutocreation</key>
|
||||
<dict>
|
||||
<key>BEF9890A18E4E7F7005554D1</key>
|
||||
<dict>
|
||||
<key>primary</key>
|
||||
<true/>
|
||||
</dict>
|
||||
</dict>
|
||||
</dict>
|
||||
</plist>
|
||||
@@ -0,0 +1,86 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<Scheme
|
||||
LastUpgradeVersion = "0500"
|
||||
version = "1.3">
|
||||
<BuildAction
|
||||
parallelizeBuildables = "YES"
|
||||
buildImplicitDependencies = "YES">
|
||||
<BuildActionEntries>
|
||||
<BuildActionEntry
|
||||
buildForTesting = "YES"
|
||||
buildForRunning = "YES"
|
||||
buildForProfiling = "YES"
|
||||
buildForArchiving = "YES"
|
||||
buildForAnalyzing = "YES">
|
||||
<BuildableReference
|
||||
BuildableIdentifier = "primary"
|
||||
BlueprintIdentifier = "BEF9890A18E4E7F7005554D1"
|
||||
BuildableName = "xpcExample"
|
||||
BlueprintName = "xpcExample"
|
||||
ReferencedContainer = "container:xpcExample.xcodeproj">
|
||||
</BuildableReference>
|
||||
</BuildActionEntry>
|
||||
</BuildActionEntries>
|
||||
</BuildAction>
|
||||
<TestAction
|
||||
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
|
||||
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
|
||||
shouldUseLaunchSchemeArgsEnv = "YES"
|
||||
buildConfiguration = "Debug">
|
||||
<Testables>
|
||||
</Testables>
|
||||
<MacroExpansion>
|
||||
<BuildableReference
|
||||
BuildableIdentifier = "primary"
|
||||
BlueprintIdentifier = "BEF9890A18E4E7F7005554D1"
|
||||
BuildableName = "xpcExample"
|
||||
BlueprintName = "xpcExample"
|
||||
ReferencedContainer = "container:xpcExample.xcodeproj">
|
||||
</BuildableReference>
|
||||
</MacroExpansion>
|
||||
</TestAction>
|
||||
<LaunchAction
|
||||
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
|
||||
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
|
||||
launchStyle = "0"
|
||||
useCustomWorkingDirectory = "NO"
|
||||
buildConfiguration = "Debug"
|
||||
ignoresPersistentStateOnLaunch = "NO"
|
||||
debugDocumentVersioning = "YES"
|
||||
allowLocationSimulation = "YES">
|
||||
<BuildableProductRunnable>
|
||||
<BuildableReference
|
||||
BuildableIdentifier = "primary"
|
||||
BlueprintIdentifier = "BEF9890A18E4E7F7005554D1"
|
||||
BuildableName = "xpcExample"
|
||||
BlueprintName = "xpcExample"
|
||||
ReferencedContainer = "container:xpcExample.xcodeproj">
|
||||
</BuildableReference>
|
||||
</BuildableProductRunnable>
|
||||
<AdditionalOptions>
|
||||
</AdditionalOptions>
|
||||
</LaunchAction>
|
||||
<ProfileAction
|
||||
shouldUseLaunchSchemeArgsEnv = "YES"
|
||||
savedToolIdentifier = ""
|
||||
useCustomWorkingDirectory = "NO"
|
||||
buildConfiguration = "Release"
|
||||
debugDocumentVersioning = "YES">
|
||||
<BuildableProductRunnable>
|
||||
<BuildableReference
|
||||
BuildableIdentifier = "primary"
|
||||
BlueprintIdentifier = "BEF9890A18E4E7F7005554D1"
|
||||
BuildableName = "xpcExample"
|
||||
BlueprintName = "xpcExample"
|
||||
ReferencedContainer = "container:xpcExample.xcodeproj">
|
||||
</BuildableReference>
|
||||
</BuildableProductRunnable>
|
||||
</ProfileAction>
|
||||
<AnalyzeAction
|
||||
buildConfiguration = "Debug">
|
||||
</AnalyzeAction>
|
||||
<ArchiveAction
|
||||
buildConfiguration = "Release"
|
||||
revealArchiveInOrganizer = "YES">
|
||||
</ArchiveAction>
|
||||
</Scheme>
|
||||
131
C/xpcExample/xpcExample/main.cpp
Normal file
131
C/xpcExample/xpcExample/main.cpp
Normal file
@@ -0,0 +1,131 @@
|
||||
//
|
||||
// main.cpp
|
||||
// xpcExample
|
||||
//
|
||||
// Created by Chris Teubert on 3/27/14.
|
||||
// Copyright (c) 2014 Chris Teubert. All rights reserved.
|
||||
//
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <time.h>
|
||||
#include "xplaneConnect.h"
|
||||
|
||||
int main() {
|
||||
int i,j;
|
||||
struct xpcSocket sendfd,readfd;
|
||||
float data[4][9] = {0};
|
||||
char DREF[100] = {0};
|
||||
char DREFArray[100][100];
|
||||
char DREFArray2[100][100];
|
||||
short DREFSizes[100];
|
||||
float *recDATA[100];
|
||||
float POSI[9] = {0.0};
|
||||
float CTRL[5] = {0.0};
|
||||
float gear;
|
||||
char IP[16] = "143.232.73.41";//"127.0.0.1";//;// //IP Address of computer running X-Plane
|
||||
short PORT = 49009; //xpcPlugin Receiving port (usually 49009)
|
||||
|
||||
printf("xplaneconnect Example Script\n- Setting up Simulation\n");
|
||||
|
||||
for (i = 0; i < 100; i++) {
|
||||
recDATA[i] = (float *) malloc(40*sizeof(float));
|
||||
memset(DREFArray[i],0,100);
|
||||
memset(DREFArray2[i],0,100);
|
||||
}
|
||||
|
||||
// Open Sockets
|
||||
readfd = openUDP(49055, IP, PORT); //Open socket for receiving
|
||||
sendfd = openUDP(49077, IP, PORT); //Open socket for sending
|
||||
|
||||
// Set up Connection
|
||||
setCONN(sendfd, 49055); // Setup so data will be received on port 49055
|
||||
|
||||
// Set Location/Orientation (sendPOSI)
|
||||
// Set Up Position Array
|
||||
POSI[0] = 37.524; // Lat
|
||||
POSI[1] = -122.06899; // Lon
|
||||
POSI[2] = 2500; // Alt
|
||||
POSI[3] = 0; // Pitch
|
||||
POSI[4] = 0; // Roll
|
||||
POSI[5] = 0; // Heading
|
||||
POSI[6] = 1; // Gear
|
||||
|
||||
sendPOSI(sendfd, 0, 7, POSI);
|
||||
POSI[0] = 37.52465;
|
||||
POSI[4] = 20;
|
||||
sendPOSI(sendfd, 1, 7, POSI);
|
||||
|
||||
// Set Rates (sendDATA)
|
||||
|
||||
for (i=0;i<4;i++) { // Set array to -999
|
||||
for (j=0;j<9;j++) data[i][j] = -999;
|
||||
}
|
||||
// Set up Data Array (first item in row is item number (example: 20=position)
|
||||
data[0][0] = 18; // Alpha
|
||||
data[0][1] = 0;
|
||||
data[0][3] = 0;
|
||||
|
||||
data[1][0] = 3;//21; //Velocity
|
||||
data[1][1] = 130;
|
||||
data[1][2] = 130;
|
||||
data[1][3] = 130;
|
||||
data[1][4] = 130;
|
||||
|
||||
data[2][0] = 16; //PQR
|
||||
data[2][1] = 0;
|
||||
data[2][2] = 0;
|
||||
data[2][3] = 0;
|
||||
|
||||
sendDATA(sendfd, data, 3); // Throttle/Velocity/Alpha/PQR
|
||||
|
||||
// Set CTRL
|
||||
CTRL[3] = 0.8; // Throttle
|
||||
|
||||
sendCTRL(sendfd, 4, CTRL);
|
||||
|
||||
// pauseSim
|
||||
pauseSim(sendfd, 1); // Sending 1 to pause
|
||||
|
||||
// Pause for 5 seconds
|
||||
sleep(5);
|
||||
|
||||
// Unpause
|
||||
pauseSim(sendfd, 0); // Sending 0 to unpause
|
||||
printf("- Resuming Simulation\n");
|
||||
|
||||
// Simulate for 10 seconds
|
||||
sleep(10);
|
||||
|
||||
// SendDREF (Landing Gear)
|
||||
printf("- Stowing Landing Gear\n");
|
||||
|
||||
strcpy(DREF,"cockpit/switches/gear_handle_status"); // Gear handle data reference
|
||||
DREFSizes[0] = sizeof(DREF);
|
||||
gear = 1; // Stow gear
|
||||
|
||||
sendDREF(sendfd, DREF, DREFSizes[0], &gear, 1); // Set gear to stow
|
||||
|
||||
// Simulate for 10 seconds
|
||||
sleep(10);
|
||||
|
||||
// Check Landing gear, Pause
|
||||
printf("- Confirming Gear Status\n");
|
||||
strcpy(DREFArray2[0],"sim/cockpit/switches/gear_handle_status");
|
||||
strcpy(DREFArray2[1],"sim/operation/override/override_planepath");
|
||||
for (i=0;i<2;i++) {
|
||||
DREFSizes[i] = (int) strlen(DREFArray2[i]);
|
||||
}
|
||||
requestDREF(sendfd, readfd, DREFArray2, DREFSizes, 2, recDATA, DREFSizes); // Request 2 values
|
||||
|
||||
if (*(recDATA[0])==0) {
|
||||
printf("\tGear Stowed\n");
|
||||
} else {
|
||||
printf("\tERROR: Gear Stowage unsuccessful\n");
|
||||
}
|
||||
|
||||
printf("---End Program---\n");
|
||||
|
||||
return 0;
|
||||
}
|
||||
79
C/xpcExample/xpcExample/xpcExample.1
Normal file
79
C/xpcExample/xpcExample/xpcExample.1
Normal file
@@ -0,0 +1,79 @@
|
||||
.\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.
|
||||
.\"See Also:
|
||||
.\"man mdoc.samples for a complete listing of options
|
||||
.\"man mdoc for the short list of editing options
|
||||
.\"/usr/share/misc/mdoc.template
|
||||
.Dd 3/27/14 \" DATE
|
||||
.Dt xpcExample 1 \" Program name and manual section number
|
||||
.Os Darwin
|
||||
.Sh NAME \" Section Header - required - don't modify
|
||||
.Nm xpcExample,
|
||||
.\" The following lines are read in generating the apropos(man -k) database. Use only key
|
||||
.\" words here as the database is built based on the words here and in the .ND line.
|
||||
.Nm Other_name_for_same_program(),
|
||||
.Nm Yet another name for the same program.
|
||||
.\" Use .Nm macro to designate other names for the documented program.
|
||||
.Nd This line parsed for whatis database.
|
||||
.Sh SYNOPSIS \" Section Header - required - don't modify
|
||||
.Nm
|
||||
.Op Fl abcd \" [-abcd]
|
||||
.Op Fl a Ar path \" [-a path]
|
||||
.Op Ar file \" [file]
|
||||
.Op Ar \" [file ...]
|
||||
.Ar arg0 \" Underlined argument - use .Ar anywhere to underline
|
||||
arg2 ... \" Arguments
|
||||
.Sh DESCRIPTION \" Section Header - required - don't modify
|
||||
Use the .Nm macro to refer to your program throughout the man page like such:
|
||||
.Nm
|
||||
Underlining is accomplished with the .Ar macro like this:
|
||||
.Ar underlined text .
|
||||
.Pp \" Inserts a space
|
||||
A list of items with descriptions:
|
||||
.Bl -tag -width -indent \" Begins a tagged list
|
||||
.It item a \" Each item preceded by .It macro
|
||||
Description of item a
|
||||
.It item b
|
||||
Description of item b
|
||||
.El \" Ends the list
|
||||
.Pp
|
||||
A list of flags and their descriptions:
|
||||
.Bl -tag -width -indent \" Differs from above in tag removed
|
||||
.It Fl a \"-a flag as a list item
|
||||
Description of -a flag
|
||||
.It Fl b
|
||||
Description of -b flag
|
||||
.El \" Ends the list
|
||||
.Pp
|
||||
.\" .Sh ENVIRONMENT \" May not be needed
|
||||
.\" .Bl -tag -width "ENV_VAR_1" -indent \" ENV_VAR_1 is width of the string ENV_VAR_1
|
||||
.\" .It Ev ENV_VAR_1
|
||||
.\" Description of ENV_VAR_1
|
||||
.\" .It Ev ENV_VAR_2
|
||||
.\" Description of ENV_VAR_2
|
||||
.\" .El
|
||||
.Sh FILES \" File used or created by the topic of the man page
|
||||
.Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact
|
||||
.It Pa /usr/share/file_name
|
||||
FILE_1 description
|
||||
.It Pa /Users/joeuser/Library/really_long_file_name
|
||||
FILE_2 description
|
||||
.El \" Ends the list
|
||||
.\" .Sh DIAGNOSTICS \" May not be needed
|
||||
.\" .Bl -diag
|
||||
.\" .It Diagnostic Tag
|
||||
.\" Diagnostic informtion here.
|
||||
.\" .It Diagnostic Tag
|
||||
.\" Diagnostic informtion here.
|
||||
.\" .El
|
||||
.Sh SEE ALSO
|
||||
.\" List links in ascending order by section, alphabetically within a section.
|
||||
.\" Please do not reference files that do not exist without filing a bug report
|
||||
.Xr a 1 ,
|
||||
.Xr b 1 ,
|
||||
.Xr c 1 ,
|
||||
.Xr a 2 ,
|
||||
.Xr b 2 ,
|
||||
.Xr a 3 ,
|
||||
.Xr b 3
|
||||
.\" .Sh BUGS \" Document known, unremedied bugs
|
||||
.\" .Sh HISTORY \" Document history if command behaves in a unique manner
|
||||
BIN
Docs/Capability Matrix.xlsx
Normal file
BIN
Docs/Capability Matrix.xlsx
Normal file
Binary file not shown.
BIN
Docs/Interface Control Document.xlsx
Normal file
BIN
Docs/Interface Control Document.xlsx
Normal file
Binary file not shown.
BIN
Docs/PBS.pdf
Normal file
BIN
Docs/PBS.pdf
Normal file
Binary file not shown.
40
MATLAB/+XPlaneConnect/clearUDPBuffer.m
Normal file
40
MATLAB/+XPlaneConnect/clearUDPBuffer.m
Normal file
@@ -0,0 +1,40 @@
|
||||
function socket = clearUDPBuffer(socket,varargin)
|
||||
% clearUDPBuffer Script that clears an UDP Socket Buffer by closing and
|
||||
% reopening the socket
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% Socket: UDP Socket to be cleared
|
||||
%
|
||||
% Outputs
|
||||
% Socket: UDP Socket
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. Socket = openUDP(49005);
|
||||
% 3. Socket = clearUDPBuffer(Socket);
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] Added Versioning
|
||||
% 09/12/13: [CT] Add optional arguments
|
||||
% 09/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
% BEGIN CODE
|
||||
|
||||
import XPlaneConnect.*
|
||||
|
||||
%% Close and reopen socket
|
||||
if ~socket.isClosed()
|
||||
port = socket.getLocalPort(); %get port of socket
|
||||
socket.close; %Close Socket
|
||||
socket = openUDP(port,varargin); %open new socket
|
||||
end
|
||||
end
|
||||
32
MATLAB/+XPlaneConnect/closeUDP.m
Normal file
32
MATLAB/+XPlaneConnect/closeUDP.m
Normal file
@@ -0,0 +1,32 @@
|
||||
function [socket] = closeUDP(socket)
|
||||
% closeUDP Script that closes a UDP Socket
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% Socket: UDP Socket to be closed
|
||||
%
|
||||
% Outputs
|
||||
% Socket: Closed Socket
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. Socket = openUDP(49005);
|
||||
% 3. Status = closeUDP(Socket);
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Added Versioning
|
||||
% 09/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
% BEGIN CODE
|
||||
|
||||
socket.close;
|
||||
|
||||
end
|
||||
46
MATLAB/+XPlaneConnect/openUDP.m
Normal file
46
MATLAB/+XPlaneConnect/openUDP.m
Normal file
@@ -0,0 +1,46 @@
|
||||
function [socket] = openUDP(port, varargin)
|
||||
%openUDP Script that opens an UDP Socket
|
||||
% Version 0.25
|
||||
%
|
||||
%Inputs
|
||||
% port: UDP Port for socket
|
||||
% timeout (optional): Optional parameter for time to UDP timeout (in ms)
|
||||
%Outputs
|
||||
% Socket: UDP Socket
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. Socket = openUDP(49005); %Open socket at port 49005 with timeout=0.1 sec
|
||||
% or
|
||||
% 2. Socket = openUDP(49005); %Open socket at port 49005 with timeout=0.2 sec
|
||||
%
|
||||
%Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] Added Versioning
|
||||
% 09/12/13: [CT] Added optional timeout input argument
|
||||
% 09/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
% BEGIN CODE
|
||||
|
||||
import java.net.DatagramSocket
|
||||
|
||||
%% create socket
|
||||
socket = DatagramSocket(port);
|
||||
socket.setSoTimeout(100);
|
||||
socket.setReceiveBufferSize(2000);
|
||||
|
||||
%% interpret input
|
||||
if ~isempty(varargin)
|
||||
if isnumeric(varargin(1))
|
||||
socket.setSoTimeout(varargin(1));
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
50
MATLAB/+XPlaneConnect/pauseSim.m
Normal file
50
MATLAB/+XPlaneConnect/pauseSim.m
Normal file
@@ -0,0 +1,50 @@
|
||||
function status = pauseSim( pause, varargin )
|
||||
%pauseSim pause Simulation
|
||||
% Version 0.25
|
||||
%
|
||||
%Inputs
|
||||
% Pause: binary value 0=run, 1=pause
|
||||
% IP Address (optional): IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)
|
||||
% port (optional): Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin
|
||||
%
|
||||
%Outputs
|
||||
% status: If there was an error. Status<0 means there was an error.
|
||||
%
|
||||
%Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. status = pauseSim(1);
|
||||
%
|
||||
%Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/19/14: [CT] V0.2: First Created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
%BEGIN CODE
|
||||
|
||||
import XPlaneConnect.*
|
||||
|
||||
%% Handle Input
|
||||
% Optional parameters
|
||||
p = inputParser;
|
||||
addRequired(p,'pause',@isnumeric);
|
||||
addOptional(p,'IP','127.0.0.1',@ischar);
|
||||
addOptional(p,'port',49009,@isnumeric);
|
||||
parse(p,pause,varargin{:});
|
||||
|
||||
% Check format of input-TODO
|
||||
|
||||
%% BODY
|
||||
message = zeros(1,7);
|
||||
|
||||
message(1:4) = 'SIMU'-0;
|
||||
message(6) = uint8(p.Results.pause);
|
||||
message(7) = 0;
|
||||
|
||||
status = sendUDP(message, p.Results.IP, p.Results.port);
|
||||
end
|
||||
98
MATLAB/+XPlaneConnect/readDATA.m
Normal file
98
MATLAB/+XPlaneConnect/readDATA.m
Normal file
@@ -0,0 +1,98 @@
|
||||
function [ sensor ] = readDATA( socket )
|
||||
% readDATA Reads UDP Socket and interprets data
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% location: Either an opened UDP Socket or integer port number
|
||||
%
|
||||
% Outputs
|
||||
% If data is X-Plane data format:
|
||||
% data: Matlab X-Plane DATA Structure
|
||||
% .h: Header array containing header numbers corresponding to values in the X-Plane UDP Data screen.
|
||||
% .d: 2-D Data array. Each row contains eight values corresponding to the header value (.h(1) corresponds to .d(1,:))
|
||||
% .raw: raw UDP data array received by readUDP
|
||||
%
|
||||
% If data is matlab structure:
|
||||
% data: Matlab Structure. raw UDP data saved to data.raw
|
||||
%
|
||||
% If data is any other format:
|
||||
% data: Matlab Structure containing one field
|
||||
% .raw & .d: raw UDP data array received by readUDP
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. socket = openUDP(49005);
|
||||
% 3. data = readDATA(socket);
|
||||
% 4. status = closeUDP(socket);
|
||||
% or
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. data = readDATA(49005);
|
||||
%
|
||||
% NOTE: sending in a port number instead of an opened socket clears the UDP buffer. This only works if the data is being sent at a fast rate. Sending in a UDP Socket reads the first packet in the buffer.
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Updated to work with new Plugin
|
||||
% 09/10/13: [CT] Updated to receive UDP socket or port number
|
||||
% 06/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
% BEGIN CODE
|
||||
|
||||
import XPlaneConnect.*
|
||||
|
||||
%% Read UDP Socket
|
||||
[ sensor.raw] = readUDP(socket);
|
||||
|
||||
%% Interpret Input
|
||||
bits = size(sensor.raw);
|
||||
if sensor.raw ~= -998 %If the signal exists
|
||||
header = char(sensor.raw(1:4)');
|
||||
if strcmp(header,'DATA') %DATA signal type
|
||||
Values = floor((bits-5)/36);
|
||||
sensor.d = [];
|
||||
sensor.h = zeros(Values(1),1);
|
||||
for i=1:Values(1)
|
||||
sensor.h(i) = sensor.raw(6+(i-1)*36);
|
||||
sensor.d = [sensor.d; typecast(uint8(sensor.raw(10+(i-1)*36:5+i*36))','single')];
|
||||
end
|
||||
elseif strcmp(header,'STRU') %STRU signal type
|
||||
a = 6;
|
||||
while a<length(sensor.raw)
|
||||
strdim = sensor.raw(a);
|
||||
if strdim == 0
|
||||
break
|
||||
end
|
||||
fieldName = char(sensor.raw(a+1:a+strdim)');
|
||||
a = a+strdim+1;
|
||||
dim1 = sensor.raw(a);
|
||||
dim2 = sensor.raw(a+1);
|
||||
if dim1 == 0 %String
|
||||
value = char(sensor.raw(a+2:a+1+dim2));
|
||||
a = a + dim2 + 2;
|
||||
else
|
||||
value = [];
|
||||
for i=1:dim1
|
||||
value(i,:) = typecast(uint8(sensor.raw(a+2+(i-1)*dim2*4:a+1+i*dim2*4))','single');
|
||||
end
|
||||
a = a + dim1*dim2*4+2;
|
||||
end
|
||||
sensor.(fieldName) = value;
|
||||
end
|
||||
elseif strcmp(header,'OTHR')
|
||||
sensor.d = sensor.raw(6:end);
|
||||
else %Other signal type
|
||||
sensor.d = sensor.raw;
|
||||
end
|
||||
else %No Signal
|
||||
sensor.d = -998;
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
79
MATLAB/+XPlaneConnect/readUDP.m
Normal file
79
MATLAB/+XPlaneConnect/readUDP.m
Normal file
@@ -0,0 +1,79 @@
|
||||
function [ data ] = readUDP( input )
|
||||
%readUDP Read Array from UDP Socket
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% input: Either an opened UDP Socket or integer port number
|
||||
%
|
||||
% Outputs
|
||||
% data: UDP uint8 Array. Equal to -998 in the case of an error
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. socket = openUDP(49005);
|
||||
% 3. data = readUDP(socket);
|
||||
% 4. status = closeUDP(socket);
|
||||
%
|
||||
% or
|
||||
%
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. data = readUDP(49005);
|
||||
%
|
||||
% NOTE: sending in a port number instead of an opened socket clears the
|
||||
%UDP buffer. This only works if the data is being sent at a fast rate.
|
||||
%Sending in a UDP Socket reads the first packet in the buffer.
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Added Versioning
|
||||
% 09/08/13: [CT] Added option for either UDP Socket or port number input
|
||||
% 06/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
% BEGIN CODE
|
||||
|
||||
import XPlaneConnect.*
|
||||
import java.net.DatagramPacket
|
||||
bits = 2000;
|
||||
|
||||
%% Interpret Input
|
||||
socket = input;
|
||||
if isnumeric(input)
|
||||
socket=openUDP(input);
|
||||
end
|
||||
|
||||
%% Try reading packet
|
||||
try
|
||||
packet = DatagramPacket(zeros(1,bits,'int8'),bits);
|
||||
socket.receive(packet)
|
||||
data = packet.getData;
|
||||
|
||||
data = int16(data);
|
||||
data(data(:)<0) = uint8(data(data(:)<0) + 256); %fix signed issue
|
||||
size = int16(data(5)); %size of data stream
|
||||
|
||||
%% trim trailing data
|
||||
for i=1:floor(length(data)/256)+1
|
||||
if data(size+1:end)==0
|
||||
break
|
||||
end
|
||||
size = size + 256;
|
||||
end
|
||||
data = data(1:size);
|
||||
|
||||
catch err %Read Unsuccessful
|
||||
data = -998;
|
||||
end
|
||||
|
||||
%% Close Port (if opened in code)
|
||||
if isnumeric(input)
|
||||
socket.close()
|
||||
end
|
||||
end
|
||||
|
||||
59
MATLAB/+XPlaneConnect/requestDREF.m
Normal file
59
MATLAB/+XPlaneConnect/requestDREF.m
Normal file
@@ -0,0 +1,59 @@
|
||||
function status = requestDREF( DREFArray, varargin )
|
||||
%requestDREF request the value of a specific DataRef from X-Plane over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
%Inputs
|
||||
% DREFArray: Cell Array of DataRefs to be requested
|
||||
% IP Address (optional): IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)
|
||||
% port (optional): Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin
|
||||
%
|
||||
%Outputs
|
||||
% status: If there was an error. Status<0 means there was an error.
|
||||
%
|
||||
%Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. DREFArray = {'sim/cockpit2/controls/yoke_heading_ratio','sim/cockpit2/controls/yoke_roll_ratio'};
|
||||
% 3. status = requestDREF( DREFArray, '172.0.100.54' );
|
||||
%
|
||||
%Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/19/14: [CT] V0.2: First Created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Complete- Receive response
|
||||
%
|
||||
%BEGIN CODE
|
||||
|
||||
disp('This Function is not functional yet-use the C version. Sorry for any inconvenience')
|
||||
import XPlaneConnect.*
|
||||
|
||||
message = zeros(1,6);
|
||||
len = 7;
|
||||
|
||||
%% Handle Input
|
||||
p = inputParser;
|
||||
addRequired(p,'DREFArray');
|
||||
addOptional(p,'IP','127.0.0.1',@ischar);
|
||||
addOptional(p,'port',49009,@isnumeric);
|
||||
parse(p,DREFArray,varargin{:});
|
||||
|
||||
%% BODY
|
||||
% Header
|
||||
message(1:4) = 'GETD'-0;
|
||||
message(6) = length(p.Results.DREFArray);
|
||||
|
||||
% DREFS
|
||||
for i=1:length(p.Results.DREFArray)
|
||||
message(len) = length(p.Results.DREFArray{i});
|
||||
message(len+1:len+message(len)) = p.Results.DREFArray{i};
|
||||
len = len+1+message(len);
|
||||
end
|
||||
|
||||
% Send UDP
|
||||
status = sendUDP(message, p.Results.IP, p.Results.port);
|
||||
|
||||
end
|
||||
49
MATLAB/+XPlaneConnect/selectDATA.m
Normal file
49
MATLAB/+XPlaneConnect/selectDATA.m
Normal file
@@ -0,0 +1,49 @@
|
||||
function [ status ] = selectDATA( index, varargin )
|
||||
% selectDATA Choose specific X-Plane parameters to be send over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% index: An array of the values that to be sent. Corresponds to the numbers on the XPlane Output screen
|
||||
% IP Address (optional): IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)
|
||||
% port (optional): Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp
|
||||
%
|
||||
% Outputs
|
||||
% status: If there was an error. Status<0 means there was an error.
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. values = [1, 2, 3, 27, 40];
|
||||
% 3. status = selectDATA( values, '127.0.0.1', 49005 ); % send to localhose port 49005
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Added Versioning
|
||||
% 06/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
% BEGIN CODE
|
||||
|
||||
import XPlaneConnect.*
|
||||
|
||||
%% Handle Input
|
||||
p = inputParser;
|
||||
addRequired(p,'index');
|
||||
addOptional(p,'IP','127.0.0.1',@ischar);
|
||||
addOptional(p,'port',49009,@isnumeric);
|
||||
parse(p,index,varargin{:});
|
||||
|
||||
%% BODY
|
||||
dataString = ['DSEL'-0,0];
|
||||
for i=1:length(index)
|
||||
dataString = [dataString, p.Results.index(i), 0, 0, 0];
|
||||
end
|
||||
status = sendUDP(dataStream, p.Results.IP, p.Results.port);
|
||||
|
||||
end
|
||||
|
||||
66
MATLAB/+XPlaneConnect/sendCTRL.m
Normal file
66
MATLAB/+XPlaneConnect/sendCTRL.m
Normal file
@@ -0,0 +1,66 @@
|
||||
function [ status ] = sendCTRL( ctrl, acft, IP, port )
|
||||
% sendCTRL Send X-Plane Aircraft Control Commands over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% ctrl: control array where the elements are as follows:
|
||||
% 1. Latitudinal Stick [-1,1]
|
||||
% 2. Longitudinal Stick [-1,1]
|
||||
% 3. Pedal [-1, 1]
|
||||
% 4. Throttle [-1, 1]
|
||||
% 5. Gear (0=up, 1=down)
|
||||
% 6. Flaps [0, 1]
|
||||
% acft (optional): Aircraft # (default is 0; 0 = own aircraft)
|
||||
% IP Address (optional): IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)
|
||||
% port (optional): Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp
|
||||
%
|
||||
% Outputs
|
||||
% status: If there was an error. Status<0 means there was an error.
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. #Send the data array to port 49009 on the computer at IP address 172.0.100.54.
|
||||
% 3. status = sendCTRL([0, 0, 0, 0.8, 0, 1], 1, '172.0.100.54',49009);
|
||||
%
|
||||
% Note: send the value -998 to not overwrite that parameter. That is, if -998 is sent, the parameter will stay at the current X-Plane value
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 09/26/14: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
% BEGIN CODE
|
||||
|
||||
import XPlaneConnect.*
|
||||
|
||||
%% Handle Input
|
||||
% Optional parameters
|
||||
if ~exist('IP','var'), IP = "127.0.0.1"; end
|
||||
if ~exist('port','var'), port = 49009; end
|
||||
if ~exist('acft','var'), acft = 0; end
|
||||
|
||||
% Check format of input-TODO
|
||||
|
||||
%%BODY
|
||||
header = ['CTRL'-0,0];
|
||||
dataStream = [header, acft];
|
||||
|
||||
% Deal with position update
|
||||
control = [0, 0, 0, 0.8, 0, 1];
|
||||
|
||||
for i=1:min(length(ctrl),length(control))
|
||||
control(i) = ctrl(i);
|
||||
end
|
||||
dataStream = [dataStream, typecast(single(control),'uint8')];
|
||||
|
||||
% Send DATA
|
||||
status = sendUDP(IP, port, dataStream);
|
||||
|
||||
end
|
||||
|
||||
63
MATLAB/+XPlaneConnect/sendDATA.m
Normal file
63
MATLAB/+XPlaneConnect/sendDATA.m
Normal file
@@ -0,0 +1,63 @@
|
||||
function [ status ] = sendDATA(data, varargin)
|
||||
% sendDATA Send X-Plane formatted DATA over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% data: X-Plane formatted data. Is a matlab structure with the following fields:
|
||||
% .h: Header array containing header numbers corresponding to values in the X-Plane UDP Data screen.
|
||||
% .d: 2-D Data array. Each row contains eight values corresponding to the header value (.h(1) corresponds to .d(1,:))
|
||||
% IP Address (optional): IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)
|
||||
% port (optional): Port on the receiving machine where the data will be sent . Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp interface.
|
||||
%
|
||||
% Outputs
|
||||
% status: 0: no error, <0: error
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. data = struct('h',27,'d',[1,-998,-998,-998,-998,-998,-998,-998]);
|
||||
% 3. %Send the data array to port 49005 on the computer at IP address 172.0.100.54.
|
||||
% 4. status = sendDATA(data, '172.0.100.54', 49005);
|
||||
%
|
||||
% Note: send the value -998 to not overwrite that parameter. That is, if -998 is sent, the parameter will stay at the current X-Plane value
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Updated to work with new Plugin
|
||||
% 06/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
%
|
||||
% BEGIN CODE
|
||||
|
||||
import XPlaneConnect.*
|
||||
|
||||
%% Handle Input
|
||||
p = inputParser;
|
||||
addRequired(p,'data');
|
||||
addOptional(p,'IP','127.0.0.1',@ischar);
|
||||
addOptional(p,'port',49009,@isnumeric);
|
||||
parse(p,data,varargin{:});
|
||||
|
||||
%% BODY
|
||||
|
||||
header = ['DATA'-0,0];
|
||||
dataStream = header;
|
||||
|
||||
for i=1:length(p.Results.data.h)
|
||||
dataStream = [dataStream, p.Results.data.h(i), 0, 0, 0, typecast(single(p.Results.data.d(i,1:8)),'uint8')]; %#ok<AGROW>
|
||||
end
|
||||
|
||||
% Send DATA
|
||||
if length(dataStream) > 5
|
||||
status = sendUDP(dataStream, p.Results.IP, p.Results.port);
|
||||
else
|
||||
disp('Warning in sendDATA: Sending empty dataStream')
|
||||
status = -2;
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
63
MATLAB/+XPlaneConnect/sendDREF.m
Normal file
63
MATLAB/+XPlaneConnect/sendDREF.m
Normal file
@@ -0,0 +1,63 @@
|
||||
function status = sendDREF( dataRef, Value, varargin )
|
||||
% sendDREF Send a command to change any DataRef in X-Plane over UDP. This requires the X-Plane Connect Plugin to be running
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% dataRef: The X-Plane Dataref that will be chaged
|
||||
% Value: The value that the above dataref is set to
|
||||
% IP Address (optional): IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)
|
||||
% port (optional): Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp
|
||||
%
|
||||
% Outputs
|
||||
% status: If there was an error. status<0 means there was an error.
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*
|
||||
% 2. dataRef = 'sim/aircraft/parts/acf_gear_deploy'; // Landing Gear
|
||||
% 3. Value = 0;
|
||||
% 4. status = sendDREF(dataRef, Value);
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: First Version
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
% BEGIN CODE
|
||||
|
||||
import XPlaneConnect.*
|
||||
|
||||
status = 0;
|
||||
|
||||
%% Handle Input
|
||||
p = inputParser;
|
||||
addRequired(p,'dataRef');
|
||||
addRequired(p,'Value');
|
||||
addOptional(p,'IP','127.0.0.1',@ischar);
|
||||
addOptional(p,'port',49009,@isnumeric);
|
||||
parse(p,dataRef, Value ,varargin{:});
|
||||
|
||||
%% BODY
|
||||
dataStream = zeros(1,7+length(p.Results.dataRef)+length(p.Results.Value)*4);
|
||||
% Build Header
|
||||
dataStream(1:4) = 'DREF'-0;
|
||||
|
||||
% Add DREF
|
||||
dataStream(6) = uint8(length(p.Results.dataRef));
|
||||
len = 6+length(p.Results.dataRef);
|
||||
dataStream(7:len)=p.Results.dataRef-0;
|
||||
|
||||
% Add Value
|
||||
dataStream(len+1) =uint8(length(p.Results.Value));
|
||||
dataStream(len+2:end)=typecast(single(p.Results.Value),'uint8');
|
||||
|
||||
% Send DREF
|
||||
if length(dataStream) > 5
|
||||
status = sendUDP(dataStream, p.Results.IP, p.Results.port);
|
||||
end
|
||||
end
|
||||
66
MATLAB/+XPlaneConnect/sendPOSI.m
Normal file
66
MATLAB/+XPlaneConnect/sendPOSI.m
Normal file
@@ -0,0 +1,66 @@
|
||||
function [ status ] = sendPOSI( posi, varargin )
|
||||
% sendPOSI Send X-Plane Aircraft Position over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% posi: Position array where the elements are as follows:
|
||||
% 1. Latitiude (deg)
|
||||
% 2. Longitude (deg)
|
||||
% 3. Altitude (m above MSL)
|
||||
% 4. Roll (deg)
|
||||
% 5. Pitch (deg)
|
||||
% 6. True Heading (deg)
|
||||
% 7. Gear (0=up, 1=down)
|
||||
% acft (optional): Aircraft # (default is 0; 0 = own aircraft)
|
||||
% IP Address (optional): IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)
|
||||
% port (optional): Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp
|
||||
%
|
||||
% Outputs
|
||||
% status: If there was an error. Status<0 means there was an error.
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. #Send the data array to port 49009 on the computer at IP address 172.0.100.54.
|
||||
% 3. status = sendPOSI([37.5242422, -122.06899, 2500, 0, 0, 0, 1], 1, '172.0.100.54');
|
||||
%
|
||||
% Note: send the value -998 to not overwrite that parameter. That is, if -998 is sent, the parameter will stay at the current X-Plane value
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 09/25/14: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
%
|
||||
% BEGIN CODE
|
||||
|
||||
import XPlaneConnect.*
|
||||
|
||||
%% Handle Input
|
||||
p = inputParser;
|
||||
addRequired(p,'posi');
|
||||
addOptional(p,'acft',0,@isnumeric);
|
||||
addOptional(p,'IP','127.0.0.1',@ischar);
|
||||
addOptional(p,'port',49009,@isnumeric);
|
||||
parse(p,posi,varargin{:});
|
||||
|
||||
%% BODY
|
||||
header = ['POSI'-0,0];
|
||||
dataStream = [header, p.Results.acft];
|
||||
|
||||
% Deal with position update
|
||||
position = [37.4185718,-121.935565,500,0,0,0, 0];
|
||||
|
||||
for i=1:min(length(position),length(p.Results.posi))
|
||||
position(i) = p.Results.posi(i);
|
||||
end
|
||||
dataStream = [dataStream, typecast(single(position),'uint8')];
|
||||
|
||||
% Send POSI
|
||||
status = sendUDP(dataStream, p.Results.IP, p.Results.port);
|
||||
|
||||
end
|
||||
|
||||
63
MATLAB/+XPlaneConnect/sendSTRU.m
Normal file
63
MATLAB/+XPlaneConnect/sendSTRU.m
Normal file
@@ -0,0 +1,63 @@
|
||||
function [ status ] = sendSTRU( STRU, varargin )
|
||||
%sendSTRU Send a MATLAB structure over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
%Inputs
|
||||
% stru: A MATLAB structure
|
||||
% IP Address (optional): IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)
|
||||
% port (optional): Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin
|
||||
%
|
||||
%Outputs
|
||||
% status: If there was an error. Status<0 means there was an error.
|
||||
%
|
||||
%Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. data = struct('a',[1:20],'b',1.853,'name','Example Structure');
|
||||
% 3. #Send the data structure to port 49005 on the computer at IP address 172.0.100.54
|
||||
% 4. status = sendUDP( data, '172.0.100.54', 49005 );
|
||||
%
|
||||
%Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Added Versioning
|
||||
% 08/01/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
%
|
||||
%BEGIN CODE
|
||||
|
||||
import XPlaneConnect.*
|
||||
|
||||
%% Handle Input
|
||||
p = inputParser;
|
||||
addRequired(p,'STRU');
|
||||
addOptional(p,'IP','127.0.0.1',@ischar);
|
||||
addOptional(p,'port',49009,@isnumeric);
|
||||
parse(p,STRU,varargin{:});
|
||||
|
||||
%% Form Data Array representing the structure
|
||||
DATA = ['STRU'-0,0]; %array header
|
||||
fieldName = fieldnames(p.Results.STRU); %all Struct fields
|
||||
for i=1:length(fieldName) %for each field
|
||||
field = getfield(p.Results.STRU,fieldName{i}); %get field
|
||||
if ischar(field) %String
|
||||
dim1 = 0; %Indicates string
|
||||
dim2 = length(field); %length
|
||||
data = field-0; %data
|
||||
else %Numeric
|
||||
dim1 = size(field,1); %Array Dim1
|
||||
dim2 = size(field,2); %Array Dim2
|
||||
data = typecast(single(reshape(field',1,dim1*dim2)),'uint8'); %Data
|
||||
end
|
||||
|
||||
DATA = [DATA,length(fieldName{i}),fieldName{i}-0,dim1,dim2,data]; %add to array
|
||||
end
|
||||
|
||||
%% Send Array
|
||||
status = sendUDP(DATA, p.Results.IP, p.Results.port);
|
||||
|
||||
end
|
||||
|
||||
64
MATLAB/+XPlaneConnect/sendUDP.m
Normal file
64
MATLAB/+XPlaneConnect/sendUDP.m
Normal file
@@ -0,0 +1,64 @@
|
||||
function [ status ] = sendUDP( data, IP, port )
|
||||
%sendUDP Send an one dimensional array of type uint8 data over an UDP connection using a java DatagramSocket
|
||||
% Version 0.25
|
||||
%
|
||||
%Inputs
|
||||
% Data: 1-D array of type uint8 data to be sent
|
||||
% IP Address (optional): IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)
|
||||
% port (optional): Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin
|
||||
%
|
||||
%Outputs
|
||||
% status: If there was an error. Status<0 means there was an error.
|
||||
%
|
||||
%Use
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. data = uint8([1:20]);
|
||||
% 3. #Send the data array to port 49005 on the computer at IP address 172.0.100.54.
|
||||
% 4. status = sendUDP( data, '172.0.100.54', 49005 );
|
||||
%
|
||||
%Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 09/25/14: [CT] V0.24: Added persistant socket
|
||||
% 04/21/14: [CT] V0.2:Added Versioning, support for DREF/SIMU/GETD/CONN
|
||||
% 06/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
%BEGIN CODE
|
||||
|
||||
import java.net.DatagramSocket
|
||||
import java.net.DatagramPacket
|
||||
import java.net.InetAddress
|
||||
|
||||
data(5) = length(data);
|
||||
status = 0;
|
||||
|
||||
%% Send array
|
||||
persistent socket
|
||||
if isempty(socket)
|
||||
try
|
||||
socket = DatagramSocket;
|
||||
catch err
|
||||
status = 1;
|
||||
disp(err)
|
||||
end
|
||||
end
|
||||
|
||||
try
|
||||
IP = InetAddress.getByName(IP);
|
||||
packet = DatagramPacket(data, length(data), IP, port); %create packet
|
||||
socket.send(packet);
|
||||
catch err
|
||||
status = 1;
|
||||
disp(err)
|
||||
end
|
||||
|
||||
|
||||
|
||||
end
|
||||
|
||||
52
MATLAB/+XPlaneConnect/setConn.m
Normal file
52
MATLAB/+XPlaneConnect/setConn.m
Normal file
@@ -0,0 +1,52 @@
|
||||
function status = setConn( recvPort, IP, port )
|
||||
% setConn Send a command to set up the port where you will receive data on
|
||||
% this computer.
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% Receiving Port: Port that data will be sent to in the future for this connection
|
||||
% IP Address (optional): IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)
|
||||
% port (optional): Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp
|
||||
%
|
||||
% Outputs
|
||||
% status: If there was an error. status<0 means there was an error.
|
||||
%
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*
|
||||
% 2. status = setConn(49011);
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/21/14: [CT] V0.2: First Version
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
%
|
||||
% To Do
|
||||
% 1. Verify Input
|
||||
%
|
||||
% BEGIN CODE
|
||||
import XPlaneConnect.*
|
||||
|
||||
status = 0;
|
||||
message = zeros(1,9);
|
||||
|
||||
%% Handle Input
|
||||
% Optional parameters
|
||||
if ~exist('IP','var'), IP = "127.0.0.1"; end
|
||||
if ~exist('port','var'), port = 49009; end
|
||||
|
||||
% Check format of input-TODO
|
||||
|
||||
%% BODY
|
||||
% Header
|
||||
message(1:4) = 'CONN'-0;
|
||||
|
||||
% RecvPort
|
||||
message(6:9) = typecast(uint32(recvPort),'uint8');
|
||||
|
||||
% Send
|
||||
sendUDP(IP,port,message);
|
||||
|
||||
end
|
||||
122
MATLAB/Documentation (MATLAB).html
Normal file
122
MATLAB/Documentation (MATLAB).html
Normal file
@@ -0,0 +1,122 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<h1>XPC-MATLAB</h1>
|
||||
Version 0.25 September 29, 2014<br />
|
||||
Chris Teubert (Christopher.A.Teubert@nasa.gov)<br />
|
||||
|
||||
<h2>Summary</h2>
|
||||
XPC-MATLAB is a series of MATLAB functions that facilitate communication with X-Plane. This toolbox allows for the real-time application of active control to an XPlane simulation, flight visualization, record state during a flight, or interact with a mission using UDP.
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
<ol>
|
||||
<li><a href="#Func">Functions</a></li>
|
||||
<li><a href="#Setup">Setup</a>
|
||||
<li><a href="#Use">Use</a></li>
|
||||
<li><a href="#Example">Example</a></li>
|
||||
<li><a href="#Future">Future Work</a></li>
|
||||
<li><a href="#Notice">Notices and Disclaimers</a></li>
|
||||
<li><a href="#Changes">Change Log</a></li>
|
||||
</ol>
|
||||
|
||||
<a id="Func"><h2>Functions</h2></a>
|
||||
<h3>Basic Package</h3>
|
||||
|
||||
<table><tr><td width="150px">
|
||||
- <a href="pages/sendDATA.html"><b>sendDATA:</b></a></td><td>
|
||||
Send X-Plane Formatted DATA over UDP</td></tr><tr><td>
|
||||
- <a href="pages/sendPOSI.html"><b>sendPOSI:</b></a></td><td>
|
||||
Send Position and orientation update command to X-Plane over UDP for any aircraft (own or traffic)</td></tr><tr><td>
|
||||
- <a href="pages/sendCTRL.html"><b>sendCTRL:</b></a></td><td>
|
||||
Send control commands to X-Plane over UDP for any aircraft (own or traffic)</td></tr><tr><td>
|
||||
- <a href="pages/sendDREF.html"><b>sendDREF:</b></a></td><td>
|
||||
Set any X-Plane internal variable (dataref) over UDP </td></tr><tr><td>
|
||||
- <a href="pages/selectDATA.html"><b>selectDATA:</b></a></td><td>
|
||||
Choose specific X-Plane DATA parameters to be sent by X-Plane over UDP</td></tr><tr><td>
|
||||
- <a href="pages/setConn.html"><b>setConn:</b></a></td><td>
|
||||
Sets the return port for requested datarefs.</td></tr><tr><td>
|
||||
- <a href="pages/pauseSim.html"><b>pauseSim:</b></a></td><td>
|
||||
Pause simulation</td></tr><tr><td>
|
||||
- <a href="pages/openUDP.html"><b>openUDP:</b></a></td><td>
|
||||
Script that opens an UDP Socket</td></tr><tr><td>
|
||||
- <a href="pages/closeUDP.html"><b> closeUDP:</b></a></td><td>
|
||||
Script that closes an UDP Socket</td></tr>
|
||||
</table>
|
||||
|
||||
<h3>Advanced/Special-Use Functions</h3>
|
||||
<table><tr><td width="150px">
|
||||
- <a href="pages/clearUDPBuffer.html"><b> clearUDPBuffer:</b></a></td><td>
|
||||
Script that clears an UDP Socket Buffer</td></tr><tr><td>
|
||||
- <a href="pages/readDATA.html"><b>readDATA:</b></a></td><td>
|
||||
Read X-Plane Formatted Data from UDP Socket</td></tr><tr><td>
|
||||
- <a href="pages/readUDP.html"><b>readUDP:</b></a></td><td>
|
||||
Read Array from UDP Socket</td></tr><tr><td>
|
||||
- <a href="pages/sendSTRU.html"><b>sendSTRU:</b></a></td><td>
|
||||
Send a MATLAB structure over UDP</td></tr><tr><td>
|
||||
- <a href="pages/sendUDP.html"><b>sendUDP:</b></a></td><td>
|
||||
Send array over UDP</td></tr>
|
||||
</table>
|
||||
|
||||
<h3>Future</h3>
|
||||
<table><tr><td width="150px">
|
||||
- <a href="pages/requestDREF.html"><b>requestDREF:</b></a></td><td>
|
||||
Request the value of a specific data ref</td></tr><tr><td>
|
||||
- <b>drawWaypoint:</b></td><td>
|
||||
NOT FUNCTIONAL</td></tr>
|
||||
</table>
|
||||
|
||||
<a id="Setup"><h2>Setup</h2></a>
|
||||
Before using XPC Functions you must
|
||||
1. Install X-Plane (http://www.x-plane.com)
|
||||
2. Copy the file xpcPlugin.xpl to the "[X-Plane Directory]/Resources/plugins" directory.
|
||||
a. For Mac xpcPlugin can be found in the "[XPlaneConnect]/xpcPlugin/Mac" directory.
|
||||
a. For Windows xpcPlugin can be found in the "[XPlaneConnect]/xpcPlugin/Win" directory.
|
||||
3. Insert X-Plane CD 1 or X-Plane USB Key.
|
||||
4. Start X-Plane.
|
||||
5. import XPlaneConnect.*
|
||||
|
||||
<a id="Example"><h2>Examples</h2></a>
|
||||
<h3>Files</h3>
|
||||
TO BE ADDED
|
||||
<h3>Description</h3>
|
||||
|
||||
<a id="Future"><h2>Future Work</h2></a>
|
||||
<ul>
|
||||
<li> </li>
|
||||
</ul>
|
||||
|
||||
<a id="Notice"><h2>Notices and Disclaimers</h2></a>
|
||||
<b>Notices:</b><br />
|
||||
Copyright ©2013-2014 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.<br />
|
||||
|
||||
<br/><b>Disclaimers:</b>
|
||||
|
||||
<p><b>No Warranty:</b> THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER, CONSTITUTE AN ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT OF ANY RESULTS, RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY OTHER APPLICATIONS RESULTING FROM USE OF THE SUBJECT SOFTWARE. FURTHER, GOVERNMENT AGENCY DISCLAIMS ALL WARRANTIES AND LIABILITIES REGARDING THIRD-PARTY SOFTWARE, IF PRESENT IN THE ORIGINAL SOFTWARE, AND DISTRIBUTES IT "AS IS."</p>
|
||||
|
||||
<p><b>Waiver and Indemnity:</b> RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT. IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS IN ANY LIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH USE, INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S USE OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW. RECIPIENT'S SOLE REMEDY FOR ANY SUCH MATTER SHALL BE THE IMMEDIATE, UNILATERAL TERMINATION OF THIS AGREEMENT.</p>
|
||||
|
||||
<br /><b>X-Plane API</b><br/>
|
||||
Copyright (c) 2008, Sandy Barbour and Ben Supnik All rights reserved.<br/>
|
||||
<p>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:</p>
|
||||
<ul>
|
||||
<li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>
|
||||
<li>Neither the names of the authors nor that of X-Plane or Laminar Research may be used to endorse or promote products derived from this software without specific prior written permission from the authors or Laminar Research, respectively.</li>
|
||||
</ul>
|
||||
|
||||
<p>X-Plane API SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
|
||||
|
||||
<a id="Changes"><h2>Change Log</h2></a>
|
||||
-October 16, 2014 (Chris Teubert): Added Notices and Disclaimers<br />
|
||||
-September 29, 2014 (Chris Teubert): Updated documentation to use new plugin</br />
|
||||
-September 11, 2013 (Chris Teubert): Updated for Version 0.7<br />
|
||||
-February 13, 2013 (Chris Teubert): Hello World!
|
||||
|
||||
</body>
|
||||
</html>
|
||||
37
MATLAB/pages/clearUDPBuffer.html
Normal file
37
MATLAB/pages/clearUDPBuffer.html
Normal file
@@ -0,0 +1,37 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-ClearUDPBuffer</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>clearUDPBuffer</h1>
|
||||
Script that clears an UDP Socket Buffer
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>Socket:</b> UDP Socket to be cleared</li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>Socket:</b> UDP Socket</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. Socket = openUDP(49005); <br />
|
||||
3. Socket = clearUDPBuffer(Socket);<br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
09/12/13: [CT] Add optional arguments<br />
|
||||
09/10/13: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
36
MATLAB/pages/closeUDP.html
Normal file
36
MATLAB/pages/closeUDP.html
Normal file
@@ -0,0 +1,36 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-closeUDP</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>closeUDP</h1>
|
||||
Script that closes a UDP Socket
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>Socket:</b> UDP Socket to be closed</li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>Status:</b> Integer indicating the success of socket closing. 1 = Success 0 = Failure</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*; <br />
|
||||
2. Socket = openUDP(49005); <br />
|
||||
3. Status = closeUDP(Socket);<br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
09/10/13: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
39
MATLAB/pages/openUDP.html
Normal file
39
MATLAB/pages/openUDP.html
Normal file
@@ -0,0 +1,39 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-openUDP</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>openUDP</h1>
|
||||
Script that opens a UDP Socket
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>port:</b> UDP Port for socket</li>
|
||||
<li><b>timeout (optional):</b> Optional parameter for time to UDP timeout (in ms)-Default 0.1 seconds</li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>Socket:</b> UDP Socket</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. Socket = openUDP(49005);%Open socket at port 49005 with timeout of 0.1 seconds <br /><br />
|
||||
or<br/><br/>
|
||||
2. Socket = openUDP(49005,200);%Open socket at port 49005 with timeout of 0.2 seconds<br /><br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
09/12/13: [CT] Added optional timeout input argument<br />
|
||||
09/10/13: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
36
MATLAB/pages/pauseSim.html
Normal file
36
MATLAB/pages/pauseSim.html
Normal file
@@ -0,0 +1,36 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-pauseSim</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>pauseSim</h1>
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>Pause:</b> binary value 0=run, 1=pause</li>
|
||||
<li><b>IP Address (optional):</b> IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)</li>
|
||||
<li><b>port (optional):</b> Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp </li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>status:</b> If there was an error. status<0 means there was an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. status = pauseSim(1);<br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
06/10/13: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
59
MATLAB/pages/readDATA.html
Normal file
59
MATLAB/pages/readDATA.html
Normal file
@@ -0,0 +1,59 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-readDATA</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>readDATA</h1>
|
||||
Reads UDP Socket and interprets data
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>location:</b> Either an opened UDP Socket or integer port number</li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
If data is X-Plane data format:
|
||||
<ul>
|
||||
<li><b>data:</b> Matlab X-Plane DATA Structure<ul>
|
||||
<li>.h: Header array containing header numbers corresponding to values in the X-Plane UDP Data screen. </li>
|
||||
<li>.d: 2-D Data array. Each row contains eight values corresponding to the header value (.h(1) corresponds to .d(1,:))</li>
|
||||
<li>.raw: raw UDP data array received by readUDP</li></ul></li>
|
||||
</ul>
|
||||
If data is matlab structure:
|
||||
<ul>
|
||||
<li><b>data:</b> Matlab Structure. Raw udp data saved to data.raw</li>
|
||||
</ul>
|
||||
If data is any other format:
|
||||
<ul>
|
||||
<li><b>data:</b> Matlab Structure containing one field <ul>
|
||||
<li>.raw & .d: raw UDP data array received by readUDP</li></ul></li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. socket = openUDP(49005); <br />
|
||||
3. data = readDATA(socket); <br />
|
||||
4. status = closeUDP(socket); <br /><br />
|
||||
|
||||
or <br /> <br />
|
||||
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. data = readDATA(49005);
|
||||
|
||||
<h2>Note</h2>
|
||||
NOTE: sending in a port number instead of an opened socket clears the UDP buffer. This only works if the data is being sent at a fast rate. Sending in a UDP Socket reads the first packet in the buffer. <br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
09/10/13: [CT] Updated to receive UDP socket or port number<br />
|
||||
06/10/13: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
43
MATLAB/pages/readUDP.html
Normal file
43
MATLAB/pages/readUDP.html
Normal file
@@ -0,0 +1,43 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-readUDP</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>readUDP</h1>
|
||||
Read Array from UDP Socket
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>location:</b> Either an opened UDP Socket or integer port number</li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>data:</b> UDP uint8 Array. Equal to -998 in the case of an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. socket = openUDP(49005); <br />
|
||||
3. data = readUDP(socket); <br />
|
||||
4. status = closeUDP(socket); <br /><br />
|
||||
|
||||
or <br /> <br />
|
||||
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. data = readUDP(49005); <br />
|
||||
|
||||
<h2>Note</h2>
|
||||
NOTE: sending in a port number instead of an opened socket clears the UDP buffer. This only works if the data is being sent at a fast rate. Sending in a UDP Socket reads the first packet in the buffer.
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
09/08/13: [CT] Added option for either UDP Socket or port number input <br/>
|
||||
06/10/13: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
37
MATLAB/pages/requestDREF.html
Normal file
37
MATLAB/pages/requestDREF.html
Normal file
@@ -0,0 +1,37 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-requestDREF</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>requestDREF</h1>
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>DREFArray:</b> Cell Array of DataRefs to be requested</li>
|
||||
<li><b>IP Address (optional):</b> IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)</li>
|
||||
<li><b>port (optional):</b> Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin </li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>status:</b> If there was an error. status<0 means there was an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*; <br />
|
||||
2. DREFArray = {'sim/cockpit2/controls/yoke_heading_ratio','sim/cockpit2/controls/yoke_roll_ratio'}; <br />
|
||||
3. status = requestDREF( DREFArray, '172.0.100.54' );<br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
06/10/13: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
39
MATLAB/pages/selectDATA.html
Normal file
39
MATLAB/pages/selectDATA.html
Normal file
@@ -0,0 +1,39 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-selectDATA</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>selectDATA</h1>
|
||||
Choose specific X-Plane parameters to be send over UDP
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>index:</b> An array of the values that to be sent. Corresponds to the numbers on the XPlane Output screen (ACTUAL NAME?)</li>
|
||||
<li><b>IP Address (optional):</b> IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)</li>
|
||||
<li><b>port (optional):</b> Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp </li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>status:</b> If there was an error. Status<0 means there was an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. values = [1, 2, 3, 27, 40];
|
||||
3. status = selectDATA(values,'127.0.0.1',49005);<br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
04/18/14: [CT] V0.2: Added Versioning<br />
|
||||
06/10/13: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
48
MATLAB/pages/sendCTRL.html
Normal file
48
MATLAB/pages/sendCTRL.html
Normal file
@@ -0,0 +1,48 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-sendCTRL</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>sendCTRL</h1>
|
||||
Send position and orientation update command to X-Plane over UDP. This requires the X-Plane Connect Plugin to be running
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>ctrl:</b> Array of 6 values where:
|
||||
<ul>
|
||||
<li>ctrl(1) Latitudinal Stick [-1,1] </li>
|
||||
<li>ctrl(2) Longitudinal Stick [-1,1] </li>
|
||||
<li>ctrl(3) Pedal [-1, 1] </li>
|
||||
<li>ctrl(4) Throttle [-1, 1] </li>
|
||||
<li>ctrl(5) Gear (0=up, 1=down) </li>
|
||||
<li>ctrl(6) Flaps [0, 1] </li>
|
||||
</ul>
|
||||
<li><b>aircraft number (optional):</b> 0=own aircraft</li>
|
||||
<li><b>IP Address (optional):</b> IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)</li>
|
||||
<li><b>port (optional):</b> Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp </li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>status:</b> If there was an error. status<0 means there was an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. ctrl = [0, 0, 0, 0.8, 0, 0];
|
||||
3. status = sendCTRL(ctrl); % Set position of own aircraft<br />
|
||||
4. status2 = sendCTRL(ctrl,1); % Set position of aircraft 1<br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9 Updated to use new xpcPlugin<br />
|
||||
09/26/14: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
46
MATLAB/pages/sendDATA.html
Normal file
46
MATLAB/pages/sendDATA.html
Normal file
@@ -0,0 +1,46 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-sendDATA</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation%20(MATLAB).html"><-- Back</a><br />
|
||||
<h1>sendDATA</h1>
|
||||
Send X-Plane formatted DATA over UDP. This function is used to change one of the parameters listed in the x-plane udp data screen (see http://www.nuclearprojects.com/xplane/images/xp_datainout.jpg)
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>data:</b> X-Plane formatted data. Is a matlab structure with the following fields:
|
||||
<ul>
|
||||
<li>.h: Header array containing header numbers corresponding to values in the X-Plane UDP Data screen. </li>
|
||||
<li>.d: 2-D Data array. Each row contains eight values corresponding to the header value (.h(1) corresponds to .d(1,:))</li>
|
||||
</ul></li>
|
||||
<li><b>IP Address (optional):</b> IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)</li>
|
||||
<li><b>port (optional):</b> Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp </li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>status:</b> If there was an error. Status=1 means there was an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. data = struct('h',14,'d',[1,-998,-998,-998,-998,-998,-998,-998]); %Set Gear<br />
|
||||
3. %Send the data array to port 49005 on the computer at IP address 172.0.100.54.<br />
|
||||
4. status = sendDATA(data, '172.0.100.54', 49005);
|
||||
|
||||
<h2>note</h2>
|
||||
Note: send the value -998 to not overwrite that parameter. That is, if -998 is sent, the parameter will stay at the current X-Plane value<br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/01/14: [CT] V0.9: updated to function with new xpcPlugin<br />
|
||||
06/10/13: [CT] First created<br /><br />
|
||||
<a href="../Documentation%20(MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
48
MATLAB/pages/sendDREF.html
Normal file
48
MATLAB/pages/sendDREF.html
Normal file
@@ -0,0 +1,48 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-sendCTRL</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>sendCTRL</h1>
|
||||
Send position and orientation update command to X-Plane over UDP. This requires the X-Plane Connect Plugin to be running
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<ul>
|
||||
<li>data(1) Latitudinal Stick [-1,1] </li>
|
||||
<li>data(2) Longitudinal Stick [-1,1] </li>
|
||||
<li>data(3) Pedal [-1, 1] </li>
|
||||
<li>data(4) Throttle [-1, 1] </li>
|
||||
<li>data(5) Gear (0=up, 1=down) </li>
|
||||
<li>data(6) Flaps [0, 1] </li>
|
||||
</ul>
|
||||
<li><b>aircraft number (optional):</b> 0=own aircraft</li>
|
||||
<li><b>IP Address (optional):</b> IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)</li>
|
||||
<li><b>port (optional):</b> Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp </li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>status:</b> If there was an error. status<0 means there was an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.* <br />
|
||||
2. dataRef = 'sim/aircraft/parts/acf_gear_deploy'; // Landing Gear <br />
|
||||
3. Value = 0; <br />
|
||||
4. status = sendDREF(dataRef, Value); <br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to use new xpcPlugin
|
||||
06/10/13: [CT] Code created<br /><br />
|
||||
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
50
MATLAB/pages/sendPOSI.html
Normal file
50
MATLAB/pages/sendPOSI.html
Normal file
@@ -0,0 +1,50 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-sendDREF</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>sendPosition</h1>
|
||||
Send position and orientation update command to X-Plane over UDP. This requires the X-Plane Connect Plugin to be running
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>data:</b> Array of 6 values where:
|
||||
<ul>
|
||||
<li>data(1) is the aircraft's Latitude (degrees) </li>
|
||||
<li>data(2) is the aircraft's Longitude (degrees) </li>
|
||||
<li>data(3) is the aircraft's altitude (meters above sea level)</li>
|
||||
<li>data(4) is the aircraft's roll angle (degrees)</li>
|
||||
<li>data(5) is the aircraft's pitch angle (degrees)</li>
|
||||
<li>data(6) is the aircraft's heading/yaw angle (degrees)</li>
|
||||
</ul>
|
||||
<li><b>aircraft number (optional):</b> 0=own aircraft</li>
|
||||
<li><b>IP Address (optional):</b> IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)</li>
|
||||
<li><b>port (optional):</b> Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp </li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>status:</b> If there was an error. status<0 means there was an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. latlon = [37.4185718,-121.935565]; %Lat,lon of NASA Ames Research Center<br />
|
||||
3. alt = 500; %meters above sea level<br />
|
||||
4. orient = [0,20,180]; %Orientation (roll,pitch,yaw/heading). 20 degrees yaw, heading south<br />
|
||||
5. status = sendPOSI([latlon,alt,orient]); % Set position of own aircraft<br />
|
||||
6. status2 = sendPOSI([[latlon(1)+0.005,latlon(2)],alt,orient],1); % Set position of aircraft 1<br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9 Updated to use new xpcPlugin<br />
|
||||
06/10/13: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
39
MATLAB/pages/sendSTRU.html
Normal file
39
MATLAB/pages/sendSTRU.html
Normal file
@@ -0,0 +1,39 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-sendSTRU</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>sendSTRU</h1>
|
||||
Send a MATLAB structure over UDP
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>stru:</b> A MATLAB structure</li>
|
||||
<li><b>IP Address (optional):</b> IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)</li>
|
||||
<li><b>port (optional):</b> Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin </li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>status:</b> If there was an error. Status<0 means there was an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. data = struct('a',[1:20],'b',1.853,'name','Example Structure');<br />
|
||||
3. #Send the data structure to port 49005 on the computer at IP address 172.0.100.54<br />
|
||||
4. status = sendSTRU( data, '172.0.100.54', 49005 ); <br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
08/01/13: [CT] Code created<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
39
MATLAB/pages/sendUDP.html
Normal file
39
MATLAB/pages/sendUDP.html
Normal file
@@ -0,0 +1,39 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-sendUDP</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>sendUDP</h1>
|
||||
Send an one dimensional array of type uint8 data over an UDP connection
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>data:</b> 1-D array of type uint8 data to be sent</li>
|
||||
<li><b>IP Address (optional):</b> IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)</li>
|
||||
<li><b>port (optional):</b> Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp </li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>status:</b> If there was an error. Status=1 means there was an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.*;<br />
|
||||
2. data = uint8([1:20]);<br />
|
||||
3. #Send the data array to port 49005 on the computer at IP address 172.0.100.54.<br />
|
||||
4. status = sendUDP( data, '172.0.100.54', 49005 ); <br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
06/10/13: [CT] Code created <br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
37
MATLAB/pages/setConn.html
Normal file
37
MATLAB/pages/setConn.html
Normal file
@@ -0,0 +1,37 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta http-equiv="Content-Style-Type" content="text/css">
|
||||
<title>XPlaneConnect Toolbox-setConn</title>
|
||||
<meta name="Generator" content="Cocoa HTML Writer">
|
||||
<meta name="CocoaVersion" content="1138.51">
|
||||
</head>
|
||||
<body>
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
<h1>setConn</h1>
|
||||
Send a command to set up the port where you will receive data on this computer.
|
||||
|
||||
<h2>Inputs</h2>
|
||||
<ul>
|
||||
<li><b>Receiving Port:</b> Port that data will be sent to in the future for this connection</li>
|
||||
<li><b>IP Address (optional):</b> IP Address of the machine that will receive the data as a character array. Default is '127.0.0.1' (local machine)</li>
|
||||
<li><b>port (optional):</b> Port on the receiving machine where the data will be sent. Default is 49009 (XPlaneConnect). In general use 49009 to send to the plugin and 49005 to send to the x-plane udp </li>
|
||||
</ul>
|
||||
|
||||
<h2>Outputs</h2>
|
||||
<ul>
|
||||
<li><b>status:</b> If there was an error. status<0 means there was an error.</li>
|
||||
</ul>
|
||||
|
||||
<h2>Use</h2>
|
||||
1. import XPlaneConnect.* <br />
|
||||
2. status = setConn(49011); <br />
|
||||
|
||||
<h2>Change Log</h2>
|
||||
10/02/14: [CT] V0.9: Updated to work with updated xpcPlugin<br />
|
||||
04/21/14: [CT] V0.2: First Version<br /><br />
|
||||
<a href="../Documentation (MATLAB).html"><-- Back</a><br />
|
||||
|
||||
</body>
|
||||
</html>
|
||||
67
Readme.txt
Normal file
67
Readme.txt
Normal file
@@ -0,0 +1,67 @@
|
||||
X-Plane Connect (XPC) Toolbox
|
||||
|
||||
Description
|
||||
The X-Plane Connect (XPC) Toolbox facilitates communication with X-Plane. This toolbox allows for the real-time manipulation of X-Plane variables. Possible applications include active control of an XPlane simulation, flight visualization, recording states during a flight, or interacting with a mission over UDP.
|
||||
|
||||
Architecture
|
||||
XPC includes a plugin (xpcPlugin) which is to be copied into the X-Plane Plugin Directory ([X-Plane Directory]/Resources/Plugin/), and the xpcScripts-A series of functions for communication with X-Plane.
|
||||
|
||||
xpcPlugin (Directory: xpcPlugin/)
|
||||
|
||||
xpcScripts
|
||||
C: (Directory: C/src/, Example: C/xpcExample/)
|
||||
MATLAB: (Directory: Matlab/+XPlaneConnect/, Example: MATLAB/xpcExample/)
|
||||
java: (future-Not complete yet): (Directory: java/src/, Example: java/xpcExample/)
|
||||
python: (future-Not complete yet): (Directory: python/xpc/, Example: python/xpcExample/)
|
||||
|
||||
Instructions:
|
||||
1. Purchase/Install X-Plane
|
||||
2. Copy the X-Plane Plugin to the plugin directory
|
||||
Windows Plugin: xpcPlugin/Win/xpcPlugin.xpl
|
||||
Mac Plugin: xpcPlugin/Mac/xpcPlugin.xpl
|
||||
Plugin Directory: [X-Plane Directory]/Resources/plugins/
|
||||
3. Write code using the xpcScrips to manipulate X-Plane
|
||||
|
||||
Capabilities:
|
||||
Set Aircraft Position (own or other aircraft): Use sendPOSI()
|
||||
Control Aircraft (own or other aircraft): Use sendCTRL()
|
||||
Set any internal X-Plane dataref: Use sendDREF()
|
||||
Get the value of any X-Plane dataref: Use requestDREF()
|
||||
Pause Simulation: Use pauseSim()
|
||||
|
||||
Compatability:
|
||||
Windows:
|
||||
Tested on Windows Vista and Windows 7
|
||||
Mac OSX
|
||||
Tested on OS X 10.8-10.10
|
||||
X-Plane
|
||||
Tested with X-Plane 9 & 10
|
||||
|
||||
Notices:
|
||||
|
||||
Copyright ©2013-2014 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.
|
||||
|
||||
Disclaimers
|
||||
|
||||
No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER, CONSTITUTE AN ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT OF ANY RESULTS, RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY OTHER APPLICATIONS RESULTING FROM USE OF THE SUBJECT SOFTWARE. FURTHER, GOVERNMENT AGENCY DISCLAIMS ALL WARRANTIES AND LIABILITIES REGARDING THIRD-PARTY SOFTWARE, IF PRESENT IN THE ORIGINAL SOFTWARE, AND DISTRIBUTES IT "AS IS."
|
||||
|
||||
Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT. IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS IN ANY LIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH USE, INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S USE OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW. RECIPIENT'S SOLE REMEDY FOR ANY SUCH MATTER SHALL BE THE IMMEDIATE, UNILATERAL TERMINATION OF THIS AGREEMENT.
|
||||
X-Plane API
|
||||
Copyright (c) 2008, Sandy Barbour and Ben Supnik All rights reserved.
|
||||
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:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
* Neither the names of the authors nor that of X-Plane or Laminar Research
|
||||
may be used to endorse or promote products derived from this software
|
||||
without specific prior written permission from the authors or
|
||||
Laminar Research, respectively.
|
||||
|
||||
X-Plane API SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
Version History:
|
||||
10/16/2014: [CT] Added Notices and Disclaimers
|
||||
10/03/2014: [CT] First version
|
||||
|
||||
Contributors:
|
||||
CT: Chris Teubert (christopher.a.teubert@nasa.gov)
|
||||
BIN
license.pdf
Normal file
BIN
license.pdf
Normal file
Binary file not shown.
BIN
xpcPlugin/Mac/xpcPlugin.xpl
Executable file
BIN
xpcPlugin/Mac/xpcPlugin.xpl
Executable file
Binary file not shown.
580
xpcPlugin/SDK/CHeaders/Widgets/XPStandardWidgets.h
Executable file
580
xpcPlugin/SDK/CHeaders/Widgets/XPStandardWidgets.h
Executable file
@@ -0,0 +1,580 @@
|
||||
#ifndef _XPStandardWidgets_h_
|
||||
#define _XPStandardWidgets_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* XPStandardWidgets - THEORY OF OPERATION
|
||||
*
|
||||
* The standard widgets are widgets built into the widgets library. While you
|
||||
* can gain access to the widget function that drives them, you generally use
|
||||
* them by calling XPCreateWidget and then listening for special messages,
|
||||
* etc.
|
||||
*
|
||||
* The standard widgets often send mesages to themselves when the user
|
||||
* performs an event; these messages are sent up the widget hierarchy until
|
||||
* they are handled. So you can add a widget proc directly to a push button
|
||||
* (for example) to intercept the message when it is clicked, or you can put
|
||||
* one widget proc on a window for all of the push buttons in the window.
|
||||
* Most of these messages contain the original widget ID as a parameter so you
|
||||
* can know which widget is messaging no matter who it is sent to.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPWidgetDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* MAIN WINDOW
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The main window widget class provides a "window" as the user knows it.
|
||||
* These windows are dragable and can be selected. Use them to create
|
||||
* floating windows and non-modal dialogs.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#define xpWidgetClass_MainWindow 1
|
||||
|
||||
/*
|
||||
* Main Window Type Values
|
||||
*
|
||||
* These type values are used to control the appearance of a main window.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* The standard main window; pin stripes on XP7, metal frame on XP 6. */
|
||||
xpMainWindowStyle_MainWindow = 0
|
||||
|
||||
/* A translucent dark gray window, like the one ATC messages appear in. */
|
||||
,xpMainWindowStyle_Translucent = 1
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* Main Window Properties
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This property specifies the type of window. Set to one of the main window *
|
||||
* types above. */
|
||||
xpProperty_MainWindowType = 1100
|
||||
|
||||
/* This property specifies whether the main window has close boxes in its *
|
||||
* corners. */
|
||||
,xpProperty_MainWindowHasCloseBoxes = 1200
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* MainWindow Messages
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This message is sent when the close buttons are pressed for your window. */
|
||||
xpMessage_CloseButtonPushed = 1200
|
||||
|
||||
|
||||
};
|
||||
|
||||
/***************************************************************************
|
||||
* SUB WINDOW
|
||||
***************************************************************************/
|
||||
/*
|
||||
* X-plane dialogs are divided into separate areas; the sub window widgets
|
||||
* allow you to make these areas. Create one main window and place several
|
||||
* subwindows inside it. Then place your controls inside the subwindows.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#define xpWidgetClass_SubWindow 2
|
||||
|
||||
/*
|
||||
* SubWindow Type Values
|
||||
*
|
||||
* These values control the appearance of the subwindow.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* A panel that sits inside a main window. */
|
||||
xpSubWindowStyle_SubWindow = 0
|
||||
|
||||
/* A screen that sits inside a panel for showing text information. */
|
||||
,xpSubWindowStyle_Screen = 2
|
||||
|
||||
/* A list view for scrolling lists. */
|
||||
,xpSubWindowStyle_ListView = 3
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* SubWindow Properties
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This property specifies the type of window. Set to one of the subwindow *
|
||||
* types above. */
|
||||
xpProperty_SubWindowType = 1200
|
||||
|
||||
|
||||
};
|
||||
|
||||
/***************************************************************************
|
||||
* BUTTON
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The button class provides a number of different button styles and
|
||||
* behaviors, including push buttons, radio buttons, check boxes, etc. The
|
||||
* button label appears on or next to the button depending on the button's
|
||||
* appearance, or type.
|
||||
*
|
||||
* The button's behavior is a separate property that dictates who it hilights
|
||||
* and what kinds of messages it sends. Since behavior and type are
|
||||
* different, you can do strange things like make check boxes that act as push
|
||||
* buttons or push buttons with radio button behavior.
|
||||
*
|
||||
* In X-Plane 6 there were no check box graphics. The result is the following
|
||||
* behavior: in x-plane 6 all check box and radio buttons are round
|
||||
* (radio-button style) buttons; in X-Plane 7 they are all square (check-box
|
||||
* style) buttons. In a future version of x-plane, the xpButtonBehavior enums
|
||||
* will provide the correct graphic (check box or radio button) giving the
|
||||
* expected result.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#define xpWidgetClass_Button 3
|
||||
|
||||
/*
|
||||
* Button Types
|
||||
*
|
||||
* These define the visual appearance of buttons but not how they respond to
|
||||
* the mouse.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This is a standard push button, like an "OK" or "Cancel" button in a dialog *
|
||||
* box. */
|
||||
xpPushButton = 0
|
||||
|
||||
/* A check box or radio button. Use this and the button behaviors below to *
|
||||
* get the desired behavior. */
|
||||
,xpRadioButton = 1
|
||||
|
||||
/* A window close box. */
|
||||
,xpWindowCloseBox = 3
|
||||
|
||||
/* A small down arrow. */
|
||||
,xpLittleDownArrow = 5
|
||||
|
||||
/* A small up arrow. */
|
||||
,xpLittleUpArrow = 6
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* Button Behavior Values
|
||||
*
|
||||
* These define how the button responds to mouse clicks.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* Standard push button behavior. The button hilites while the mouse is *
|
||||
* clicked over it and unhilites when the mouse is moved outside of it or *
|
||||
* released. If the mouse is released over the button, the *
|
||||
* xpMsg_PushButtonPressed message is sent. */
|
||||
xpButtonBehaviorPushButton = 0
|
||||
|
||||
/* Check box behavior. The button immediately toggles its value when the *
|
||||
* mouse is clicked and sends out a xpMsg_ButtonStateChanged message. */
|
||||
,xpButtonBehaviorCheckBox = 1
|
||||
|
||||
/* Radio button behavior. The button immediately sets its state to one and *
|
||||
* sends out a xpMsg_ButtonStateChanged message if it was not already set to *
|
||||
* one. You must turn off other radio buttons in a group in your code. */
|
||||
,xpButtonBehaviorRadioButton = 2
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* Button Properties
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This property sets the visual type of button. Use one of the button types *
|
||||
* above. */
|
||||
xpProperty_ButtonType = 1300
|
||||
|
||||
/* This property sets the button's behavior. Use one of the button behaviors *
|
||||
* above. */
|
||||
,xpProperty_ButtonBehavior = 1301
|
||||
|
||||
/* This property tells whether a check box or radio button is "checked" or *
|
||||
* not. Not used for push buttons. */
|
||||
,xpProperty_ButtonState = 1302
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* Button Messages
|
||||
*
|
||||
* These messages are sent by the button to itself and then up the widget
|
||||
* chain when the button is clicked. (You may intercept them by providing a
|
||||
* widget handler for the button itself or by providing a handler in a parent
|
||||
* widget.)
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This message is sent when the user completes a click and release in a *
|
||||
* button with push button behavior. Parameter one of the message is the *
|
||||
* widget ID of the button. This message is dispatched up the widget *
|
||||
* hierarchy. */
|
||||
xpMsg_PushButtonPressed = 1300
|
||||
|
||||
/* This message is sent when a button is clicked that has radio button or *
|
||||
* check box behavior and its value changes. (Note that if the value changes *
|
||||
* by setting a property you do not receive this message!) Parameter one is *
|
||||
* the widget ID of the button, parameter 2 is the new state value, either *
|
||||
* zero or one. This message is dispatched up the widget hierarchy. */
|
||||
,xpMsg_ButtonStateChanged = 1301
|
||||
|
||||
|
||||
};
|
||||
|
||||
/***************************************************************************
|
||||
* TEXT FIELD
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The text field widget provides an editable text field including mouse
|
||||
* selection and keyboard navigation. The contents of the text field are its
|
||||
* descriptor. (The descriptor changes as the user types.)
|
||||
*
|
||||
* The text field can have a number of types, that effect the visual layout of
|
||||
* the text field. The text field sends messages to itself so you may control
|
||||
* its behavior.
|
||||
*
|
||||
* If you need to filter keystrokes, add a new handler and intercept the key
|
||||
* press message. Since key presses are passed by pointer, you can modify the
|
||||
* keystroke and pass it through to the text field widget.
|
||||
*
|
||||
* WARNING: in x-plane before 7.10 (including 6.70) null characters could
|
||||
* crash x-plane. To prevent this, wrap this object with a filter function
|
||||
* (more instructions can be found on the SDK website).
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#define xpWidgetClass_TextField 4
|
||||
|
||||
/*
|
||||
* Text Field Type Values
|
||||
*
|
||||
* These control the look of the text field.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* A field for text entry. */
|
||||
xpTextEntryField = 0
|
||||
|
||||
/* A transparent text field. The user can type and the text is drawn, but no *
|
||||
* background is drawn. You can draw your own background by adding a widget *
|
||||
* handler and prehandling the draw message. */
|
||||
,xpTextTransparent = 3
|
||||
|
||||
/* A translucent edit field, dark gray. */
|
||||
,xpTextTranslucent = 4
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* Text Field Properties
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This is the character position the selection starts at, zero based. If it *
|
||||
* is the same as the end insertion point, the insertion point is not a *
|
||||
* selection. */
|
||||
xpProperty_EditFieldSelStart = 1400
|
||||
|
||||
/* This is the character position of the end of the selection. */
|
||||
,xpProperty_EditFieldSelEnd = 1401
|
||||
|
||||
/* This is the character position a drag was started at if the user is *
|
||||
* dragging to select text, or -1 if a drag is not in progress. */
|
||||
,xpProperty_EditFieldSelDragStart = 1402
|
||||
|
||||
/* This is the type of text field to display, from the above list. */
|
||||
,xpProperty_TextFieldType = 1403
|
||||
|
||||
/* Set this property to 1 to password protect the field. Characters will be *
|
||||
* drawn as *s even though the descriptor will contain plain-text. */
|
||||
,xpProperty_PasswordMode = 1404
|
||||
|
||||
/* The max number of characters you can enter, if limited. Zero means *
|
||||
* unlimited. */
|
||||
,xpProperty_MaxCharacters = 1405
|
||||
|
||||
/* The first visible character on the left. This effectively scrolls the text *
|
||||
* field. */
|
||||
,xpProperty_ScrollPosition = 1406
|
||||
|
||||
/* The font to draw the field's text with. (An XPLMFontID.) */
|
||||
,xpProperty_Font = 1407
|
||||
|
||||
/* This is the active side of the insert selection. (Internal) */
|
||||
,xpProperty_ActiveEditSide = 1408
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* Text Field Messages
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* Text Field Messages *
|
||||
* *
|
||||
* The text field sends this message to itself when its text changes. It *
|
||||
* sends the message up the call chain; param1 is the text field's widget ID. */
|
||||
xpMsg_TextFieldChanged = 1400
|
||||
|
||||
|
||||
};
|
||||
|
||||
/***************************************************************************
|
||||
* SCROLL BAR
|
||||
***************************************************************************/
|
||||
/*
|
||||
* A standard scroll bar or slider control. The scroll bar has a minimum,
|
||||
* maximum and current value that is updated when the user drags it. The
|
||||
* scroll bar sends continuous messages as it is dragged.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#define xpWidgetClass_ScrollBar 5
|
||||
|
||||
/*
|
||||
* Scroll Bar Type Values
|
||||
*
|
||||
* This defines how the scroll bar looks.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* Scroll bar types. *
|
||||
* *
|
||||
* A standard x-plane scroll bar (with arrows on the ends). */
|
||||
xpScrollBarTypeScrollBar = 0
|
||||
|
||||
/* A slider, no arrows. */
|
||||
,xpScrollBarTypeSlider = 1
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* Scroll Bar Properties
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* The current position of the thumb (in between the min and max, inclusive) */
|
||||
xpProperty_ScrollBarSliderPosition = 1500
|
||||
|
||||
/* The value the scroll bar has when the thumb is in the lowest position. */
|
||||
,xpProperty_ScrollBarMin = 1501
|
||||
|
||||
/* The value the scroll bar has when the thumb is in the highest position. */
|
||||
,xpProperty_ScrollBarMax = 1502
|
||||
|
||||
/* How many units to moev the scroll bar when clicking next to the thumb. The *
|
||||
* scroll bar always moves one unit when the arrows are clicked. */
|
||||
,xpProperty_ScrollBarPageAmount = 1503
|
||||
|
||||
/* The type of scrollbar from the enums above. */
|
||||
,xpProperty_ScrollBarType = 1504
|
||||
|
||||
/* Used internally. */
|
||||
,xpProperty_ScrollBarSlop = 1505
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* Scroll Bar Messages
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* The Scroll Bar sends this message when the slider position changes. It *
|
||||
* sends the message up the call chain; param1 is the Scroll Bar widget ID. */
|
||||
xpMsg_ScrollBarSliderPositionChanged = 1500
|
||||
|
||||
|
||||
};
|
||||
|
||||
/***************************************************************************
|
||||
* CAPTION
|
||||
***************************************************************************/
|
||||
/*
|
||||
* A caption is a simple widget that shows its descriptor as a string, useful
|
||||
* for labeling parts of a window. It always shows its descriptor as its
|
||||
* string and is otherwise transparent.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#define xpWidgetClass_Caption 6
|
||||
|
||||
/*
|
||||
* Caption Properties
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This property specifies whether the caption is lit; use lit captions *
|
||||
* against screens. */
|
||||
xpProperty_CaptionLit = 1600
|
||||
|
||||
|
||||
};
|
||||
|
||||
/***************************************************************************
|
||||
* GENERAL GRAPHICS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The general graphics widget can show one of many icons available from
|
||||
* x-plane.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#define xpWidgetClass_GeneralGraphics 7
|
||||
|
||||
/*
|
||||
* General Graphics Types Values
|
||||
*
|
||||
* These define the icon for the general graphics.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
xpShip = 4
|
||||
|
||||
,xpILSGlideScope = 5
|
||||
|
||||
,xpMarkerLeft = 6
|
||||
|
||||
,xp_Airport = 7
|
||||
|
||||
,xpNDB = 8
|
||||
|
||||
,xpVOR = 9
|
||||
|
||||
,xpRadioTower = 10
|
||||
|
||||
,xpAircraftCarrier = 11
|
||||
|
||||
,xpFire = 12
|
||||
|
||||
,xpMarkerRight = 13
|
||||
|
||||
,xpCustomObject = 14
|
||||
|
||||
,xpCoolingTower = 15
|
||||
|
||||
,xpSmokeStack = 16
|
||||
|
||||
,xpBuilding = 17
|
||||
|
||||
,xpPowerLine = 18
|
||||
|
||||
,xpVORWithCompassRose = 19
|
||||
|
||||
,xpOilPlatform = 21
|
||||
|
||||
,xpOilPlatformSmall = 22
|
||||
|
||||
,xpWayPoint = 23
|
||||
|
||||
|
||||
};
|
||||
|
||||
/*
|
||||
* General Graphics Properties
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This property controls the type of icon that is drawn. */
|
||||
xpProperty_GeneralGraphicsType = 1700
|
||||
|
||||
|
||||
};
|
||||
|
||||
/***************************************************************************
|
||||
* PROGRESS INDICATOR
|
||||
***************************************************************************/
|
||||
/*
|
||||
* This widget implements a progress indicator as seen when x-plane starts up.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#define xpWidgetClass_Progress 8
|
||||
|
||||
/*
|
||||
* Progress Indicator Properties
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This is the current value of the progress indicator. */
|
||||
xpProperty_ProgressPosition = 1800
|
||||
|
||||
/* This is the minimum value, equivalent to 0% filled. */
|
||||
,xpProperty_ProgressMin = 1801
|
||||
|
||||
/* This is the maximum value, equivalent to 100% filled. */
|
||||
,xpProperty_ProgressMax = 1802
|
||||
|
||||
|
||||
};
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
363
xpcPlugin/SDK/CHeaders/Widgets/XPUIGraphics.h
Executable file
363
xpcPlugin/SDK/CHeaders/Widgets/XPUIGraphics.h
Executable file
@@ -0,0 +1,363 @@
|
||||
#ifndef _XPUIGraphics_h_
|
||||
#define _XPUIGraphics_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPWidgetDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* UI GRAPHICS
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* XPWindowStyle
|
||||
*
|
||||
* There are a few built-in window styles in X-Plane that you can use.
|
||||
*
|
||||
* Note that X-Plane 6 does not offer real shadow-compositing; you must make
|
||||
* sure to put a window on top of another window of the right style to the
|
||||
* shadows work, etc. This applies to elements with insets and shadows. The
|
||||
* rules are:
|
||||
*
|
||||
* Sub windows must go on top of main windows, and screens and list views on
|
||||
* top of subwindows. Only help and main windows can be over the main screen.
|
||||
*
|
||||
*
|
||||
* With X-Plane 7 any window or element may be placed over any other element.
|
||||
*
|
||||
* Some windows are scaled by stretching, some by repeating. The drawing
|
||||
* routines know which scaling method to use. The list view cannot be
|
||||
* rescaled in x-plane 6 because it has both a repeating pattern and a
|
||||
* gradient in one element. All other elements can be rescaled.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* An LCD screen that shows help. */
|
||||
xpWindow_Help = 0
|
||||
|
||||
/* A dialog box window. */
|
||||
,xpWindow_MainWindow = 1
|
||||
|
||||
/* A panel or frame within a dialog box window. */
|
||||
,xpWindow_SubWindow = 2
|
||||
|
||||
/* An LCD screen within a panel to hold text displays. */
|
||||
,xpWindow_Screen = 4
|
||||
|
||||
/* A list view within a panel for scrolling file names, etc. */
|
||||
,xpWindow_ListView = 5
|
||||
|
||||
|
||||
};
|
||||
typedef int XPWindowStyle;
|
||||
|
||||
/*
|
||||
* XPDrawWindow
|
||||
*
|
||||
* This routine draws a window of the given dimensions at the given offset on
|
||||
* the virtual screen in a given style. The window is automatically scaled as
|
||||
* appropriate using a bitmap scaling technique (scaling or repeating) as
|
||||
* appropriate to the style.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPDrawWindow(
|
||||
int inX1,
|
||||
int inY1,
|
||||
int inX2,
|
||||
int inY2,
|
||||
XPWindowStyle inStyle);
|
||||
|
||||
/*
|
||||
* XPGetWindowDefaultDimensions
|
||||
*
|
||||
* This routine returns the default dimensions for a window. Output is either
|
||||
* a minimum or fixed value depending on whether the window is scalable.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPGetWindowDefaultDimensions(
|
||||
XPWindowStyle inStyle,
|
||||
int * outWidth, /* Can be NULL */
|
||||
int * outHeight); /* Can be NULL */
|
||||
|
||||
/*
|
||||
* XPElementStyle
|
||||
*
|
||||
* Elements are individually drawable UI things like push buttons, etc. The
|
||||
* style defines what kind of element you are drawing. Elements can be
|
||||
* stretched in one or two dimensions (depending on the element). Some
|
||||
* elements can be lit.
|
||||
*
|
||||
* In x-plane 6 some elements must be drawn over metal. Some are scalable and
|
||||
* some are not. Any element can be drawn anywhere in x-plane 7.
|
||||
*
|
||||
* Scalable Axis Required Background
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* x metal */
|
||||
xpElement_TextField = 6
|
||||
|
||||
/* none metal */
|
||||
,xpElement_CheckBox = 9
|
||||
|
||||
/* none metal */
|
||||
,xpElement_CheckBoxLit = 10
|
||||
|
||||
/* none window header */
|
||||
,xpElement_WindowCloseBox = 14
|
||||
|
||||
/* none window header */
|
||||
,xpElement_WindowCloseBoxPressed = 15
|
||||
|
||||
/* x metal */
|
||||
,xpElement_PushButton = 16
|
||||
|
||||
/* x metal */
|
||||
,xpElement_PushButtonLit = 17
|
||||
|
||||
/* none any */
|
||||
,xpElement_OilPlatform = 24
|
||||
|
||||
/* none any */
|
||||
,xpElement_OilPlatformSmall = 25
|
||||
|
||||
/* none any */
|
||||
,xpElement_Ship = 26
|
||||
|
||||
/* none any */
|
||||
,xpElement_ILSGlideScope = 27
|
||||
|
||||
/* none any */
|
||||
,xpElement_MarkerLeft = 28
|
||||
|
||||
/* none any */
|
||||
,xpElement_Airport = 29
|
||||
|
||||
/* none any */
|
||||
,xpElement_Waypoint = 30
|
||||
|
||||
/* none any */
|
||||
,xpElement_NDB = 31
|
||||
|
||||
/* none any */
|
||||
,xpElement_VOR = 32
|
||||
|
||||
/* none any */
|
||||
,xpElement_RadioTower = 33
|
||||
|
||||
/* none any */
|
||||
,xpElement_AircraftCarrier = 34
|
||||
|
||||
/* none any */
|
||||
,xpElement_Fire = 35
|
||||
|
||||
/* none any */
|
||||
,xpElement_MarkerRight = 36
|
||||
|
||||
/* none any */
|
||||
,xpElement_CustomObject = 37
|
||||
|
||||
/* none any */
|
||||
,xpElement_CoolingTower = 38
|
||||
|
||||
/* none any */
|
||||
,xpElement_SmokeStack = 39
|
||||
|
||||
/* none any */
|
||||
,xpElement_Building = 40
|
||||
|
||||
/* none any */
|
||||
,xpElement_PowerLine = 41
|
||||
|
||||
/* none metal */
|
||||
,xpElement_CopyButtons = 45
|
||||
|
||||
/* none metal */
|
||||
,xpElement_CopyButtonsWithEditingGrid = 46
|
||||
|
||||
/* x, y metal */
|
||||
,xpElement_EditingGrid = 47
|
||||
|
||||
/* THIS CAN PROBABLY BE REMOVED */
|
||||
,xpElement_ScrollBar = 48
|
||||
|
||||
/* none any */
|
||||
,xpElement_VORWithCompassRose = 49
|
||||
|
||||
/* none metal */
|
||||
,xpElement_Zoomer = 51
|
||||
|
||||
/* x, y metal */
|
||||
,xpElement_TextFieldMiddle = 52
|
||||
|
||||
/* none metal */
|
||||
,xpElement_LittleDownArrow = 53
|
||||
|
||||
/* none metal */
|
||||
,xpElement_LittleUpArrow = 54
|
||||
|
||||
/* none metal */
|
||||
,xpElement_WindowDragBar = 61
|
||||
|
||||
/* none metal */
|
||||
,xpElement_WindowDragBarSmooth = 62
|
||||
|
||||
|
||||
};
|
||||
typedef int XPElementStyle;
|
||||
|
||||
/*
|
||||
* XPDrawElement
|
||||
*
|
||||
* XPDrawElement draws a given element at an offset on the virtual screen in
|
||||
* set dimensions. EVEN if the element is not scalable, it will be scaled if
|
||||
* the width and height do not match the preferred dimensions; it'll just look
|
||||
* ugly. Pass inLit to see the lit version of the element; if the element
|
||||
* cannot be lit this is ignored.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPDrawElement(
|
||||
int inX1,
|
||||
int inY1,
|
||||
int inX2,
|
||||
int inY2,
|
||||
XPElementStyle inStyle,
|
||||
int inLit);
|
||||
|
||||
/*
|
||||
* XPGetElementDefaultDimensions
|
||||
*
|
||||
* This routine returns the recommended or minimum dimensions of a given UI
|
||||
* element. outCanBeLit tells whether the element has both a lit and unlit
|
||||
* state. Pass NULL to not receive any of these parameters.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPGetElementDefaultDimensions(
|
||||
XPElementStyle inStyle,
|
||||
int * outWidth, /* Can be NULL */
|
||||
int * outHeight, /* Can be NULL */
|
||||
int * outCanBeLit); /* Can be NULL */
|
||||
|
||||
/*
|
||||
* XPTrackStyle
|
||||
*
|
||||
* A track is a UI element that displays a value vertically or horizontally.
|
||||
* X-Plane has three kinds of tracks: scroll bars, sliders, and progress bars.
|
||||
* Tracks can be displayed either horizontally or vertically; tracks will
|
||||
* choose their own layout based on the larger dimension of their dimensions
|
||||
* (e.g. they know if they are tall or wide). Sliders may be lit or unlit
|
||||
* (showing the user manipulating them).
|
||||
*
|
||||
* ScrollBar - this is a standard scroll bar with arrows and a thumb to drag.
|
||||
* Slider - this is a simple track with a ball in the middle that can be
|
||||
* slid. Progress - this is a progress indicator showing how a long task is
|
||||
* going.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* not over metal can be lit can be rotated */
|
||||
xpTrack_ScrollBar = 0
|
||||
|
||||
/* over metal can be lit can be rotated */
|
||||
,xpTrack_Slider = 1
|
||||
|
||||
/* over metal cannot be lit cannot be rotated */
|
||||
,xpTrack_Progress = 2
|
||||
|
||||
|
||||
};
|
||||
typedef int XPTrackStyle;
|
||||
|
||||
/*
|
||||
* XPDrawTrack
|
||||
*
|
||||
* This routine draws a track. You pass in the track dimensions and size; the
|
||||
* track picks the optimal orientation for these dimensions. Pass in the
|
||||
* track's minimum current and maximum values; the indicator will be
|
||||
* positioned appropriately. You can also specify whether the track is lit or
|
||||
* not.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPDrawTrack(
|
||||
int inX1,
|
||||
int inY1,
|
||||
int inX2,
|
||||
int inY2,
|
||||
int inMin,
|
||||
int inMax,
|
||||
int inValue,
|
||||
XPTrackStyle inTrackStyle,
|
||||
int inLit);
|
||||
|
||||
/*
|
||||
* XPGetTrackDefaultDimensions
|
||||
*
|
||||
* This routine returns a track's default smaller dimension; all tracks are
|
||||
* scalable in the larger dimension. It also returns whether a track can be
|
||||
* lit.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPGetTrackDefaultDimensions(
|
||||
XPTrackStyle inStyle,
|
||||
int * outWidth,
|
||||
int * outCanBeLit);
|
||||
|
||||
/*
|
||||
* XPGetTrackMetrics
|
||||
*
|
||||
* This routine returns the metrics of a track. If you want to write UI code
|
||||
* to manipulate a track, this routine helps you know where the mouse
|
||||
* locations are. For most other elements, the rectangle the element is drawn
|
||||
* in is enough information. However, the scrollbar drawing routine does some
|
||||
* automatic placement; this routine lets you know where things ended up. You
|
||||
* pass almost everything you would pass to the draw routine. You get out the
|
||||
* orientation, and other useful stuff.
|
||||
*
|
||||
* Besides orientation, you get five dimensions for the five parts of a
|
||||
* scrollbar, which are the down button, down area (area before the thumb),
|
||||
* the thumb, and the up area and button. For horizontal scrollers, the left
|
||||
* button decreases; for vertical scrollers, the top button decreases.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPGetTrackMetrics(
|
||||
int inX1,
|
||||
int inY1,
|
||||
int inX2,
|
||||
int inY2,
|
||||
int inMin,
|
||||
int inMax,
|
||||
int inValue,
|
||||
XPTrackStyle inTrackStyle,
|
||||
int * outIsVertical,
|
||||
int * outDownBtnSize,
|
||||
int * outDownPageSize,
|
||||
int * outThumbSize,
|
||||
int * outUpPageSize,
|
||||
int * outUpBtnSize);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
486
xpcPlugin/SDK/CHeaders/Widgets/XPWidgetDefs.h
Executable file
486
xpcPlugin/SDK/CHeaders/Widgets/XPWidgetDefs.h
Executable file
@@ -0,0 +1,486 @@
|
||||
#ifndef _XPWidgetDefs_h_
|
||||
#define _XPWidgetDefs_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
|
||||
#if APL
|
||||
#if XPWIDGETS
|
||||
#if __GNUC__ >= 4
|
||||
#define WIDGET_API __attribute__((visibility("default")))
|
||||
#elif __MACH__
|
||||
#define WIDGET_API
|
||||
#else
|
||||
#define WIDGET_API __declspec(dllexport)
|
||||
#endif
|
||||
#else
|
||||
#define WIDGET_API
|
||||
#endif
|
||||
#elif IBM
|
||||
#if XPWIDGETS
|
||||
#define WIDGET_API __declspec(dllexport)
|
||||
#else
|
||||
#define WIDGET_API __declspec(dllimport)
|
||||
#endif
|
||||
#elif LIN
|
||||
#if XPWIDGETS
|
||||
#if __GNUC__ >= 4
|
||||
#define WIDGET_API __attribute__((visibility("default")))
|
||||
#else
|
||||
#define WIDGET_API
|
||||
#endif
|
||||
#else
|
||||
#define WIDGET_API
|
||||
#endif
|
||||
#else
|
||||
#pragma error "Platform not defined!"
|
||||
#endif
|
||||
/***************************************************************************
|
||||
* WIDGET DEFINITIONS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* A widget is a call-back driven screen entity like a push-button, window,
|
||||
* text entry field, etc.
|
||||
*
|
||||
* Use the widget API to create widgets of various classes. You can nest them
|
||||
* into trees of widgets to create complex user interfaces.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPWidgetID
|
||||
*
|
||||
* A Widget ID is an opaque unique non-zero handle identifying your widget.
|
||||
* Use 0 to specify "no widget". This type is defined as wide enough to hold
|
||||
* a pointer. You receive a widget ID when you create a new widget and then
|
||||
* use that widget ID to further refer to the widget.
|
||||
*
|
||||
*/
|
||||
typedef void * XPWidgetID;
|
||||
|
||||
/*
|
||||
* XPWidgetPropertyID
|
||||
*
|
||||
* Properties are values attached to instances of your widgets. A property is
|
||||
* identified by a 32-bit ID and its value is the width of a pointer.
|
||||
*
|
||||
* Each widget instance may have a property or not have it. When you set a
|
||||
* property on a widget for the first time, the property is added to the
|
||||
* widget; it then stays there for the life of the widget.
|
||||
*
|
||||
* Some property IDs are predefined by the widget package; you can make up
|
||||
* your own property IDs as well.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* A window's refcon is an opaque value used by client code to find other data *
|
||||
* based on it. */
|
||||
xpProperty_Refcon = 0
|
||||
|
||||
/* These properties are used by the utlities to implement dragging. */
|
||||
,xpProperty_Dragging = 1
|
||||
|
||||
,xpProperty_DragXOff = 2
|
||||
|
||||
,xpProperty_DragYOff = 3
|
||||
|
||||
/* Is the widget hilited? (For widgets that support this kind of thing.) */
|
||||
,xpProperty_Hilited = 4
|
||||
|
||||
/* Is there a C++ object attached to this widget? */
|
||||
,xpProperty_Object = 5
|
||||
|
||||
/* If this property is 1, the widget package will use OpenGL to restrict *
|
||||
* drawing to the Wiget's exposed rectangle. */
|
||||
,xpProperty_Clip = 6
|
||||
|
||||
/* Is this widget enabled (for those that have a disabled state too)? */
|
||||
,xpProperty_Enabled = 7
|
||||
|
||||
/* NOTE: Property IDs 1 - 999 are reserved for the widget's library. *
|
||||
* *
|
||||
* NOTE: Property IDs 1000 - 9999 are allocated to the standard widget classes *
|
||||
* provided with the library Properties 1000 - 1099 are for widget class 0, *
|
||||
* 1100 - 1199 for widget class 1, etc. */
|
||||
,xpProperty_UserStart = 10000
|
||||
|
||||
|
||||
};
|
||||
typedef int XPWidgetPropertyID;
|
||||
|
||||
/*
|
||||
* XPMouseState_t
|
||||
*
|
||||
* When the mouse is clicked or dragged, a pointer to this structure is passed
|
||||
* to your widget function.
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
int x;
|
||||
int y;
|
||||
/* Mouse Button number, left = 0 (right button not yet supported. */
|
||||
int button;
|
||||
#if defined(XPLM200)
|
||||
/* Scroll wheel delta (button in this case would be the wheel axis number). */
|
||||
int delta;
|
||||
#endif /* XPLM200 */
|
||||
} XPMouseState_t;
|
||||
|
||||
/*
|
||||
* XPKeyState_t
|
||||
*
|
||||
* When a key is pressed, a pointer to this struct is passed to your widget
|
||||
* function.
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
/* The ASCII key that was pressed. WARNING: this may be 0 for some non-ASCII *
|
||||
* key sequences. */
|
||||
char key;
|
||||
/* The flags. Make sure to check this if you only want key-downs! */
|
||||
XPLMKeyFlags flags;
|
||||
/* The virtual key code for the key */
|
||||
char vkey;
|
||||
} XPKeyState_t;
|
||||
|
||||
/*
|
||||
* XPWidgetGeometryChange_t
|
||||
*
|
||||
* This structure contains the deltas for your widget's geometry when it
|
||||
* changes.
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
int dx;
|
||||
/* +Y = the widget moved up */
|
||||
int dy;
|
||||
int dwidth;
|
||||
int dheight;
|
||||
} XPWidgetGeometryChange_t;
|
||||
|
||||
/*
|
||||
* XPDispatchMode
|
||||
*
|
||||
* The dispatching modes describe how the widgets library sends out messages.
|
||||
* Currently there are three modes:
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* The message will only be sent to the target widget. */
|
||||
xpMode_Direct = 0
|
||||
|
||||
/* The message is sent to the target widget, then up the chain of parents *
|
||||
* until the message is handled or a parentless widget is reached. */
|
||||
,xpMode_UpChain = 1
|
||||
|
||||
/* The message is sent to the target widget and then all of its children *
|
||||
* recursively depth-first. */
|
||||
,xpMode_Recursive = 2
|
||||
|
||||
/* The message is snet just to the target, but goes to every callback, even if *
|
||||
* it is handled. */
|
||||
,xpMode_DirectAllCallbacks = 3
|
||||
|
||||
/* The message is only sent to the very first handler even if it is not *
|
||||
* accepted. (This is really only useful for some internal Widget Lib *
|
||||
* functions. */
|
||||
,xpMode_Once = 4
|
||||
|
||||
|
||||
};
|
||||
typedef int XPDispatchMode;
|
||||
|
||||
/*
|
||||
* XPWidgetClass
|
||||
*
|
||||
* Widget classes define predefined widget types. A widget class basically
|
||||
* specifies from a library the widget function to be used for the widget.
|
||||
* Most widgets can be made right from classes.
|
||||
*
|
||||
*/
|
||||
typedef int XPWidgetClass;
|
||||
|
||||
/* An unspecified widget class. Other widget classes are in *
|
||||
* XPStandardWidgets.h */
|
||||
#define xpWidgetClass_None 0
|
||||
|
||||
/***************************************************************************
|
||||
* WIDGET MESSAGES
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* XPWidgetMessage
|
||||
*
|
||||
* Widgets receive 32-bit messages indicating what action is to be taken or
|
||||
* notifications of events. The list of messages may be expanded.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* No message, should not be sent. */
|
||||
xpMsg_None = 0
|
||||
|
||||
/* The create message is sent once per widget that is created with your widget *
|
||||
* function and once for any widget that has your widget function attached. *
|
||||
* *
|
||||
* Dispatching: Direct *
|
||||
* *
|
||||
* Param 1: 1 if you are being added as a subclass, 0 if the widget is first *
|
||||
* being created. */
|
||||
,xpMsg_Create = 1
|
||||
|
||||
/* The destroy message is sent once for each message that is destroyed that *
|
||||
* has your widget function. *
|
||||
* *
|
||||
* Dispatching: Direct for all *
|
||||
* *
|
||||
* Param 1: 1 if being deleted by a recursive delete to the parent, 0 for *
|
||||
* explicit deletion. */
|
||||
,xpMsg_Destroy = 2
|
||||
|
||||
/* The paint message is sent to your widget to draw itself. The paint message *
|
||||
* is the bare-bones message; in response you must draw yourself, draw your *
|
||||
* children, set up clipping and culling, check for visibility, etc. If you *
|
||||
* don't want to do all of this, ignore the paint message and a draw message *
|
||||
* (see below) will be sent to you. *
|
||||
* *
|
||||
* Dispatching: Direct */
|
||||
,xpMsg_Paint = 3
|
||||
|
||||
/* The draw message is sent to your widget when it is time to draw yourself. *
|
||||
* OpenGL will be set up to draw in 2-d global screen coordinates, but you *
|
||||
* should use the XPLM to set up OpenGL state. *
|
||||
* *
|
||||
* Dispatching: Direct */
|
||||
,xpMsg_Draw = 4
|
||||
|
||||
/* The key press message is sent once per key that is pressed. The first *
|
||||
* parameter is the type of key code (integer or char) and the second is the *
|
||||
* code itself. By handling this event, you consume the key stroke. *
|
||||
* *
|
||||
* Handling this message 'consumes' the keystroke; not handling it passes it *
|
||||
* to your parent widget. *
|
||||
* *
|
||||
* Dispatching: Up Chain *
|
||||
* *
|
||||
* : Param 1: A pointer to an XPKeyState_t structure with the keystroke. */
|
||||
,xpMsg_KeyPress = 5
|
||||
|
||||
/* Keyboard focus is being given to you. By handling this message you accept *
|
||||
* keyboard focus. The first parameter will be one if a child of yours gave *
|
||||
* up focus to you, 0 if someone set focus on you explicitly. *
|
||||
* *
|
||||
* : Handling this message accepts focus; not handling refuses focus. *
|
||||
* *
|
||||
* Dispatching: direct *
|
||||
* *
|
||||
* Param 1: 1 if you are gaining focus because your child is giving it up, 0 *
|
||||
* if someone is explicitly giving you focus. */
|
||||
,xpMsg_KeyTakeFocus = 6
|
||||
|
||||
/* Keyboard focus is being taken away from you. The first parameter will be *
|
||||
* one if you are losing focus because another widget is taking it, or 0 if *
|
||||
* someone called the API to make you lose focus explicitly. *
|
||||
* *
|
||||
* Dispatching: Direct *
|
||||
* *
|
||||
* Param 1: 1 if focus is being taken by another widget, 0 if code requested *
|
||||
* to remove focus. */
|
||||
,xpMsg_KeyLoseFocus = 7
|
||||
|
||||
/* You receive one mousedown event per click with a mouse-state structure *
|
||||
* pointed to by parameter 1, by accepting this you eat the click, otherwise *
|
||||
* your parent gets it. You will not receive drag and mouse up messages if *
|
||||
* you do not accept the down message. *
|
||||
* *
|
||||
* Handling this message consumes the mouse click, not handling it passes it *
|
||||
* to the next widget. You can act 'transparent' as a window by never handling *
|
||||
* moues clicks to certain areas. *
|
||||
* *
|
||||
* Dispatching: Up chain NOTE: Technically this is direct dispatched, but the *
|
||||
* widgets library will shop it to each widget until one consumes the click, *
|
||||
* making it effectively "up chain". *
|
||||
* *
|
||||
* Param 1: A pointer to an XPMouseState_t containing the mouse status. */
|
||||
,xpMsg_MouseDown = 8
|
||||
|
||||
/* You receive a series of mouse drag messages (typically one per frame in the *
|
||||
* sim) as the mouse is moved once you have accepted a mouse down message. *
|
||||
* Parameter one points to a mouse-state structure describing the mouse *
|
||||
* location. You will continue to receive these until the mouse button is *
|
||||
* released. You may receive multiple mouse state messages with the same mouse *
|
||||
* position. You will receive mouse drag events even if the mouse is dragged *
|
||||
* out of your current or original bounds at the time of the mouse down. *
|
||||
* *
|
||||
* Dispatching: Direct *
|
||||
* *
|
||||
* Param 1: A pointer to an XPMouseState_t containing the mouse status. */
|
||||
,xpMsg_MouseDrag = 9
|
||||
|
||||
/* The mouseup event is sent once when the mouse button is released after a *
|
||||
* drag or click. You only receive this message if you accept the mouseDown *
|
||||
* message. Parameter one points to a mouse state structure. *
|
||||
* *
|
||||
* Dispatching: Direct *
|
||||
* *
|
||||
* Param 1: A pointer to an XPMouseState_t containing the mouse status. */
|
||||
,xpMsg_MouseUp = 10
|
||||
|
||||
/* Your geometry or a child's geometry is being changed. *
|
||||
* *
|
||||
* Dispatching: Up chain *
|
||||
* *
|
||||
* Param 1: The widget ID of the original reshaped target. *
|
||||
* *
|
||||
* Param 2: A pointer to a XPWidgetGeometryChange_t struct describing the *
|
||||
* change. */
|
||||
,xpMsg_Reshape = 11
|
||||
|
||||
/* Your exposed area has changed. *
|
||||
* *
|
||||
* Dispatching: Direct */
|
||||
,xpMsg_ExposedChanged = 12
|
||||
|
||||
/* A child has been added to you. The child's ID is passed in parameter one. *
|
||||
* *
|
||||
* *
|
||||
* Dispatching: Direct *
|
||||
* *
|
||||
* Param 1: The Widget ID of the child being added. */
|
||||
,xpMsg_AcceptChild = 13
|
||||
|
||||
/* A child has been removed from to you. The child's ID is passed in *
|
||||
* parameter one. *
|
||||
* *
|
||||
* Dispatching: Direct *
|
||||
* *
|
||||
* Param 1: The Widget ID of the child being removed. */
|
||||
,xpMsg_LoseChild = 14
|
||||
|
||||
/* You now have a new parent, or have no parent. The parent's ID is passed *
|
||||
* in, or 0 for no parent. *
|
||||
* *
|
||||
* Dispatching: Direct *
|
||||
* *
|
||||
* Param 1: The Widget ID of your parent */
|
||||
,xpMsg_AcceptParent = 15
|
||||
|
||||
/* You or a child has been shown. Note that this does not include you being *
|
||||
* shown because your parent was shown, you were put in a new parent, your *
|
||||
* root was shown, etc. *
|
||||
* *
|
||||
* Dispatching: Up chain *
|
||||
* *
|
||||
* Param 1: The widget ID of the shown widget. */
|
||||
,xpMsg_Shown = 16
|
||||
|
||||
/* You have been hidden. See limitations above. *
|
||||
* *
|
||||
* Dispatching: Up chain *
|
||||
* *
|
||||
* Param 1: The widget ID of the hidden widget. */
|
||||
,xpMsg_Hidden = 17
|
||||
|
||||
/* Your descriptor has changed. *
|
||||
* *
|
||||
* Dispatching: Direct */
|
||||
,xpMsg_DescriptorChanged = 18
|
||||
|
||||
/* A property has changed. Param 1 contains the property ID. *
|
||||
* *
|
||||
* Dispatching: Direct *
|
||||
* *
|
||||
* Param 1: The Property ID being changed. *
|
||||
* *
|
||||
* Param 2: The new property value */
|
||||
,xpMsg_PropertyChanged = 19
|
||||
|
||||
#if defined(XPLM200)
|
||||
/* The mouse wheel has moved. *
|
||||
* *
|
||||
* Return 1 to consume the mouse wheel move, or 0 to pass the message to a *
|
||||
* parent. Dispatching: Up chain *
|
||||
* *
|
||||
* Param 1: A pointer to an XPMouseState_t containing the mouse status. */
|
||||
,xpMsg_MouseWheel = 20
|
||||
|
||||
#endif /* XPLM200 */
|
||||
#if defined(XPLM200)
|
||||
/* The cursor is over your widget. If you consume this message, change the *
|
||||
* XPLMCursorStatus value to indicate the desired result, with the same rules *
|
||||
* as in XPLMDisplay.h. *
|
||||
* *
|
||||
* Return 1 to consume this message, 0 to pass it on. *
|
||||
* *
|
||||
* Dispatching: Up chain Param 1: A pointer to an XPMouseState_t struct *
|
||||
* containing the mouse status. *
|
||||
* *
|
||||
* Param 2: A pointer to a XPLMCursorStatus - set this to the cursor result *
|
||||
* you desire. */
|
||||
,xpMsg_CursorAdjust = 21
|
||||
|
||||
#endif /* XPLM200 */
|
||||
/* NOTE: Message IDs 1000 - 9999 are allocated to the standard widget classes *
|
||||
* provided with the library with 1000 - 1099 for widget class 0, 1100 - 1199 *
|
||||
* for widget class 1, etc. Message IDs 10,000 and beyond are for plugin use. */
|
||||
,xpMsg_UserStart = 10000
|
||||
|
||||
|
||||
};
|
||||
typedef int XPWidgetMessage;
|
||||
|
||||
/***************************************************************************
|
||||
* WIDGET CALLBACK FUNCTION
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* XPWidgetFunc_t
|
||||
*
|
||||
* This function defines your custom widget's behavior. It will be called by
|
||||
* the widgets library to send messages to your widget. The message and
|
||||
* widget ID are passed in, as well as two ptr-width signed parameters whose
|
||||
* meaning varies with the message. Return 1 to indicate that you have
|
||||
* processed the message, 0 to indicate that you have not. For any message
|
||||
* that is not understood, return 0.
|
||||
*
|
||||
*/
|
||||
typedef int (* XPWidgetFunc_t)(
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
intptr_t inParam1,
|
||||
intptr_t inParam2);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
234
xpcPlugin/SDK/CHeaders/Widgets/XPWidgetUtils.h
Executable file
234
xpcPlugin/SDK/CHeaders/Widgets/XPWidgetUtils.h
Executable file
@@ -0,0 +1,234 @@
|
||||
#ifndef _XPWidgetUtils_h_
|
||||
#define _XPWidgetUtils_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* XPWidgetUtils - USAGE NOTES
|
||||
*
|
||||
* The XPWidgetUtils library contains useful functions that make writing and
|
||||
* using widgets less of a pain.
|
||||
*
|
||||
* One set of functions are the widget behavior functions. These functions
|
||||
* each add specific useful behaviors to widgets. They can be used in two
|
||||
* manners:
|
||||
*
|
||||
* 1. You can add a widget behavior function to a widget as a callback proc
|
||||
* using the XPAddWidgetCallback function. The widget will gain that
|
||||
* behavior. Remember that the last function you add has highest priority.
|
||||
* You can use this to change or augment the behavior of an existing finished
|
||||
* widget.
|
||||
*
|
||||
* 2. You can call a widget function from inside your own widget function.
|
||||
* This allows you to include useful behaviors in custom-built widgets. A
|
||||
* number of the standard widgets get their behavior from this library. To do
|
||||
* this, call the behavior function from your function first. If it returns
|
||||
* 1, that means it handled the event and you don't need to; simply return 1.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPWidgetDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* GENERAL UTILITIES
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* Convenience accessors
|
||||
*
|
||||
* It can be clumsy accessing the variables passed in by pointer to a struct
|
||||
* for mouse and reshape messages; these accessors let you simply pass in the param
|
||||
* right from the arguments of your widget proc and get back the value you want.
|
||||
*
|
||||
*/
|
||||
#define MOUSE_X(param) (((XPMouseState_t *) (param))->x)
|
||||
#define MOUSE_Y(param) (((XPMouseState_t *) (param))->y)
|
||||
|
||||
#define DELTA_X(param) (((XPWidgetGeometryChange_t *) (param))->dx)
|
||||
#define DELTA_Y(param) (((XPWidgetGeometryChange_t *) (param))->dy)
|
||||
#define DELTA_W(param) (((XPWidgetGeometryChange_t *) (param))->dwidth)
|
||||
#define DELTA_H(param) (((XPWidgetGeometryChange_t *) (param))->dheight)
|
||||
|
||||
#define KEY_CHAR(param) (((XPKeyState_t *) (param))->key)
|
||||
#define KEY_FLAGS(param) (((XPKeyState_t *) (param))->flags)
|
||||
#define KEY_VKEY(param) (((XPKeyState_t *) (param))->vkey)
|
||||
|
||||
#define IN_RECT(x, y, l, t, r, b) \
|
||||
(((x) >= (l)) && ((x) <= (r)) && ((y) >= (b)) && ((y) <= (t)))
|
||||
|
||||
/*
|
||||
* XPWidgetCreate_t
|
||||
*
|
||||
* This structure contains all of the parameters needed to create a wiget. It
|
||||
* is used with XPUCreateWidgets to create widgets in bulk from an array. All
|
||||
* parameters correspond to those of XPCreateWidget except for the container
|
||||
* index. If the container index is equal to the index of a widget in the
|
||||
* array, the widget in the array passed to XPUCreateWidgets is used as the
|
||||
* parent of this widget. Note that if you pass an index greater than your
|
||||
* own position in the array, the parent you are requesting will not exist
|
||||
* yet. If the container index is NO_PARENT, the parent widget is specified as
|
||||
* NULL. If the container index is PARAM_PARENT, the widget passed into
|
||||
* XPUCreateWidgets is used.
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
int left;
|
||||
int top;
|
||||
int right;
|
||||
int bottom;
|
||||
int visible;
|
||||
const char * descriptor;
|
||||
int isRoot;
|
||||
int containerIndex;
|
||||
XPWidgetClass widgetClass;
|
||||
} XPWidgetCreate_t;
|
||||
|
||||
#define NO_PARENT -1
|
||||
|
||||
#define PARAM_PARENT -2
|
||||
|
||||
#define WIDGET_COUNT(x) ((sizeof(x) / sizeof(XPWidgetCreate_t)))
|
||||
|
||||
/*
|
||||
* XPUCreateWidgets
|
||||
*
|
||||
* This function creates a series of widgets from a table...see
|
||||
* XPCreateWidget_t above. Pass in an array of widget creation structures and
|
||||
* an array of widget IDs that will receive each widget.
|
||||
*
|
||||
* Widget parents are specified by index into the created widget table,
|
||||
* allowing you to create nested widget structures. You can create multiple
|
||||
* widget trees in one table. Generally you should create widget trees from
|
||||
* the top down.
|
||||
*
|
||||
* You can also pass in a widget ID that will be used when the widget's parent
|
||||
* is listed as PARAM_PARENT; this allows you to embed widgets created with
|
||||
* XPUCreateWidgets in a widget created previously.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPUCreateWidgets(
|
||||
const XPWidgetCreate_t * inWidgetDefs,
|
||||
int inCount,
|
||||
XPWidgetID inParamParent,
|
||||
XPWidgetID * ioWidgets);
|
||||
|
||||
/*
|
||||
* XPUMoveWidgetBy
|
||||
*
|
||||
* Simply moves a widget by an amount, +x = right, +y=up, without resizing the
|
||||
* widget.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPUMoveWidgetBy(
|
||||
XPWidgetID inWidget,
|
||||
int inDeltaX,
|
||||
int inDeltaY);
|
||||
|
||||
/***************************************************************************
|
||||
* LAYOUT MANAGERS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The layout managers are widget behavior functions for handling where
|
||||
* widgets move. Layout managers can be called from a widget function or
|
||||
* attached to a widget later.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPUFixedLayout
|
||||
*
|
||||
* This function causes the widget to maintain its children in fixed position
|
||||
* relative to itself as it is resized. Use this on the top level 'window'
|
||||
* widget for your window.
|
||||
*
|
||||
*/
|
||||
WIDGET_API int XPUFixedLayout(
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
intptr_t inParam1,
|
||||
intptr_t inParam2);
|
||||
|
||||
/***************************************************************************
|
||||
* WIDGET PROC BEHAVIORS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These widget behavior functions add other useful behaviors to widgets.
|
||||
* These functions cannot be attached to a widget; they must be called from
|
||||
* your widget function.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPUSelectIfNeeded
|
||||
*
|
||||
* This causes the widget to bring its window to the foreground if it is not
|
||||
* already. inEatClick specifies whether clicks in the background should be
|
||||
* consumed by bringin the window to the foreground.
|
||||
*
|
||||
*/
|
||||
WIDGET_API int XPUSelectIfNeeded(
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
intptr_t inParam1,
|
||||
intptr_t inParam2,
|
||||
int inEatClick);
|
||||
|
||||
/*
|
||||
* XPUDefocusKeyboard
|
||||
*
|
||||
* This causes a click in the widget to send keyboard focus back to X-Plane.
|
||||
* This stops editing of any text fields, etc.
|
||||
*
|
||||
*/
|
||||
WIDGET_API int XPUDefocusKeyboard(
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
intptr_t inParam1,
|
||||
intptr_t inParam2,
|
||||
int inEatClick);
|
||||
|
||||
/*
|
||||
* XPUDragWidget
|
||||
*
|
||||
* XPUDragWidget drags the widget in response to mouse clicks. Pass in not
|
||||
* only the event, but the global coordinates of the drag region, which might
|
||||
* be a sub-region of your widget (for example, a title bar).
|
||||
*
|
||||
*/
|
||||
WIDGET_API int XPUDragWidget(
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
intptr_t inParam1,
|
||||
intptr_t inParam2,
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
569
xpcPlugin/SDK/CHeaders/Widgets/XPWidgets.h
Executable file
569
xpcPlugin/SDK/CHeaders/Widgets/XPWidgets.h
Executable file
@@ -0,0 +1,569 @@
|
||||
#ifndef _XPWidgets_h_
|
||||
#define _XPWidgets_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* WIDGETS - THEORY OF OPERATION AND NOTES
|
||||
*
|
||||
* Widgets are persistent view 'objects' for X-Plane. A widget is an object
|
||||
* referenced by its opaque handle (widget ID) and the APIs in this file. You
|
||||
* cannot access the widget's guts directly. Every Widget has the following
|
||||
* intrinsic data:
|
||||
*
|
||||
* - A bounding box defined in global screen coordinates with 0,0 in the
|
||||
* bottom left and +y = up, +x = right.
|
||||
*
|
||||
* - A visible box, which is the intersection of the bounding box with the
|
||||
* widget's parents visible box.
|
||||
*
|
||||
* - Zero or one parent widgets. (Always zero if the widget is a root widget.
|
||||
*
|
||||
*
|
||||
* - Zero or more child widgets.
|
||||
*
|
||||
* - Whether the widget is a root. Root widgets are the top level plugin
|
||||
* windows.
|
||||
*
|
||||
* - Whether the widget is visible.
|
||||
*
|
||||
* - A text string descriptor, whose meaning varies from widget to widget.
|
||||
*
|
||||
* - An arbitrary set of 32 bit integral properties defined by 32-bit integral
|
||||
* keys. This is how specific widgets
|
||||
*
|
||||
* store specific data.
|
||||
*
|
||||
* - A list of widget callbacks proc that implements the widgets behaviors.
|
||||
*
|
||||
* The Widgets library sends messages to widgets to request specific behaviors
|
||||
* or notify the widget of things.
|
||||
*
|
||||
* Widgets may have more than one callback function, in which case messages
|
||||
* are sent to the most recently added callback function until the message is
|
||||
* handled. Messages may also be sent to parents or children; see the
|
||||
* XPWidgetDefs.h header file for the different widget message dispatching
|
||||
* functions. By adding a callback function to a window you can 'subclass'
|
||||
* its behavior.
|
||||
*
|
||||
* A set of standard widgets are provided that serve common UI purposes. You
|
||||
* can also customize or implement entirely custom widgets.
|
||||
*
|
||||
* Widgets are different than other view hierarchies (most notably Win32,
|
||||
* which they bear a striking resemblance to) in the following ways:
|
||||
*
|
||||
* - Not all behavior can be patched. State that is managed by the XPWidgets
|
||||
* DLL and not by individual widgets cannot be customized.
|
||||
*
|
||||
* - All coordinates are in global screen coordinates. Coordinates are not
|
||||
* relative to an enclosing widget, nor are they relative to a display window.
|
||||
*
|
||||
*
|
||||
* - Widget messages are always dispatched synchronously, and there is no
|
||||
* concept of scheduling an update or a dirty region. Messages originate from
|
||||
* X-Plane as the sim cycle goes by. Since x-plane is constantly redrawing,
|
||||
* so are widgets; there is no need to mark a part of a widget as 'needing
|
||||
* redrawing' because redrawing happens frequently whether the widget needs it
|
||||
* or not.
|
||||
*
|
||||
* - Any widget may be a 'root' widget, causing it to be drawn; there is no
|
||||
* relationship between widget class and rootness. Root widgets are
|
||||
* imlemented as XPLMDisply windows.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPWidgetDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* WIDGET CREATION AND MANAGEMENT
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* XPCreateWidget
|
||||
*
|
||||
* This function creates a new widget and returns the new widget's ID to you.
|
||||
* If the widget creation fails for some reason, it returns NULL. Widget
|
||||
* creation will fail either if you pass a bad class ID or if there is not
|
||||
* adequate memory.
|
||||
*
|
||||
* Input Parameters:
|
||||
*
|
||||
* - Top, left, bottom, and right in global screen coordinates defining the
|
||||
* widget's location on the screen.
|
||||
*
|
||||
* - inVisible is 1 if the widget should be drawn, 0 to start the widget as
|
||||
* hidden.
|
||||
*
|
||||
* - inDescriptor is a null terminated string that will become the widget's
|
||||
* descriptor.
|
||||
*
|
||||
* - inIsRoot is 1 if this is going to be a root widget, 0 if it will not be.
|
||||
*
|
||||
* - inContainer is the ID of this widget's container. It must be 0 for a
|
||||
* root widget. for a non-root widget, pass the widget ID of the widget to
|
||||
* place this widget within. If this widget is not going to start inside
|
||||
* another widget, pass 0; this new widget will then just be floating off in
|
||||
* space (and will not be drawn until it is placed in a widget.
|
||||
*
|
||||
* - inClass is the class of the widget to draw. Use one of the predefined
|
||||
* class-IDs to create a standard widget.
|
||||
*
|
||||
* A note on widget embedding: a widget is only called (and will be drawn,
|
||||
* etc.) if it is placed within a widget that will be called. Root widgets
|
||||
* are always called. So it is possible to have whole chains of widgets that
|
||||
* are simply not called. You can preconstruct widget trees and then place
|
||||
* them into root widgets later to activate them if you wish.
|
||||
*
|
||||
*/
|
||||
WIDGET_API XPWidgetID XPCreateWidget(
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom,
|
||||
int inVisible,
|
||||
const char * inDescriptor,
|
||||
int inIsRoot,
|
||||
XPWidgetID inContainer,
|
||||
XPWidgetClass inClass);
|
||||
|
||||
/*
|
||||
* XPCreateCustomWidget
|
||||
*
|
||||
* This function is the same as XPCreateWidget except that instead of passing
|
||||
* a class ID, you pass your widget callback function pointer defining the
|
||||
* widget. Use this function to define a custom widget. All parameters are
|
||||
* the same as XPCreateWidget, except that the widget class has been replaced
|
||||
* with the widget function.
|
||||
*
|
||||
*/
|
||||
WIDGET_API XPWidgetID XPCreateCustomWidget(
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom,
|
||||
int inVisible,
|
||||
const char * inDescriptor,
|
||||
int inIsRoot,
|
||||
XPWidgetID inContainer,
|
||||
XPWidgetFunc_t inCallback);
|
||||
|
||||
/*
|
||||
* XPDestroyWidget
|
||||
*
|
||||
* This class destroys a widget. Pass in the ID of the widget to kill. If
|
||||
* you pass 1 for inDestroyChilren, the widget's children will be destroyed
|
||||
* first, then this widget will be destroyed. (Furthermore, the widget's
|
||||
* children will be destroyed with the inDestroyChildren flag set to 1, so the
|
||||
* destruction will recurse down the widget tree.) If you pass 0 for this
|
||||
* flag, the child widgets will simply end up with their parent set to 0.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPDestroyWidget(
|
||||
XPWidgetID inWidget,
|
||||
int inDestroyChildren);
|
||||
|
||||
/*
|
||||
* XPSendMessageToWidget
|
||||
*
|
||||
* This sends any message to a widget. You should probably not go around
|
||||
* simulating the predefined messages that the widgets library defines for
|
||||
* you. You may however define custom messages for your widgets and send them
|
||||
* with this method.
|
||||
*
|
||||
* This method supports several dispatching patterns; see XPDispatchMode for
|
||||
* more info. The function returns 1 if the message was handled, 0 if it was
|
||||
* not.
|
||||
*
|
||||
* For each widget that receives the message (see the dispatching modes), each
|
||||
* widget function from the most recently installed to the oldest one
|
||||
* receives the message in order until it is handled.
|
||||
*
|
||||
*/
|
||||
WIDGET_API int XPSendMessageToWidget(
|
||||
XPWidgetID inWidget,
|
||||
XPWidgetMessage inMessage,
|
||||
XPDispatchMode inMode,
|
||||
intptr_t inParam1,
|
||||
intptr_t inParam2);
|
||||
|
||||
/***************************************************************************
|
||||
* WIDGET POSITIONING AND VISIBILITY
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* XPPlaceWidgetWithin
|
||||
*
|
||||
* This function changes which container a widget resides in. You may NOT use
|
||||
* this function on a root widget! inSubWidget is the widget that will be
|
||||
* moved. Pass a widget ID in inContainer to make inSubWidget be a child of
|
||||
* inContainer. It will become the last/closest widget in the container.
|
||||
* Pass 0 to remove the widget from any container. Any call to this other
|
||||
* than passing the widget ID of the old parent of the affected widget will
|
||||
* cause the widget to be removed from its old parent. Placing a widget within
|
||||
* its own parent simply makes it the last widget.
|
||||
*
|
||||
* NOTE: this routine does not reposition the sub widget in global
|
||||
* coordinates. If the container has layout management code, it will
|
||||
* reposition the subwidget for you, otherwise you must do it with
|
||||
* SetWidgetGeometry.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPPlaceWidgetWithin(
|
||||
XPWidgetID inSubWidget,
|
||||
XPWidgetID inContainer);
|
||||
|
||||
/*
|
||||
* XPCountChildWidgets
|
||||
*
|
||||
* This routine returns the number of widgets another widget contains.
|
||||
*
|
||||
*/
|
||||
WIDGET_API int XPCountChildWidgets(
|
||||
XPWidgetID inWidget);
|
||||
|
||||
/*
|
||||
* XPGetNthChildWidget
|
||||
*
|
||||
* This routine returns the widget ID of a child widget by index. Indexes are
|
||||
* 0 based, from 0 to one minus the number of widgets in the parent,
|
||||
* inclusive. If the index is invalid, 0 is returned.
|
||||
*
|
||||
*/
|
||||
WIDGET_API XPWidgetID XPGetNthChildWidget(
|
||||
XPWidgetID inWidget,
|
||||
int inIndex);
|
||||
|
||||
/*
|
||||
* XPGetParentWidget
|
||||
*
|
||||
* This routine returns the parent of a widget, or 0 if the widget has no
|
||||
* parent. Root widgets never have parents and therefore always return 0.
|
||||
*
|
||||
*/
|
||||
WIDGET_API XPWidgetID XPGetParentWidget(
|
||||
XPWidgetID inWidget);
|
||||
|
||||
/*
|
||||
* XPShowWidget
|
||||
*
|
||||
* This routine makes a widget visible if it is not already. Note that if a
|
||||
* widget is not in a rooted widget hierarchy or one of its parents is not
|
||||
* visible, it will still not be visible to the user.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPShowWidget(
|
||||
XPWidgetID inWidget);
|
||||
|
||||
/*
|
||||
* XPHideWidget
|
||||
*
|
||||
* Makes a widget invisible. See XPShowWidget for considerations of when a
|
||||
* widget might not be visible despite its own visibility state.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPHideWidget(
|
||||
XPWidgetID inWidget);
|
||||
|
||||
/*
|
||||
* XPIsWidgetVisible
|
||||
*
|
||||
* This returns 1 if a widget is visible, 0 if it is not. Note that this
|
||||
* routine takes into consideration whether a parent is invisible. Use this
|
||||
* routine to tell if the user can see the widget.
|
||||
*
|
||||
*/
|
||||
WIDGET_API int XPIsWidgetVisible(
|
||||
XPWidgetID inWidget);
|
||||
|
||||
/*
|
||||
* XPFindRootWidget
|
||||
*
|
||||
* XPFindRootWidget returns the Widget ID of the root widget that contains the
|
||||
* passed in widget or NULL if the passed in widget is not in a rooted
|
||||
* hierarchy.
|
||||
*
|
||||
*/
|
||||
WIDGET_API XPWidgetID XPFindRootWidget(
|
||||
XPWidgetID inWidget);
|
||||
|
||||
/*
|
||||
* XPBringRootWidgetToFront
|
||||
*
|
||||
* This routine makes the specified widget be in the front most widget
|
||||
* hierarchy. If this widget is a root widget, its widget hierarchy comes to
|
||||
* front, otherwise the widget's root is brought to the front. If this widget
|
||||
* is not in an active widget hiearchy (e.g. there is no root widget at the
|
||||
* top of the tree), this routine does nothing.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPBringRootWidgetToFront(
|
||||
XPWidgetID inWidget);
|
||||
|
||||
/*
|
||||
* XPIsWidgetInFront
|
||||
*
|
||||
* This routine returns true if this widget's hierarchy is the front most
|
||||
* hierarchy. It returns false if the widget's hierarchy is not in front, or
|
||||
* if the widget is not in a rooted hierarchy.
|
||||
*
|
||||
*/
|
||||
WIDGET_API int XPIsWidgetInFront(
|
||||
XPWidgetID inWidget);
|
||||
|
||||
/*
|
||||
* XPGetWidgetGeometry
|
||||
*
|
||||
* This routine returns the bounding box of a widget in global coordinates.
|
||||
* Pass NULL for any parameter you are not interested in.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPGetWidgetGeometry(
|
||||
XPWidgetID inWidget,
|
||||
int * outLeft, /* Can be NULL */
|
||||
int * outTop, /* Can be NULL */
|
||||
int * outRight, /* Can be NULL */
|
||||
int * outBottom); /* Can be NULL */
|
||||
|
||||
/*
|
||||
* XPSetWidgetGeometry
|
||||
*
|
||||
* This function changes the bounding box of a widget.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPSetWidgetGeometry(
|
||||
XPWidgetID inWidget,
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom);
|
||||
|
||||
/*
|
||||
* XPGetWidgetForLocation
|
||||
*
|
||||
* Given a widget and a location, this routine returns the widget ID of the
|
||||
* child of that widget that owns that location. If inRecursive is true then
|
||||
* this will return a child of a child of a widget as it tries to find the
|
||||
* deepest widget at that location. If inVisibleOnly is true, then only
|
||||
* visible widgets are considered, otherwise all widgets are considered. The
|
||||
* widget ID passed for inContainer will be returned if the location is in
|
||||
* that widget but not in a child widget. 0 is returned if the location is
|
||||
* not in the container.
|
||||
*
|
||||
* NOTE: if a widget's geometry extends outside its parents geometry, it will
|
||||
* not be returned by this call for mouse locations outside the parent
|
||||
* geometry. The parent geometry limits the child's eligibility for mouse
|
||||
* location.
|
||||
*
|
||||
*/
|
||||
WIDGET_API XPWidgetID XPGetWidgetForLocation(
|
||||
XPWidgetID inContainer,
|
||||
int inXOffset,
|
||||
int inYOffset,
|
||||
int inRecursive,
|
||||
int inVisibleOnly);
|
||||
|
||||
/*
|
||||
* XPGetWidgetExposedGeometry
|
||||
*
|
||||
* This routine returns the bounds of the area of a widget that is completely
|
||||
* within its parent widgets. Since a widget's bounding box can be outside
|
||||
* its parent, part of its area will not be elligible for mouse clicks and
|
||||
* should not draw. Use XPGetWidgetGeometry to find out what area defines
|
||||
* your widget's shape, but use this routine to find out what area to actually
|
||||
* draw into. Note that the widget library does not use OpenGL clipping to
|
||||
* keep frame rates up, although you could use it internally.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPGetWidgetExposedGeometry(
|
||||
XPWidgetID inWidgetID,
|
||||
int * outLeft, /* Can be NULL */
|
||||
int * outTop, /* Can be NULL */
|
||||
int * outRight, /* Can be NULL */
|
||||
int * outBottom); /* Can be NULL */
|
||||
|
||||
/***************************************************************************
|
||||
* ACCESSING WIDGET DATA
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* XPSetWidgetDescriptor
|
||||
*
|
||||
* Every widget has a descriptor, which is a text string. What the text
|
||||
* string is used for varies from widget to widget; for example, a push
|
||||
* button's text is its descriptor, a caption shows its descriptor, and a text
|
||||
* field's descriptor is the text being edited. In other words, the usage for
|
||||
* the text varies from widget to widget, but this API provides a universal
|
||||
* and convenient way to get at it. While not all UI widgets need their
|
||||
* descriptor, many do.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPSetWidgetDescriptor(
|
||||
XPWidgetID inWidget,
|
||||
const char * inDescriptor);
|
||||
|
||||
/*
|
||||
* XPGetWidgetDescriptor
|
||||
*
|
||||
* This routine returns the widget's descriptor. Pass in the length of the
|
||||
* buffer you are going to receive the descriptor in. The descriptor will be
|
||||
* null terminated for you. This routine returns the length of the actual
|
||||
* descriptor; if you pass NULL for outDescriptor, you can get the
|
||||
* descriptor's length without getting its text. If the length of the
|
||||
* descriptor exceeds your buffer length, the buffer will not be null
|
||||
* terminated (this routine has 'strncpy' semantics).
|
||||
*
|
||||
*/
|
||||
WIDGET_API int XPGetWidgetDescriptor(
|
||||
XPWidgetID inWidget,
|
||||
char * outDescriptor,
|
||||
int inMaxDescLength);
|
||||
|
||||
/*
|
||||
* XPSetWidgetProperty
|
||||
*
|
||||
* This function sets a widget's property. Properties are arbitrary values
|
||||
* associated by a widget by ID.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPSetWidgetProperty(
|
||||
XPWidgetID inWidget,
|
||||
XPWidgetPropertyID inProperty,
|
||||
intptr_t inValue);
|
||||
|
||||
/*
|
||||
* XPGetWidgetProperty
|
||||
*
|
||||
* This routine returns the value of a widget's property, or 0 if the property
|
||||
* is not defined. If you need to know whether the property is defined, pass
|
||||
* a pointer to an int for inExists; the existence of that property will be
|
||||
* returned in the int. Pass NULL for inExists if you do not need this
|
||||
* information.
|
||||
*
|
||||
*/
|
||||
WIDGET_API intptr_t XPGetWidgetProperty(
|
||||
XPWidgetID inWidget,
|
||||
XPWidgetPropertyID inProperty,
|
||||
int * inExists); /* Can be NULL */
|
||||
|
||||
/***************************************************************************
|
||||
* KEYBOARD MANAGEMENT
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* XPSetKeyboardFocus
|
||||
*
|
||||
* XPSetKeyboardFocus controls which widget will receive keystrokes. Pass the
|
||||
* Widget ID of the widget to get the keys. Note that if the widget does not
|
||||
* care about keystrokes, they will go to the parent widget, and if no widget
|
||||
* cares about them, they go to X-Plane.
|
||||
*
|
||||
* If you set the keyboard focus to Widget ID 0, X-Plane gets keyboard focus.
|
||||
*
|
||||
* This routine returns the widget ID that ended up with keyboard focus, or 0
|
||||
* for x-plane.
|
||||
*
|
||||
* Keyboard focus is not changed if the new widget will not accept it. For
|
||||
* setting to x-plane, keyboard focus is always accepted.
|
||||
*
|
||||
* *
|
||||
*/
|
||||
WIDGET_API XPWidgetID XPSetKeyboardFocus(
|
||||
XPWidgetID inWidget);
|
||||
|
||||
/*
|
||||
* XPLoseKeyboardFocus
|
||||
*
|
||||
* This causes the specified widget to lose focus; focus is passed to its
|
||||
* parent, or the next parent that will accept it. This routine does nothing
|
||||
* if this widget does not have focus.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPLoseKeyboardFocus(
|
||||
XPWidgetID inWidget);
|
||||
|
||||
/*
|
||||
* XPGetWidgetWithFocus
|
||||
*
|
||||
* This routine returns the widget that has keyboard focus, or 0 if X-Plane
|
||||
* has keyboard focus or some other plugin window that does not have widgets
|
||||
* has focus.
|
||||
*
|
||||
*/
|
||||
WIDGET_API XPWidgetID XPGetWidgetWithFocus(void);
|
||||
|
||||
/***************************************************************************
|
||||
* CREATING CUSTOM WIDGETS
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* XPAddWidgetCallback
|
||||
*
|
||||
* This function adds a new widget callback to a widget. This widget callback
|
||||
* supercedes any existing ones and will receive messages first; if it does
|
||||
* not handle messages they will go on to be handled by pre-existing widgets.
|
||||
*
|
||||
* The widget function will remain on the widget for the life of the widget.
|
||||
* The creation message will be sent to the new callback immediately with the
|
||||
* widget ID, and the destruction message will be sent before the other widget
|
||||
* function receives a destruction message.
|
||||
*
|
||||
* This provides a way to 'subclass' an existing widget. By providing a
|
||||
* second hook that only handles certain widget messages, you can customize or
|
||||
* extend widget behavior.
|
||||
*
|
||||
*/
|
||||
WIDGET_API void XPAddWidgetCallback(
|
||||
XPWidgetID inWidget,
|
||||
XPWidgetFunc_t inNewCallback);
|
||||
|
||||
/*
|
||||
* XPGetWidgetClassFunc
|
||||
*
|
||||
* Given a widget class, this function returns the callbacks that power that
|
||||
* widget class.
|
||||
*
|
||||
*/
|
||||
WIDGET_API XPWidgetFunc_t XPGetWidgetClassFunc(
|
||||
XPWidgetClass inWidgetClass);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
56
xpcPlugin/SDK/CHeaders/Wrappers/XPCBroadcaster.cpp
Executable file
56
xpcPlugin/SDK/CHeaders/Wrappers/XPCBroadcaster.cpp
Executable file
@@ -0,0 +1,56 @@
|
||||
#include "XPCBroadcaster.h"
|
||||
#include "XPCListener.h"
|
||||
|
||||
XPCBroadcaster::XPCBroadcaster() :
|
||||
mIterator(NULL)
|
||||
{
|
||||
}
|
||||
|
||||
XPCBroadcaster::~XPCBroadcaster()
|
||||
{
|
||||
ListenerVector::iterator iter;
|
||||
mIterator = &iter;
|
||||
for (iter = mListeners.begin(); iter != mListeners.end(); ++iter)
|
||||
{
|
||||
(*iter)->BroadcasterRemoved(this);
|
||||
}
|
||||
}
|
||||
|
||||
void XPCBroadcaster::AddListener(
|
||||
XPCListener * inListener)
|
||||
{
|
||||
mListeners.push_back(inListener);
|
||||
inListener->BroadcasterAdded(this);
|
||||
}
|
||||
|
||||
void XPCBroadcaster::RemoveListener(
|
||||
XPCListener * inListener)
|
||||
{
|
||||
ListenerVector::iterator iter = std::find
|
||||
(mListeners.begin(), mListeners.end(), inListener);
|
||||
if (iter == mListeners.end())
|
||||
return;
|
||||
|
||||
if (mIterator != NULL)
|
||||
{
|
||||
if (*mIterator >= iter)
|
||||
(*mIterator)--;
|
||||
}
|
||||
|
||||
mListeners.erase(iter);
|
||||
inListener->BroadcasterRemoved(this);
|
||||
}
|
||||
|
||||
void XPCBroadcaster::BroadcastMessage(
|
||||
long inMessage,
|
||||
void * inParam)
|
||||
{
|
||||
ListenerVector::iterator iter;
|
||||
mIterator = &iter;
|
||||
for (iter = mListeners.begin(); iter != mListeners.end(); ++iter)
|
||||
{
|
||||
(*iter)->ListenToMessage(inMessage, inParam);
|
||||
}
|
||||
mIterator = NULL;
|
||||
}
|
||||
|
||||
38
xpcPlugin/SDK/CHeaders/Wrappers/XPCBroadcaster.h
Executable file
38
xpcPlugin/SDK/CHeaders/Wrappers/XPCBroadcaster.h
Executable file
@@ -0,0 +1,38 @@
|
||||
#ifndef _XPCBroadcaster_h_
|
||||
#define _XPCBroadcaster_h_
|
||||
|
||||
#include <vector>
|
||||
#include <algorithm>
|
||||
|
||||
class XPCListener;
|
||||
|
||||
class XPCBroadcaster {
|
||||
public:
|
||||
|
||||
XPCBroadcaster();
|
||||
virtual ~XPCBroadcaster();
|
||||
|
||||
void AddListener(
|
||||
XPCListener * inListener);
|
||||
void RemoveListener(
|
||||
XPCListener * inListener);
|
||||
|
||||
protected:
|
||||
|
||||
void BroadcastMessage(
|
||||
long inMessage,
|
||||
void * inParam=0);
|
||||
|
||||
private:
|
||||
|
||||
typedef std::vector<XPCListener *> ListenerVector;
|
||||
|
||||
ListenerVector mListeners;
|
||||
|
||||
// Reentrancy support
|
||||
|
||||
ListenerVector::iterator * mIterator;
|
||||
|
||||
};
|
||||
|
||||
#endif
|
||||
104
xpcPlugin/SDK/CHeaders/Wrappers/XPCDisplay.cpp
Executable file
104
xpcPlugin/SDK/CHeaders/Wrappers/XPCDisplay.cpp
Executable file
@@ -0,0 +1,104 @@
|
||||
#include "XPCDisplay.h"
|
||||
|
||||
XPCKeySniffer::XPCKeySniffer(int inBeforeWindows) : mBeforeWindows(inBeforeWindows)
|
||||
{
|
||||
XPLMRegisterKeySniffer(KeySnifferCB, mBeforeWindows, reinterpret_cast<void *>(this));
|
||||
}
|
||||
|
||||
XPCKeySniffer::~XPCKeySniffer()
|
||||
{
|
||||
XPLMUnregisterKeySniffer(KeySnifferCB, mBeforeWindows, reinterpret_cast<void *>(this));
|
||||
}
|
||||
|
||||
|
||||
int XPCKeySniffer::KeySnifferCB(
|
||||
char inCharKey,
|
||||
XPLMKeyFlags inFlags,
|
||||
char inVirtualKey,
|
||||
void * inRefCon)
|
||||
{
|
||||
XPCKeySniffer * me = reinterpret_cast<XPCKeySniffer *>(inRefCon);
|
||||
return me->HandleKeyStroke(inCharKey, inFlags, inVirtualKey);
|
||||
}
|
||||
|
||||
XPCWindow::XPCWindow(
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom,
|
||||
int inIsVisible)
|
||||
{
|
||||
mWindow = XPLMCreateWindow(inLeft, inTop, inRight, inBottom, inIsVisible,
|
||||
DrawCB, HandleKeyCB, MouseClickCB,
|
||||
reinterpret_cast<void *>(this));
|
||||
}
|
||||
|
||||
XPCWindow::~XPCWindow()
|
||||
{
|
||||
XPLMDestroyWindow(mWindow);
|
||||
}
|
||||
|
||||
void XPCWindow::GetWindowGeometry(
|
||||
int * outLeft,
|
||||
int * outTop,
|
||||
int * outRight,
|
||||
int * outBottom)
|
||||
{
|
||||
XPLMGetWindowGeometry(mWindow, outLeft, outTop, outRight, outBottom);
|
||||
}
|
||||
|
||||
void XPCWindow::SetWindowGeometry(
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom)
|
||||
{
|
||||
XPLMSetWindowGeometry(mWindow, inLeft, inTop, inRight, inBottom);
|
||||
}
|
||||
|
||||
int XPCWindow::GetWindowIsVisible(void)
|
||||
{
|
||||
return XPLMGetWindowIsVisible(mWindow);
|
||||
}
|
||||
|
||||
void XPCWindow::SetWindowIsVisible(
|
||||
int inIsVisible)
|
||||
{
|
||||
XPLMSetWindowIsVisible(mWindow, inIsVisible);
|
||||
}
|
||||
|
||||
void XPCWindow::TakeKeyboardFocus(void)
|
||||
{
|
||||
XPLMTakeKeyboardFocus(mWindow);
|
||||
}
|
||||
|
||||
void XPCWindow::BringWindowToFront(void)
|
||||
{
|
||||
XPLMBringWindowToFront(mWindow);
|
||||
}
|
||||
|
||||
int XPCWindow::IsWindowInFront(void)
|
||||
{
|
||||
return XPLMIsWindowInFront(mWindow);
|
||||
}
|
||||
|
||||
void XPCWindow::DrawCB(XPLMWindowID inWindowID, void * inRefcon)
|
||||
{
|
||||
XPCWindow * me = reinterpret_cast<XPCWindow *>(inRefcon);
|
||||
me->DoDraw();
|
||||
}
|
||||
|
||||
void XPCWindow::HandleKeyCB(XPLMWindowID inWindowID, char inKey, XPLMKeyFlags inFlags, char inVirtualKey, void * inRefcon, int losingFocus)
|
||||
{
|
||||
XPCWindow * me = reinterpret_cast<XPCWindow *>(inRefcon);
|
||||
if (losingFocus)
|
||||
me->LoseFocus();
|
||||
else
|
||||
me->HandleKey(inKey, inFlags, inVirtualKey);
|
||||
}
|
||||
|
||||
int XPCWindow::MouseClickCB(XPLMWindowID inWindowID, int x, int y, XPLMMouseStatus inMouse, void * inRefcon)
|
||||
{
|
||||
XPCWindow * me = reinterpret_cast<XPCWindow *>(inRefcon);
|
||||
return me->HandleClick(x, y, inMouse);
|
||||
}
|
||||
73
xpcPlugin/SDK/CHeaders/Wrappers/XPCDisplay.h
Executable file
73
xpcPlugin/SDK/CHeaders/Wrappers/XPCDisplay.h
Executable file
@@ -0,0 +1,73 @@
|
||||
#ifndef _XPCDisplay_h_
|
||||
#define _XPCDisplay_h_
|
||||
|
||||
#include "XPLMDisplay.h"
|
||||
|
||||
class XPCKeySniffer {
|
||||
public:
|
||||
|
||||
XPCKeySniffer(int inBeforeWindows);
|
||||
virtual ~XPCKeySniffer();
|
||||
|
||||
virtual int HandleKeyStroke(
|
||||
char inCharKey,
|
||||
XPLMKeyFlags inFlags,
|
||||
char inVirtualKey)=0;
|
||||
|
||||
private:
|
||||
|
||||
int mBeforeWindows;
|
||||
|
||||
static int KeySnifferCB(
|
||||
char inCharKey,
|
||||
XPLMKeyFlags inFlags,
|
||||
char inVirtualKey,
|
||||
void * inRefCon);
|
||||
};
|
||||
|
||||
|
||||
|
||||
class XPCWindow {
|
||||
public:
|
||||
|
||||
XPCWindow(
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom,
|
||||
int inIsVisible);
|
||||
virtual ~XPCWindow();
|
||||
|
||||
virtual void DoDraw(void)=0;
|
||||
virtual void HandleKey(char inKey, XPLMKeyFlags inFlags, char inVirtualKey)=0;
|
||||
virtual void LoseFocus(void)=0;
|
||||
virtual int HandleClick(int x, int y, XPLMMouseStatus inMouse)=0;
|
||||
|
||||
void GetWindowGeometry(
|
||||
int * outLeft,
|
||||
int * outTop,
|
||||
int * outRight,
|
||||
int * outBottom);
|
||||
void SetWindowGeometry(
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom);
|
||||
int GetWindowIsVisible(void);
|
||||
void SetWindowIsVisible(
|
||||
int inIsVisible);
|
||||
void TakeKeyboardFocus(void);
|
||||
void BringWindowToFront(void);
|
||||
int IsWindowInFront(void);
|
||||
|
||||
private:
|
||||
|
||||
XPLMWindowID mWindow;
|
||||
|
||||
static void DrawCB(XPLMWindowID inWindowID, void * inRefcon);
|
||||
static void HandleKeyCB(XPLMWindowID inWindowID, char inKey, XPLMKeyFlags inFlags, char inVirtualKey, void * inRefcon, int losingFocus);
|
||||
static int MouseClickCB(XPLMWindowID inWindowID, int x, int y, XPLMMouseStatus inMouse, void * inRefcon);
|
||||
|
||||
};
|
||||
|
||||
#endif
|
||||
27
xpcPlugin/SDK/CHeaders/Wrappers/XPCListener.cpp
Executable file
27
xpcPlugin/SDK/CHeaders/Wrappers/XPCListener.cpp
Executable file
@@ -0,0 +1,27 @@
|
||||
#include "XPCListener.h"
|
||||
#include "XPCBroadcaster.h"
|
||||
|
||||
XPCListener::XPCListener()
|
||||
{
|
||||
}
|
||||
|
||||
XPCListener::~XPCListener()
|
||||
{
|
||||
while (!mBroadcasters.empty())
|
||||
mBroadcasters.front()->RemoveListener(this);
|
||||
}
|
||||
|
||||
void XPCListener::BroadcasterAdded(
|
||||
XPCBroadcaster * inBroadcaster)
|
||||
{
|
||||
mBroadcasters.push_back(inBroadcaster);
|
||||
}
|
||||
|
||||
void XPCListener::BroadcasterRemoved(
|
||||
XPCBroadcaster * inBroadcaster)
|
||||
{
|
||||
BroadcastVector::iterator iter = std::find(mBroadcasters.begin(),
|
||||
mBroadcasters.end(), inBroadcaster);
|
||||
if (iter != mBroadcasters.end())
|
||||
mBroadcasters.erase(iter);
|
||||
}
|
||||
36
xpcPlugin/SDK/CHeaders/Wrappers/XPCListener.h
Executable file
36
xpcPlugin/SDK/CHeaders/Wrappers/XPCListener.h
Executable file
@@ -0,0 +1,36 @@
|
||||
#ifndef _XPCListener_h_
|
||||
#define _XPCListener_h_
|
||||
|
||||
#include <vector>
|
||||
#include <algorithm>
|
||||
|
||||
class XPCBroadcaster;
|
||||
|
||||
|
||||
class XPCListener {
|
||||
public:
|
||||
|
||||
XPCListener();
|
||||
virtual ~XPCListener();
|
||||
|
||||
virtual void ListenToMessage(
|
||||
long inMessage,
|
||||
void * inParam)=0;
|
||||
|
||||
private:
|
||||
|
||||
typedef std::vector<XPCBroadcaster *> BroadcastVector;
|
||||
|
||||
BroadcastVector mBroadcasters;
|
||||
|
||||
friend class XPCBroadcaster;
|
||||
|
||||
void BroadcasterAdded(
|
||||
XPCBroadcaster * inBroadcaster);
|
||||
|
||||
void BroadcasterRemoved(
|
||||
XPCBroadcaster * inBroadcaster);
|
||||
|
||||
};
|
||||
|
||||
#endif
|
||||
52
xpcPlugin/SDK/CHeaders/Wrappers/XPCProcessing.cpp
Executable file
52
xpcPlugin/SDK/CHeaders/Wrappers/XPCProcessing.cpp
Executable file
@@ -0,0 +1,52 @@
|
||||
#include "XPCProcessing.h"
|
||||
#include "XPLMUtilities.h"
|
||||
|
||||
XPCProcess::XPCProcess() :
|
||||
mInCallback(false),
|
||||
mCallbackTime(0)
|
||||
{
|
||||
XPLMRegisterFlightLoopCallback(FlightLoopCB, 0, reinterpret_cast<void *>(this));
|
||||
}
|
||||
|
||||
XPCProcess::~XPCProcess()
|
||||
{
|
||||
XPLMUnregisterFlightLoopCallback(FlightLoopCB, reinterpret_cast<void *>(this));
|
||||
}
|
||||
|
||||
void XPCProcess::StartProcessTime(float inSeconds)
|
||||
{
|
||||
mCallbackTime = inSeconds;
|
||||
if (!mInCallback)
|
||||
XPLMSetFlightLoopCallbackInterval(
|
||||
FlightLoopCB, mCallbackTime, 1/*relative to now*/, reinterpret_cast<void *>(this));
|
||||
}
|
||||
|
||||
void XPCProcess::StartProcessCycles(long inCycles)
|
||||
{
|
||||
mCallbackTime = -inCycles;
|
||||
if (!mInCallback)
|
||||
XPLMSetFlightLoopCallbackInterval(
|
||||
FlightLoopCB, mCallbackTime, 1/*relative to now*/, reinterpret_cast<void *>(this));
|
||||
}
|
||||
|
||||
void XPCProcess::StopProcess(void)
|
||||
{
|
||||
mCallbackTime = 0;
|
||||
if (!mInCallback)
|
||||
XPLMSetFlightLoopCallbackInterval(
|
||||
FlightLoopCB, mCallbackTime, 1/*relative to now*/, reinterpret_cast<void *>(this));
|
||||
}
|
||||
|
||||
|
||||
float XPCProcess::FlightLoopCB(
|
||||
float inElapsedSinceLastCall,
|
||||
float inElapsedTimeSinceLastFlightLoop,
|
||||
int inCounter,
|
||||
void * inRefcon)
|
||||
{
|
||||
XPCProcess * me = reinterpret_cast<XPCProcess *>(inRefcon);
|
||||
me->mInCallback = true;
|
||||
me->DoProcessing(inElapsedSinceLastCall, inElapsedTimeSinceLastFlightLoop, inCounter);
|
||||
me->mInCallback = false;
|
||||
return me->mCallbackTime;
|
||||
}
|
||||
37
xpcPlugin/SDK/CHeaders/Wrappers/XPCProcessing.h
Executable file
37
xpcPlugin/SDK/CHeaders/Wrappers/XPCProcessing.h
Executable file
@@ -0,0 +1,37 @@
|
||||
#ifndef _XPCProcessing_h_
|
||||
#define _XPCProcessing_h_
|
||||
|
||||
#include "XPLMProcessing.h"
|
||||
|
||||
class XPCProcess {
|
||||
public:
|
||||
|
||||
XPCProcess();
|
||||
virtual ~XPCProcess();
|
||||
|
||||
void StartProcessTime(float inSeconds);
|
||||
void StartProcessCycles(long inCycles);
|
||||
void StopProcess(void);
|
||||
|
||||
virtual void DoProcessing(
|
||||
float inElapsedSinceLastCall,
|
||||
float inElapsedTimeSinceLastFlightLoop,
|
||||
int inCounter)=0;
|
||||
|
||||
private:
|
||||
|
||||
static float FlightLoopCB(
|
||||
float inElapsedSinceLastCall,
|
||||
float inElapsedTimeSinceLastFlightLoop,
|
||||
int inCounter,
|
||||
void * inRefcon);
|
||||
|
||||
bool mInCallback;
|
||||
float mCallbackTime;
|
||||
|
||||
XPCProcess(const XPCProcess&);
|
||||
XPCProcess& operator=(const XPCProcess&);
|
||||
|
||||
};
|
||||
|
||||
#endif
|
||||
123
xpcPlugin/SDK/CHeaders/Wrappers/XPCWidget.cpp
Executable file
123
xpcPlugin/SDK/CHeaders/Wrappers/XPCWidget.cpp
Executable file
@@ -0,0 +1,123 @@
|
||||
#include "XPCWidget.h"
|
||||
|
||||
XPCWidget::XPCWidget(
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom,
|
||||
bool inVisible,
|
||||
const char * inDescriptor,
|
||||
bool inIsRoot,
|
||||
XPWidgetID inParent,
|
||||
XPWidgetClass inClass) :
|
||||
mWidget(NULL),
|
||||
mOwnsChildren(false),
|
||||
mOwnsWidget(true)
|
||||
{
|
||||
mWidget = XPCreateWidget(
|
||||
inLeft, inTop, inRight, inBottom,
|
||||
inVisible ? 1 : 0,
|
||||
inDescriptor,
|
||||
inIsRoot ? 1 : 0,
|
||||
inIsRoot ? NULL : inParent,
|
||||
inClass);
|
||||
|
||||
XPSetWidgetProperty(mWidget, xpProperty_Object, reinterpret_cast<long>(this));
|
||||
XPAddWidgetCallback(mWidget, WidgetCallback);
|
||||
}
|
||||
|
||||
XPCWidget::XPCWidget(
|
||||
XPWidgetID inWidget,
|
||||
bool inOwnsWidget) :
|
||||
mWidget(inWidget),
|
||||
mOwnsChildren(false),
|
||||
mOwnsWidget(inOwnsWidget)
|
||||
{
|
||||
XPSetWidgetProperty(mWidget, xpProperty_Object, reinterpret_cast<long>(this));
|
||||
XPAddWidgetCallback(mWidget, WidgetCallback);
|
||||
}
|
||||
|
||||
XPCWidget::~XPCWidget()
|
||||
{
|
||||
if (mOwnsWidget)
|
||||
XPDestroyWidget(mWidget, mOwnsChildren ? 1 : 0);
|
||||
}
|
||||
|
||||
void XPCWidget::SetOwnsWidget(
|
||||
bool inOwnsWidget)
|
||||
{
|
||||
mOwnsWidget = inOwnsWidget;
|
||||
}
|
||||
|
||||
void XPCWidget::SetOwnsChildren(
|
||||
bool inOwnsChildren)
|
||||
{
|
||||
mOwnsChildren = inOwnsChildren;
|
||||
}
|
||||
|
||||
XPCWidget::operator XPWidgetID () const
|
||||
{
|
||||
return mWidget;
|
||||
}
|
||||
|
||||
XPWidgetID XPCWidget::Get(void) const
|
||||
{
|
||||
return mWidget;
|
||||
}
|
||||
|
||||
void XPCWidget::AddAttachment(
|
||||
XPCWidgetAttachment * inAttachment,
|
||||
bool inOwnsAttachment,
|
||||
bool inPrefilter)
|
||||
{
|
||||
if (inPrefilter)
|
||||
{
|
||||
mAttachments.insert(mAttachments.begin(), AttachmentInfo(inAttachment, inOwnsAttachment));
|
||||
} else {
|
||||
mAttachments.push_back(AttachmentInfo(inAttachment, inOwnsAttachment));
|
||||
}
|
||||
}
|
||||
|
||||
void XPCWidget::RemoveAttachment(
|
||||
XPCWidgetAttachment * inAttachment)
|
||||
{
|
||||
for (AttachmentVector::iterator iter = mAttachments.begin();
|
||||
iter != mAttachments.end(); ++iter)
|
||||
{
|
||||
if (iter->first == inAttachment)
|
||||
{
|
||||
mAttachments.erase(iter);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
int XPCWidget::HandleWidgetMessage(
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
int XPCWidget::WidgetCallback(
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2)
|
||||
{
|
||||
XPCWidget * me = reinterpret_cast<XPCWidget *>(XPGetWidgetProperty(inWidget, xpProperty_Object, NULL));
|
||||
if (me == NULL)
|
||||
return 0;
|
||||
|
||||
for (AttachmentVector::iterator iter = me->mAttachments.begin(); iter !=
|
||||
me->mAttachments.end(); ++iter)
|
||||
{
|
||||
int result = iter->first->HandleWidgetMessage(me, inMessage, inWidget, inParam1, inParam2);
|
||||
if (result != 0)
|
||||
return result;
|
||||
}
|
||||
|
||||
return me->HandleWidgetMessage(inMessage, inWidget, inParam1, inParam2);
|
||||
}
|
||||
84
xpcPlugin/SDK/CHeaders/Wrappers/XPCWidget.h
Executable file
84
xpcPlugin/SDK/CHeaders/Wrappers/XPCWidget.h
Executable file
@@ -0,0 +1,84 @@
|
||||
#ifndef _XPCWidget_h_
|
||||
#define _XPCWidget_h_
|
||||
|
||||
#include <vector>
|
||||
#include <algorithm>
|
||||
#include "XPWidgets.h"
|
||||
|
||||
class XPCWidget;
|
||||
|
||||
class XPCWidgetAttachment {
|
||||
public:
|
||||
|
||||
virtual int HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2)=0;
|
||||
|
||||
};
|
||||
|
||||
class XPCWidget {
|
||||
public:
|
||||
|
||||
XPCWidget(
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom,
|
||||
bool inVisible,
|
||||
const char * inDescriptor,
|
||||
bool inIsRoot,
|
||||
XPWidgetID inParent,
|
||||
XPWidgetClass inClass);
|
||||
XPCWidget(
|
||||
XPWidgetID inWidget,
|
||||
bool inOwnsWidget);
|
||||
virtual ~XPCWidget();
|
||||
|
||||
void SetOwnsWidget(
|
||||
bool inOwnsWidget);
|
||||
void SetOwnsChildren(
|
||||
bool inOwnsChildren);
|
||||
|
||||
operator XPWidgetID () const;
|
||||
|
||||
XPWidgetID Get(void) const;
|
||||
|
||||
void AddAttachment(
|
||||
XPCWidgetAttachment * inAttachment,
|
||||
bool inOwnsAttachment,
|
||||
bool inPrefilter);
|
||||
void RemoveAttachment(
|
||||
XPCWidgetAttachment * inAttachment);
|
||||
|
||||
virtual int HandleWidgetMessage(
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2);
|
||||
|
||||
private:
|
||||
|
||||
static int WidgetCallback(
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2);
|
||||
|
||||
typedef std::pair<XPCWidgetAttachment *, bool> AttachmentInfo;
|
||||
typedef std::vector<AttachmentInfo> AttachmentVector;
|
||||
|
||||
AttachmentVector mAttachments;
|
||||
XPWidgetID mWidget;
|
||||
bool mOwnsChildren;
|
||||
bool mOwnsWidget;
|
||||
|
||||
XPCWidget();
|
||||
XPCWidget(const XPCWidget&);
|
||||
XPCWidget& operator=(const XPCWidget&);
|
||||
|
||||
};
|
||||
|
||||
#endif
|
||||
267
xpcPlugin/SDK/CHeaders/Wrappers/XPCWidgetAttachments.cpp
Executable file
267
xpcPlugin/SDK/CHeaders/Wrappers/XPCWidgetAttachments.cpp
Executable file
@@ -0,0 +1,267 @@
|
||||
#include "XPCWidgetAttachments.h"
|
||||
#include "XPStandardWidgets.h"
|
||||
#include "XPWidgetUtils.h"
|
||||
|
||||
static void XPCGetOrderedSubWidgets(
|
||||
XPWidgetID inWidget,
|
||||
std::vector<XPWidgetID>& outChildren);
|
||||
|
||||
XPCKeyFilterAttachment::XPCKeyFilterAttachment(
|
||||
const char * inValidKeys,
|
||||
const char * outValidKeys) :
|
||||
mInput(inValidKeys),
|
||||
mOutput(outValidKeys)
|
||||
{
|
||||
}
|
||||
|
||||
XPCKeyFilterAttachment::~XPCKeyFilterAttachment()
|
||||
{
|
||||
}
|
||||
|
||||
int XPCKeyFilterAttachment::HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2)
|
||||
{
|
||||
if (inMessage == xpMsg_KeyPress)
|
||||
{
|
||||
char& theKey = KEY_CHAR(inParam1);
|
||||
std::string::size_type pos = mInput.find(theKey);
|
||||
if (pos == std::string::npos)
|
||||
return 1; // Not found; eat the key!
|
||||
else {
|
||||
theKey = mOutput[pos];
|
||||
return 0;
|
||||
} // Let it live.
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
XPCKeyMessageAttachment::XPCKeyMessageAttachment(
|
||||
char inKey,
|
||||
long inMessage,
|
||||
void * inParam,
|
||||
bool inConsume,
|
||||
bool inVkey,
|
||||
XPCListener * inListener) :
|
||||
mKey(inKey), mMsg(inMessage), mParam(inParam), mConsume(inConsume),
|
||||
mVkey(inVkey)
|
||||
{
|
||||
if (inListener != NULL)
|
||||
this->AddListener(inListener);
|
||||
}
|
||||
|
||||
XPCKeyMessageAttachment::~XPCKeyMessageAttachment()
|
||||
{
|
||||
}
|
||||
|
||||
int XPCKeyMessageAttachment::HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2)
|
||||
{
|
||||
if (inMessage == xpMsg_KeyPress)
|
||||
{
|
||||
char theKey = mVkey ? KEY_VKEY(inParam1) : KEY_CHAR(inParam1);
|
||||
if (theKey != mKey)
|
||||
return 0;
|
||||
if (!(KEY_FLAGS(inParam1) & xplm_DownFlag))
|
||||
return 0;
|
||||
|
||||
BroadcastMessage(mMsg, mParam);
|
||||
return mConsume ? 1 : 0;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
XPCPushButtonMessageAttachment::XPCPushButtonMessageAttachment(
|
||||
XPWidgetID inWidget,
|
||||
long inMessage,
|
||||
void * inParam,
|
||||
XPCListener * inListener) :
|
||||
mMsg(inMessage), mParam(inParam), mWidget(inWidget)
|
||||
{
|
||||
if (inListener != NULL)
|
||||
this->AddListener(inListener);
|
||||
}
|
||||
|
||||
XPCPushButtonMessageAttachment::~XPCPushButtonMessageAttachment()
|
||||
{
|
||||
}
|
||||
|
||||
int XPCPushButtonMessageAttachment::HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2)
|
||||
{
|
||||
if ((inMessage == xpMsg_PushButtonPressed) && ((XPWidgetID) inParam1 == mWidget))
|
||||
{
|
||||
BroadcastMessage(mMsg, mParam);
|
||||
return 1;
|
||||
}
|
||||
|
||||
if ((inMessage == xpMsg_ButtonStateChanged) && ((XPWidgetID) inParam1 == mWidget))
|
||||
{
|
||||
BroadcastMessage(mMsg, mParam);
|
||||
return 1;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
XPCSliderMessageAttachment::XPCSliderMessageAttachment(
|
||||
XPWidgetID inWidget,
|
||||
long inMessage,
|
||||
void * inParam,
|
||||
XPCListener * inListener) :
|
||||
mMsg(inMessage), mParam(inParam), mWidget(inWidget)
|
||||
{
|
||||
if (inListener != NULL)
|
||||
this->AddListener(inListener);
|
||||
}
|
||||
|
||||
XPCSliderMessageAttachment::~XPCSliderMessageAttachment()
|
||||
{
|
||||
}
|
||||
|
||||
int XPCSliderMessageAttachment::HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2)
|
||||
{
|
||||
if ((inMessage == xpMsg_ScrollBarSliderPositionChanged) && ((XPWidgetID) inParam1 == mWidget))
|
||||
{
|
||||
BroadcastMessage(mMsg, mParam);
|
||||
return 1;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
XPCCloseButtonMessageAttachment::XPCCloseButtonMessageAttachment(
|
||||
XPWidgetID inWidget,
|
||||
long inMessage,
|
||||
void * inParam,
|
||||
XPCListener * inListener) :
|
||||
mMsg(inMessage), mParam(inParam), mWidget(inWidget)
|
||||
{
|
||||
if (inListener != NULL)
|
||||
this->AddListener(inListener);
|
||||
}
|
||||
|
||||
XPCCloseButtonMessageAttachment::~XPCCloseButtonMessageAttachment()
|
||||
{
|
||||
}
|
||||
|
||||
int XPCCloseButtonMessageAttachment::HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2)
|
||||
{
|
||||
if ((inMessage == xpMessage_CloseButtonPushed) && ((XPWidgetID) inParam1 == mWidget))
|
||||
{
|
||||
BroadcastMessage(mMsg, mParam);
|
||||
return 1;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
XPCTabGroupAttachment::XPCTabGroupAttachment()
|
||||
{
|
||||
}
|
||||
|
||||
XPCTabGroupAttachment::~XPCTabGroupAttachment()
|
||||
{
|
||||
}
|
||||
|
||||
int XPCTabGroupAttachment::HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2)
|
||||
{
|
||||
if ((inMessage == xpMsg_KeyPress) && (KEY_CHAR(inParam1) == XPLM_KEY_TAB) &&
|
||||
((KEY_FLAGS(inParam1) & xplm_UpFlag) == 0))
|
||||
{
|
||||
bool backwards = (KEY_FLAGS(inParam1) & xplm_ShiftFlag) != 0;
|
||||
std::vector<XPWidgetID> widgets;
|
||||
XPCGetOrderedSubWidgets(inWidget, widgets);
|
||||
long n, index = 0;
|
||||
XPWidgetID focusWidget = XPGetWidgetWithFocus();
|
||||
std::vector<XPWidgetID>::iterator iter = std::find(widgets.begin(), widgets.end(), focusWidget);
|
||||
if (iter != widgets.end())
|
||||
{
|
||||
index = std::distance(widgets.begin(), iter);
|
||||
if (backwards)
|
||||
index--;
|
||||
else
|
||||
index++;
|
||||
if (index < 0)
|
||||
index = widgets.size() - 1;
|
||||
if (index >= widgets.size())
|
||||
index = 0;
|
||||
}
|
||||
|
||||
if (backwards)
|
||||
{
|
||||
for (n = index; n >= 0; --n)
|
||||
{
|
||||
if (XPGetWidgetProperty(widgets[n], xpProperty_Enabled, NULL))
|
||||
if (XPSetKeyboardFocus(widgets[n]) != NULL)
|
||||
return 1;
|
||||
}
|
||||
for (n = widgets.size() - 1; n > index; --n)
|
||||
{
|
||||
if (XPGetWidgetProperty(widgets[n], xpProperty_Enabled, NULL))
|
||||
if (XPSetKeyboardFocus(widgets[n]) != NULL)
|
||||
return 1;
|
||||
}
|
||||
} else {
|
||||
for (n = index; n < widgets.size(); ++n)
|
||||
{
|
||||
if (XPGetWidgetProperty(widgets[n], xpProperty_Enabled, NULL))
|
||||
if (XPSetKeyboardFocus(widgets[n]) != NULL)
|
||||
return 1;
|
||||
}
|
||||
for (n = 0; n < index; ++n)
|
||||
{
|
||||
if (XPGetWidgetProperty(widgets[n], xpProperty_Enabled, NULL))
|
||||
if (XPSetKeyboardFocus(widgets[n]) != NULL)
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
|
||||
static void XPCGetOrderedSubWidgets(
|
||||
XPWidgetID inWidget,
|
||||
std::vector<XPWidgetID>& outChildren)
|
||||
{
|
||||
outChildren.clear();
|
||||
long count = XPCountChildWidgets(inWidget);
|
||||
for (long n = 0; n < count; ++n)
|
||||
{
|
||||
XPWidgetID child = XPGetNthChildWidget(inWidget, n);
|
||||
outChildren.push_back(child);
|
||||
std::vector<XPWidgetID> grandChildren;
|
||||
XPCGetOrderedSubWidgets(child, grandChildren);
|
||||
|
||||
outChildren.insert(outChildren.end(), grandChildren.begin(), grandChildren.end());
|
||||
}
|
||||
}
|
||||
146
xpcPlugin/SDK/CHeaders/Wrappers/XPCWidgetAttachments.h
Executable file
146
xpcPlugin/SDK/CHeaders/Wrappers/XPCWidgetAttachments.h
Executable file
@@ -0,0 +1,146 @@
|
||||
#ifndef _XPCWidgetAttachments_h_
|
||||
#define _XPCWidgetAttachments_h_
|
||||
|
||||
#include <string>
|
||||
|
||||
#include "XPCWidget.h"
|
||||
#include "XPCBroadcaster.h"
|
||||
|
||||
class XPCKeyFilterAttachment : public XPCWidgetAttachment {
|
||||
public:
|
||||
|
||||
XPCKeyFilterAttachment(
|
||||
const char * inValidKeys,
|
||||
const char * outValidKeys);
|
||||
virtual ~XPCKeyFilterAttachment();
|
||||
|
||||
virtual int HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2);
|
||||
|
||||
private:
|
||||
|
||||
std::string mInput;
|
||||
std::string mOutput;
|
||||
|
||||
};
|
||||
|
||||
|
||||
class XPCKeyMessageAttachment : public XPCWidgetAttachment, public XPCBroadcaster {
|
||||
public:
|
||||
|
||||
XPCKeyMessageAttachment(
|
||||
char inKey,
|
||||
long inMessage,
|
||||
void * inParam,
|
||||
bool inConsume,
|
||||
bool inVkey,
|
||||
XPCListener * inListener);
|
||||
virtual ~XPCKeyMessageAttachment();
|
||||
|
||||
virtual int HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2);
|
||||
|
||||
private:
|
||||
|
||||
char mKey;
|
||||
bool mVkey;
|
||||
long mMsg;
|
||||
void * mParam;
|
||||
bool mConsume;
|
||||
|
||||
};
|
||||
|
||||
class XPCPushButtonMessageAttachment : public XPCWidgetAttachment, XPCBroadcaster {
|
||||
public:
|
||||
|
||||
XPCPushButtonMessageAttachment(
|
||||
XPWidgetID inWidget,
|
||||
long inMessage,
|
||||
void * inParam,
|
||||
XPCListener * inListener);
|
||||
virtual ~XPCPushButtonMessageAttachment();
|
||||
|
||||
virtual int HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2);
|
||||
|
||||
private:
|
||||
XPWidgetID mWidget;
|
||||
long mMsg;
|
||||
void * mParam;
|
||||
};
|
||||
|
||||
class XPCSliderMessageAttachment : public XPCWidgetAttachment, XPCBroadcaster {
|
||||
public:
|
||||
|
||||
XPCSliderMessageAttachment(
|
||||
XPWidgetID inWidget,
|
||||
long inMessage,
|
||||
void * inParam,
|
||||
XPCListener * inListener);
|
||||
virtual ~XPCSliderMessageAttachment();
|
||||
|
||||
virtual int HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2);
|
||||
|
||||
private:
|
||||
XPWidgetID mWidget;
|
||||
long mMsg;
|
||||
void * mParam;
|
||||
};
|
||||
|
||||
|
||||
class XPCCloseButtonMessageAttachment : public XPCWidgetAttachment, XPCBroadcaster {
|
||||
public:
|
||||
|
||||
XPCCloseButtonMessageAttachment(
|
||||
XPWidgetID inWidget,
|
||||
long inMessage,
|
||||
void * inParam,
|
||||
XPCListener * inListener);
|
||||
virtual ~XPCCloseButtonMessageAttachment();
|
||||
|
||||
virtual int HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2);
|
||||
|
||||
private:
|
||||
XPWidgetID mWidget;
|
||||
long mMsg;
|
||||
void * mParam;
|
||||
};
|
||||
|
||||
class XPCTabGroupAttachment : public XPCWidgetAttachment {
|
||||
public:
|
||||
|
||||
XPCTabGroupAttachment();
|
||||
virtual ~XPCTabGroupAttachment();
|
||||
|
||||
virtual int HandleWidgetMessage(
|
||||
XPCWidget * inObject,
|
||||
XPWidgetMessage inMessage,
|
||||
XPWidgetID inWidget,
|
||||
long inParam1,
|
||||
long inParam2);
|
||||
|
||||
};
|
||||
|
||||
#endif
|
||||
168
xpcPlugin/SDK/CHeaders/XPLM/XPLMCamera.h
Executable file
168
xpcPlugin/SDK/CHeaders/XPLM/XPLMCamera.h
Executable file
@@ -0,0 +1,168 @@
|
||||
#ifndef _XPLMCamera_h_
|
||||
#define _XPLMCamera_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* XPLMCamera - THEORY OF OPERATION The XPLMCamera APIs allow plug-ins to
|
||||
* control the camera angle in X-Plane. This has a number of applications,
|
||||
* including but not limited to:
|
||||
*
|
||||
* - Creating new views (including dynamic/user-controllable views) for the
|
||||
* user.
|
||||
*
|
||||
* - Creating applications that use X-Plane as a renderer of scenery,
|
||||
* aircrafts, or both.
|
||||
*
|
||||
* The camera is controlled via six parameters: a location in OpenGL
|
||||
* coordinates and pitch, roll and yaw, similar to an airplane's position.
|
||||
* OpenGL coordinate info is described in detail in the XPLMGraphics
|
||||
* documentation; generally you should use the XPLMGraphics routines to
|
||||
* convert from world to local coordinates. The camera's orientation starts
|
||||
* facing level with the ground directly up the negative-Z axis
|
||||
* (approximately north) with the horizon horizontal. It is then rotated
|
||||
* clockwise for yaw, pitched up for positive pitch, and rolled clockwise
|
||||
* around the vector it is looking along for roll.
|
||||
*
|
||||
* You control the camera either either until the user selects a new view or
|
||||
* permanently (the later being similar to how UDP camera control works). You
|
||||
* control the camera by registering a callback per frame from which you
|
||||
* calculate the new camera positions. This guarantees smooth camera motion.
|
||||
*
|
||||
* Use the XPLMDataAccess APIs to get information like the position of the
|
||||
* aircraft, etc. for complex camera positioning.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* CAMERA CONTROL
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* XPLMCameraControlDuration
|
||||
*
|
||||
* This enumeration states how long you want to retain control of the camera.
|
||||
* You can retain it indefinitely or until the user selects a new view.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* Control the camera until the user picks a new view. */
|
||||
xplm_ControlCameraUntilViewChanges = 1
|
||||
|
||||
/* Control the camera until your plugin is disabled or another plugin forcably *
|
||||
* takes control. */
|
||||
,xplm_ControlCameraForever = 2
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMCameraControlDuration;
|
||||
|
||||
/*
|
||||
* XPLMCameraPosition_t
|
||||
*
|
||||
* This structure contains a full specification of the camera. X, Y, and Z
|
||||
* are the camera's position in OpenGL coordiantes; pitch, roll, and yaw are
|
||||
* rotations from a camera facing flat north in degrees. Positive pitch means
|
||||
* nose up, positive roll means roll right, and positive yaw means yaw right,
|
||||
* all in degrees. Zoom is a zoom factor, with 1.0 meaning normal zoom and 2.0
|
||||
* magnifying by 2x (objects appear larger).
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
float x;
|
||||
float y;
|
||||
float z;
|
||||
float pitch;
|
||||
float heading;
|
||||
float roll;
|
||||
float zoom;
|
||||
} XPLMCameraPosition_t;
|
||||
|
||||
/*
|
||||
* XPLMCameraControl_f
|
||||
*
|
||||
* You use an XPLMCameraControl function to provide continuous control over
|
||||
* the camera. You are passed in a structure in which to put the new camera
|
||||
* position; modify it and return 1 to reposition the camera. Return 0 to
|
||||
* surrender control of the camera; camera control will be handled by X-Plane
|
||||
* on this draw loop. The contents of the structure as you are called are
|
||||
* undefined.
|
||||
*
|
||||
* If X-Plane is taking camera control away from you, this function will be
|
||||
* called with inIsLosingControl set to 1 and ioCameraPosition NULL.
|
||||
*
|
||||
*/
|
||||
typedef int (* XPLMCameraControl_f)(
|
||||
XPLMCameraPosition_t * outCameraPosition, /* Can be NULL */
|
||||
int inIsLosingControl,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMControlCamera
|
||||
*
|
||||
* This function repositions the camera on the next drawing cycle. You must
|
||||
* pass a non-null control function. Specify in inHowLong how long you'd like
|
||||
* control (indefinitely or until a key is pressed).
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMControlCamera(
|
||||
XPLMCameraControlDuration inHowLong,
|
||||
XPLMCameraControl_f inControlFunc,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMDontControlCamera
|
||||
*
|
||||
* This function stops you from controlling the camera. If you have a camera
|
||||
* control function, it will not be called with an inIsLosingControl flag.
|
||||
* X-Plane will control the camera on the next cycle.
|
||||
*
|
||||
* For maximum compatibility you should not use this routine unless you are in
|
||||
* posession of the camera.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDontControlCamera(void);
|
||||
|
||||
/*
|
||||
* XPLMIsCameraBeingControlled
|
||||
*
|
||||
* This routine returns 1 if the camera is being controlled, zero if it is
|
||||
* not. If it is and you pass in a pointer to a camera control duration, the
|
||||
* current control duration will be returned.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMIsCameraBeingControlled(
|
||||
XPLMCameraControlDuration * outCameraControlDuration); /* Can be NULL */
|
||||
|
||||
/*
|
||||
* XPLMReadCameraPosition
|
||||
*
|
||||
* This function reads the current camera position.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMReadCameraPosition(
|
||||
XPLMCameraPosition_t * outCameraPosition);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
707
xpcPlugin/SDK/CHeaders/XPLM/XPLMDataAccess.h
Executable file
707
xpcPlugin/SDK/CHeaders/XPLM/XPLMDataAccess.h
Executable file
@@ -0,0 +1,707 @@
|
||||
#ifndef _XPLMDataAccess_h_
|
||||
#define _XPLMDataAccess_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* XPLM Data Access API - Theory of Operation
|
||||
*
|
||||
* The data access API gives you a generic, flexible, high performance way to
|
||||
* read and write data to and from X-Plane and other plug-ins. For example,
|
||||
* this API allows you to read and set the nav radios, get the plane location,
|
||||
* determine the current effective graphics frame rate, etc.
|
||||
*
|
||||
* The data access APIs are the way that you read and write data from the sim
|
||||
* as well as other plugins.
|
||||
*
|
||||
* The API works using opaque data references. A data reference is a source
|
||||
* of data; you do not know where it comes from, but once you have it you can
|
||||
* read the data quickly and possibly write it. To get a data reference, you
|
||||
* look it up.
|
||||
*
|
||||
* Data references are identified by verbose string names
|
||||
* (sim/cockpit/radios/nav1_freq_hz). The actual numeric value of the data
|
||||
* reference is implementation defined and is likely to change each time the
|
||||
* simulator is run (or the plugin that provides the datareference is
|
||||
* reloaded).
|
||||
*
|
||||
* The task of looking up a data reference is relatively expensive; look up
|
||||
* your data references once based on verbose strings, and save the opaque
|
||||
* data reference value for the duration of your plugin's operation. Reading
|
||||
* and writing data references is relatively fast (the cost is equivalent to
|
||||
* two function calls through function pointers).
|
||||
*
|
||||
* This allows data access to be high performance, while leaving in
|
||||
* abstraction; since data references are opaque and are searched for, the
|
||||
* underlying data access system can be rebuilt.
|
||||
*
|
||||
* A note on typing: you must know the correct data type to read and write.
|
||||
* APIs are provided for reading and writing data in a number of ways. You
|
||||
* can also double check the data type for a data ref. Note that automatic
|
||||
* conversion is not done for you.
|
||||
*
|
||||
* A note for plugins sharing data with other plugins: the load order of
|
||||
* plugins is not guaranteed. To make sure that every plugin publishing data
|
||||
* has published their data references before other plugins try to subscribe,
|
||||
* publish your data references in your start routine but resolve them the
|
||||
* first time your 'enable' routine is called, or the first time they are
|
||||
* needed in code.
|
||||
*
|
||||
* X-Plane publishes well over 1000 datarefs; a complete list may be found in
|
||||
* the reference section of the SDK online documentation (from the SDK home
|
||||
* page, choose Documentation).
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* READING AND WRITING DATA
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These routines allow you to access a wide variety of data from within
|
||||
* x-plane and modify some of it.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMDataRef
|
||||
*
|
||||
* A data ref is an opaque handle to data provided by the simulator or another
|
||||
* plugin. It uniquely identifies one variable (or array of variables) over
|
||||
* the lifetime of your plugin. You never hard code these values; you always
|
||||
* get them from XPLMFindDataRef.
|
||||
*
|
||||
*/
|
||||
typedef void * XPLMDataRef;
|
||||
|
||||
/*
|
||||
* XPLMDataTypeID
|
||||
*
|
||||
* This is an enumeration that defines the type of the data behind a data
|
||||
* reference. This allows you to sanity check that the data type matches what
|
||||
* you expect. But for the most part, you will know the type of data you are
|
||||
* expecting from the online documentation.
|
||||
*
|
||||
* Data types each take a bit field, so sets of data types may be formed.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* Data of a type the current XPLM doesn't do. */
|
||||
xplmType_Unknown = 0
|
||||
|
||||
/* A single 4-byte integer, native endian. */
|
||||
,xplmType_Int = 1
|
||||
|
||||
/* A single 4-byte float, native endian. */
|
||||
,xplmType_Float = 2
|
||||
|
||||
/* A single 8-byte double, native endian. */
|
||||
,xplmType_Double = 4
|
||||
|
||||
/* An array of 4-byte floats, native endian. */
|
||||
,xplmType_FloatArray = 8
|
||||
|
||||
/* An array of 4-byte integers, native endian. */
|
||||
,xplmType_IntArray = 16
|
||||
|
||||
/* A variable block of data. */
|
||||
,xplmType_Data = 32
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMDataTypeID;
|
||||
|
||||
/*
|
||||
* XPLMFindDataRef
|
||||
*
|
||||
* Given a c-style string that names the data ref, this routine looks up the
|
||||
* actual opaque XPLMDataRef that you use to read and write the data. The
|
||||
* string names for datarefs are published on the x-plane SDK web site.
|
||||
*
|
||||
* This function returns NULL if the data ref cannot be found.
|
||||
*
|
||||
* NOTE: this function is relatively expensive; save the XPLMDataRef this
|
||||
* function returns for future use. Do not look up your data ref by string
|
||||
* every time you need to read or write it.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMDataRef XPLMFindDataRef(
|
||||
const char * inDataRefName);
|
||||
|
||||
/*
|
||||
* XPLMCanWriteDataRef
|
||||
*
|
||||
* Given a data ref, this routine returns true if you can successfully set
|
||||
* the data, false otherwise. Some datarefs are read-only.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMCanWriteDataRef(
|
||||
XPLMDataRef inDataRef);
|
||||
|
||||
/*
|
||||
* XPLMIsDataRefGood
|
||||
*
|
||||
* WARNING: This function is deprecated and should not be used. Datarefs are
|
||||
* valid until plugins are reloaded or the sim quits. Plugins sharing
|
||||
* datarefs should support these semantics by not unregistering datarefs
|
||||
* during operation. (You should however unregister datarefs when your plugin
|
||||
* is unloaded, as part of general resource cleanup.)
|
||||
*
|
||||
* This function returns whether a data ref is still valid. If it returns
|
||||
* false, you should refind the data ref from its original string. Calling an
|
||||
* accessor function on a bad data ref will return a default value, typically
|
||||
* 0 or 0-length data.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMIsDataRefGood(
|
||||
XPLMDataRef inDataRef);
|
||||
|
||||
/*
|
||||
* XPLMGetDataRefTypes
|
||||
*
|
||||
* This routine returns the types of the data ref for accessor use. If a data
|
||||
* ref is available in multiple data types, they will all be returned.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMDataTypeID XPLMGetDataRefTypes(
|
||||
XPLMDataRef inDataRef);
|
||||
|
||||
/***************************************************************************
|
||||
* DATA ACCESSORS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These routines read and write the data references. For each supported data
|
||||
* type there is a reader and a writer.
|
||||
*
|
||||
* If the data ref is invalid or the plugin that provides it is disabled or
|
||||
* there is a type mismatch, the functions that read data will return 0 as a
|
||||
* default value or not modify the passed in memory. The plugins that write
|
||||
* data will not write under these circumstances or if the data ref is
|
||||
* read-only. NOTE: to keep the overhead of reading datarefs low, these
|
||||
* routines do not do full validation of a dataref; passing a junk value for
|
||||
* a dataref can result in crashing the sim.
|
||||
*
|
||||
* For array-style datarefs, you specify the number of items to read/write and
|
||||
* the offset into the array; the actual number of items read or written is
|
||||
* returned. This may be less to prevent an array-out-of-bounds error.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMGetDatai
|
||||
*
|
||||
* Read an integer data ref and return its value. The return value is the
|
||||
* dataref value or 0 if the dataref is invalid/NULL or the plugin is
|
||||
* disabled.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMGetDatai(
|
||||
XPLMDataRef inDataRef);
|
||||
|
||||
/*
|
||||
* XPLMSetDatai
|
||||
*
|
||||
* Write a new value to an integer data ref. This routine is a no-op if the
|
||||
* plugin publishing the dataref is disabled, the dataref is invalid, or the
|
||||
* dataref is not writable.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetDatai(
|
||||
XPLMDataRef inDataRef,
|
||||
int inValue);
|
||||
|
||||
/*
|
||||
* XPLMGetDataf
|
||||
*
|
||||
* Read a single precision floating point dataref and return its value. The
|
||||
* return value is the dataref value or 0.0 if the dataref is invalid/NULL or
|
||||
* the plugin is disabled.
|
||||
*
|
||||
*/
|
||||
XPLM_API float XPLMGetDataf(
|
||||
XPLMDataRef inDataRef);
|
||||
|
||||
/*
|
||||
* XPLMSetDataf
|
||||
*
|
||||
* Write a new value to a single precision floating point data ref. This
|
||||
* routine is a no-op if the plugin publishing the dataref is disabled, the
|
||||
* dataref is invalid, or the dataref is not writable.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetDataf(
|
||||
XPLMDataRef inDataRef,
|
||||
float inValue);
|
||||
|
||||
/*
|
||||
* XPLMGetDatad
|
||||
*
|
||||
* Read a double precision floating point dataref and return its value. The
|
||||
* return value is the dataref value or 0.0 if the dataref is invalid/NULL or
|
||||
* the plugin is disabled.
|
||||
*
|
||||
*/
|
||||
XPLM_API double XPLMGetDatad(
|
||||
XPLMDataRef inDataRef);
|
||||
|
||||
/*
|
||||
* XPLMSetDatad
|
||||
*
|
||||
* Write a new value to a double precision floating point data ref. This
|
||||
* routine is a no-op if the plugin publishing the dataref is disabled, the
|
||||
* dataref is invalid, or the dataref is not writable.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetDatad(
|
||||
XPLMDataRef inDataRef,
|
||||
double inValue);
|
||||
|
||||
/*
|
||||
* XPLMGetDatavi
|
||||
*
|
||||
* Read a part of an integer array dataref. If you pass NULL for outVaules,
|
||||
* the routine will return the size of the array, ignoring inOffset and inMax.
|
||||
*
|
||||
*
|
||||
* If outValues is not NULL, then up to inMax values are copied from the
|
||||
* dataref into outValues, starting at inOffset in the dataref. If inMax +
|
||||
* inOffset is larger than the size of the dataref, less than inMax values
|
||||
* will be copied. The number of values copied is returned.
|
||||
*
|
||||
* Note: the semantics of array datarefs are entirely implemented by the
|
||||
* plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
* above description is how these datarefs are intended to work, but a rogue
|
||||
* plugin may have different behavior.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMGetDatavi(
|
||||
XPLMDataRef inDataRef,
|
||||
int * outValues, /* Can be NULL */
|
||||
int inOffset,
|
||||
int inMax);
|
||||
|
||||
/*
|
||||
* XPLMSetDatavi
|
||||
*
|
||||
* Write part or all of an integer array dataref. The values passed by
|
||||
* inValues are written into the dataref starting at inOffset. Up to inCount
|
||||
* values are written; however if the values would write "off the end" of the
|
||||
* dataref array, then fewer values are written.
|
||||
*
|
||||
* Note: the semantics of array datarefs are entirely implemented by the
|
||||
* plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
* above description is how these datarefs are intended to work, but a rogue
|
||||
* plugin may have different behavior.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetDatavi(
|
||||
XPLMDataRef inDataRef,
|
||||
int * inValues,
|
||||
int inoffset,
|
||||
int inCount);
|
||||
|
||||
/*
|
||||
* XPLMGetDatavf
|
||||
*
|
||||
* Read a part of a single precision floating point array dataref. If you
|
||||
* pass NULL for outVaules, the routine will return the size of the array,
|
||||
* ignoring inOffset and inMax.
|
||||
*
|
||||
* If outValues is not NULL, then up to inMax values are copied from the
|
||||
* dataref into outValues, starting at inOffset in the dataref. If inMax +
|
||||
* inOffset is larger than the size of the dataref, less than inMax values
|
||||
* will be copied. The number of values copied is returned.
|
||||
*
|
||||
* Note: the semantics of array datarefs are entirely implemented by the
|
||||
* plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
* above description is how these datarefs are intended to work, but a rogue
|
||||
* plugin may have different behavior.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMGetDatavf(
|
||||
XPLMDataRef inDataRef,
|
||||
float * outValues, /* Can be NULL */
|
||||
int inOffset,
|
||||
int inMax);
|
||||
|
||||
/*
|
||||
* XPLMSetDatavf
|
||||
*
|
||||
* Write part or all of a single precision floating point array dataref. The
|
||||
* values passed by inValues are written into the dataref starting at
|
||||
* inOffset. Up to inCount values are written; however if the values would
|
||||
* write "off the end" of the dataref array, then fewer values are written.
|
||||
*
|
||||
* Note: the semantics of array datarefs are entirely implemented by the
|
||||
* plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
* above description is how these datarefs are intended to work, but a rogue
|
||||
* plugin may have different behavior.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetDatavf(
|
||||
XPLMDataRef inDataRef,
|
||||
float * inValues,
|
||||
int inoffset,
|
||||
int inCount);
|
||||
|
||||
/*
|
||||
* XPLMGetDatab
|
||||
*
|
||||
* Read a part of a byte array dataref. If you pass NULL for outVaules, the
|
||||
* routine will return the size of the array, ignoring inOffset and inMax.
|
||||
*
|
||||
* If outValues is not NULL, then up to inMax values are copied from the
|
||||
* dataref into outValues, starting at inOffset in the dataref. If inMax +
|
||||
* inOffset is larger than the size of the dataref, less than inMax values
|
||||
* will be copied. The number of values copied is returned.
|
||||
*
|
||||
* Note: the semantics of array datarefs are entirely implemented by the
|
||||
* plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
* above description is how these datarefs are intended to work, but a rogue
|
||||
* plugin may have different behavior.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMGetDatab(
|
||||
XPLMDataRef inDataRef,
|
||||
void * outValue, /* Can be NULL */
|
||||
int inOffset,
|
||||
int inMaxBytes);
|
||||
|
||||
/*
|
||||
* XPLMSetDatab
|
||||
*
|
||||
* Write part or all of a byte array dataref. The values passed by inValues
|
||||
* are written into the dataref starting at inOffset. Up to inCount values
|
||||
* are written; however if the values would write "off the end" of the dataref
|
||||
* array, then fewer values are written.
|
||||
*
|
||||
* Note: the semantics of array datarefs are entirely implemented by the
|
||||
* plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
* above description is how these datarefs are intended to work, but a rogue
|
||||
* plugin may have different behavior.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetDatab(
|
||||
XPLMDataRef inDataRef,
|
||||
void * inValue,
|
||||
int inOffset,
|
||||
int inLength);
|
||||
|
||||
/***************************************************************************
|
||||
* PUBLISHING YOUR PLUGINS DATA
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These functions allow you to create data references that other plug-ins can
|
||||
* access via the above data access APIs. Data references published by other
|
||||
* plugins operate the same as ones published by x-plane in all manners except
|
||||
* that your data reference will not be available to other plugins if/when
|
||||
* your plugin is disabled.
|
||||
*
|
||||
* You share data by registering data provider callback functions. When a
|
||||
* plug-in requests your data, these callbacks are then called. You provide
|
||||
* one callback to return the value when a plugin 'reads' it and another to
|
||||
* change the value when a plugin 'writes' it.
|
||||
*
|
||||
* Important: you must pick a prefix for your datarefs other than "sim/" -
|
||||
* this prefix is reserved for X-Plane. The X-Plane SDK website contains a
|
||||
* registry where authors can select a unique first word for dataref names, to
|
||||
* prevent dataref collisions between plugins.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMGetDatai_f
|
||||
*
|
||||
* Data provider function pointers.
|
||||
*
|
||||
* These define the function pointers you provide to get or set data. Note
|
||||
* that you are passed a generic pointer for each one. This is the same
|
||||
* pointer you pass in your register routine; you can use it to find global
|
||||
* variables, etc.
|
||||
*
|
||||
* The semantics of your callbacks are the same as the dataref accessor above
|
||||
* - basically routines like XPLMGetDatai are just pass-throughs from a caller
|
||||
* to your plugin. Be particularly mindful in implementing array dataref
|
||||
* read-write accessors; you are responsible for avoiding overruns, supporting
|
||||
* offset read/writes, and handling a read with a NULL buffer.
|
||||
*
|
||||
*/
|
||||
typedef int (* XPLMGetDatai_f)(
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMSetDatai_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMSetDatai_f)(
|
||||
void * inRefcon,
|
||||
int inValue);
|
||||
|
||||
/*
|
||||
* XPLMGetDataf_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef float (* XPLMGetDataf_f)(
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMSetDataf_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMSetDataf_f)(
|
||||
void * inRefcon,
|
||||
float inValue);
|
||||
|
||||
/*
|
||||
* XPLMGetDatad_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef double (* XPLMGetDatad_f)(
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMSetDatad_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMSetDatad_f)(
|
||||
void * inRefcon,
|
||||
double inValue);
|
||||
|
||||
/*
|
||||
* XPLMGetDatavi_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef int (* XPLMGetDatavi_f)(
|
||||
void * inRefcon,
|
||||
int * outValues, /* Can be NULL */
|
||||
int inOffset,
|
||||
int inMax);
|
||||
|
||||
/*
|
||||
* XPLMSetDatavi_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMSetDatavi_f)(
|
||||
void * inRefcon,
|
||||
int * inValues,
|
||||
int inOffset,
|
||||
int inCount);
|
||||
|
||||
/*
|
||||
* XPLMGetDatavf_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef int (* XPLMGetDatavf_f)(
|
||||
void * inRefcon,
|
||||
float * outValues, /* Can be NULL */
|
||||
int inOffset,
|
||||
int inMax);
|
||||
|
||||
/*
|
||||
* XPLMSetDatavf_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMSetDatavf_f)(
|
||||
void * inRefcon,
|
||||
float * inValues,
|
||||
int inOffset,
|
||||
int inCount);
|
||||
|
||||
/*
|
||||
* XPLMGetDatab_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef int (* XPLMGetDatab_f)(
|
||||
void * inRefcon,
|
||||
void * outValue, /* Can be NULL */
|
||||
int inOffset,
|
||||
int inMaxLength);
|
||||
|
||||
/*
|
||||
* XPLMSetDatab_f
|
||||
*
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMSetDatab_f)(
|
||||
void * inRefcon,
|
||||
void * inValue,
|
||||
int inOffset,
|
||||
int inLength);
|
||||
|
||||
/*
|
||||
* XPLMRegisterDataAccessor
|
||||
*
|
||||
* This routine creates a new item of data that can be read and written. Pass
|
||||
* in the data's full name for searching, the type(s) of the data for
|
||||
* accessing, and whether the data can be written to. For each data type you
|
||||
* support, pass in a read accessor function and a write accessor function if
|
||||
* necessary. Pass NULL for data types you do not support or write accessors
|
||||
* if you are read-only.
|
||||
*
|
||||
* You are returned a data ref for the new item of data created. You can use
|
||||
* this data ref to unregister your data later or read or write from it.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMDataRef XPLMRegisterDataAccessor(
|
||||
const char * inDataName,
|
||||
XPLMDataTypeID inDataType,
|
||||
int inIsWritable,
|
||||
XPLMGetDatai_f inReadInt,
|
||||
XPLMSetDatai_f inWriteInt,
|
||||
XPLMGetDataf_f inReadFloat,
|
||||
XPLMSetDataf_f inWriteFloat,
|
||||
XPLMGetDatad_f inReadDouble,
|
||||
XPLMSetDatad_f inWriteDouble,
|
||||
XPLMGetDatavi_f inReadIntArray,
|
||||
XPLMSetDatavi_f inWriteIntArray,
|
||||
XPLMGetDatavf_f inReadFloatArray,
|
||||
XPLMSetDatavf_f inWriteFloatArray,
|
||||
XPLMGetDatab_f inReadData,
|
||||
XPLMSetDatab_f inWriteData,
|
||||
void * inReadRefcon,
|
||||
void * inWriteRefcon);
|
||||
|
||||
/*
|
||||
* XPLMUnregisterDataAccessor
|
||||
*
|
||||
* Use this routine to unregister any data accessors you may have registered.
|
||||
* You unregister a data ref by the XPLMDataRef you get back from
|
||||
* registration. Once you unregister a data ref, your function pointer will
|
||||
* not be called anymore.
|
||||
*
|
||||
* For maximum compatibility, do not unregister your data accessors until
|
||||
* final shutdown (when your XPluginStop routine is called). This allows
|
||||
* other plugins to find your data reference once and use it for their entire
|
||||
* time of operation.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMUnregisterDataAccessor(
|
||||
XPLMDataRef inDataRef);
|
||||
|
||||
/***************************************************************************
|
||||
* SHARING DATA BETWEEN MULTIPLE PLUGINS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The data reference registration APIs from the previous section allow a
|
||||
* plugin to publish data in a one-owner manner; the plugin that publishes the
|
||||
* data reference owns the real memory that the data ref uses. This is
|
||||
* satisfactory for most cases, but there are also cases where plugnis need to
|
||||
* share actual data.
|
||||
*
|
||||
* With a shared data reference, no one plugin owns the actual memory for the
|
||||
* data reference; the plugin SDK allocates that for you. When the first
|
||||
* plugin asks to 'share' the data, the memory is allocated. When the data is
|
||||
* changed, every plugin that is sharing the data is notified.
|
||||
*
|
||||
* Shared data references differ from the 'owned' data references from the
|
||||
* previous section in a few ways:
|
||||
*
|
||||
* - With shared data references, any plugin can create the data reference;
|
||||
* with owned plugins one plugin must create the data reference and others
|
||||
* subscribe. (This can be a problem if you don't know which set of plugins
|
||||
* will be present).
|
||||
*
|
||||
* - With shared data references, every plugin that is sharing the data is
|
||||
* notified when the data is changed. With owned data references, only the
|
||||
* one owner is notified when the data is changed.
|
||||
*
|
||||
* - With shared data references, you cannot access the physical memory of the
|
||||
* data reference; you must use the XPLMGet... and XPLMSet... APIs. With an
|
||||
* owned data reference, the one owning data reference can manipulate the
|
||||
* data reference's memory in any way it sees fit.
|
||||
*
|
||||
* Shared data references solve two problems: if you need to have a data
|
||||
* reference used by several plugins but do not know which plugins will be
|
||||
* installed, or if all plugins sharing data need to be notified when that
|
||||
* data is changed, use shared data references.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMDataChanged_f
|
||||
*
|
||||
* An XPLMDataChanged_f is a callback that the XPLM calls whenever any other
|
||||
* plug-in modifies shared data. A refcon you provide is passed back to help
|
||||
* identify which data is being changed. In response, you may want to call one
|
||||
* of the XPLMGetDataxxx routines to find the new value of the data.
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMDataChanged_f)(
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMShareData
|
||||
*
|
||||
* This routine connects a plug-in to shared data, creating the shared data if
|
||||
* necessary. inDataName is a standard path for the data ref, and inDataType
|
||||
* specifies the type. This function will create the data if it does not
|
||||
* exist. If the data already exists but the type does not match, an error is
|
||||
* returned, so it is important that plug-in authors collaborate to establish
|
||||
* public standards for shared data.
|
||||
*
|
||||
* If a notificationFunc is passed in and is not NULL, that notification
|
||||
* function will be called whenever the data is modified. The notification
|
||||
* refcon will be passed to it. This allows your plug-in to know which shared
|
||||
* data was changed if multiple shared data are handled by one callback, or if
|
||||
* the plug-in does not use global variables.
|
||||
*
|
||||
* A one is returned for successfully creating or finding the shared data; a
|
||||
* zero if the data already exists but is of the wrong type.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMShareData(
|
||||
const char * inDataName,
|
||||
XPLMDataTypeID inDataType,
|
||||
XPLMDataChanged_f inNotificationFunc,
|
||||
void * inNotificationRefcon);
|
||||
|
||||
/*
|
||||
* XPLMUnshareData
|
||||
*
|
||||
* This routine removes your notification function for shared data. Call it
|
||||
* when done with the data to stop receiving change notifications. Arguments
|
||||
* must match XPLMShareData. The actual memory will not necessarily be freed,
|
||||
* since other plug-ins could be using it.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMUnshareData(
|
||||
const char * inDataName,
|
||||
XPLMDataTypeID inDataType,
|
||||
XPLMDataChanged_f inNotificationFunc,
|
||||
void * inNotificationRefcon);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
518
xpcPlugin/SDK/CHeaders/XPLM/XPLMDefs.h
Executable file
518
xpcPlugin/SDK/CHeaders/XPLM/XPLMDefs.h
Executable file
@@ -0,0 +1,518 @@
|
||||
#ifndef _XPLMDefs_h_
|
||||
#define _XPLMDefs_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file is contains the cross-platform and basic definitions for the
|
||||
* X-Plane SDK.
|
||||
*
|
||||
* The preprocessor macros APL and IBM must be defined to specify the
|
||||
* compilation target; define APL to 1 and IBM 0 to compile on Macintosh and
|
||||
* APL to 0 and IBM to 1 for Windows. You must specify these macro definitions
|
||||
* before including XPLMDefs.h or any other XPLM headers. You can do this
|
||||
* using the -D command line option or a preprocessor header.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#ifdef _WIN32
|
||||
#include <windows.h>
|
||||
#else
|
||||
#include <stdint.h>
|
||||
#endif
|
||||
/***************************************************************************
|
||||
* DLL Definitions
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These definitions control the importing and exporting of functions within
|
||||
* the DLL.
|
||||
*
|
||||
* You can prefix your five required callbacks with the PLUGIN_API macro to
|
||||
* declare them as exported C functions. The XPLM_API macro identifies
|
||||
* functions that are provided to you via the plugin SDK. (Link against
|
||||
* XPLM.lib to use these functions.)
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
#ifdef APL
|
||||
#if __GNUC__ >= 4
|
||||
#define PLUGIN_API extern "C" __attribute__((visibility("default")))
|
||||
#elif __MACH__
|
||||
#define PLUGIN_API extern "C"
|
||||
#else
|
||||
#define PLUGIN_API extern "C" __declspec(dllexport)
|
||||
#endif
|
||||
#endif
|
||||
#ifdef _WIN32
|
||||
#define PLUGIN_API extern "C" __declspec(dllexport)
|
||||
#endif
|
||||
#ifdef LIN
|
||||
#if __GNUC__ >= 4
|
||||
#define PLUGIN_API extern "C" __attribute__((visibility("default")))
|
||||
#else
|
||||
#define PLUGIN_API extern "C"
|
||||
#endif
|
||||
#endif
|
||||
#else
|
||||
#if APL
|
||||
#if __GNUC__ >= 4
|
||||
#define PLUGIN_API __attribute__((visibility("default")))
|
||||
#elif __MACH__
|
||||
#define PLUGIN_API
|
||||
#else
|
||||
#define PLUGIN_API __declspec(dllexport)
|
||||
#endif
|
||||
#elif IBM
|
||||
#define PLUGIN_API __declspec(dllexport)
|
||||
#elif LIN
|
||||
#if __GNUC__ >= 4
|
||||
#define PLUGIN_API __attribute__((visibility("default")))
|
||||
#else
|
||||
#define PLUGIN_API
|
||||
#endif
|
||||
#else
|
||||
#error "Platform not defined!"
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#ifdef APL
|
||||
#if XPLM
|
||||
#if __GNUC__ >= 4
|
||||
#define XPLM_API __attribute__((visibility("default")))
|
||||
#elif __MACH__
|
||||
#define XPLM_API
|
||||
#else
|
||||
#define XPLM_API __declspec(dllexport)
|
||||
#endif
|
||||
#else
|
||||
#define XPLM_API
|
||||
#endif
|
||||
#endif
|
||||
#ifdef _WIN32
|
||||
#if XPLM
|
||||
#define XPLM_API __declspec(dllexport)
|
||||
#else
|
||||
#define XPLM_API __declspec(dllimport)
|
||||
#endif
|
||||
#endif
|
||||
#ifdef LIN
|
||||
#if XPLM
|
||||
#if __GNUC__ >= 4
|
||||
#define XPLM_API __attribute__((visibility("default")))
|
||||
#else
|
||||
#define XPLM_API
|
||||
#endif
|
||||
#else
|
||||
#define XPLM_API
|
||||
#endif
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* GLOBAL DEFINITIONS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These definitions are used in all parts of the SDK.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMPluginID
|
||||
*
|
||||
* Each plug-in is identified by a unique integer ID. This ID can be used to
|
||||
* disable or enable a plug-in, or discover what plug-in is 'running' at the
|
||||
* time. A plug-in ID is unique within the currently running instance of
|
||||
* X-Plane unless plug-ins are reloaded. Plug-ins may receive a different
|
||||
* unique ID each time they are loaded.
|
||||
*
|
||||
* For persistent identification of plug-ins, use XPLMFindPluginBySignature in
|
||||
* XPLMUtiltiies.h
|
||||
*
|
||||
* -1 indicates no plug-in.
|
||||
*
|
||||
*/
|
||||
typedef int XPLMPluginID;
|
||||
|
||||
/* No plugin. */
|
||||
#define XPLM_NO_PLUGIN_ID (-1)
|
||||
|
||||
/* X-Plane itself */
|
||||
#define XPLM_PLUGIN_XPLANE (0)
|
||||
|
||||
/* The current XPLM revision is 2.10 (210). */
|
||||
#define kXPLM_Version (210)
|
||||
|
||||
/*
|
||||
* XPLMKeyFlags
|
||||
*
|
||||
* These bitfields define modifier keys in a platform independent way. When a
|
||||
* key is pressed, a series of messages are sent to your plugin. The down
|
||||
* flag is set in the first of these messages, and the up flag in the last.
|
||||
* While the key is held down, messages are sent with neither to indicate that
|
||||
* the key is being held down as a repeated character.
|
||||
*
|
||||
* The control flag is mapped to the control flag on Macintosh and PC.
|
||||
* Generally X-Plane uses the control key and not the command key on
|
||||
* Macintosh, providing a consistent interface across platforms that does not
|
||||
* necessarily match the Macintosh user interface guidelines. There is not
|
||||
* yet a way for plugins to access the Macintosh control keys without using
|
||||
* #ifdefed code.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* The shift key is down */
|
||||
xplm_ShiftFlag = 1
|
||||
|
||||
/* The option or alt key is down */
|
||||
,xplm_OptionAltFlag = 2
|
||||
|
||||
/* The control key is down* */
|
||||
,xplm_ControlFlag = 4
|
||||
|
||||
/* The key is being pressed down */
|
||||
,xplm_DownFlag = 8
|
||||
|
||||
/* The key is being released */
|
||||
,xplm_UpFlag = 16
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMKeyFlags;
|
||||
|
||||
/***************************************************************************
|
||||
* ASCII CONTROL KEY CODES
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These definitions define how various control keys are mapped to ASCII key
|
||||
* codes. Not all key presses generate an ASCII value, so plugin code should
|
||||
* be prepared to see null characters come from the keyboard...this usually
|
||||
* represents a key stroke that has no equivalent ASCII, like a page-down
|
||||
* press. Use virtual key codes to find these key strokes. ASCII key codes
|
||||
* take into account modifier keys; shift keys will affect capitals and
|
||||
* punctuation; control key combinations may have no vaild ASCII and produce
|
||||
* NULL. To detect control-key combinations, use virtual key codes, not ASCII
|
||||
* keys.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#define XPLM_KEY_RETURN 13
|
||||
|
||||
#define XPLM_KEY_ESCAPE 27
|
||||
|
||||
#define XPLM_KEY_TAB 9
|
||||
|
||||
#define XPLM_KEY_DELETE 8
|
||||
|
||||
#define XPLM_KEY_LEFT 28
|
||||
|
||||
#define XPLM_KEY_RIGHT 29
|
||||
|
||||
#define XPLM_KEY_UP 30
|
||||
|
||||
#define XPLM_KEY_DOWN 31
|
||||
|
||||
#define XPLM_KEY_0 48
|
||||
|
||||
#define XPLM_KEY_1 49
|
||||
|
||||
#define XPLM_KEY_2 50
|
||||
|
||||
#define XPLM_KEY_3 51
|
||||
|
||||
#define XPLM_KEY_4 52
|
||||
|
||||
#define XPLM_KEY_5 53
|
||||
|
||||
#define XPLM_KEY_6 54
|
||||
|
||||
#define XPLM_KEY_7 55
|
||||
|
||||
#define XPLM_KEY_8 56
|
||||
|
||||
#define XPLM_KEY_9 57
|
||||
|
||||
#define XPLM_KEY_DECIMAL 46
|
||||
|
||||
/***************************************************************************
|
||||
* VIRTUAL KEY CODES
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These are cross-platform defines for every distinct keyboard press on the
|
||||
* computer. Every physical key on the keyboard has a virtual key code. So
|
||||
* the "two" key on the top row of the main keyboard has a different code
|
||||
* from the "two" key on the numeric key pad. But the 'w' and 'W' character
|
||||
* are indistinguishable by virtual key code because they are the same
|
||||
* physical key (one with and one without the shift key).
|
||||
*
|
||||
* Use virtual key codes to detect keystrokes that do not have ASCII
|
||||
* equivalents, allow the user to map the numeric keypad separately from the
|
||||
* main keyboard, and detect control key and other modifier-key combinations
|
||||
* that generate ASCII control key sequences (many of which are not available
|
||||
* directly via character keys in the SDK).
|
||||
*
|
||||
* To assign virtual key codes we started with the Microsoft set but made some
|
||||
* additions and changes. A few differences:
|
||||
*
|
||||
* 1. Modifier keys are not available as virtual key codes. You cannot get
|
||||
* distinct modifier press and release messages. Please do not try to use
|
||||
* modifier keys as regular keys; doing so will almost certainly interfere
|
||||
* with users' abilities to use the native x-plane key bindings.
|
||||
*
|
||||
* 2. Some keys that do not exist on both Mac and PC keyboards are removed.
|
||||
*
|
||||
* 3. Do not assume that the values of these keystrokes are interchangeable
|
||||
* with MS v-keys.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#define XPLM_VK_BACK 0x08
|
||||
|
||||
#define XPLM_VK_TAB 0x09
|
||||
|
||||
#define XPLM_VK_CLEAR 0x0C
|
||||
|
||||
#define XPLM_VK_RETURN 0x0D
|
||||
|
||||
#define XPLM_VK_ESCAPE 0x1B
|
||||
|
||||
#define XPLM_VK_SPACE 0x20
|
||||
|
||||
#define XPLM_VK_PRIOR 0x21
|
||||
|
||||
#define XPLM_VK_NEXT 0x22
|
||||
|
||||
#define XPLM_VK_END 0x23
|
||||
|
||||
#define XPLM_VK_HOME 0x24
|
||||
|
||||
#define XPLM_VK_LEFT 0x25
|
||||
|
||||
#define XPLM_VK_UP 0x26
|
||||
|
||||
#define XPLM_VK_RIGHT 0x27
|
||||
|
||||
#define XPLM_VK_DOWN 0x28
|
||||
|
||||
#define XPLM_VK_SELECT 0x29
|
||||
|
||||
#define XPLM_VK_PRINT 0x2A
|
||||
|
||||
#define XPLM_VK_EXECUTE 0x2B
|
||||
|
||||
#define XPLM_VK_SNAPSHOT 0x2C
|
||||
|
||||
#define XPLM_VK_INSERT 0x2D
|
||||
|
||||
#define XPLM_VK_DELETE 0x2E
|
||||
|
||||
#define XPLM_VK_HELP 0x2F
|
||||
|
||||
/* XPLM_VK_0 thru XPLM_VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
|
||||
#define XPLM_VK_0 0x30
|
||||
|
||||
#define XPLM_VK_1 0x31
|
||||
|
||||
#define XPLM_VK_2 0x32
|
||||
|
||||
#define XPLM_VK_3 0x33
|
||||
|
||||
#define XPLM_VK_4 0x34
|
||||
|
||||
#define XPLM_VK_5 0x35
|
||||
|
||||
#define XPLM_VK_6 0x36
|
||||
|
||||
#define XPLM_VK_7 0x37
|
||||
|
||||
#define XPLM_VK_8 0x38
|
||||
|
||||
#define XPLM_VK_9 0x39
|
||||
|
||||
/* XPLM_VK_A thru XPLM_VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
|
||||
#define XPLM_VK_A 0x41
|
||||
|
||||
#define XPLM_VK_B 0x42
|
||||
|
||||
#define XPLM_VK_C 0x43
|
||||
|
||||
#define XPLM_VK_D 0x44
|
||||
|
||||
#define XPLM_VK_E 0x45
|
||||
|
||||
#define XPLM_VK_F 0x46
|
||||
|
||||
#define XPLM_VK_G 0x47
|
||||
|
||||
#define XPLM_VK_H 0x48
|
||||
|
||||
#define XPLM_VK_I 0x49
|
||||
|
||||
#define XPLM_VK_J 0x4A
|
||||
|
||||
#define XPLM_VK_K 0x4B
|
||||
|
||||
#define XPLM_VK_L 0x4C
|
||||
|
||||
#define XPLM_VK_M 0x4D
|
||||
|
||||
#define XPLM_VK_N 0x4E
|
||||
|
||||
#define XPLM_VK_O 0x4F
|
||||
|
||||
#define XPLM_VK_P 0x50
|
||||
|
||||
#define XPLM_VK_Q 0x51
|
||||
|
||||
#define XPLM_VK_R 0x52
|
||||
|
||||
#define XPLM_VK_S 0x53
|
||||
|
||||
#define XPLM_VK_T 0x54
|
||||
|
||||
#define XPLM_VK_U 0x55
|
||||
|
||||
#define XPLM_VK_V 0x56
|
||||
|
||||
#define XPLM_VK_W 0x57
|
||||
|
||||
#define XPLM_VK_X 0x58
|
||||
|
||||
#define XPLM_VK_Y 0x59
|
||||
|
||||
#define XPLM_VK_Z 0x5A
|
||||
|
||||
#define XPLM_VK_NUMPAD0 0x60
|
||||
|
||||
#define XPLM_VK_NUMPAD1 0x61
|
||||
|
||||
#define XPLM_VK_NUMPAD2 0x62
|
||||
|
||||
#define XPLM_VK_NUMPAD3 0x63
|
||||
|
||||
#define XPLM_VK_NUMPAD4 0x64
|
||||
|
||||
#define XPLM_VK_NUMPAD5 0x65
|
||||
|
||||
#define XPLM_VK_NUMPAD6 0x66
|
||||
|
||||
#define XPLM_VK_NUMPAD7 0x67
|
||||
|
||||
#define XPLM_VK_NUMPAD8 0x68
|
||||
|
||||
#define XPLM_VK_NUMPAD9 0x69
|
||||
|
||||
#define XPLM_VK_MULTIPLY 0x6A
|
||||
|
||||
#define XPLM_VK_ADD 0x6B
|
||||
|
||||
#define XPLM_VK_SEPARATOR 0x6C
|
||||
|
||||
#define XPLM_VK_SUBTRACT 0x6D
|
||||
|
||||
#define XPLM_VK_DECIMAL 0x6E
|
||||
|
||||
#define XPLM_VK_DIVIDE 0x6F
|
||||
|
||||
#define XPLM_VK_F1 0x70
|
||||
|
||||
#define XPLM_VK_F2 0x71
|
||||
|
||||
#define XPLM_VK_F3 0x72
|
||||
|
||||
#define XPLM_VK_F4 0x73
|
||||
|
||||
#define XPLM_VK_F5 0x74
|
||||
|
||||
#define XPLM_VK_F6 0x75
|
||||
|
||||
#define XPLM_VK_F7 0x76
|
||||
|
||||
#define XPLM_VK_F8 0x77
|
||||
|
||||
#define XPLM_VK_F9 0x78
|
||||
|
||||
#define XPLM_VK_F10 0x79
|
||||
|
||||
#define XPLM_VK_F11 0x7A
|
||||
|
||||
#define XPLM_VK_F12 0x7B
|
||||
|
||||
#define XPLM_VK_F13 0x7C
|
||||
|
||||
#define XPLM_VK_F14 0x7D
|
||||
|
||||
#define XPLM_VK_F15 0x7E
|
||||
|
||||
#define XPLM_VK_F16 0x7F
|
||||
|
||||
#define XPLM_VK_F17 0x80
|
||||
|
||||
#define XPLM_VK_F18 0x81
|
||||
|
||||
#define XPLM_VK_F19 0x82
|
||||
|
||||
#define XPLM_VK_F20 0x83
|
||||
|
||||
#define XPLM_VK_F21 0x84
|
||||
|
||||
#define XPLM_VK_F22 0x85
|
||||
|
||||
#define XPLM_VK_F23 0x86
|
||||
|
||||
#define XPLM_VK_F24 0x87
|
||||
|
||||
/* The following definitions are extended and are not based on the Microsoft *
|
||||
* key set. */
|
||||
#define XPLM_VK_EQUAL 0xB0
|
||||
|
||||
#define XPLM_VK_MINUS 0xB1
|
||||
|
||||
#define XPLM_VK_RBRACE 0xB2
|
||||
|
||||
#define XPLM_VK_LBRACE 0xB3
|
||||
|
||||
#define XPLM_VK_QUOTE 0xB4
|
||||
|
||||
#define XPLM_VK_SEMICOLON 0xB5
|
||||
|
||||
#define XPLM_VK_BACKSLASH 0xB6
|
||||
|
||||
#define XPLM_VK_COMMA 0xB7
|
||||
|
||||
#define XPLM_VK_SLASH 0xB8
|
||||
|
||||
#define XPLM_VK_PERIOD 0xB9
|
||||
|
||||
#define XPLM_VK_BACKQUOTE 0xBA
|
||||
|
||||
#define XPLM_VK_ENTER 0xBB
|
||||
|
||||
#define XPLM_VK_NUMPAD_ENT 0xBC
|
||||
|
||||
#define XPLM_VK_NUMPAD_EQ 0xBD
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
760
xpcPlugin/SDK/CHeaders/XPLM/XPLMDisplay.h
Executable file
760
xpcPlugin/SDK/CHeaders/XPLM/XPLMDisplay.h
Executable file
@@ -0,0 +1,760 @@
|
||||
#ifndef _XPLMDisplay_h_
|
||||
#define _XPLMDisplay_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* XPLM Display APIs - THEORY OF OPERATION
|
||||
*
|
||||
* This API provides the basic hooks to draw in X-Plane and create user
|
||||
* interface. All X-Plane drawing is done in OpenGL. The X-Plane plug-in
|
||||
* manager takes care of properly setting up the OpenGL context and matrices.
|
||||
* You do not decide when in your code's execution to draw; X-Plane tells you
|
||||
* when it is ready to have your plugin draw.
|
||||
*
|
||||
* X-Plane's drawing strategy is straightforward: every "frame" the screen is
|
||||
* rendered by drawing the 3-d scene (dome, ground, objects, airplanes, etc.)
|
||||
* and then drawing the cockpit on top of it. Alpha blending is used to
|
||||
* overlay the cockpit over the world (and the gauges over the panel, etc.).
|
||||
*
|
||||
* There are two ways you can draw: directly and in a window.
|
||||
*
|
||||
* Direct drawing involves drawing to the screen before or after X-Plane
|
||||
* finishes a phase of drawing. When you draw directly, you can specify
|
||||
* whether x-plane is to complete this phase or not. This allows you to do
|
||||
* three things: draw before x-plane does (under it), draw after x-plane does
|
||||
* (over it), or draw instead of x-plane.
|
||||
*
|
||||
* To draw directly, you register a callback and specify what phase you want
|
||||
* to intercept. The plug-in manager will call you over and over to draw that
|
||||
* phase.
|
||||
*
|
||||
* Direct drawing allows you to override scenery, panels, or anything. Note
|
||||
* that you cannot assume that you are the only plug-in drawing at this
|
||||
* phase.
|
||||
*
|
||||
* Window drawing provides slightly higher level functionality. With window
|
||||
* drawing you create a window that takes up a portion of the screen. Window
|
||||
* drawing is always two dimensional. Window drawing is front-to-back
|
||||
* controlled; you can specify that you want your window to be brought on
|
||||
* top, and other plug-ins may put their window on top of you. Window drawing
|
||||
* also allows you to sign up for key presses and receive mouse clicks.
|
||||
*
|
||||
* There are three ways to get keystrokes:
|
||||
*
|
||||
* If you create a window, the window can take keyboard focus. It will then
|
||||
* receive all keystrokes. If no window has focus, X-Plane receives
|
||||
* keystrokes. Use this to implement typing in dialog boxes, etc. Only one
|
||||
* window may have focus at a time; your window will be notified if it loses
|
||||
* focus.
|
||||
*
|
||||
* If you need to associate key strokes with commands/functions in your
|
||||
* plug-in, use a hot key. A hoy is a key-specific callback. Hotkeys are
|
||||
* sent based on virtual key strokes, so any key may be distinctly mapped with
|
||||
* any modifiers. Hot keys can be remapped by other plug-ins. As a plug-in,
|
||||
* you don't have to worry about what your hot key ends up mapped to; other
|
||||
* plug-ins may provide a UI for remapping keystrokes. So hotkeys allow a
|
||||
* user to resolve conflicts and customize keystrokes.
|
||||
*
|
||||
* If you need low level access to the keystroke stream, install a key
|
||||
* sniffer. Key sniffers can be installed above everything or right in front
|
||||
* of the sim.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* DRAWING CALLBACKS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* Basic drawing callbacks, for low level intercepting of render loop. The
|
||||
* purpose of drawing callbacks is to provide targeted additions or
|
||||
* replacements to x-plane's graphics environment (for example, to add extra
|
||||
* custom objects, or replace drawing of the AI aircraft). Do not assume that
|
||||
* the drawing callbacks will be called in the order implied by the
|
||||
* enumerations. Also do not assume that each drawing phase ends before
|
||||
* another begins; they may be nested.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMDrawingPhase
|
||||
*
|
||||
* This constant indicates which part of drawing we are in. Drawing is done
|
||||
* from the back to the front. We get a callback before or after each item.
|
||||
* Metaphases provide access to the beginning and end of the 3d (scene) and 2d
|
||||
* (cockpit) drawing in a manner that is independent of new phases added via
|
||||
* x-plane implementation.
|
||||
*
|
||||
* WARNING: As X-Plane's scenery evolves, some drawing phases may cease to
|
||||
* exist and new ones may be invented. If you need a particularly specific
|
||||
* use of these codes, consult Austin and/or be prepared to revise your code
|
||||
* as X-Plane evolves.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* This is the earliest point at which you can draw in 3-d. */
|
||||
xplm_Phase_FirstScene = 0
|
||||
|
||||
/* Drawing of land and water. */
|
||||
,xplm_Phase_Terrain = 5
|
||||
|
||||
/* Drawing runways and other airport detail. */
|
||||
,xplm_Phase_Airports = 10
|
||||
|
||||
/* Drawing roads, trails, trains, etc. */
|
||||
,xplm_Phase_Vectors = 15
|
||||
|
||||
/* 3-d objects (houses, smokestacks, etc. */
|
||||
,xplm_Phase_Objects = 20
|
||||
|
||||
/* External views of airplanes, both yours and the AI aircraft. */
|
||||
,xplm_Phase_Airplanes = 25
|
||||
|
||||
/* This is the last point at which you can draw in 3-d. */
|
||||
,xplm_Phase_LastScene = 30
|
||||
|
||||
/* This is the first phase where you can draw in 2-d. */
|
||||
,xplm_Phase_FirstCockpit = 35
|
||||
|
||||
/* The non-moving parts of the aircraft panel. */
|
||||
,xplm_Phase_Panel = 40
|
||||
|
||||
/* The moving parts of the aircraft panel. */
|
||||
,xplm_Phase_Gauges = 45
|
||||
|
||||
/* Floating windows from plugins. */
|
||||
,xplm_Phase_Window = 50
|
||||
|
||||
/* The last change to draw in 2d. */
|
||||
,xplm_Phase_LastCockpit = 55
|
||||
|
||||
#if defined(XPLM200)
|
||||
/* 3-d Drawing for the local map. Use regular OpenGL coordinates to draw in *
|
||||
* this phase. */
|
||||
,xplm_Phase_LocalMap3D = 100
|
||||
|
||||
#endif /* XPLM200 */
|
||||
#if defined(XPLM200)
|
||||
/* 2-d Drawing of text over the local map. */
|
||||
,xplm_Phase_LocalMap2D = 101
|
||||
|
||||
#endif /* XPLM200 */
|
||||
#if defined(XPLM200)
|
||||
/* Drawing of the side-profile view in the local map screen. */
|
||||
,xplm_Phase_LocalMapProfile = 102
|
||||
|
||||
#endif /* XPLM200 */
|
||||
|
||||
};
|
||||
typedef int XPLMDrawingPhase;
|
||||
|
||||
/*
|
||||
* XPLMDrawCallback_f
|
||||
*
|
||||
* This is the prototype for a low level drawing callback. You are passed in
|
||||
* the phase and whether it is before or after. If you are before the phase,
|
||||
* return 1 to let x-plane draw or 0 to suppress x-plane drawing. If you are
|
||||
* after the phase the return value is ignored.
|
||||
*
|
||||
* Refcon is a unique value that you specify when registering the callback,
|
||||
* allowing you to slip a pointer to your own data to the callback.
|
||||
*
|
||||
* Upon entry the OpenGL context will be correctly set up for you and OpenGL
|
||||
* will be in 'local' coordinates for 3d drawing and panel coordinates for 2d
|
||||
* drawing. The OpenGL state (texturing, etc.) will be unknown.
|
||||
*
|
||||
*/
|
||||
typedef int (* XPLMDrawCallback_f)(
|
||||
XPLMDrawingPhase inPhase,
|
||||
int inIsBefore,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMKeySniffer_f
|
||||
*
|
||||
* This is the prototype for a low level key-sniffing function. Window-based
|
||||
* UI _should not use this_! The windowing system provides high-level
|
||||
* mediated keyboard access. By comparison, the key sniffer provides low
|
||||
* level keyboard access.
|
||||
*
|
||||
* Key sniffers are provided to allow libraries to provide non-windowed user
|
||||
* interaction. For example, the MUI library uses a key sniffer to do pop-up
|
||||
* text entry.
|
||||
*
|
||||
* inKey is the character pressed, inRefCon is a value you supply during
|
||||
* registration. Return 1 to pass the key on to the next sniffer, the window
|
||||
* mgr, x-plane, or whomever is down stream. Return 0 to consume the key.
|
||||
*
|
||||
* Warning: this API declares virtual keys as a signed character; however the
|
||||
* VKEY #define macros in XPLMDefs.h define the vkeys using unsigned values
|
||||
* (that is 0x80 instead of -0x80). So you may need to cast the incoming vkey
|
||||
* to an unsigned char to get correct comparisons in C.
|
||||
*
|
||||
*/
|
||||
typedef int (* XPLMKeySniffer_f)(
|
||||
char inChar,
|
||||
XPLMKeyFlags inFlags,
|
||||
char inVirtualKey,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMRegisterDrawCallback
|
||||
*
|
||||
* This routine registers a low level drawing callback. Pass in the phase you
|
||||
* want to be called for and whether you want to be called before or after.
|
||||
* This routine returns 1 if the registration was successful, or 0 if the
|
||||
* phase does not exist in this version of x-plane. You may register a
|
||||
* callback multiple times for the same or different phases as long as the
|
||||
* refcon is unique each time.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMRegisterDrawCallback(
|
||||
XPLMDrawCallback_f inCallback,
|
||||
XPLMDrawingPhase inPhase,
|
||||
int inWantsBefore,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMUnregisterDrawCallback
|
||||
*
|
||||
* This routine unregisters a draw callback. You must unregister a callback
|
||||
* for each time you register a callback if you have registered it multiple
|
||||
* times with different refcons. The routine returns 1 if it can find the
|
||||
* callback to unregister, 0 otherwise.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMUnregisterDrawCallback(
|
||||
XPLMDrawCallback_f inCallback,
|
||||
XPLMDrawingPhase inPhase,
|
||||
int inWantsBefore,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMRegisterKeySniffer
|
||||
*
|
||||
* This routine registers a key sniffing callback. You specify whether you
|
||||
* want to sniff before the window system, or only sniff keys the window
|
||||
* system does not consume. You should ALMOST ALWAYS sniff non-control keys
|
||||
* after the window system. When the window system consumes a key, it is
|
||||
* because the user has "focused" a window. Consuming the key or taking
|
||||
* action based on the key will produce very weird results. Returns 1 if
|
||||
* successful.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMRegisterKeySniffer(
|
||||
XPLMKeySniffer_f inCallback,
|
||||
int inBeforeWindows,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMUnregisterKeySniffer
|
||||
*
|
||||
* This routine unregisters a key sniffer. You must unregister a key sniffer
|
||||
* for every time you register one with the exact same signature. Returns 1
|
||||
* if successful.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMUnregisterKeySniffer(
|
||||
XPLMKeySniffer_f inCallback,
|
||||
int inBeforeWindows,
|
||||
void * inRefcon);
|
||||
|
||||
/***************************************************************************
|
||||
* WINDOW API
|
||||
***************************************************************************/
|
||||
/*
|
||||
* Window API, for higher level drawing with UI interaction.
|
||||
*
|
||||
* Note: all 2-d (and thus all window drawing) is done in 'cockpit pixels'.
|
||||
* Even when the OpenGL window contains more than 1024x768 pixels, the cockpit
|
||||
* drawing is magnified so that only 1024x768 pixels are available.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMMouseStatus
|
||||
*
|
||||
* When the mouse is clicked, your mouse click routine is called repeatedly.
|
||||
* It is first called with the mouse down message. It is then called zero or
|
||||
* more times with the mouse-drag message, and finally it is called once with
|
||||
* the mouse up message. All of these messages will be directed to the same
|
||||
* window.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
xplm_MouseDown = 1
|
||||
|
||||
,xplm_MouseDrag = 2
|
||||
|
||||
,xplm_MouseUp = 3
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMMouseStatus;
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMCursorStatus
|
||||
*
|
||||
* XPLMCursorStatus describes how you would like X-Plane to manage the cursor.
|
||||
* See XPLMHandleCursor_f for more info.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* X-Plane manages the cursor normally, plugin does not affect the cusrsor. */
|
||||
xplm_CursorDefault = 0
|
||||
|
||||
/* X-Plane hides the cursor. */
|
||||
,xplm_CursorHidden = 1
|
||||
|
||||
/* X-Plane shows the cursor as the default arrow. */
|
||||
,xplm_CursorArrow = 2
|
||||
|
||||
/* X-Plane shows the cursor but lets you select an OS cursor. */
|
||||
,xplm_CursorCustom = 3
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMCursorStatus;
|
||||
#endif /* XPLM200 */
|
||||
|
||||
/*
|
||||
* XPLMWindowID
|
||||
*
|
||||
* This is an opaque identifier for a window. You use it to control your
|
||||
* window. When you create a window, you will specify callbacks to handle
|
||||
* drawing and mouse interaction, etc.
|
||||
*
|
||||
*/
|
||||
typedef void * XPLMWindowID;
|
||||
|
||||
/*
|
||||
* XPLMDrawWindow_f
|
||||
*
|
||||
* This function handles drawing. You are passed in your window and its
|
||||
* refcon. Draw the window. You can use XPLM functions to find the current
|
||||
* dimensions of your window, etc. When this callback is called, the OpenGL
|
||||
* context will be set properly for cockpit drawing. NOTE: Because you are
|
||||
* drawing your window over a background, you can make a translucent window
|
||||
* easily by simply not filling in your entire window's bounds.
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMDrawWindow_f)(
|
||||
XPLMWindowID inWindowID,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMHandleKey_f
|
||||
*
|
||||
* This function is called when a key is pressed or keyboard focus is taken
|
||||
* away from your window. If losingFocus is 1, you are losign the keyboard
|
||||
* focus, otherwise a key was pressed and inKey contains its character. You
|
||||
* are also passewd your window and a refcon. Warning: this API declares
|
||||
* virtual keys as a signed character; however the VKEY #define macros in
|
||||
* XPLMDefs.h define the vkeys using unsigned values (that is 0x80 instead of
|
||||
* -0x80). So you may need to cast the incoming vkey to an unsigned char to
|
||||
* get correct comparisons in C.
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMHandleKey_f)(
|
||||
XPLMWindowID inWindowID,
|
||||
char inKey,
|
||||
XPLMKeyFlags inFlags,
|
||||
char inVirtualKey,
|
||||
void * inRefcon,
|
||||
int losingFocus);
|
||||
|
||||
/*
|
||||
* XPLMHandleMouseClick_f
|
||||
*
|
||||
* You receive this call when the mouse button is pressed down or released.
|
||||
* Between then these two calls is a drag. You receive the x and y of the
|
||||
* click, your window, and a refcon. Return 1 to consume the click, or 0 to
|
||||
* pass it through.
|
||||
*
|
||||
* WARNING: passing clicks through windows (as of this writing) causes mouse
|
||||
* tracking problems in X-Plane; do not use this feature!
|
||||
*
|
||||
*/
|
||||
typedef int (* XPLMHandleMouseClick_f)(
|
||||
XPLMWindowID inWindowID,
|
||||
int x,
|
||||
int y,
|
||||
XPLMMouseStatus inMouse,
|
||||
void * inRefcon);
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMHandleCursor_f
|
||||
*
|
||||
* The SDK calls your cursor status callback when the mouse is over your
|
||||
* plugin window. Return a cursor status code to indicate how you would like
|
||||
* X-Plane to manage the cursor. If you return xplm_CursorDefault, the SDK
|
||||
* will try lower-Z-order plugin windows, then let the sim manage the cursor.
|
||||
*
|
||||
* Note: you should never show or hide the cursor yourself - these APIs are
|
||||
* typically reference-counted and thus cannot safely and predictably be used
|
||||
* by the SDK. Instead return one of xplm_CursorHidden to hide the cursor or
|
||||
* xplm_CursorArrow/xplm_CursorCustom to show the cursor.
|
||||
*
|
||||
* If you want to implement a custom cursor by drawing a cursor in OpenGL, use
|
||||
* xplm_CursorHidden to hide the OS cursor and draw the cursor using a 2-d
|
||||
* drawing callback (after xplm_Phase_Window is probably a good choice). If
|
||||
* you want to use a custom OS-based cursor, use xplm_CursorCustom to ask
|
||||
* X-Plane to show the cursor but not affect its image. You can then use an
|
||||
* OS specific call like SetThemeCursor (Mac) or SetCursor/LoadCursor
|
||||
* (Windows).
|
||||
*
|
||||
*/
|
||||
typedef XPLMCursorStatus (* XPLMHandleCursor_f)(
|
||||
XPLMWindowID inWindowID,
|
||||
int x,
|
||||
int y,
|
||||
void * inRefcon);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMHandleMouseWheel_f
|
||||
*
|
||||
* The SDK calls your mouse wheel callback when one of the mouse wheels is
|
||||
* turned within your window. Return 1 to consume the mouse wheel clicks or
|
||||
* 0 to pass them on to a lower window. (You should consume mouse wheel
|
||||
* clicks even if they do nothing if your window appears opaque to the user.)
|
||||
* The number of clicks indicates how far the wheel was turned since the last
|
||||
* callback. The wheel is 0 for the vertical axis or 1 for the horizontal axis
|
||||
* (for OS/mouse combinations that support this).
|
||||
*
|
||||
*/
|
||||
typedef int (* XPLMHandleMouseWheel_f)(
|
||||
XPLMWindowID inWindowID,
|
||||
int x,
|
||||
int y,
|
||||
int wheel,
|
||||
int clicks,
|
||||
void * inRefcon);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMCreateWindow_t
|
||||
*
|
||||
* The XPMCreateWindow_t structure defines all of the parameters used to
|
||||
* create a window using XPLMCreateWindowEx. The structure will be expanded
|
||||
* in future SDK APIs to include more features. Always set the structSize
|
||||
* member to the size of your struct in bytes!
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
int structSize;
|
||||
int left;
|
||||
int top;
|
||||
int right;
|
||||
int bottom;
|
||||
int visible;
|
||||
XPLMDrawWindow_f drawWindowFunc;
|
||||
XPLMHandleMouseClick_f handleMouseClickFunc;
|
||||
XPLMHandleKey_f handleKeyFunc;
|
||||
XPLMHandleCursor_f handleCursorFunc;
|
||||
XPLMHandleMouseWheel_f handleMouseWheelFunc;
|
||||
void * refcon;
|
||||
} XPLMCreateWindow_t;
|
||||
#endif /* XPLM200 */
|
||||
|
||||
/*
|
||||
* XPLMGetScreenSize
|
||||
*
|
||||
* This routine returns the size of the size of the X-Plane OpenGL window in
|
||||
* pixels. Please note that this is not the size of the screen when doing
|
||||
* 2-d drawing (the 2-d screen is currently always 1024x768, and graphics are
|
||||
* scaled up by OpenGL when doing 2-d drawing for higher-res monitors). This
|
||||
* number can be used to get a rough idea of the amount of detail the user
|
||||
* will be able to see when drawing in 3-d.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetScreenSize(
|
||||
int * outWidth, /* Can be NULL */
|
||||
int * outHeight); /* Can be NULL */
|
||||
|
||||
/*
|
||||
* XPLMGetMouseLocation
|
||||
*
|
||||
* This routine returns the current mouse location in cockpit pixels. The
|
||||
* bottom left corner of the display is 0,0. Pass NULL to not receive info
|
||||
* about either parameter.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetMouseLocation(
|
||||
int * outX, /* Can be NULL */
|
||||
int * outY); /* Can be NULL */
|
||||
|
||||
/*
|
||||
* XPLMCreateWindow
|
||||
*
|
||||
* This routine creates a new window. Pass in the dimensions and offsets to
|
||||
* the window's bottom left corner from the bottom left of the screen. You
|
||||
* can specify whether the window is initially visible or not. Also, you pass
|
||||
* in three callbacks to run the window and a refcon. This function returns a
|
||||
* window ID you can use to refer to the new window.
|
||||
*
|
||||
* NOTE: windows do not have "frames"; you are responsible for drawing the
|
||||
* background and frame of the window. Higher level libraries have routines
|
||||
* which make this easy.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMWindowID XPLMCreateWindow(
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom,
|
||||
int inIsVisible,
|
||||
XPLMDrawWindow_f inDrawCallback,
|
||||
XPLMHandleKey_f inKeyCallback,
|
||||
XPLMHandleMouseClick_f inMouseCallback,
|
||||
void * inRefcon);
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMCreateWindowEx
|
||||
*
|
||||
* This routine creates a new window - you pass in an XPLMCreateWindow_t
|
||||
* structure with all of the fields set in. You must set the structSize of
|
||||
* the structure to the size of the actual structure you used. Also, you
|
||||
* must provide funtions for every callback - you may not leave them null!
|
||||
* (If you do not support the cursor or mouse wheel, use functions that return
|
||||
* the default values.) The numeric values of the XPMCreateWindow_t structure
|
||||
* correspond to the parameters of XPLMCreateWindow.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMWindowID XPLMCreateWindowEx(
|
||||
XPLMCreateWindow_t * inParams);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
/*
|
||||
* XPLMDestroyWindow
|
||||
*
|
||||
* This routine destroys a window. The callbacks are not called after this
|
||||
* call. Keyboard focus is removed from the window before destroying it.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDestroyWindow(
|
||||
XPLMWindowID inWindowID);
|
||||
|
||||
/*
|
||||
* XPLMGetWindowGeometry
|
||||
*
|
||||
* This routine returns the position and size of a window in cockpit pixels.
|
||||
* Pass NULL to not receive any paramter.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetWindowGeometry(
|
||||
XPLMWindowID inWindowID,
|
||||
int * outLeft, /* Can be NULL */
|
||||
int * outTop, /* Can be NULL */
|
||||
int * outRight, /* Can be NULL */
|
||||
int * outBottom); /* Can be NULL */
|
||||
|
||||
/*
|
||||
* XPLMSetWindowGeometry
|
||||
*
|
||||
* This routine allows you to set the position or height aspects of a window.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetWindowGeometry(
|
||||
XPLMWindowID inWindowID,
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom);
|
||||
|
||||
/*
|
||||
* XPLMGetWindowIsVisible
|
||||
*
|
||||
* This routine returns whether a window is visible.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMGetWindowIsVisible(
|
||||
XPLMWindowID inWindowID);
|
||||
|
||||
/*
|
||||
* XPLMSetWindowIsVisible
|
||||
*
|
||||
* This routine shows or hides a window.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetWindowIsVisible(
|
||||
XPLMWindowID inWindowID,
|
||||
int inIsVisible);
|
||||
|
||||
/*
|
||||
* XPLMGetWindowRefCon
|
||||
*
|
||||
* This routine returns a windows refcon, the unique value you can use for
|
||||
* your own purposes.
|
||||
*
|
||||
*/
|
||||
XPLM_API void * XPLMGetWindowRefCon(
|
||||
XPLMWindowID inWindowID);
|
||||
|
||||
/*
|
||||
* XPLMSetWindowRefCon
|
||||
*
|
||||
* This routine sets a window's reference constant. Use this to pass data to
|
||||
* yourself in the callbacks.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetWindowRefCon(
|
||||
XPLMWindowID inWindowID,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMTakeKeyboardFocus
|
||||
*
|
||||
* This routine gives a specific window keyboard focus. Keystrokes will be
|
||||
* sent to that window. Pass a window ID of 0 to pass keyboard strokes
|
||||
* directly to X-Plane.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMTakeKeyboardFocus(
|
||||
XPLMWindowID inWindow);
|
||||
|
||||
/*
|
||||
* XPLMBringWindowToFront
|
||||
*
|
||||
* This routine brings the window to the front of the Z-order. Windows are
|
||||
* brought to the front when they are created...beyond that you should make
|
||||
* sure you are front before handling mouse clicks.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMBringWindowToFront(
|
||||
XPLMWindowID inWindow);
|
||||
|
||||
/*
|
||||
* XPLMIsWindowInFront
|
||||
*
|
||||
* This routine returns true if you pass inthe ID of the frontmost visible
|
||||
* window.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMIsWindowInFront(
|
||||
XPLMWindowID inWindow);
|
||||
|
||||
/***************************************************************************
|
||||
* HOT KEYS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* Hot Keys - keystrokes that can be managed by others.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMHotKey_f
|
||||
*
|
||||
* Your hot key callback simply takes a pointer of your choosing.
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMHotKey_f)(
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMHotKeyID
|
||||
*
|
||||
* Hot keys are identified by opaque IDs.
|
||||
*
|
||||
*/
|
||||
typedef void * XPLMHotKeyID;
|
||||
|
||||
/*
|
||||
* XPLMRegisterHotKey
|
||||
*
|
||||
* This routine registers a hot key. You specify your preferred key stroke
|
||||
* virtual key/flag combination, a description of what your callback does (so
|
||||
* other plug-ins can describe the plug-in to the user for remapping) and a
|
||||
* callback function and opaque pointer to pass in). A new hot key ID is
|
||||
* returned. During execution, the actual key associated with your hot key
|
||||
* may change, but you are insulated from this.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMHotKeyID XPLMRegisterHotKey(
|
||||
char inVirtualKey,
|
||||
XPLMKeyFlags inFlags,
|
||||
const char * inDescription,
|
||||
XPLMHotKey_f inCallback,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMUnregisterHotKey
|
||||
*
|
||||
* This API unregisters a hot key. You can only register your own hot keys.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMUnregisterHotKey(
|
||||
XPLMHotKeyID inHotKey);
|
||||
|
||||
/*
|
||||
* XPLMCountHotKeys
|
||||
*
|
||||
* Returns the number of current hot keys.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMCountHotKeys(void);
|
||||
|
||||
/*
|
||||
* XPLMGetNthHotKey
|
||||
*
|
||||
* Returns a hot key by index, for iteration on all hot keys.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMHotKeyID XPLMGetNthHotKey(
|
||||
int inIndex);
|
||||
|
||||
/*
|
||||
* XPLMGetHotKeyInfo
|
||||
*
|
||||
* Returns information about the hot key. Return NULL for any parameter you
|
||||
* don't want info about. The description should be at least 512 chars long.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetHotKeyInfo(
|
||||
XPLMHotKeyID inHotKey,
|
||||
char * outVirtualKey, /* Can be NULL */
|
||||
XPLMKeyFlags * outFlags, /* Can be NULL */
|
||||
char * outDescription, /* Can be NULL */
|
||||
XPLMPluginID * outPlugin); /* Can be NULL */
|
||||
|
||||
/*
|
||||
* XPLMSetHotKeyCombination
|
||||
*
|
||||
* XPLMSetHotKeyCombination remaps a hot keys keystrokes. You may remap
|
||||
* another plugin's keystrokes.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetHotKeyCombination(
|
||||
XPLMHotKeyID inHotKey,
|
||||
char inVirtualKey,
|
||||
XPLMKeyFlags inFlags);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
408
xpcPlugin/SDK/CHeaders/XPLM/XPLMGraphics.h
Executable file
408
xpcPlugin/SDK/CHeaders/XPLM/XPLMGraphics.h
Executable file
@@ -0,0 +1,408 @@
|
||||
#ifndef _XPLMGraphics_h_
|
||||
#define _XPLMGraphics_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* Graphics routines for X-Plane and OpenGL.
|
||||
*
|
||||
* A few notes on coordinate systems:
|
||||
*
|
||||
* X-Plane uses three kinds of coordinates. Global coordinates are specified
|
||||
* as latitude, longitude and elevation. This coordinate system never changes
|
||||
* but is not very precise.
|
||||
*
|
||||
* OpenGL (or 'local') coordinates are cartesian and shift with the plane.
|
||||
* They offer more precision and are used for 3-d OpenGL drawing. The X axis
|
||||
* is aligned east-west with positive X meaning east. The Y axis is aligned
|
||||
* straight up and down at the point 0,0,0 (but since the earth is round it is
|
||||
* not truly straight up and down at other points). The Z axis is aligned
|
||||
* north-south at 0, 0, 0 with positive Z pointing south (but since the earth
|
||||
* is round it isn't exactly north-south as you move east or west of 0, 0, 0).
|
||||
* One unit is one meter and the point 0,0,0 is on the surface of the earth
|
||||
* at sea level for some latitude and longitude picked by the sim such that
|
||||
* the user's aircraft is reasonably nearby.
|
||||
*
|
||||
* Cockpit coordinates are 2d, with the X axis horizontal and the Y axis
|
||||
* vertical. The point 0,0 is the bottom left and 1024,768 is the upper right
|
||||
* of the screen. This is true no matter what resolution the user's monitor is
|
||||
* in; when running in higher resolution, graphics will be scaled.
|
||||
*
|
||||
* Use X-Plane's routines to convert between global and local coordinates. Do
|
||||
* not attempt to do this conversion yourself; the precise 'roundness' of
|
||||
* X-Plane's physics model may not match your own, and (to make things
|
||||
* weirder) the user can potentially customize the physics of the current
|
||||
* planet.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* X-PLANE GRAPHICS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These routines allow you to use OpenGL with X-Plane.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMTextureID
|
||||
*
|
||||
* XPLM Texture IDs name well-known textures in the sim for you to use. This
|
||||
* allows you to recycle textures from X-Plane, saving VRAM.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* The bitmap that contains window outlines, button outlines, fonts, etc. */
|
||||
xplm_Tex_GeneralInterface = 0
|
||||
|
||||
/* The exterior paint for the user's aircraft (daytime). */
|
||||
,xplm_Tex_AircraftPaint = 1
|
||||
|
||||
/* The exterior light map for the user's aircraft. */
|
||||
,xplm_Tex_AircraftLiteMap = 2
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMTextureID;
|
||||
|
||||
/*
|
||||
* XPLMSetGraphicsState
|
||||
*
|
||||
* XPLMSetGraphicsState changes OpenGL's graphics state in a number of ways:
|
||||
*
|
||||
* inEnableFog - enables or disables fog, equivalent to: glEnable(GL_FOG);
|
||||
*
|
||||
* inNumberTexUnits - enables or disables a number of multitexturing units. If
|
||||
* the number is 0, 2d texturing is disabled entirely, as in
|
||||
* glDisable(GL_TEXTURE_2D); Otherwise, 2d texturing is enabled, and a
|
||||
* number of multitexturing units are enabled sequentially, starting with
|
||||
* unit 0, e.g. glActiveTextureARB(GL_TEXTURE0_ARB); glEnable
|
||||
* (GL_TEXTURE_2D);
|
||||
*
|
||||
* inEnableLighting - enables or disables OpenGL lighting, e.g.
|
||||
* glEnable(GL_LIGHTING); glEnable(GL_LIGHT0);
|
||||
*
|
||||
* inEnableAlphaTesting - enables or disables the alpha test per pixel, e.g.
|
||||
* glEnable(GL_ALPHA_TEST);
|
||||
*
|
||||
* inEnableAlphaBlending - enables or disables alpha blending per pixel, e.g.
|
||||
* glEnable(GL_BLEND);
|
||||
*
|
||||
* inEnableDepthTesting - enables per pixel depth testing, as in
|
||||
* glEnable(GL_DEPTH_TEST);
|
||||
*
|
||||
* inEnableDepthWriting - enables writing back of depth information to the
|
||||
* depth bufffer, as in glDepthMask(GL_TRUE);
|
||||
*
|
||||
* The purpose of this function is to change OpenGL state while keeping
|
||||
* X-Plane aware of the state changes; this keeps X-Plane from getting
|
||||
* surprised by OGL state changes, and prevents X-Plane and plug-ins from
|
||||
* having to set all state before all draws; XPLMSetGraphicsState internally
|
||||
* skips calls to change state that is already properly enabled.
|
||||
*
|
||||
* X-Plane does not have a 'default' OGL state to plug-ins; plug-ins should
|
||||
* totally set OGL state before drawing. Use XPLMSetGraphicsState instead of
|
||||
* any of the above OpenGL calls.
|
||||
*
|
||||
* WARNING: Any routine that performs drawing (e.g. XPLMDrawString or widget
|
||||
* code) may change X-Plane's state. Always set state before drawing after
|
||||
* unknown code has executed.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetGraphicsState(
|
||||
int inEnableFog,
|
||||
int inNumberTexUnits,
|
||||
int inEnableLighting,
|
||||
int inEnableAlphaTesting,
|
||||
int inEnableAlphaBlending,
|
||||
int inEnableDepthTesting,
|
||||
int inEnableDepthWriting);
|
||||
|
||||
/*
|
||||
* XPLMBindTexture2d
|
||||
*
|
||||
* XPLMBindTexture2d changes what texture is bound to the 2d texturing target.
|
||||
* This routine caches the current 2d texture across all texturing units in
|
||||
* the sim and plug-ins, preventing extraneous binding. For example, consider
|
||||
* several plug-ins running in series; if they all use the 'general interface'
|
||||
* bitmap to do UI, calling this function will skip the rebinding of the
|
||||
* general interface texture on all but the first plug-in, which can provide
|
||||
* better frame rate son some graphics cards.
|
||||
*
|
||||
* inTextureID is the ID of the texture object to bind; inTextureUnit is a
|
||||
* zero-based texture unit (e.g. 0 for the first one), up to a maximum of 4
|
||||
* units. (This number may increase in future versions of x-plane.)
|
||||
*
|
||||
* Use this routine instead of glBindTexture(GL_TEXTURE_2D, ....);
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMBindTexture2d(
|
||||
int inTextureNum,
|
||||
int inTextureUnit);
|
||||
|
||||
/*
|
||||
* XPLMGenerateTextureNumbers
|
||||
*
|
||||
* This routine generates unused texture numbers that a plug-in can use to
|
||||
* safely bind textures. Use this routine instead of glGenTextures;
|
||||
* glGenTextures will allocate texture numbers in ranges that X-Plane reserves
|
||||
* for its own use but does not always use; for example, it might provide an
|
||||
* ID within the range of textures reserved for terrain...loading a new .env
|
||||
* file as the plane flies might then cause X-Plane to use this texture ID.
|
||||
* X-Plane will then overwrite the plug-ins texture. This routine returns
|
||||
* texture IDs that are out of X-Plane's usage range.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGenerateTextureNumbers(
|
||||
int * outTextureIDs,
|
||||
int inCount);
|
||||
|
||||
/*
|
||||
* XPLMGetTexture
|
||||
*
|
||||
* XPLMGetTexture returns the OpenGL texture enumeration of an X-Plane texture
|
||||
* based on a generic identifying code. For example, you can get the texture
|
||||
* for X-Plane's UI bitmaps. This allows you to build new gauges that take
|
||||
* advantage of x-plane's textures, for smooth artwork integration and also
|
||||
* saving texture memory. Note that the texture might not be loaded yet,
|
||||
* depending on what the plane's panel contains.
|
||||
*
|
||||
* OPEN ISSUE: We really need a way to make sure X-Plane loads this texture if
|
||||
* it isn't around, or at least a way to find out whether it is loaded or not.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMGetTexture(
|
||||
XPLMTextureID inTexture);
|
||||
|
||||
/*
|
||||
* XPLMWorldToLocal
|
||||
*
|
||||
* This routine translates coordinates from latitude, longitude, and altitude
|
||||
* to local scene coordinates. Latitude and longitude are in decimal degrees,
|
||||
* and altitude is in meters MSL (mean sea level). The XYZ coordinates are in
|
||||
* meters in the local OpenGL coordinate system.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMWorldToLocal(
|
||||
double inLatitude,
|
||||
double inLongitude,
|
||||
double inAltitude,
|
||||
double * outX,
|
||||
double * outY,
|
||||
double * outZ);
|
||||
|
||||
/*
|
||||
* XPLMLocalToWorld
|
||||
*
|
||||
* This routine translates a local coordinate triplet back into latitude,
|
||||
* longitude, and altitude. Latitude and longitude are in decimal degrees,
|
||||
* and altitude is in meters MSL (mean sea level). The XYZ coordinates are in
|
||||
* meters in the local OpenGL coordinate system.
|
||||
*
|
||||
* NOTE: world coordinates are less precise than local coordinates; you should
|
||||
* try to avoid round tripping from local to world and back.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMLocalToWorld(
|
||||
double inX,
|
||||
double inY,
|
||||
double inZ,
|
||||
double * outLatitude,
|
||||
double * outLongitude,
|
||||
double * outAltitude);
|
||||
|
||||
/*
|
||||
* XPLMDrawTranslucentDarkBox
|
||||
*
|
||||
* This routine draws a translucent dark box, partially obscuring parts of the
|
||||
* screen but making text easy to read. This is the same graphics primitive
|
||||
* used by X-Plane to show text files and ATC info.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDrawTranslucentDarkBox(
|
||||
int inLeft,
|
||||
int inTop,
|
||||
int inRight,
|
||||
int inBottom);
|
||||
|
||||
/***************************************************************************
|
||||
* X-PLANE TEXT
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMFontID
|
||||
*
|
||||
* X-Plane features some fixed-character fonts. Each font may have its own
|
||||
* metrics.
|
||||
*
|
||||
* WARNING: Some of these fonts are no longer supported or may have changed
|
||||
* geometries. For maximum copmatibility, see the comments below.
|
||||
*
|
||||
* Note: X-Plane 7 supports proportional-spaced fonts. Since no measuring
|
||||
* routine is available yet, the SDK will normally draw using a fixed-width
|
||||
* font. You can use a dataref to enable proportional font drawing on XP7 if
|
||||
* you want to.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* Mono-spaced font for user interface. Available in all versions of the SDK. */
|
||||
xplmFont_Basic = 0
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_Menus = 1
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_Metal = 2
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_Led = 3
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_LedWide = 4
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_PanelHUD = 5
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_PanelEFIS = 6
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_PanelGPS = 7
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_RadiosGA = 8
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_RadiosBC = 9
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_RadiosHM = 10
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_RadiosGANarrow = 11
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_RadiosBCNarrow = 12
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_RadiosHMNarrow = 13
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_Timer = 14
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_FullRound = 15
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_SmallRound = 16
|
||||
|
||||
/* Deprecated, do not use. */
|
||||
,xplmFont_Menus_Localized = 17
|
||||
|
||||
#if defined(XPLM200)
|
||||
/* Proportional UI font. */
|
||||
,xplmFont_Proportional = 18
|
||||
|
||||
#endif /* XPLM200 */
|
||||
|
||||
};
|
||||
typedef int XPLMFontID;
|
||||
|
||||
/*
|
||||
* XPLMDrawString
|
||||
*
|
||||
* This routine draws a NULL termianted string in a given font. Pass in the
|
||||
* lower left pixel that the character is to be drawn onto. Also pass the
|
||||
* character and font ID. This function returns the x offset plus the width of
|
||||
* all drawn characters. The color to draw in is specified as a pointer to an
|
||||
* array of three floating point colors, representing RGB intensities from 0.0
|
||||
* to 1.0.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDrawString(
|
||||
float * inColorRGB,
|
||||
int inXOffset,
|
||||
int inYOffset,
|
||||
char * inChar,
|
||||
int * inWordWrapWidth, /* Can be NULL */
|
||||
XPLMFontID inFontID);
|
||||
|
||||
/*
|
||||
* XPLMDrawNumber
|
||||
*
|
||||
* This routine draws a number similar to the digit editing fields in
|
||||
* PlaneMaker and data output display in X-Plane. Pass in a color, a
|
||||
* position, a floating point value, and formatting info. Specify how many
|
||||
* integer and how many decimal digits to show and whether to show a sign, as
|
||||
* well as a character set. This routine returns the xOffset plus width of the
|
||||
* string drawn.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDrawNumber(
|
||||
float * inColorRGB,
|
||||
int inXOffset,
|
||||
int inYOffset,
|
||||
double inValue,
|
||||
int inDigits,
|
||||
int inDecimals,
|
||||
int inShowSign,
|
||||
XPLMFontID inFontID);
|
||||
|
||||
/*
|
||||
* XPLMGetFontDimensions
|
||||
*
|
||||
* This routine returns the width and height of a character in a given font.
|
||||
* It also tells you if the font only supports numeric digits. Pass NULL if
|
||||
* you don't need a given field. Note that for a proportional font the width
|
||||
* will be an arbitrary, hopefully average width.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetFontDimensions(
|
||||
XPLMFontID inFontID,
|
||||
int * outCharWidth, /* Can be NULL */
|
||||
int * outCharHeight, /* Can be NULL */
|
||||
int * outDigitsOnly); /* Can be NULL */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMMeasureString
|
||||
*
|
||||
* This routine returns the width in pixels of a string using a given font.
|
||||
* The string is passed as a pointer plus length (and does not need to be null
|
||||
* terminated); this is used to allow for measuring substrings. The return
|
||||
* value is floating point; it is possible that future font drawing may allow
|
||||
* for fractional pixels.
|
||||
*
|
||||
*/
|
||||
XPLM_API float XPLMMeasureString(
|
||||
XPLMFontID inFontID,
|
||||
const char * inChar,
|
||||
int inNumChars);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
225
xpcPlugin/SDK/CHeaders/XPLM/XPLMMenus.h
Executable file
225
xpcPlugin/SDK/CHeaders/XPLM/XPLMMenus.h
Executable file
@@ -0,0 +1,225 @@
|
||||
#ifndef _XPLMMenus_h_
|
||||
#define _XPLMMenus_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* XPLMMenus - Theory of Operation
|
||||
*
|
||||
* Plug-ins can create menus in the menu bar of X-Plane. This is done by
|
||||
* creating a menu and then creating items. Menus are referred to by an
|
||||
* opaque ID. Items are referred to by index number. For each menu and item
|
||||
* you specify a void *. Per menu you specify a handler function that is
|
||||
* called with each void * when the menu item is picked. Menu item indices
|
||||
* are zero based.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* XPLM MENUS
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMMenuCheck
|
||||
*
|
||||
* These enumerations define the various 'check' states for an X-Plane menu.
|
||||
* 'checking' in x-plane actually appears as a light which may or may not be
|
||||
* lit. So there are three possible states.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* there is no symbol to the left of the menu item. */
|
||||
xplm_Menu_NoCheck = 0
|
||||
|
||||
/* the menu has a mark next to it that is unmarked (not lit). */
|
||||
,xplm_Menu_Unchecked = 1
|
||||
|
||||
/* the menu has a mark next to it that is checked (lit). */
|
||||
,xplm_Menu_Checked = 2
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMMenuCheck;
|
||||
|
||||
/*
|
||||
* XPLMMenuID
|
||||
*
|
||||
* This is a unique ID for each menu you create.
|
||||
*
|
||||
*/
|
||||
typedef void * XPLMMenuID;
|
||||
|
||||
/*
|
||||
* XPLMMenuHandler_f
|
||||
*
|
||||
* A menu handler function takes two reference pointers, one for the menu
|
||||
* (specified when the menu was created) and one for the item (specified when
|
||||
* the item was created).
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMMenuHandler_f)(
|
||||
void * inMenuRef,
|
||||
void * inItemRef);
|
||||
|
||||
/*
|
||||
* XPLMFindPluginsMenu
|
||||
*
|
||||
* This function returns the ID of the plug-ins menu, which is created for you
|
||||
* at startup.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMMenuID XPLMFindPluginsMenu(void);
|
||||
|
||||
/*
|
||||
* XPLMCreateMenu
|
||||
*
|
||||
* This function creates a new menu and returns its ID. It returns NULL if
|
||||
* the menu cannot be created. Pass in a parent menu ID and an item index to
|
||||
* create a submenu, or NULL for the parent menu to put the menu in the menu
|
||||
* bar. The menu's name is only used if the menu is in the menubar. You also
|
||||
* pass a handler function and a menu reference value. Pass NULL for the
|
||||
* handler if you do not need callbacks from the menu (for example, if it only
|
||||
* contains submenus).
|
||||
*
|
||||
* Important: you must pass a valid, non-empty menu title even if the menu is
|
||||
* a submenu where the title is not visible.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMMenuID XPLMCreateMenu(
|
||||
const char * inName,
|
||||
XPLMMenuID inParentMenu,
|
||||
int inParentItem,
|
||||
XPLMMenuHandler_f inHandler,
|
||||
void * inMenuRef);
|
||||
|
||||
/*
|
||||
* XPLMDestroyMenu
|
||||
*
|
||||
* This function destroys a menu that you have created. Use this to remove a
|
||||
* submenu if necessary. (Normally this function will not be necessary.)
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDestroyMenu(
|
||||
XPLMMenuID inMenuID);
|
||||
|
||||
/*
|
||||
* XPLMClearAllMenuItems
|
||||
*
|
||||
* This function removes all menu items from a menu, allowing you to rebuild
|
||||
* it. Use this function if you need to change the number of items on a menu.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMClearAllMenuItems(
|
||||
XPLMMenuID inMenuID);
|
||||
|
||||
/*
|
||||
* XPLMAppendMenuItem
|
||||
*
|
||||
* This routine appends a new menu item to the bottom of a menu and returns
|
||||
* its index. Pass in the menu to add the item to, the items name, and a void
|
||||
* * ref for this item. If you pass in inForceEnglish, this menu item will be
|
||||
* drawn using the english character set no matter what language x-plane is
|
||||
* running in. Otherwise the menu item will be drawn localized. (An example
|
||||
* of why you'd want to do this is for a proper name.) See XPLMUtilities for
|
||||
* determining the current langauge.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMAppendMenuItem(
|
||||
XPLMMenuID inMenu,
|
||||
const char * inItemName,
|
||||
void * inItemRef,
|
||||
int inForceEnglish);
|
||||
|
||||
/*
|
||||
* XPLMAppendMenuSeparator
|
||||
*
|
||||
* This routine adds a seperator to the end of a menu.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMAppendMenuSeparator(
|
||||
XPLMMenuID inMenu);
|
||||
|
||||
/*
|
||||
* XPLMSetMenuItemName
|
||||
*
|
||||
* This routine changes the name of an existing menu item. Pass in the menu
|
||||
* ID and the index of the menu item.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetMenuItemName(
|
||||
XPLMMenuID inMenu,
|
||||
int inIndex,
|
||||
const char * inItemName,
|
||||
int inForceEnglish);
|
||||
|
||||
/*
|
||||
* XPLMCheckMenuItem
|
||||
*
|
||||
* Set whether a menu item is checked. Pass in the menu ID and item index.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMCheckMenuItem(
|
||||
XPLMMenuID inMenu,
|
||||
int index,
|
||||
XPLMMenuCheck inCheck);
|
||||
|
||||
/*
|
||||
* XPLMCheckMenuItemState
|
||||
*
|
||||
* This routine returns whether a menu item is checked or not. A menu item's
|
||||
* check mark may be on or off, or a menu may not have an icon at all.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMCheckMenuItemState(
|
||||
XPLMMenuID inMenu,
|
||||
int index,
|
||||
XPLMMenuCheck * outCheck);
|
||||
|
||||
/*
|
||||
* XPLMEnableMenuItem
|
||||
*
|
||||
* Sets whether this menu item is enabled. Items start out enabled.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMEnableMenuItem(
|
||||
XPLMMenuID inMenu,
|
||||
int index,
|
||||
int enabled);
|
||||
|
||||
#if defined(XPLM210)
|
||||
/*
|
||||
* XPLMRemoveMenuItem
|
||||
*
|
||||
* Removes one item from a menu. Note that all menu items below are moved up
|
||||
* one; your plugin must track the change in index numbers.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMRemoveMenuItem(
|
||||
XPLMMenuID inMenu,
|
||||
int inIndex);
|
||||
#endif /* XPLM210 */
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
376
xpcPlugin/SDK/CHeaders/XPLM/XPLMNavigation.h
Executable file
376
xpcPlugin/SDK/CHeaders/XPLM/XPLMNavigation.h
Executable file
@@ -0,0 +1,376 @@
|
||||
#ifndef _XPLMNavigation_h_
|
||||
#define _XPLMNavigation_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* XPLMNavigation - THEORY OF OPERATION
|
||||
*
|
||||
* The XPLM Navigation APIs give you some access to the navigation databases
|
||||
* inside X-Plane. X-Plane stores all navigation information in RAM, so by
|
||||
* using these APIs you can gain access to most information without having to
|
||||
* go to disk or parse the files yourself.
|
||||
*
|
||||
* You can also use this API to program the FMS. You must use the navigation
|
||||
* APIs to find the nav-aids you want to program into the FMS, since the FMS
|
||||
* is powered internally by x-plane's navigation database.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* NAVIGATION DATABASE ACCESS
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMNavType
|
||||
*
|
||||
* These enumerations define the different types of navaids. They are each
|
||||
* defined with a separate bit so that they may be bit-wise added together to
|
||||
* form sets of nav-aid types.
|
||||
*
|
||||
* NOTE: xplm_Nav_LatLon is a specific lat-lon coordinate entered into the
|
||||
* FMS. It will not exist in the database, and cannot be programmed into the
|
||||
* FMS. Querying the FMS for navaids will return it. Use
|
||||
* XPLMSetFMSEntryLatLon to set a lat/lon waypoint.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
xplm_Nav_Unknown = 0
|
||||
|
||||
,xplm_Nav_Airport = 1
|
||||
|
||||
,xplm_Nav_NDB = 2
|
||||
|
||||
,xplm_Nav_VOR = 4
|
||||
|
||||
,xplm_Nav_ILS = 8
|
||||
|
||||
,xplm_Nav_Localizer = 16
|
||||
|
||||
,xplm_Nav_GlideSlope = 32
|
||||
|
||||
,xplm_Nav_OuterMarker = 64
|
||||
|
||||
,xplm_Nav_MiddleMarker = 128
|
||||
|
||||
,xplm_Nav_InnerMarker = 256
|
||||
|
||||
,xplm_Nav_Fix = 512
|
||||
|
||||
,xplm_Nav_DME = 1024
|
||||
|
||||
,xplm_Nav_LatLon = 2048
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMNavType;
|
||||
|
||||
/*
|
||||
* XPLMNavRef
|
||||
*
|
||||
* XPLMNavRef is an iterator into the navigation database. The navigation
|
||||
* database is essentially an array, but it is not necessarily densely
|
||||
* populated. The only assumption you can safely make is that like-typed
|
||||
* nav-aids are grouped together.
|
||||
*
|
||||
* Use XPLMNavRef to refer to a nav-aid.
|
||||
*
|
||||
* XPLM_NAV_NOT_FOUND is returned by functions that return an XPLMNavRef when
|
||||
* the iterator must be invalid.
|
||||
*
|
||||
*/
|
||||
typedef int XPLMNavRef;
|
||||
|
||||
#define XPLM_NAV_NOT_FOUND -1
|
||||
|
||||
/*
|
||||
* XPLMGetFirstNavAid
|
||||
*
|
||||
* This returns the very first navaid in the database. Use this to traverse
|
||||
* the entire database. Returns XPLM_NAV_NOT_FOUND if the nav database is
|
||||
* empty.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMNavRef XPLMGetFirstNavAid(void);
|
||||
|
||||
/*
|
||||
* XPLMGetNextNavAid
|
||||
*
|
||||
* Given a nav aid ref, this routine returns the next navaid. It returns
|
||||
* XPLM_NAV_NOT_FOUND if the nav aid passed in was invalid or if the navaid
|
||||
* passed in was the last one in the database. Use this routine to iterate
|
||||
* across all like-typed navaids or the entire database.
|
||||
*
|
||||
* WARNING: due to a bug in the SDK, when fix loading is disabled in the
|
||||
* rendering settings screen, calling this routine with the last airport
|
||||
* returns a bogus nav aid. Using this nav aid can crash x-plane.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMNavRef XPLMGetNextNavAid(
|
||||
XPLMNavRef inNavAidRef);
|
||||
|
||||
/*
|
||||
* XPLMFindFirstNavAidOfType
|
||||
*
|
||||
* This routine returns the ref of the first navaid of the given type in the
|
||||
* database or XPLM_NAV_NOT_FOUND if there are no navaids of that type in the
|
||||
* database. You must pass exactly one nav aid type to this routine.
|
||||
*
|
||||
* WARNING: due to a bug in the SDK, when fix loading is disabled in the
|
||||
* rendering settings screen, calling this routine with fixes returns a bogus
|
||||
* nav aid. Using this nav aid can crash x-plane.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMNavRef XPLMFindFirstNavAidOfType(
|
||||
XPLMNavType inType);
|
||||
|
||||
/*
|
||||
* XPLMFindLastNavAidOfType
|
||||
*
|
||||
* This routine returns the ref of the last navaid of the given type in the
|
||||
* database or XPLM_NAV_NOT_FOUND if there are no navaids of that type in the
|
||||
* database. You must pass exactly one nav aid type to this routine.
|
||||
*
|
||||
* WARNING: due to a bug in the SDK, when fix loading is disabled in the
|
||||
* rendering settings screen, calling this routine with fixes returns a bogus
|
||||
* nav aid. Using this nav aid can crash x-plane.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMNavRef XPLMFindLastNavAidOfType(
|
||||
XPLMNavType inType);
|
||||
|
||||
/*
|
||||
* XPLMFindNavAid
|
||||
*
|
||||
* This routine provides a number of searching capabilities for the nav
|
||||
* database. XPLMFindNavAid will search through every nav aid whose type is
|
||||
* within inType (multiple types may be added together) and return any
|
||||
* nav-aids found based on the following rules:
|
||||
*
|
||||
* If inLat and inLon are not NULL, the navaid nearest to that lat/lon will be
|
||||
* returned, otherwise the last navaid found will be returned.
|
||||
*
|
||||
* If inFrequency is not NULL, then any navaids considered must match this
|
||||
* frequency. Note that this will screen out radio beacons that do not have
|
||||
* frequency data published (like inner markers) but not fixes and airports.
|
||||
*
|
||||
* If inNameFragment is not NULL, only navaids that contain the fragment in
|
||||
* their name will be returned.
|
||||
*
|
||||
* If inIDFragment is not NULL, only navaids that contain the fragment in
|
||||
* their IDs will be returned.
|
||||
*
|
||||
* This routine provides a simple way to do a number of useful searches:
|
||||
*
|
||||
* Find the nearest navaid on this frequency. Find the nearest airport. Find
|
||||
* the VOR whose ID is "KBOS". Find the nearest airport whose name contains
|
||||
* "Chicago".
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMNavRef XPLMFindNavAid(
|
||||
const char * inNameFragment, /* Can be NULL */
|
||||
const char * inIDFragment, /* Can be NULL */
|
||||
float * inLat, /* Can be NULL */
|
||||
float * inLon, /* Can be NULL */
|
||||
int * inFrequency, /* Can be NULL */
|
||||
XPLMNavType inType);
|
||||
|
||||
/*
|
||||
* XPLMGetNavAidInfo
|
||||
*
|
||||
* This routine returns information about a navaid. Any non-null field is
|
||||
* filled out with information if it is available.
|
||||
*
|
||||
* Frequencies are in the nav.dat convention as described in the X-Plane nav
|
||||
* database FAQ: NDB frequencies are exact, all others are multiplied by 100.
|
||||
*
|
||||
* The buffer for IDs should be at least 6 chars and the buffer for names
|
||||
* should be at least 41 chars, but since these values are likely to go up, I
|
||||
* recommend passing at least 32 chars for IDs and 256 chars for names when
|
||||
* possible.
|
||||
*
|
||||
* The outReg parameter tells if the navaid is within the local "region" of
|
||||
* loaded DSFs. (This information may not be particularly useful to plugins.)
|
||||
* The parameter is a single byte value 1 for true or 0 for false, not a C
|
||||
* string.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetNavAidInfo(
|
||||
XPLMNavRef inRef,
|
||||
XPLMNavType * outType, /* Can be NULL */
|
||||
float * outLatitude, /* Can be NULL */
|
||||
float * outLongitude, /* Can be NULL */
|
||||
float * outHeight, /* Can be NULL */
|
||||
int * outFrequency, /* Can be NULL */
|
||||
float * outHeading, /* Can be NULL */
|
||||
char * outID, /* Can be NULL */
|
||||
char * outName, /* Can be NULL */
|
||||
char * outReg); /* Can be NULL */
|
||||
|
||||
/***************************************************************************
|
||||
* FLIGHT MANAGEMENT COMPUTER
|
||||
***************************************************************************/
|
||||
/*
|
||||
* Note: the FMS works based on an array of entries. Indices into the array
|
||||
* are zero-based. Each entry is a nav-aid plus an altitude. The FMS tracks
|
||||
* the currently displayed entry and the entry that it is flying to.
|
||||
*
|
||||
* The FMS must be programmed with contiguous entries, so clearing an entry at
|
||||
* the end shortens the effective flight plan. There is a max of 100
|
||||
* waypoints in the flight plan.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMCountFMSEntries
|
||||
*
|
||||
* This routine returns the number of entries in the FMS.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMCountFMSEntries(void);
|
||||
|
||||
/*
|
||||
* XPLMGetDisplayedFMSEntry
|
||||
*
|
||||
* This routine returns the index of the entry the pilot is viewing.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMGetDisplayedFMSEntry(void);
|
||||
|
||||
/*
|
||||
* XPLMGetDestinationFMSEntry
|
||||
*
|
||||
* This routine returns the index of the entry the FMS is flying to.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMGetDestinationFMSEntry(void);
|
||||
|
||||
/*
|
||||
* XPLMSetDisplayedFMSEntry
|
||||
*
|
||||
* This routine changes which entry the FMS is showing to the index specified.
|
||||
* *
|
||||
*/
|
||||
XPLM_API void XPLMSetDisplayedFMSEntry(
|
||||
int inIndex);
|
||||
|
||||
/*
|
||||
* XPLMSetDestinationFMSEntry
|
||||
*
|
||||
* This routine changes which entry the FMS is flying the aircraft toward.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetDestinationFMSEntry(
|
||||
int inIndex);
|
||||
|
||||
/*
|
||||
* XPLMGetFMSEntryInfo
|
||||
*
|
||||
* This routine returns information about a given FMS entry. A reference to a
|
||||
* navaid can be returned allowing you to find additional information (such as
|
||||
* a frequency, ILS heading, name, etc.). Some information is available
|
||||
* immediately. For a lat/lon entry, the lat/lon is returned by this routine
|
||||
* but the navaid cannot be looked up (and the reference will be
|
||||
* XPLM_NAV_NOT_FOUND. FMS name entry buffers should be at least 256 chars in
|
||||
* length.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetFMSEntryInfo(
|
||||
int inIndex,
|
||||
XPLMNavType * outType, /* Can be NULL */
|
||||
char * outID, /* Can be NULL */
|
||||
XPLMNavRef * outRef, /* Can be NULL */
|
||||
int * outAltitude, /* Can be NULL */
|
||||
float * outLat, /* Can be NULL */
|
||||
float * outLon); /* Can be NULL */
|
||||
|
||||
/*
|
||||
* XPLMSetFMSEntryInfo
|
||||
*
|
||||
* This routine changes an entry in the FMS to have the destination navaid
|
||||
* passed in and the altitude specified. Use this only for airports, fixes,
|
||||
* and radio-beacon navaids. Currently of radio beacons, the FMS can only
|
||||
* support VORs and NDBs. Use the routines below to clear or fly to a lat/lon.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetFMSEntryInfo(
|
||||
int inIndex,
|
||||
XPLMNavRef inRef,
|
||||
int inAltitude);
|
||||
|
||||
/*
|
||||
* XPLMSetFMSEntryLatLon
|
||||
*
|
||||
* This routine changes the entry in the FMS to a lat/lon entry with the given
|
||||
* coordinates.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetFMSEntryLatLon(
|
||||
int inIndex,
|
||||
float inLat,
|
||||
float inLon,
|
||||
int inAltitude);
|
||||
|
||||
/*
|
||||
* XPLMClearFMSEntry
|
||||
*
|
||||
* This routine clears the given entry, potentially shortening the flight
|
||||
* plan.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMClearFMSEntry(
|
||||
int inIndex);
|
||||
|
||||
/***************************************************************************
|
||||
* GPS RECEIVER
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These APIs let you read data from the GPS unit.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMGetGPSDestinationType
|
||||
*
|
||||
* This routine returns the type of the currently selected GPS destination,
|
||||
* one of fix, airport, VOR or NDB.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMNavType XPLMGetGPSDestinationType(void);
|
||||
|
||||
/*
|
||||
* XPLMGetGPSDestination
|
||||
*
|
||||
* This routine returns the current GPS destination.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMNavRef XPLMGetGPSDestination(void);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
258
xpcPlugin/SDK/CHeaders/XPLM/XPLMPlanes.h
Executable file
258
xpcPlugin/SDK/CHeaders/XPLM/XPLMPlanes.h
Executable file
@@ -0,0 +1,258 @@
|
||||
#ifndef _XPLMPlanes_h_
|
||||
#define _XPLMPlanes_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* The XPLMPlanes APIs allow you to control the various aircraft in x-plane,
|
||||
* both the user's and the sim's.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* USER AIRCRAFT ACCESS
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* XPLMSetUsersAircraft
|
||||
*
|
||||
* This routine changes the user's aircraft. Note that this will reinitialize
|
||||
* the user to be on the nearest airport's first runway. Pass in a full path
|
||||
* (hard drive and everything including the .acf extension) to the .acf file.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetUsersAircraft(
|
||||
const char * inAircraftPath);
|
||||
/*
|
||||
* XPLMPlaceUserAtAirport
|
||||
*
|
||||
* This routine places the user at a given airport. Specify the airport by
|
||||
* its ICAO code (e.g. 'KBOS').
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMPlaceUserAtAirport(
|
||||
const char * inAirportCode);
|
||||
/***************************************************************************
|
||||
* GLOBAL AIRCRAFT ACCESS
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/* The user's aircraft is always index 0. */
|
||||
#define XPLM_USER_AIRCRAFT 0
|
||||
/*
|
||||
* XPLMPlaneDrawState_t
|
||||
*
|
||||
* This structure contains additional plane parameter info to be passed to
|
||||
* draw plane. Make sure to fill in the size of the structure field with
|
||||
* sizeof(XPLMDrawPlaneState_t) so that the XPLM can tell how many fields you
|
||||
* knew about when compiling your plugin (since more fields may be added
|
||||
* later).
|
||||
*
|
||||
* Most of these fields are ratios from 0 to 1 for control input. X-Plane
|
||||
* calculates what the actual controls look like based on the .acf file for
|
||||
* that airplane. Note for the yoke inputs, this is what the pilot of the
|
||||
* plane has commanded (post artificial stability system if there were one)
|
||||
* and affects aelerons, rudder, etc. It is not necessarily related to the
|
||||
* actual position of the plane!
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
/* The size of the draw state struct. */
|
||||
int structSize;
|
||||
/* A ratio from [0..1] describing how far the landing gear is extended. */
|
||||
float gearPosition;
|
||||
/* Ratio of flap deployment, 0 = up, 1 = full deploy. */
|
||||
float flapRatio;
|
||||
/* Ratio of spoiler deployment, 0 = none, 1 = full deploy. */
|
||||
float spoilerRatio;
|
||||
/* Ratio of speed brake deployment, 0 = none, 1 = full deploy. */
|
||||
float speedBrakeRatio;
|
||||
/* Ratio of slat deployment, 0 = none, 1 = full deploy. */
|
||||
float slatRatio;
|
||||
/* Wing sweep ratio, 0 = forward, 1 = swept. */
|
||||
float wingSweep;
|
||||
/* Thrust power, 0 = none, 1 = full fwd, -1 = full reverse. */
|
||||
float thrust;
|
||||
/* Total pitch input for this plane. */
|
||||
float yokePitch;
|
||||
/* Total Heading input for this plane. */
|
||||
float yokeHeading;
|
||||
/* Total Roll input for this plane. */
|
||||
float yokeRoll;
|
||||
} XPLMPlaneDrawState_t;
|
||||
/*
|
||||
* XPLMCountAircraft
|
||||
*
|
||||
* This function returns the number of aircraft X-Plane is capable of having,
|
||||
* as well as the number of aircraft that are currently active. These numbers
|
||||
* count the user's aircraft. It can also return the plugin that is currently
|
||||
* controlling aircraft. In X-Plane 7, this routine reflects the number of
|
||||
* aircraft the user has enabled in the rendering options window.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMCountAircraft(
|
||||
int * outTotalAircraft,
|
||||
int * outActiveAircraft,
|
||||
XPLMPluginID * outController);
|
||||
/*
|
||||
* XPLMGetNthAircraftModel
|
||||
*
|
||||
* This function returns the aircraft model for the Nth aircraft. Indices are
|
||||
* zero based, with zero being the user's aircraft. The file name should be
|
||||
* at least 256 chars in length; the path should be at least 512 chars in
|
||||
* length.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetNthAircraftModel(
|
||||
int inIndex,
|
||||
char * outFileName,
|
||||
char * outPath);
|
||||
/***************************************************************************
|
||||
* EXCLUSIVE AIRCRAFT ACCESS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The following routines require exclusive access to the airplane APIs. Only
|
||||
* one plugin may have this access at a time.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMPlanesAvailable_f
|
||||
*
|
||||
* Your airplanes available callback is called when another plugin gives up
|
||||
* access to the multiplayer planes. Use this to wait for access to
|
||||
* multiplayer.
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMPlanesAvailable_f)(
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMAcquirePlanes
|
||||
*
|
||||
* XPLMAcquirePlanes grants your plugin exclusive access to the aircraft. It
|
||||
* returns 1 if you gain access, 0 if you do not. inAircraft - pass in an
|
||||
* array of pointers to strings specifying the planes you want loaded. For
|
||||
* any plane index you do not want loaded, pass a 0-length string. Other
|
||||
* strings should be full paths with the .acf extension. NULL terminates this
|
||||
* array, or pass NULL if there are no planes you want loaded. If you pass in
|
||||
* a callback and do not receive access to the planes your callback will be
|
||||
* called when the airplanes are available. If you do receive airplane access,
|
||||
* your callback will not be called.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMAcquirePlanes(
|
||||
char ** inAircraft, /* Can be NULL */
|
||||
XPLMPlanesAvailable_f inCallback,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMReleasePlanes
|
||||
*
|
||||
* Call this function to release access to the planes. Note that if you are
|
||||
* disabled, access to planes is released for you and you must reacquire it.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMReleasePlanes(void);
|
||||
|
||||
/*
|
||||
* XPLMSetActiveAircraftCount
|
||||
*
|
||||
* This routine sets the number of active planes. If you pass in a number
|
||||
* higher than the total number of planes availables, only the total number of
|
||||
* planes available is actually used.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetActiveAircraftCount(
|
||||
int inCount);
|
||||
|
||||
/*
|
||||
* XPLMSetAircraftModel
|
||||
*
|
||||
* This routine loads an aircraft model. It may only be called if you have
|
||||
* exclusive access to the airplane APIs. Pass in the path of the model with
|
||||
* the .acf extension. The index is zero based, but you may not pass in 0
|
||||
* (use XPLMSetUsersAircraft to load the user's aircracft).
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetAircraftModel(
|
||||
int inIndex,
|
||||
const char * inAircraftPath);
|
||||
|
||||
/*
|
||||
* XPLMDisableAIForPlane
|
||||
*
|
||||
* This routine turns off X-Plane's AI for a given plane. The plane will
|
||||
* continue to draw and be a real plane in X-Plane, but will not move itself.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDisableAIForPlane(
|
||||
int inPlaneIndex);
|
||||
|
||||
/*
|
||||
* XPLMDrawAircraft
|
||||
*
|
||||
* This routine draws an aircraft. It can only be called from a 3-d drawing
|
||||
* callback. Pass in the position of the plane in OpenGL local coordinates
|
||||
* and the orientation of the plane. A 1 for full drawing indicates that the
|
||||
* whole plane must be drawn; a 0 indicates you only need the nav lights
|
||||
* drawn. (This saves rendering time when planes are far away.)
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDrawAircraft(
|
||||
int inPlaneIndex,
|
||||
float inX,
|
||||
float inY,
|
||||
float inZ,
|
||||
float inPitch,
|
||||
float inRoll,
|
||||
float inYaw,
|
||||
int inFullDraw,
|
||||
XPLMPlaneDrawState_t * inDrawStateInfo);
|
||||
|
||||
/*
|
||||
* XPLMReinitUsersPlane
|
||||
*
|
||||
* This function recomputes the derived flight model data from the aircraft
|
||||
* structure in memory. If you have used the data access layer to modify the
|
||||
* aircraft structure, use this routine to resynchronize x-plane; since
|
||||
* X-plane works at least partly from derived values, the sim will not behave
|
||||
* properly until this is called.
|
||||
*
|
||||
* WARNING: this routine does not necessarily place the airplane at the
|
||||
* airport; use XPLMSetUsersAircraft to be compatible. This routine is
|
||||
* provided to do special experimentation with flight models without resetting
|
||||
* flight.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMReinitUsersPlane(void);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
331
xpcPlugin/SDK/CHeaders/XPLM/XPLMPlugin.h
Executable file
331
xpcPlugin/SDK/CHeaders/XPLM/XPLMPlugin.h
Executable file
@@ -0,0 +1,331 @@
|
||||
#ifndef _XPLMPlugin_h_
|
||||
#define _XPLMPlugin_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* These APIs provide facilities to find and work with other plugins and
|
||||
* manage other plugins.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* FINDING PLUGINS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These APIs allow you to find another plugin or yourself, or iterate across
|
||||
* all plugins. For example, if you wrote an FMS plugin that needed to talk
|
||||
* to an autopilot plugin, you could use these APIs to locate the autopilot
|
||||
* plugin.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMGetMyID
|
||||
*
|
||||
* This routine returns the plugin ID of the calling plug-in. Call this to
|
||||
* get your own ID.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMPluginID XPLMGetMyID(void);
|
||||
|
||||
/*
|
||||
* XPLMCountPlugins
|
||||
*
|
||||
* This routine returns the total number of plug-ins that are loaded, both
|
||||
* disabled and enabled.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMCountPlugins(void);
|
||||
|
||||
/*
|
||||
* XPLMGetNthPlugin
|
||||
*
|
||||
* This routine returns the ID of a plug-in by index. Index is 0 based from 0
|
||||
* to XPLMCountPlugins-1, inclusive. Plugins may be returned in any arbitrary
|
||||
* order.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMPluginID XPLMGetNthPlugin(
|
||||
int inIndex);
|
||||
|
||||
/*
|
||||
* XPLMFindPluginByPath
|
||||
*
|
||||
* This routine returns the plug-in ID of the plug-in whose file exists at the
|
||||
* passed in absolute file system path. XPLM_NO_PLUGIN_ID is returned if the
|
||||
* path does not point to a currently loaded plug-in.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMPluginID XPLMFindPluginByPath(
|
||||
const char * inPath);
|
||||
|
||||
/*
|
||||
* XPLMFindPluginBySignature
|
||||
*
|
||||
* This routine returns the plug-in ID of the plug-in whose signature matches
|
||||
* what is passed in or XPLM_NO_PLUGIN_ID if no running plug-in has this
|
||||
* signature. Signatures are the best way to identify another plug-in as they
|
||||
* are independent of the file system path of a plug-in or the human-readable
|
||||
* plug-in name, and should be unique for all plug-ins. Use this routine to
|
||||
* locate another plugin that your plugin interoperates with
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMPluginID XPLMFindPluginBySignature(
|
||||
const char * inSignature);
|
||||
|
||||
/*
|
||||
* XPLMGetPluginInfo
|
||||
*
|
||||
* This routine returns information about a plug-in. Each parameter should be
|
||||
* a pointer to a buffer of at least 256 characters, or NULL to not receive
|
||||
* the information.
|
||||
*
|
||||
* outName - the human-readable name of the plug-in. outFilePath - the
|
||||
* absolute file path to the file that contains this plug-in. outSignature - a
|
||||
* unique string that identifies this plug-in. outDescription - a
|
||||
* human-readable description of this plug-in.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetPluginInfo(
|
||||
XPLMPluginID inPlugin,
|
||||
char * outName, /* Can be NULL */
|
||||
char * outFilePath, /* Can be NULL */
|
||||
char * outSignature, /* Can be NULL */
|
||||
char * outDescription); /* Can be NULL */
|
||||
|
||||
/***************************************************************************
|
||||
* ENABLING/DISABLING PLUG-INS
|
||||
***************************************************************************/
|
||||
/*
|
||||
* These routines are used to work with plug-ins and manage them. Most
|
||||
* plugins will not need to use these APIs.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMIsPluginEnabled
|
||||
*
|
||||
* Returns whether the specified plug-in is enabled for running.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMIsPluginEnabled(
|
||||
XPLMPluginID inPluginID);
|
||||
|
||||
/*
|
||||
* XPLMEnablePlugin
|
||||
*
|
||||
* This routine enables a plug-in if it is not already enabled. It returns 1
|
||||
* if the plugin was enabled or successfully enables itself, 0 if it does not.
|
||||
* Plugins may fail to enable (for example, if resources cannot be acquired)
|
||||
* by returning 0 from their XPluginEnable callback.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMEnablePlugin(
|
||||
XPLMPluginID inPluginID);
|
||||
|
||||
/*
|
||||
* XPLMDisablePlugin
|
||||
*
|
||||
* This routine disableds an enabled plug-in.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDisablePlugin(
|
||||
XPLMPluginID inPluginID);
|
||||
|
||||
/*
|
||||
* XPLMReloadPlugins
|
||||
*
|
||||
* This routine reloads all plug-ins. Once this routine is called and you
|
||||
* return from the callback you were within (e.g. a menu select callback) you
|
||||
* will receive your XPluginDisable and XPluginStop callbacks and your DLL
|
||||
* will be unloaded, then the start process happens as if the sim was starting
|
||||
* up.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMReloadPlugins(void);
|
||||
|
||||
/***************************************************************************
|
||||
* INTERPLUGIN MESSAGING
|
||||
***************************************************************************/
|
||||
/*
|
||||
* Plugin messages are defined as 32-bit integers. Messages below 0x00FFFFFF
|
||||
* are reserved for X-Plane and the plugin SDK.
|
||||
*
|
||||
* Messages have two conceptual uses: notifications and commands. Commands
|
||||
* are sent from one plugin to another to induce behavior; notifications are
|
||||
* sent from one plugin to all others for informational purposes. It is
|
||||
* important that commands and notifications not have the same values because
|
||||
* this could cause a notification sent by one plugin to accidentally induce a
|
||||
* command in another.
|
||||
*
|
||||
* By convention, plugin-defined notifications should have the high bit set
|
||||
* (e.g. be greater or equal to unsigned 0x8000000) while commands should have
|
||||
* this bit be cleared.
|
||||
*
|
||||
* The following messages are sent to your plugin by x-plane.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/* This message is sent to your plugin whenever the user's plane crashes. */
|
||||
#define XPLM_MSG_PLANE_CRASHED 101
|
||||
|
||||
/* This message is sent to your plugin whenever a new plane is loaded. The *
|
||||
* parameter is the number of the plane being loaded; 0 indicates the user's *
|
||||
* plane. */
|
||||
#define XPLM_MSG_PLANE_LOADED 102
|
||||
|
||||
/* This messages is called whenever the user's plane is positioned at a new *
|
||||
* airport. */
|
||||
#define XPLM_MSG_AIRPORT_LOADED 103
|
||||
|
||||
/* This message is sent whenever new scenery is loaded. Use datarefs to *
|
||||
* determine the new scenery files that were loaded. */
|
||||
#define XPLM_MSG_SCENERY_LOADED 104
|
||||
|
||||
/* This message is sent whenever the user adjusts the number of X-Plane *
|
||||
* aircraft models. You must use XPLMCountPlanes to find out how many planes *
|
||||
* are now available. This message will only be sent in XP7 and higher *
|
||||
* because in XP6 the number of aircraft is not user-adjustable. */
|
||||
#define XPLM_MSG_AIRPLANE_COUNT_CHANGED 105
|
||||
|
||||
#if defined(XPLM200)
|
||||
/* This message is sent to your plugin whenever a plane is unloaded. The *
|
||||
* parameter is the number of the plane being unloaded; 0 indicates the user's *
|
||||
* plane. The parameter is of type int, passed as the value of the pointer. *
|
||||
* (That is: the parameter is an int, not a pointer to an int.) */
|
||||
#define XPLM_MSG_PLANE_UNLOADED 106
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM210)
|
||||
/* This message is sent to your plugin right before X-Plane writes its *
|
||||
* preferences file. You can use this for two purposes: to write your own *
|
||||
* preferences, and to modify any datarefs to influence preferences output. *
|
||||
* For example, if your plugin temporarily modifies saved preferences, you can *
|
||||
* put them back to their default values here to avoid having the tweaks be *
|
||||
* persisted if your plugin is not loaded on the next invocation of X-Plane. */
|
||||
#define XPLM_MSG_WILL_WRITE_PREFS 107
|
||||
#endif /* XPLM210 */
|
||||
|
||||
#if defined(XPLM210)
|
||||
/* This message is sent to your plugin right after a livery is loaded for an *
|
||||
* airplane. You can use this to check the new livery (via datarefs) and *
|
||||
* react accordingly. The parameter is of type int, passed as the value of a *
|
||||
* pointer and represents the aicraft plane number - 0 is the user's plane. */
|
||||
#define XPLM_MSG_LIVERY_LOADED 108
|
||||
#endif /* XPLM210 */
|
||||
|
||||
/*
|
||||
* XPLMSendMessageToPlugin
|
||||
*
|
||||
* This function sends a message to another plug-in or X-Plane. Pass
|
||||
* XPLM_NO_PLUGIN_ID to broadcast to all plug-ins. Only enabled plug-ins with
|
||||
* a message receive function receive the message.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSendMessageToPlugin(
|
||||
XPLMPluginID inPlugin,
|
||||
int inMessage,
|
||||
void * inParam);
|
||||
|
||||
#if defined(XPLM200)
|
||||
/***************************************************************************
|
||||
* Plugin Features API
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The plugin features API allows your plugin to "sign up" for additional
|
||||
* capabilities and plugin system features that are normally disabled for
|
||||
* backward compatibility. This allows advanced plugins to "opt-in" to new
|
||||
* behavior.
|
||||
*
|
||||
* Each feature is defined by a permanent string name. The feature string
|
||||
* names will vary with the particular installation of X-Plane, so plugins
|
||||
* should not expect a feature to be guaranteed present.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMFeatureEnumerator_f
|
||||
*
|
||||
* You pass an XPLMFeatureEnumerator_f to get a list of all features supported
|
||||
* by a given version running version of X-Plane. This routine is called once
|
||||
* for each feature.
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMFeatureEnumerator_f)(
|
||||
const char * inFeature,
|
||||
void * inRef);
|
||||
|
||||
/*
|
||||
* XPLMHasFeature
|
||||
*
|
||||
* This returns 1 if the given installation of X-Plane supports a feature, or
|
||||
* 0 if it does not.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMHasFeature(
|
||||
const char * inFeature);
|
||||
|
||||
/*
|
||||
* XPLMIsFeatureEnabled
|
||||
*
|
||||
* This returns 1 if a feature is currently enabled for your plugin, or 0 if
|
||||
* it is not enabled. It is an error to call this routine with an unsupported
|
||||
* feature.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMIsFeatureEnabled(
|
||||
const char * inFeature);
|
||||
|
||||
/*
|
||||
* XPLMEnableFeature
|
||||
*
|
||||
* This routine enables or disables a feature for your plugin. This will
|
||||
* change the running behavior of X-Plane and your plugin in some way,
|
||||
* depending on the feature.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMEnableFeature(
|
||||
const char * inFeature,
|
||||
int inEnable);
|
||||
|
||||
/*
|
||||
* XPLMEnumerateFeatures
|
||||
*
|
||||
* This routine calls your enumerator callback once for each feature that this
|
||||
* running version of X-Plane supports. Use this routine to determine all of
|
||||
* the features that X-Plane can support.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMEnumerateFeatures(
|
||||
XPLMFeatureEnumerator_f inEnumerator,
|
||||
void * inRef);
|
||||
|
||||
#endif /* XPLM200 */
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
254
xpcPlugin/SDK/CHeaders/XPLM/XPLMProcessing.h
Executable file
254
xpcPlugin/SDK/CHeaders/XPLM/XPLMProcessing.h
Executable file
@@ -0,0 +1,254 @@
|
||||
#ifndef _XPLMProcessing_h_
|
||||
#define _XPLMProcessing_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* This API allows you to get regular callbacks during the flight loop, the
|
||||
* part of X-Plane where the plane's position calculates the physics of
|
||||
* flight, etc. Use these APIs to accomplish periodic tasks like logging data
|
||||
* and performing I/O.
|
||||
*
|
||||
* WARNING: Do NOT use these callbacks to draw! You cannot draw during flight
|
||||
* loop callbacks. Use the drawing callbacks (see XPLMDisplay for more info)
|
||||
* for graphics.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* FLIGHT LOOP CALLBACKS
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#if defined(XPLM210)
|
||||
/*
|
||||
* XPLMFlightLoopPhaseType
|
||||
*
|
||||
* You can register a flight loop callback to run either before or after the
|
||||
* flight model is integrated by X-Plane.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* Your callback runs before X-Plane integrates the flight model. */
|
||||
xplm_FlightLoop_Phase_BeforeFlightModel = 0
|
||||
|
||||
/* Your callback runs after X-Plane integrates the flight model. */
|
||||
,xplm_FlightLoop_Phase_AfterFlightModel = 1
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMFlightLoopPhaseType;
|
||||
#endif /* XPLM210 */
|
||||
|
||||
#if defined(XPLM210)
|
||||
/*
|
||||
* XPLMFlightLoopID
|
||||
*
|
||||
* This is an opaque identifier for a flight loop callback. You can use this
|
||||
* identifier to easily track and remove your callbacks, or to use the new
|
||||
* flight loop APIs.
|
||||
*
|
||||
*/
|
||||
typedef void * XPLMFlightLoopID;
|
||||
#endif /* XPLM210 */
|
||||
|
||||
/*
|
||||
* XPLMFlightLoop_f
|
||||
*
|
||||
* This is your flight loop callback. Each time the flight loop is iterated
|
||||
* through, you receive this call at the end. You receive a time since you
|
||||
* were last called and a time since the last loop, as well as a loop counter.
|
||||
* The 'phase' parameter is deprecated and should be ignored.
|
||||
*
|
||||
* Your return value controls when you will next be called. Return 0 to stop
|
||||
* receiving callbacks. Pass a positive number to specify how many seconds
|
||||
* until the next callback. (You will be called at or after this time, not
|
||||
* before.) Pass a negative number to specify how many loops must go by until
|
||||
* you are called. For example, -1.0 means call me the very next loop. Try
|
||||
* to run your flight loop as infrequently as is practical, and suspend it
|
||||
* (using return value 0) when you do not need it; lots of flight loop
|
||||
* callbacks that do nothing lowers x-plane's frame rate.
|
||||
*
|
||||
* Your callback will NOT be unregistered if you return 0; it will merely be
|
||||
* inactive.
|
||||
*
|
||||
* The reference constant you passed to your loop is passed back to you.
|
||||
*
|
||||
*/
|
||||
typedef float (* XPLMFlightLoop_f)(
|
||||
float inElapsedSinceLastCall,
|
||||
float inElapsedTimeSinceLastFlightLoop,
|
||||
int inCounter,
|
||||
void * inRefcon);
|
||||
|
||||
#if defined(XPLM210)
|
||||
/*
|
||||
* XPLMCreateFlightLoop_t
|
||||
*
|
||||
* XPLMCreateFlightLoop_t contains the parameters to create a new flight loop
|
||||
* callback. The strsucture can be expanded in future SDKs - always set
|
||||
* structSize to the size of your structure in bytes.
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
int structSize;
|
||||
XPLMFlightLoopPhaseType phase;
|
||||
XPLMFlightLoop_f callbackFunc;
|
||||
void * refcon;
|
||||
} XPLMCreateFlightLoop_t;
|
||||
#endif /* XPLM210 */
|
||||
|
||||
/*
|
||||
* XPLMGetElapsedTime
|
||||
*
|
||||
* This routine returns the elapsed time since the sim started up in decimal
|
||||
* seconds.
|
||||
*
|
||||
*/
|
||||
XPLM_API float XPLMGetElapsedTime(void);
|
||||
|
||||
/*
|
||||
* XPLMGetCycleNumber
|
||||
*
|
||||
* This routine returns a counter starting at zero for each sim cycle
|
||||
* computed/video frame rendered.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMGetCycleNumber(void);
|
||||
|
||||
/*
|
||||
* XPLMRegisterFlightLoopCallback
|
||||
*
|
||||
* This routine registers your flight loop callback. Pass in a pointer to a
|
||||
* flight loop function and a refcon. inInterval defines when you will be
|
||||
* called. Pass in a positive number to specify seconds from registration
|
||||
* time to the next callback. Pass in a negative number to indicate when you
|
||||
* will be called (e.g. pass -1 to be called at the next cylcle). Pass 0 to
|
||||
* not be called; your callback will be inactive.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMRegisterFlightLoopCallback(
|
||||
XPLMFlightLoop_f inFlightLoop,
|
||||
float inInterval,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMUnregisterFlightLoopCallback
|
||||
*
|
||||
* This routine unregisters your flight loop callback. Do NOT call it from
|
||||
* your flight loop callback. Once your flight loop callback is
|
||||
* unregistered, it will not be called again.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMUnregisterFlightLoopCallback(
|
||||
XPLMFlightLoop_f inFlightLoop,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMSetFlightLoopCallbackInterval
|
||||
*
|
||||
* This routine sets when a callback will be called. Do NOT call it from your
|
||||
* callback; use the return value of the callback to change your callback
|
||||
* interval from inside your callback.
|
||||
*
|
||||
* inInterval is formatted the same way as in XPLMRegisterFlightLoopCallback;
|
||||
* positive for seconds, negative for cycles, and 0 for deactivating the
|
||||
* callback. If inRelativeToNow is 1, times are from the time of this call;
|
||||
* otherwise they are from the time the callback was last called (or the time
|
||||
* it was registered if it has never been called.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetFlightLoopCallbackInterval(
|
||||
XPLMFlightLoop_f inFlightLoop,
|
||||
float inInterval,
|
||||
int inRelativeToNow,
|
||||
void * inRefcon);
|
||||
|
||||
#if defined(XPLM210)
|
||||
/*
|
||||
* XPLMCreateFlightLoop
|
||||
*
|
||||
* This routine creates a flight loop callback and returns its ID. The flight
|
||||
* loop callback is created using the input param struct, and is inited to be
|
||||
* unscheduled.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMFlightLoopID XPLMCreateFlightLoop(
|
||||
XPLMCreateFlightLoop_t * inParams);
|
||||
#endif /* XPLM210 */
|
||||
|
||||
#if defined(XPLM210)
|
||||
/*
|
||||
* XPLMDestroyFlightLoop
|
||||
*
|
||||
* This routine destroys a flight loop callback by ID.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDestroyFlightLoop(
|
||||
XPLMFlightLoopID inFlightLoopID);
|
||||
#endif /* XPLM210 */
|
||||
|
||||
#if defined(XPLM210)
|
||||
/*
|
||||
* XPLMScheduleFlightLoop
|
||||
*
|
||||
* This routine schedules a flight loop callback for future execution. If
|
||||
* inInterval is negative, it is run in a certain number of frames based on
|
||||
* the absolute value of the input. If the interval is positive, it is a
|
||||
* duration in seconds.
|
||||
*
|
||||
* If inRelativeToNow is true, ties are interpretted relative to the time this
|
||||
* routine is called; otherwise they are relative to the last call time or the
|
||||
* time the flight loop was registered (if never called).
|
||||
*
|
||||
* THREAD SAFETY: it is legal to call this routine from any thread under the
|
||||
* following conditions:
|
||||
*
|
||||
* 1. The call must be between the beginning of an XPLMEnable and the end of
|
||||
* an XPLMDisable sequence. (That is, you must not call this routine from
|
||||
* thread activity when your plugin was supposed to be disabled. Since
|
||||
* plugins are only enabled while loaded, this also implies you cannot run
|
||||
* this routine outside an XPLMStart/XPLMStop sequence.)
|
||||
*
|
||||
* 2. You may not call this routine re-entrantly for a single flight loop ID.
|
||||
* (That is, you can't enable from multiple threads at the same time.)
|
||||
*
|
||||
* 3. You must call this routine between the time after XPLMCreateFlightLoop
|
||||
* returns a value and the time you call XPLMDestroyFlightLoop. (That is, you
|
||||
* must ensure that your threaded activity is within the life of the object.
|
||||
* The SDK does not check this for you, nor does it synchronize destruction of
|
||||
* the object.)
|
||||
*
|
||||
* 4. The object must be unscheduled if this routine is to be called from a
|
||||
* thread other than the main thread.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMScheduleFlightLoop(
|
||||
XPLMFlightLoopID inFlightLoopID,
|
||||
float inInterval,
|
||||
int inRelativeToNow);
|
||||
#endif /* XPLM210 */
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
400
xpcPlugin/SDK/CHeaders/XPLM/XPLMScenery.h
Executable file
400
xpcPlugin/SDK/CHeaders/XPLM/XPLMScenery.h
Executable file
@@ -0,0 +1,400 @@
|
||||
#ifndef _XPLMScenery_h_
|
||||
#define _XPLMScenery_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* This package contains APIs to interact with X-Plane's scenery system.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if defined(XPLM200)
|
||||
/***************************************************************************
|
||||
* Terrain Y-Testing
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The Y-testing API allows you to locate the physical scenery mesh. This
|
||||
* would be used to place dynamic graphics on top of the ground in a
|
||||
* plausible way or do physics interactions.
|
||||
*
|
||||
* The Y-test API works via probe objects, which are allocated by your plugin
|
||||
* and used to query terrain. Probe objects exist both to capture which
|
||||
* algorithm you have requested (see probe types) and also to cache query
|
||||
* information.
|
||||
*
|
||||
* Performance guidelines: It is generally faster to use the same probe for
|
||||
* nearby points and different probes for different points. Try not to
|
||||
* allocate more than "hundreds" of probes at most. Share probes if you need
|
||||
* more. Generally, probing operations are expensive, and should be avoided
|
||||
* via caching when possible.
|
||||
*
|
||||
* Y testing returns a location on the terrain, a normal vectory, and a
|
||||
* velocity vector. The normal vector tells you the slope of the terrain at
|
||||
* that point. The velocity vector tells you if that terrain is moving (and
|
||||
* is in meters/second). For example, if your Y test hits the aircraft carrier
|
||||
* deck, this tells you the velocity of that point on the deck.
|
||||
*
|
||||
* Note: the Y-testing API is limited to probing the loaded scenery area,
|
||||
* which is approximately 300x300 km in X-Plane 9. Probes outside this area
|
||||
* will return the height of a 0 MSL sphere.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMProbeType
|
||||
*
|
||||
* XPLMProbeType defines the type of terrain probe - each probe has a
|
||||
* different algorithm. (Only one type of probe is provided right now, but
|
||||
* future APIs will expose more flexible or poewrful or useful probes.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* The Y probe gives you the location of the tallest physical scenery along *
|
||||
* the Y axis going through the queried point. */
|
||||
xplm_ProbeY = 0
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMProbeType;
|
||||
|
||||
/*
|
||||
* XPLMProbeResult
|
||||
*
|
||||
* Probe results - possible results from a probe query.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* The probe hit terrain and returned valid values. */
|
||||
xplm_ProbeHitTerrain = 0
|
||||
|
||||
/* An error in the API call. Either the probe struct size is bad, or the *
|
||||
* probe is invalid or the type is mismatched for the specific query call. */
|
||||
,xplm_ProbeError = 1
|
||||
|
||||
/* The probe call succeeded but there is no terrain under this point (perhaps *
|
||||
* it is off the side of the planet?) */
|
||||
,xplm_ProbeMissed = 2
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMProbeResult;
|
||||
|
||||
/*
|
||||
* XPLMProbeRef
|
||||
*
|
||||
* An XPLMProbeRef is an opaque handle to a probe, used for querying the
|
||||
* terrain.
|
||||
*
|
||||
*/
|
||||
typedef void * XPLMProbeRef;
|
||||
|
||||
/*
|
||||
* XPLMProbeInfo_t
|
||||
*
|
||||
* XPLMProbeInfo_t contains the results of a probe call. Make sure to set
|
||||
* structSize to the size of the struct before using it.
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
/* Size of structure in bytes - always set this before calling the XPLM. */
|
||||
int structSize;
|
||||
/* Resulting X location of the terrain point we hit, in local OpenGL *
|
||||
* coordinates. */
|
||||
float locationX;
|
||||
/* Resulting Y location of the terrain point we hit, in local OpenGL *
|
||||
* coordinates. */
|
||||
float locationY;
|
||||
/* Resulting Z location of the terrain point we hit, in local OpenGL *
|
||||
* coordinates. */
|
||||
float locationZ;
|
||||
/* X component of the normal vector to the terrain we found. */
|
||||
float normalX;
|
||||
/* Y component of the normal vector to the terrain we found. */
|
||||
float normalY;
|
||||
/* Z component of the normal vector to the terrain we found. */
|
||||
float normalZ;
|
||||
/* X component of the velocity vector of the terrain we found. */
|
||||
float velocityX;
|
||||
/* Y component of the velocity vector of the terrain we found. */
|
||||
float velocityY;
|
||||
/* Z component of the velocity vector of the terrain we found. */
|
||||
float velocityZ;
|
||||
/* Tells if the surface we hit is water (otherwise it is land). */
|
||||
int is_wet;
|
||||
} XPLMProbeInfo_t;
|
||||
|
||||
/*
|
||||
* XPLMCreateProbe
|
||||
*
|
||||
* Creates a new probe object of a given type and returns.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMProbeRef XPLMCreateProbe(
|
||||
XPLMProbeType inProbeType);
|
||||
|
||||
/*
|
||||
* XPLMDestroyProbe
|
||||
*
|
||||
* Deallocates an existing probe object.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDestroyProbe(
|
||||
XPLMProbeRef inProbe);
|
||||
|
||||
/*
|
||||
* XPLMProbeTerrainXYZ
|
||||
*
|
||||
* Probes the terrain. Pass in the XYZ coordinate of the probe point, a probe
|
||||
* object, and an XPLMProbeInfo_t struct that has its structSize member set
|
||||
* properly. Other fields are filled in if we hit terrain, and a probe result
|
||||
* is returned.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMProbeResult XPLMProbeTerrainXYZ(
|
||||
XPLMProbeRef inProbe,
|
||||
float inX,
|
||||
float inY,
|
||||
float inZ,
|
||||
XPLMProbeInfo_t * outInfo);
|
||||
|
||||
#endif /* XPLM200 */
|
||||
/***************************************************************************
|
||||
* Object Drawing
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The object drawing routines let you load and draw X-Plane OBJ files.
|
||||
* Objects are loaded by file path and managed via an opaque handle. X-Plane
|
||||
* naturally reference counts objects, so it is important that you balance
|
||||
* every successful call to XPLMLoadObject with a call to XPLMUnloadObject!
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMObjectRef
|
||||
*
|
||||
* An XPLMObjectRef is a opaque handle to an .obj file that has been loaded
|
||||
* into memory.
|
||||
*
|
||||
*/
|
||||
typedef void * XPLMObjectRef;
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMDrawInfo_t
|
||||
*
|
||||
* The XPLMDrawInfo_t structure contains positioning info for one object that
|
||||
* is to be drawn. Be sure to set structSize to the size of the structure for
|
||||
* future expansion.
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
/* Set this to the size of this structure! */
|
||||
int structSize;
|
||||
/* X location of the object in local coordinates. */
|
||||
float x;
|
||||
/* Y location of the object in local coordinates. */
|
||||
float y;
|
||||
/* Z location of the object in local coordinates. */
|
||||
float z;
|
||||
/* Pitch in degres to rotate the object, positive is up. */
|
||||
float pitch;
|
||||
/* Heading in local coordinates to rotate the object, clockwise. */
|
||||
float heading;
|
||||
/* Roll to rotate the object. */
|
||||
float roll;
|
||||
} XPLMDrawInfo_t;
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM210)
|
||||
/*
|
||||
* XPLMObjectLoaded_f
|
||||
*
|
||||
* You provide this callback when loading an object asynchronously; it will be
|
||||
* called once the object is loaded. Your refcon is passed back. The object
|
||||
* ref passed in is the newly loaded object (ready for use) or NULL if an
|
||||
* error occured.
|
||||
*
|
||||
* If your plugin is disabled, this callback will be delivered as soon as the
|
||||
* plugin is re-enabled. If your plugin is unloaded before this callback is
|
||||
* ever called, the SDK will release the object handle for you.
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMObjectLoaded_f)(
|
||||
XPLMObjectRef inObject,
|
||||
void * inRefcon);
|
||||
#endif /* XPLM210 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMLoadObject
|
||||
*
|
||||
* This routine loads an OBJ file and returns a handle to it. If X-plane has
|
||||
* already loaded the object, the handle to the existing object is returned.
|
||||
* Do not assume you will get the same handle back twice, but do make sure to
|
||||
* call unload once for every load to avoid "leaking" objects. The object
|
||||
* will be purged from memory when no plugins and no scenery are using it.
|
||||
*
|
||||
* The path for the object must be relative to the X-System base folder. If
|
||||
* the path is in the root of the X-System folder you may need to prepend ./
|
||||
* to it; loading objects in the root of the X-System folder is STRONGLY
|
||||
* discouraged - your plugin should not dump art resources in the root folder!
|
||||
*
|
||||
*
|
||||
* XPLMLoadObject will return NULL if the object cannot be loaded (either
|
||||
* because it is not found or the file is misformatted). This routine will
|
||||
* load any object that can be used in the X-Plane scenery system.
|
||||
*
|
||||
* It is important that the datarefs an object uses for animation already be
|
||||
* loaded before you load the object. For this reason it may be necessary to
|
||||
* defer object loading until the sim has fully started.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMObjectRef XPLMLoadObject(
|
||||
const char * inPath);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM210)
|
||||
/*
|
||||
* XPLMLoadObjectAsync
|
||||
*
|
||||
* This routine loads an object asynchronously; control is returned to you
|
||||
* immediately while X-Plane loads the object. The sim will not stop flying
|
||||
* while the object loads. For large objects, it may be several seconds
|
||||
* before the load finishes.
|
||||
*
|
||||
* You provide a callback function that is called once the load has completed.
|
||||
* Note that if the object cannot be loaded, you will not find out until the
|
||||
* callback function is called with a NULL object handle.
|
||||
*
|
||||
* There is no way to cancel an asynchronous object load; you must wait for
|
||||
* the load to complete and then release the object if it is no longer
|
||||
* desired.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMLoadObjectAsync(
|
||||
const char * inPath,
|
||||
XPLMObjectLoaded_f inCallback,
|
||||
void * inRefcon);
|
||||
#endif /* XPLM210 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMDrawObjects
|
||||
*
|
||||
* XPLMDrawObjects draws an object from an OBJ file one or more times. You
|
||||
* pass in the object and an array of XPLMDrawInfo_t structs, one for each
|
||||
* place you would like the object to be drawn.
|
||||
*
|
||||
* X-Plane will attempt to cull the objects based on LOD and visibility, and
|
||||
* will pick the appropriate LOD.
|
||||
*
|
||||
* Lighting is a boolean; pass 1 to show the night version of object with
|
||||
* night-only lights lit up. Pass 0 to show the daytime version of the
|
||||
* object.
|
||||
*
|
||||
* earth_relative controls the coordinate system. If this is 1, the rotations
|
||||
* you specify are applied to the object after its coordinate system is
|
||||
* transformed from local to earth-relative coordinates -- that is, an object
|
||||
* with no rotations will point toward true north and the Y axis will be up
|
||||
* against gravity. If this is 0, the object is drawn with your rotations
|
||||
* from local coordanates -- that is, an object with no rotations is drawn
|
||||
* pointing down the -Z axis and the Y axis of the object matches the local
|
||||
* coordinate Y axis.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDrawObjects(
|
||||
XPLMObjectRef inObject,
|
||||
int inCount,
|
||||
XPLMDrawInfo_t * inLocations,
|
||||
int lighting,
|
||||
int earth_relative);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMUnloadObject
|
||||
*
|
||||
* This routine marks an object as no longer being used by your plugin.
|
||||
* Objects are reference counted: once no plugins are using an object, it is
|
||||
* purged from memory. Make sure to call XPLMUnloadObject once for each
|
||||
* successful call to XPLMLoadObject.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMUnloadObject(
|
||||
XPLMObjectRef inObject);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/***************************************************************************
|
||||
* Library Access
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The library access routines allow you to locate scenery objects via the
|
||||
* X-Plane library system. Right now library access is only provided for
|
||||
* objects, allowing plugin-drawn objects to be extended using the library
|
||||
* system.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMLibraryEnumerator_f
|
||||
*
|
||||
* An XPLMLibraryEnumerator_f is a callback you provide that is called once
|
||||
* for each library element that is located. The returned paths will be
|
||||
* relative to the X-System folder.
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMLibraryEnumerator_f)(
|
||||
const char * inFilePath,
|
||||
void * inRef);
|
||||
|
||||
/*
|
||||
* XPLMLookupObjects
|
||||
*
|
||||
* This routine looks up a virtual path in the library system and returns all
|
||||
* matching elements. You provide a callback - one virtual path may match
|
||||
* many objects in the library. XPLMLookupObjects returns the number of
|
||||
* objects found.
|
||||
*
|
||||
* The latitude and longitude parameters specify the location the object will
|
||||
* be used. The library system allows for scenery packages to only provide
|
||||
* objects to certain local locations. Only objects that are allowed at the
|
||||
* latitude/longitude you provide will be returned.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMLookupObjects(
|
||||
const char * inPath,
|
||||
float inLatitude,
|
||||
float inLongitude,
|
||||
XPLMLibraryEnumerator_f enumerator,
|
||||
void * ref);
|
||||
|
||||
#endif /* XPLM200 */
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
839
xpcPlugin/SDK/CHeaders/XPLM/XPLMUtilities.h
Executable file
839
xpcPlugin/SDK/CHeaders/XPLM/XPLMUtilities.h
Executable file
@@ -0,0 +1,839 @@
|
||||
#ifndef _XPLMUtilities_h_
|
||||
#define _XPLMUtilities_h_
|
||||
|
||||
/*
|
||||
* Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
*
|
||||
* All rights reserved. See license.txt for usage.
|
||||
*
|
||||
* X-Plane SDK Version: 2.1.1
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
#include "XPLMDefs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/***************************************************************************
|
||||
* X-PLANE USER INTERACTION
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The user interaction APIs let you simulate commands the user can do with a
|
||||
* joystick, keyboard etc. Note that it is generally safer for future
|
||||
* compatibility to use one of these commands than to manipulate the
|
||||
* underlying sim data.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMCommandKeyID
|
||||
*
|
||||
* These enums represent all the keystrokes available within x-plane. They
|
||||
* can be sent to x-plane directly. For example, you can reverse thrust using
|
||||
* these enumerations.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
xplm_key_pause=0,
|
||||
xplm_key_revthrust,
|
||||
xplm_key_jettison,
|
||||
xplm_key_brakesreg,
|
||||
xplm_key_brakesmax,
|
||||
xplm_key_gear,
|
||||
xplm_key_timedn,
|
||||
xplm_key_timeup,
|
||||
xplm_key_fadec,
|
||||
xplm_key_otto_dis,
|
||||
xplm_key_otto_atr,
|
||||
xplm_key_otto_asi,
|
||||
xplm_key_otto_hdg,
|
||||
xplm_key_otto_gps,
|
||||
xplm_key_otto_lev,
|
||||
xplm_key_otto_hnav,
|
||||
xplm_key_otto_alt,
|
||||
xplm_key_otto_vvi,
|
||||
xplm_key_otto_vnav,
|
||||
xplm_key_otto_nav1,
|
||||
xplm_key_otto_nav2,
|
||||
xplm_key_targ_dn,
|
||||
xplm_key_targ_up,
|
||||
xplm_key_hdgdn,
|
||||
xplm_key_hdgup,
|
||||
xplm_key_barodn,
|
||||
xplm_key_baroup,
|
||||
xplm_key_obs1dn,
|
||||
xplm_key_obs1up,
|
||||
xplm_key_obs2dn,
|
||||
xplm_key_obs2up,
|
||||
xplm_key_com1_1,
|
||||
xplm_key_com1_2,
|
||||
xplm_key_com1_3,
|
||||
xplm_key_com1_4,
|
||||
xplm_key_nav1_1,
|
||||
xplm_key_nav1_2,
|
||||
xplm_key_nav1_3,
|
||||
xplm_key_nav1_4,
|
||||
xplm_key_com2_1,
|
||||
xplm_key_com2_2,
|
||||
xplm_key_com2_3,
|
||||
xplm_key_com2_4,
|
||||
xplm_key_nav2_1,
|
||||
xplm_key_nav2_2,
|
||||
xplm_key_nav2_3,
|
||||
xplm_key_nav2_4,
|
||||
xplm_key_adf_1,
|
||||
xplm_key_adf_2,
|
||||
xplm_key_adf_3,
|
||||
xplm_key_adf_4,
|
||||
xplm_key_adf_5,
|
||||
xplm_key_adf_6,
|
||||
xplm_key_transpon_1,
|
||||
xplm_key_transpon_2,
|
||||
xplm_key_transpon_3,
|
||||
xplm_key_transpon_4,
|
||||
xplm_key_transpon_5,
|
||||
xplm_key_transpon_6,
|
||||
xplm_key_transpon_7,
|
||||
xplm_key_transpon_8,
|
||||
xplm_key_flapsup,
|
||||
xplm_key_flapsdn,
|
||||
xplm_key_cheatoff,
|
||||
xplm_key_cheaton,
|
||||
xplm_key_sbrkoff,
|
||||
xplm_key_sbrkon,
|
||||
xplm_key_ailtrimL,
|
||||
xplm_key_ailtrimR,
|
||||
xplm_key_rudtrimL,
|
||||
xplm_key_rudtrimR,
|
||||
xplm_key_elvtrimD,
|
||||
xplm_key_elvtrimU,
|
||||
xplm_key_forward,
|
||||
xplm_key_down,
|
||||
xplm_key_left,
|
||||
xplm_key_right,
|
||||
xplm_key_back,
|
||||
xplm_key_tower,
|
||||
xplm_key_runway,
|
||||
xplm_key_chase,
|
||||
xplm_key_free1,
|
||||
xplm_key_free2,
|
||||
xplm_key_spot,
|
||||
xplm_key_fullscrn1,
|
||||
xplm_key_fullscrn2,
|
||||
xplm_key_tanspan,
|
||||
xplm_key_smoke,
|
||||
xplm_key_map,
|
||||
xplm_key_zoomin,
|
||||
xplm_key_zoomout,
|
||||
xplm_key_cycledump,
|
||||
xplm_key_replay,
|
||||
xplm_key_tranID,
|
||||
xplm_key_max
|
||||
};
|
||||
typedef int XPLMCommandKeyID;
|
||||
|
||||
/*
|
||||
* XPLMCommandButtonID
|
||||
*
|
||||
* These are enumerations for all of the things you can do with a joystick
|
||||
* button in X-Plane. They currently match the buttons menu in the equipment
|
||||
* setup dialog, but these enums will be stable even if they change in
|
||||
* X-Plane.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
xplm_joy_nothing=0,
|
||||
xplm_joy_start_all,
|
||||
xplm_joy_start_0,
|
||||
xplm_joy_start_1,
|
||||
xplm_joy_start_2,
|
||||
xplm_joy_start_3,
|
||||
xplm_joy_start_4,
|
||||
xplm_joy_start_5,
|
||||
xplm_joy_start_6,
|
||||
xplm_joy_start_7,
|
||||
xplm_joy_throt_up,
|
||||
xplm_joy_throt_dn,
|
||||
xplm_joy_prop_up,
|
||||
xplm_joy_prop_dn,
|
||||
xplm_joy_mixt_up,
|
||||
xplm_joy_mixt_dn,
|
||||
xplm_joy_carb_tog,
|
||||
xplm_joy_carb_on,
|
||||
xplm_joy_carb_off,
|
||||
xplm_joy_trev,
|
||||
xplm_joy_trm_up,
|
||||
xplm_joy_trm_dn,
|
||||
xplm_joy_rot_trm_up,
|
||||
xplm_joy_rot_trm_dn,
|
||||
xplm_joy_rud_lft,
|
||||
xplm_joy_rud_cntr,
|
||||
xplm_joy_rud_rgt,
|
||||
xplm_joy_ail_lft,
|
||||
xplm_joy_ail_cntr,
|
||||
xplm_joy_ail_rgt,
|
||||
xplm_joy_B_rud_lft,
|
||||
xplm_joy_B_rud_rgt,
|
||||
xplm_joy_look_up,
|
||||
xplm_joy_look_dn,
|
||||
xplm_joy_look_lft,
|
||||
xplm_joy_look_rgt,
|
||||
xplm_joy_glance_l,
|
||||
xplm_joy_glance_r,
|
||||
xplm_joy_v_fnh,
|
||||
xplm_joy_v_fwh,
|
||||
xplm_joy_v_tra,
|
||||
xplm_joy_v_twr,
|
||||
xplm_joy_v_run,
|
||||
xplm_joy_v_cha,
|
||||
xplm_joy_v_fr1,
|
||||
xplm_joy_v_fr2,
|
||||
xplm_joy_v_spo,
|
||||
xplm_joy_flapsup,
|
||||
xplm_joy_flapsdn,
|
||||
xplm_joy_vctswpfwd,
|
||||
xplm_joy_vctswpaft,
|
||||
xplm_joy_gear_tog,
|
||||
xplm_joy_gear_up,
|
||||
xplm_joy_gear_down,
|
||||
xplm_joy_lft_brake,
|
||||
xplm_joy_rgt_brake,
|
||||
xplm_joy_brakesREG,
|
||||
xplm_joy_brakesMAX,
|
||||
xplm_joy_speedbrake,
|
||||
xplm_joy_ott_dis,
|
||||
xplm_joy_ott_atr,
|
||||
xplm_joy_ott_asi,
|
||||
xplm_joy_ott_hdg,
|
||||
xplm_joy_ott_alt,
|
||||
xplm_joy_ott_vvi,
|
||||
xplm_joy_tim_start,
|
||||
xplm_joy_tim_reset,
|
||||
xplm_joy_ecam_up,
|
||||
xplm_joy_ecam_dn,
|
||||
xplm_joy_fadec,
|
||||
xplm_joy_yaw_damp,
|
||||
xplm_joy_art_stab,
|
||||
xplm_joy_chute,
|
||||
xplm_joy_JATO,
|
||||
xplm_joy_arrest,
|
||||
xplm_joy_jettison,
|
||||
xplm_joy_fuel_dump,
|
||||
xplm_joy_puffsmoke,
|
||||
xplm_joy_prerotate,
|
||||
xplm_joy_UL_prerot,
|
||||
xplm_joy_UL_collec,
|
||||
xplm_joy_TOGA,
|
||||
xplm_joy_shutdown,
|
||||
xplm_joy_con_atc,
|
||||
xplm_joy_fail_now,
|
||||
xplm_joy_pause,
|
||||
xplm_joy_rock_up,
|
||||
xplm_joy_rock_dn,
|
||||
xplm_joy_rock_lft,
|
||||
xplm_joy_rock_rgt,
|
||||
xplm_joy_rock_for,
|
||||
xplm_joy_rock_aft,
|
||||
xplm_joy_idle_hilo,
|
||||
xplm_joy_lanlights,
|
||||
xplm_joy_max
|
||||
};
|
||||
typedef int XPLMCommandButtonID;
|
||||
|
||||
/*
|
||||
* XPLMHostApplicationID
|
||||
*
|
||||
* The plug-in system is based on Austin's cross-platform OpenGL framework and
|
||||
* could theoretically be adapted to run in other apps like WorldMaker. The
|
||||
* plug-in system also runs against a test harness for internal development
|
||||
* and could be adapted to another flight sim (in theory at least). So an ID
|
||||
* is providing allowing plug-ins to indentify what app they are running
|
||||
* under.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
xplm_Host_Unknown = 0
|
||||
|
||||
,xplm_Host_XPlane = 1
|
||||
|
||||
,xplm_Host_PlaneMaker = 2
|
||||
|
||||
,xplm_Host_WorldMaker = 3
|
||||
|
||||
,xplm_Host_Briefer = 4
|
||||
|
||||
,xplm_Host_PartMaker = 5
|
||||
|
||||
,xplm_Host_YoungsMod = 6
|
||||
|
||||
,xplm_Host_XAuto = 7
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMHostApplicationID;
|
||||
|
||||
/*
|
||||
* XPLMLanguageCode
|
||||
*
|
||||
* These enums define what language the sim is running in. These enumerations
|
||||
* do not imply that the sim can or does run in all of these languages; they
|
||||
* simply provide a known encoding in the event that a given sim version is
|
||||
* localized to a certain language.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
xplm_Language_Unknown = 0
|
||||
|
||||
,xplm_Language_English = 1
|
||||
|
||||
,xplm_Language_French = 2
|
||||
|
||||
,xplm_Language_German = 3
|
||||
|
||||
,xplm_Language_Italian = 4
|
||||
|
||||
,xplm_Language_Spanish = 5
|
||||
|
||||
,xplm_Language_Korean = 6
|
||||
|
||||
#if defined(XPLM200)
|
||||
,xplm_Language_Russian = 7
|
||||
|
||||
#endif /* XPLM200 */
|
||||
#if defined(XPLM200)
|
||||
,xplm_Language_Greek = 8
|
||||
|
||||
#endif /* XPLM200 */
|
||||
#if defined(XPLM200)
|
||||
,xplm_Language_Japanese = 9
|
||||
|
||||
#endif /* XPLM200 */
|
||||
#if defined(XPLM200)
|
||||
,xplm_Language_Chinese = 10
|
||||
|
||||
#endif /* XPLM200 */
|
||||
|
||||
};
|
||||
typedef int XPLMLanguageCode;
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMDataFileType
|
||||
*
|
||||
* These enums define types of data files you can load or unload using the
|
||||
* SDK.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* A situation (.sit) file, which starts off a flight in a given *
|
||||
* configuration. */
|
||||
xplm_DataFile_Situation = 1
|
||||
|
||||
/* A situation movie (.smo) file, which replays a past flight. */
|
||||
,xplm_DataFile_ReplayMovie = 2
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMDataFileType;
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMError_f
|
||||
*
|
||||
* An XPLM error callback is a function that you provide to receive debugging
|
||||
* information from the plugin SDK. See XPLMSetErrorCallback for more
|
||||
* information. NOTE: for the sake of debugging, your error callback will be
|
||||
* called even if your plugin is not enabled, allowing you to receive debug
|
||||
* info in your XPluginStart and XPluginStop callbacks. To avoid causing
|
||||
* logic errors in the management code, do not call any other plugin routines
|
||||
* from your error callback - it is only meant for logging!
|
||||
*
|
||||
*/
|
||||
typedef void (* XPLMError_f)(
|
||||
const char * inMessage);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
/*
|
||||
* XPLMSimulateKeyPress
|
||||
*
|
||||
* This function simulates a key being pressed for x-plane. The keystroke
|
||||
* goes directly to x-plane; it is never sent to any plug-ins. However, since
|
||||
* this is a raw key stroke it may be mapped by the keys file or enter text
|
||||
* into a field.
|
||||
*
|
||||
* WARNING: This function will be deprecated; do not use it. Instead use
|
||||
* XPLMCommandKeyStroke.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSimulateKeyPress(
|
||||
int inKeyType,
|
||||
int inKey);
|
||||
|
||||
/*
|
||||
* XPLMSpeakString
|
||||
*
|
||||
* This function displays the string in a translucent overlay over the current
|
||||
* display and also speaks the string if text-to-speech is enabled. The
|
||||
* string is spoken asynchronously, this function returns immediately.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSpeakString(
|
||||
const char * inString);
|
||||
|
||||
/*
|
||||
* XPLMCommandKeyStroke
|
||||
*
|
||||
* This routine simulates a command-key stroke. However, the keys are done by
|
||||
* function, not by actual letter, so this function works even if the user has
|
||||
* remapped their keyboard. Examples of things you might do with this include
|
||||
* pausing the simulator.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMCommandKeyStroke(
|
||||
XPLMCommandKeyID inKey);
|
||||
|
||||
/*
|
||||
* XPLMCommandButtonPress
|
||||
*
|
||||
* This function simulates any of the actions that might be taken by pressing
|
||||
* a joystick button. However, this lets you call the command directly rather
|
||||
* than have to know which button is mapped where. Important: you must
|
||||
* release each button you press. The APIs are separate so that you can 'hold
|
||||
* down' a button for a fixed amount of time.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMCommandButtonPress(
|
||||
XPLMCommandButtonID inButton);
|
||||
|
||||
/*
|
||||
* XPLMCommandButtonRelease
|
||||
*
|
||||
* This function simulates any of the actions that might be taken by pressing
|
||||
* a joystick button. See XPLMCommandButtonPress
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMCommandButtonRelease(
|
||||
XPLMCommandButtonID inButton);
|
||||
|
||||
/*
|
||||
* XPLMGetVirtualKeyDescription
|
||||
*
|
||||
* Given a virtual key code (as defined in XPLMDefs.h) this routine returns a
|
||||
* human-readable string describing the character. This routine is provided
|
||||
* for showing users what keyboard mappings they have set up. The string may
|
||||
* read 'unknown' or be a blank or NULL string if the virtual key is unknown.
|
||||
*
|
||||
*/
|
||||
XPLM_API const char * XPLMGetVirtualKeyDescription(
|
||||
char inVirtualKey);
|
||||
|
||||
/***************************************************************************
|
||||
* X-PLANE MISC
|
||||
***************************************************************************/
|
||||
/*
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMReloadScenery
|
||||
*
|
||||
* XPLMReloadScenery reloads the current set of scenery. You can use this
|
||||
* function in two typical ways: simply call it to reload the scenery, picking
|
||||
* up any new installed scenery, .env files, etc. from disk. Or, change the
|
||||
* lat/ref and lon/ref data refs and then call this function to shift the
|
||||
* scenery environment.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMReloadScenery(void);
|
||||
|
||||
/*
|
||||
* XPLMGetSystemPath
|
||||
*
|
||||
* This function returns the full path to the X-System folder. Note that this
|
||||
* is a directory path, so it ends in a trailing : or /. The buffer you pass
|
||||
* should be at least 512 characters long.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetSystemPath(
|
||||
char * outSystemPath);
|
||||
|
||||
/*
|
||||
* XPLMGetPrefsPath
|
||||
*
|
||||
* This routine returns a full path to the proper directory to store
|
||||
* preferences in. It ends in a : or /. The buffer you pass should be at
|
||||
* least 512 characters long.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetPrefsPath(
|
||||
char * outPrefsPath);
|
||||
|
||||
/*
|
||||
* XPLMGetDirectorySeparator
|
||||
*
|
||||
* This routine returns a string with one char and a null terminator that is
|
||||
* the directory separator for the current platform. This allows you to write
|
||||
* code that concatinates directory paths without having to #ifdef for
|
||||
* platform.
|
||||
*
|
||||
*/
|
||||
XPLM_API const char * XPLMGetDirectorySeparator(void);
|
||||
|
||||
/*
|
||||
* XPLMExtractFileAndPath
|
||||
*
|
||||
* Given a full path to a file, this routine separates the path from the file.
|
||||
* If the path is a partial directory (e.g. ends in : or \) the trailing
|
||||
* directory separator is removed. This routine works in-place; a pointer to
|
||||
* the file part of the buffer is returned; the original buffer still starts
|
||||
* with the path.
|
||||
*
|
||||
*/
|
||||
XPLM_API char * XPLMExtractFileAndPath(
|
||||
char * inFullPath);
|
||||
|
||||
/*
|
||||
* XPLMGetDirectoryContents
|
||||
*
|
||||
* This routine returns a list of files in a directory (specified by a full
|
||||
* path, no trailing : or \). The output is returned as a list of NULL
|
||||
* terminated strings. An index array (if specified) is filled with pointers
|
||||
* into the strings. This routine The last file is indicated by a zero-length
|
||||
* string (and NULL in the indices). This routine will return 1 if you had
|
||||
* capacity for all files or 0 if you did not. You can also skip a given
|
||||
* number of files.
|
||||
*
|
||||
* inDirectoryPath - a null terminated C string containing the full path to
|
||||
* the directory with no trailing directory char.
|
||||
*
|
||||
* inFirstReturn - the zero-based index of the first file in the directory to
|
||||
* return. (Usually zero to fetch all in one pass.)
|
||||
*
|
||||
* outFileNames - a buffer to receive a series of sequential null terminated
|
||||
* C-string file names. A zero-length C string will be appended to the very
|
||||
* end.
|
||||
*
|
||||
* inFileNameBufSize - the size of the file name buffer in bytes.
|
||||
*
|
||||
* outIndices - a pointer to an array of character pointers that will become
|
||||
* an index into the directory. The last file will be followed by a NULL
|
||||
* value. Pass NULL if you do not want indexing information.
|
||||
*
|
||||
* inIndexCount - the max size of the index in entries.
|
||||
*
|
||||
* outTotalFiles - if not NULL, this is filled in with the number of files in
|
||||
* the directory.
|
||||
*
|
||||
* outReturnedFiles - if not NULL, the number of files returned by this
|
||||
* iteration.
|
||||
*
|
||||
* Return value - 1 if all info could be returned, 0 if there was a buffer
|
||||
* overrun.
|
||||
*
|
||||
* WARNING: Before X-Plane 7 this routine did not properly iterate through
|
||||
* directories. If X-Plane 6 compatibility is needed, use your own code to
|
||||
* iterate directories.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMGetDirectoryContents(
|
||||
const char * inDirectoryPath,
|
||||
int inFirstReturn,
|
||||
char * outFileNames,
|
||||
int inFileNameBufSize,
|
||||
char ** outIndices, /* Can be NULL */
|
||||
int inIndexCount,
|
||||
int * outTotalFiles, /* Can be NULL */
|
||||
int * outReturnedFiles); /* Can be NULL */
|
||||
|
||||
/*
|
||||
* XPLMInitialized
|
||||
*
|
||||
* This function returns 1 if X-Plane has properly initialized the plug-in
|
||||
* system. If this routine returns 0, many XPLM functions will not work.
|
||||
*
|
||||
* NOTE: Under normal circumstances a plug-in should never be running while
|
||||
* the plug-in manager is not initialized.
|
||||
*
|
||||
* WARNING: This function is generally not needed and may be deprecated in the
|
||||
* future.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMInitialized(void);
|
||||
|
||||
/*
|
||||
* XPLMGetVersions
|
||||
*
|
||||
* This routine returns the revision of both X-Plane and the XPLM DLL. All
|
||||
* versions are three-digit decimal numbers (e.g. 606 for version 6.06 of
|
||||
* X-Plane); the current revision of the XPLM is 200 (2.00). This routine
|
||||
* also returns the host ID of the app running us.
|
||||
*
|
||||
* The most common use of this routine is to special-case around x-plane
|
||||
* version-specific behavior.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMGetVersions(
|
||||
int * outXPlaneVersion,
|
||||
int * outXPLMVersion,
|
||||
XPLMHostApplicationID * outHostID);
|
||||
|
||||
/*
|
||||
* XPLMGetLanguage
|
||||
*
|
||||
* This routine returns the langauge the sim is running in.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMLanguageCode XPLMGetLanguage(void);
|
||||
|
||||
/*
|
||||
* XPLMDebugString
|
||||
*
|
||||
* This routine outputs a C-style string to the Log.txt file. The file is
|
||||
* immediately flushed so you will not lose data. (This does cause a
|
||||
* performance penalty.)
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMDebugString(
|
||||
const char * inString);
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMSetErrorCallback
|
||||
*
|
||||
* XPLMSetErrorCallback installs an error-reporting callback for your plugin.
|
||||
* Normally the plugin system performs minimum diagnostics to maximize
|
||||
* performance. When you install an error callback, you will receive calls
|
||||
* due to certain plugin errors, such as passing bad parameters or incorrect
|
||||
* data.
|
||||
*
|
||||
* The intention is for you to install the error callback during debug
|
||||
* sections and put a break-point inside your callback. This will cause you
|
||||
* to break into the debugger from within the SDK at the point in your plugin
|
||||
* where you made an illegal call.
|
||||
*
|
||||
* Installing an error callback may activate error checking code that would
|
||||
* not normally run, and this may adversely affect performance, so do not
|
||||
* leave error callbacks installed in shipping plugins.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMSetErrorCallback(
|
||||
XPLMError_f inCallback);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMFindSymbol
|
||||
*
|
||||
* This routine will attempt to find the symbol passed in the inString
|
||||
* parameter. If the symbol is found a pointer the function is returned,
|
||||
* othewise the function will return NULL.
|
||||
*
|
||||
*/
|
||||
XPLM_API void * XPLMFindSymbol(
|
||||
const char * inString);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMLoadDataFile
|
||||
*
|
||||
* Loads a data file of a given type. Paths must be relative to the X-System
|
||||
* folder. To clear the replay, pass a NULL file name (this is only valid with
|
||||
* replay movies, not sit files).
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMLoadDataFile(
|
||||
XPLMDataFileType inFileType,
|
||||
const char * inFilePath); /* Can be NULL */
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/*
|
||||
* XPLMSaveDataFile
|
||||
*
|
||||
* Saves the current situation or replay; paths are relative to the X-System
|
||||
* folder.
|
||||
*
|
||||
*/
|
||||
XPLM_API int XPLMSaveDataFile(
|
||||
XPLMDataFileType inFileType,
|
||||
const char * inFilePath);
|
||||
#endif /* XPLM200 */
|
||||
|
||||
#if defined(XPLM200)
|
||||
/***************************************************************************
|
||||
* X-PLANE COMMAND MANAGEMENT
|
||||
***************************************************************************/
|
||||
/*
|
||||
* The command management APIs let plugins interact with the command-system in
|
||||
* X-Plane, the abstraction behind keyboard presses and joystick buttons.
|
||||
* This API lets you create new commands and modify the behavior (or get
|
||||
* notification) of existing ones.
|
||||
*
|
||||
* An X-Plane command consists of three phases: a beginning, continuous
|
||||
* repetition, and an ending. The command may be repeated zero times in the
|
||||
* event that the user presses a button only momentarily.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* XPLMCommandPhase
|
||||
*
|
||||
* The phases of a command.
|
||||
*
|
||||
*/
|
||||
enum {
|
||||
/* The command is being started. */
|
||||
xplm_CommandBegin = 0
|
||||
|
||||
/* The command is continuing to execute. */
|
||||
,xplm_CommandContinue = 1
|
||||
|
||||
/* The command has ended. */
|
||||
,xplm_CommandEnd = 2
|
||||
|
||||
|
||||
};
|
||||
typedef int XPLMCommandPhase;
|
||||
|
||||
/*
|
||||
* XPLMCommandRef
|
||||
*
|
||||
* A command ref is an opaque identifier for an X-Plane command. Command
|
||||
* references stay the same for the life of your plugin but not between
|
||||
* executions of X-Plane. Command refs are used to execute commands, create
|
||||
* commands, and create callbacks for particular commands.
|
||||
*
|
||||
* Note that a command is not "owned" by a particular plugin. Since many
|
||||
* plugins may participate in a command's execution, the command does not go
|
||||
* away if the plugin that created it is unloaded.
|
||||
*
|
||||
*/
|
||||
typedef void * XPLMCommandRef;
|
||||
|
||||
/*
|
||||
* XPLMCommandCallback_f
|
||||
*
|
||||
* A command callback is a function in your plugin that is called when a
|
||||
* command is pressed. Your callback receives the commadn reference for the
|
||||
* particular command, the phase of the command that is executing, and a
|
||||
* reference pointer that you specify when registering the callback.
|
||||
*
|
||||
* Your command handler should return 1 to let processing of the command
|
||||
* continue to other plugins and X-Plane, or 0 to halt processing,
|
||||
* potentially bypassing X-Plane code.
|
||||
*
|
||||
*/
|
||||
typedef int (* XPLMCommandCallback_f)(
|
||||
XPLMCommandRef inCommand,
|
||||
XPLMCommandPhase inPhase,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMFindCommand
|
||||
*
|
||||
* XPLMFindCommand looks up a command by name, and returns its command
|
||||
* reference or NULL if the command does not exist.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMCommandRef XPLMFindCommand(
|
||||
const char * inName);
|
||||
|
||||
/*
|
||||
* XPLMCommandBegin
|
||||
*
|
||||
* XPLMCommandBegin starts the execution of a command, specified by its
|
||||
* command reference. The command is "held down" until XPLMCommandEnd is
|
||||
* called.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMCommandBegin(
|
||||
XPLMCommandRef inCommand);
|
||||
|
||||
/*
|
||||
* XPLMCommandEnd
|
||||
*
|
||||
* XPLMCommandEnd ends the execution of a given command that was started with
|
||||
* XPLMCommandBegin.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMCommandEnd(
|
||||
XPLMCommandRef inCommand);
|
||||
|
||||
/*
|
||||
* XPLMCommandOnce
|
||||
*
|
||||
* This executes a given command momentarily, that is, the command begins and
|
||||
* ends immediately.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMCommandOnce(
|
||||
XPLMCommandRef inCommand);
|
||||
|
||||
/*
|
||||
* XPLMCreateCommand
|
||||
*
|
||||
* XPLMCreateCommand creates a new command for a given string. If the command
|
||||
* already exists, the existing command reference is returned. The
|
||||
* description may appear in user interface contexts, such as the joystick
|
||||
* configuration screen.
|
||||
*
|
||||
*/
|
||||
XPLM_API XPLMCommandRef XPLMCreateCommand(
|
||||
const char * inName,
|
||||
const char * inDescription);
|
||||
|
||||
/*
|
||||
* XPLMRegisterCommandHandler
|
||||
*
|
||||
* XPLMRegisterCommandHandler registers a callback to be called when a command
|
||||
* is executed. You provide a callback with a reference pointer.
|
||||
*
|
||||
* If inBefore is true, your command handler callback will be executed before
|
||||
* X-Plane executes the command, and returning 0 from your callback will
|
||||
* disable X-Plane's processing of the command. If inBefore is false, your
|
||||
* callback will run after X-Plane. (You can register a single callback both
|
||||
* before and after a command.)
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMRegisterCommandHandler(
|
||||
XPLMCommandRef inComand,
|
||||
XPLMCommandCallback_f inHandler,
|
||||
int inBefore,
|
||||
void * inRefcon);
|
||||
|
||||
/*
|
||||
* XPLMUnregisterCommandHandler
|
||||
*
|
||||
* XPLMUnregisterCommandHandler removes a command callback registered with
|
||||
* XPLMRegisterCommandHandler.
|
||||
*
|
||||
*/
|
||||
XPLM_API void XPLMUnregisterCommandHandler(
|
||||
XPLMCommandRef inComand,
|
||||
XPLMCommandCallback_f inHandler,
|
||||
int inBefore,
|
||||
void * inRefcon);
|
||||
|
||||
#endif /* XPLM200 */
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
497
xpcPlugin/SDK/Delphi/Widgets/XPStandardWidgets.pas
Executable file
497
xpcPlugin/SDK/Delphi/Widgets/XPStandardWidgets.pas
Executable file
@@ -0,0 +1,497 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPStandardWidgets;
|
||||
INTERFACE
|
||||
{
|
||||
XPStandardWidgets - THEORY OF OPERATION
|
||||
|
||||
The standard widgets are widgets built into the widgets library. While you
|
||||
can gain access to the widget function that drives them, you generally use
|
||||
them by calling XPCreateWidget and then listening for special messages,
|
||||
etc.
|
||||
|
||||
The standard widgets often send mesages to themselves when the user
|
||||
performs an event; these messages are sent up the widget hierarchy until
|
||||
they are handled. So you can add a widget proc directly to a push button
|
||||
(for example) to intercept the message when it is clicked, or you can put
|
||||
one widget proc on a window for all of the push buttons in the window.
|
||||
Most of these messages contain the original widget ID as a parameter so you
|
||||
can know which widget is messaging no matter who it is sent to.
|
||||
}
|
||||
|
||||
USES XPWidgetDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* MAIN WINDOW
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The main window widget class provides a "window" as the user knows it.
|
||||
These windows are dragable and can be selected. Use them to create
|
||||
floating windows and non-modal dialogs.
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
xpWidgetClass_MainWindow = 1;
|
||||
|
||||
{
|
||||
Main Window Type Values
|
||||
|
||||
These type values are used to control the appearance of a main window.
|
||||
}
|
||||
{ The standard main window; pin stripes on XP7, metal frame on XP 6. }
|
||||
xpMainWindowStyle_MainWindow = 0
|
||||
;
|
||||
{ A translucent dark gray window, like the one ATC messages appear in. }
|
||||
xpMainWindowStyle_Translucent = 1
|
||||
;
|
||||
|
||||
{
|
||||
Main Window Properties
|
||||
|
||||
}
|
||||
{ This property specifies the type of window. Set to one of the main window }
|
||||
{ types above. }
|
||||
xpProperty_MainWindowType = 1100
|
||||
;
|
||||
{ This property specifies whether the main window has close boxes in its }
|
||||
{ corners. }
|
||||
xpProperty_MainWindowHasCloseBoxes = 1200
|
||||
;
|
||||
|
||||
{
|
||||
MainWindow Messages
|
||||
|
||||
}
|
||||
{ This message is sent when the close buttons are pressed for your window. }
|
||||
xpMessage_CloseButtonPushed = 1200
|
||||
;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* SUB WINDOW
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
X-plane dialogs are divided into separate areas; the sub window widgets
|
||||
allow you to make these areas. Create one main window and place several
|
||||
subwindows inside it. Then place your controls inside the subwindows.
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
xpWidgetClass_SubWindow = 2;
|
||||
|
||||
{
|
||||
SubWindow Type Values
|
||||
|
||||
These values control the appearance of the subwindow.
|
||||
}
|
||||
{ A panel that sits inside a main window. }
|
||||
xpSubWindowStyle_SubWindow = 0
|
||||
;
|
||||
{ A screen that sits inside a panel for showing text information. }
|
||||
xpSubWindowStyle_Screen = 2
|
||||
;
|
||||
{ A list view for scrolling lists. }
|
||||
xpSubWindowStyle_ListView = 3
|
||||
;
|
||||
|
||||
{
|
||||
SubWindow Properties
|
||||
|
||||
}
|
||||
{ This property specifies the type of window. Set to one of the subwindow }
|
||||
{ types above. }
|
||||
xpProperty_SubWindowType = 1200
|
||||
;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* BUTTON
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The button class provides a number of different button styles and
|
||||
behaviors, including push buttons, radio buttons, check boxes, etc. The
|
||||
button label appears on or next to the button depending on the button's
|
||||
appearance, or type.
|
||||
|
||||
The button's behavior is a separate property that dictates who it hilights
|
||||
and what kinds of messages it sends. Since behavior and type are
|
||||
different, you can do strange things like make check boxes that act as push
|
||||
buttons or push buttons with radio button behavior.
|
||||
|
||||
In X-Plane 6 there were no check box graphics. The result is the following
|
||||
behavior: in x-plane 6 all check box and radio buttons are round
|
||||
(radio-button style) buttons; in X-Plane 7 they are all square (check-box
|
||||
style) buttons. In a future version of x-plane, the xpButtonBehavior enums
|
||||
will provide the correct graphic (check box or radio button) giving the
|
||||
expected result.
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
xpWidgetClass_Button = 3;
|
||||
|
||||
{
|
||||
Button Types
|
||||
|
||||
These define the visual appearance of buttons but not how they respond to
|
||||
the mouse.
|
||||
}
|
||||
{ This is a standard push button, like an "OK" or "Cancel" button in a dialog }
|
||||
{ box. }
|
||||
xpPushButton = 0
|
||||
;
|
||||
{ A check box or radio button. Use this and the button behaviors below to }
|
||||
{ get the desired behavior. }
|
||||
xpRadioButton = 1
|
||||
;
|
||||
{ A window close box. }
|
||||
xpWindowCloseBox = 3
|
||||
;
|
||||
{ A small down arrow. }
|
||||
xpLittleDownArrow = 5
|
||||
;
|
||||
{ A small up arrow. }
|
||||
xpLittleUpArrow = 6
|
||||
;
|
||||
|
||||
{
|
||||
Button Behavior Values
|
||||
|
||||
These define how the button responds to mouse clicks.
|
||||
}
|
||||
{ Standard push button behavior. The button hilites while the mouse is }
|
||||
{ clicked over it and unhilites when the mouse is moved outside of it or }
|
||||
{ released. If the mouse is released over the button, the }
|
||||
{ xpMsg_PushButtonPressed message is sent. }
|
||||
xpButtonBehaviorPushButton = 0
|
||||
;
|
||||
{ Check box behavior. The button immediately toggles its value when the }
|
||||
{ mouse is clicked and sends out a xpMsg_ButtonStateChanged message. }
|
||||
xpButtonBehaviorCheckBox = 1
|
||||
;
|
||||
{ Radio button behavior. The button immediately sets its state to one and }
|
||||
{ sends out a xpMsg_ButtonStateChanged message if it was not already set to }
|
||||
{ one. You must turn off other radio buttons in a group in your code. }
|
||||
xpButtonBehaviorRadioButton = 2
|
||||
;
|
||||
|
||||
{
|
||||
Button Properties
|
||||
|
||||
}
|
||||
{ This property sets the visual type of button. Use one of the button types }
|
||||
{ above. }
|
||||
xpProperty_ButtonType = 1300
|
||||
;
|
||||
{ This property sets the button's behavior. Use one of the button behaviors }
|
||||
{ above. }
|
||||
xpProperty_ButtonBehavior = 1301
|
||||
;
|
||||
{ This property tells whether a check box or radio button is "checked" or }
|
||||
{ not. Not used for push buttons. }
|
||||
xpProperty_ButtonState = 1302
|
||||
;
|
||||
|
||||
{
|
||||
Button Messages
|
||||
|
||||
These messages are sent by the button to itself and then up the widget
|
||||
chain when the button is clicked. (You may intercept them by providing a
|
||||
widget handler for the button itself or by providing a handler in a parent
|
||||
widget.)
|
||||
}
|
||||
{ This message is sent when the user completes a click and release in a }
|
||||
{ button with push button behavior. Parameter one of the message is the }
|
||||
{ widget ID of the button. This message is dispatched up the widget }
|
||||
{ hierarchy. }
|
||||
xpMsg_PushButtonPressed = 1300
|
||||
;
|
||||
{ This message is sent when a button is clicked that has radio button or }
|
||||
{ check box behavior and its value changes. (Note that if the value changes }
|
||||
{ by setting a property you do not receive this message!) Parameter one is }
|
||||
{ the widget ID of the button, parameter 2 is the new state value, either }
|
||||
{ zero or one. This message is dispatched up the widget hierarchy. }
|
||||
xpMsg_ButtonStateChanged = 1301
|
||||
;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* TEXT FIELD
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The text field widget provides an editable text field including mouse
|
||||
selection and keyboard navigation. The contents of the text field are its
|
||||
descriptor. (The descriptor changes as the user types.)
|
||||
|
||||
The text field can have a number of types, that effect the visual layout of
|
||||
the text field. The text field sends messages to itself so you may control
|
||||
its behavior.
|
||||
|
||||
If you need to filter keystrokes, add a new handler and intercept the key
|
||||
press message. Since key presses are passed by pointer, you can modify the
|
||||
keystroke and pass it through to the text field widget.
|
||||
|
||||
WARNING: in x-plane before 7.10 (including 6.70) null characters could
|
||||
crash x-plane. To prevent this, wrap this object with a filter function
|
||||
(more instructions can be found on the SDK website).
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
xpWidgetClass_TextField = 4;
|
||||
|
||||
{
|
||||
Text Field Type Values
|
||||
|
||||
These control the look of the text field.
|
||||
}
|
||||
{ A field for text entry. }
|
||||
xpTextEntryField = 0
|
||||
;
|
||||
{ A transparent text field. The user can type and the text is drawn, but no }
|
||||
{ background is drawn. You can draw your own background by adding a widget }
|
||||
{ handler and prehandling the draw message. }
|
||||
xpTextTransparent = 3
|
||||
;
|
||||
{ A translucent edit field, dark gray. }
|
||||
xpTextTranslucent = 4
|
||||
;
|
||||
|
||||
{
|
||||
Text Field Properties
|
||||
|
||||
}
|
||||
{ This is the character position the selection starts at, zero based. If it }
|
||||
{ is the same as the end insertion point, the insertion point is not a }
|
||||
{ selection. }
|
||||
xpProperty_EditFieldSelStart = 1400
|
||||
;
|
||||
{ This is the character position of the end of the selection. }
|
||||
xpProperty_EditFieldSelEnd = 1401
|
||||
;
|
||||
{ This is the character position a drag was started at if the user is }
|
||||
{ dragging to select text, or -1 if a drag is not in progress. }
|
||||
xpProperty_EditFieldSelDragStart = 1402
|
||||
;
|
||||
{ This is the type of text field to display, from the above list. }
|
||||
xpProperty_TextFieldType = 1403
|
||||
;
|
||||
{ Set this property to 1 to password protect the field. Characters will be }
|
||||
{ drawn as *s even though the descriptor will contain plain-text. }
|
||||
xpProperty_PasswordMode = 1404
|
||||
;
|
||||
{ The max number of characters you can enter, if limited. Zero means }
|
||||
{ unlimited. }
|
||||
xpProperty_MaxCharacters = 1405
|
||||
;
|
||||
{ The first visible character on the left. This effectively scrolls the text }
|
||||
{ field. }
|
||||
xpProperty_ScrollPosition = 1406
|
||||
;
|
||||
{ The font to draw the field's text with. (An XPLMFontID.) }
|
||||
xpProperty_Font = 1407
|
||||
;
|
||||
{ This is the active side of the insert selection. (Internal) }
|
||||
xpProperty_ActiveEditSide = 1408
|
||||
;
|
||||
|
||||
{
|
||||
Text Field Messages
|
||||
|
||||
}
|
||||
{ Text Field Messages }
|
||||
{ }
|
||||
{ The text field sends this message to itself when its text changes. It }
|
||||
{ sends the message up the call chain; param1 is the text field's widget ID. }
|
||||
xpMsg_TextFieldChanged = 1400
|
||||
;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* SCROLL BAR
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
A standard scroll bar or slider control. The scroll bar has a minimum,
|
||||
maximum and current value that is updated when the user drags it. The
|
||||
scroll bar sends continuous messages as it is dragged.
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
xpWidgetClass_ScrollBar = 5;
|
||||
|
||||
{
|
||||
Scroll Bar Type Values
|
||||
|
||||
This defines how the scroll bar looks.
|
||||
}
|
||||
{ Scroll bar types. }
|
||||
{ }
|
||||
{ A standard x-plane scroll bar (with arrows on the ends). }
|
||||
xpScrollBarTypeScrollBar = 0
|
||||
;
|
||||
{ A slider, no arrows. }
|
||||
xpScrollBarTypeSlider = 1
|
||||
;
|
||||
|
||||
{
|
||||
Scroll Bar Properties
|
||||
|
||||
}
|
||||
{ The current position of the thumb (in between the min and max, inclusive) }
|
||||
xpProperty_ScrollBarSliderPosition = 1500
|
||||
;
|
||||
{ The value the scroll bar has when the thumb is in the lowest position. }
|
||||
xpProperty_ScrollBarMin = 1501
|
||||
;
|
||||
{ The value the scroll bar has when the thumb is in the highest position. }
|
||||
xpProperty_ScrollBarMax = 1502
|
||||
;
|
||||
{ How many units to moev the scroll bar when clicking next to the thumb. The }
|
||||
{ scroll bar always moves one unit when the arrows are clicked. }
|
||||
xpProperty_ScrollBarPageAmount = 1503
|
||||
;
|
||||
{ The type of scrollbar from the enums above. }
|
||||
xpProperty_ScrollBarType = 1504
|
||||
;
|
||||
{ Used internally. }
|
||||
xpProperty_ScrollBarSlop = 1505
|
||||
;
|
||||
|
||||
{
|
||||
Scroll Bar Messages
|
||||
|
||||
}
|
||||
{ The Scroll Bar sends this message when the slider position changes. It }
|
||||
{ sends the message up the call chain; param1 is the Scroll Bar widget ID. }
|
||||
xpMsg_ScrollBarSliderPositionChanged = 1500
|
||||
;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* CAPTION
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
A caption is a simple widget that shows its descriptor as a string, useful
|
||||
for labeling parts of a window. It always shows its descriptor as its
|
||||
string and is otherwise transparent.
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
xpWidgetClass_Caption = 6;
|
||||
|
||||
{
|
||||
Caption Properties
|
||||
|
||||
}
|
||||
{ This property specifies whether the caption is lit; use lit captions }
|
||||
{ against screens. }
|
||||
xpProperty_CaptionLit = 1600
|
||||
;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* GENERAL GRAPHICS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The general graphics widget can show one of many icons available from
|
||||
x-plane.
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
xpWidgetClass_GeneralGraphics = 7;
|
||||
|
||||
{
|
||||
General Graphics Types Values
|
||||
|
||||
These define the icon for the general graphics.
|
||||
}
|
||||
xpShip = 4
|
||||
;
|
||||
xpILSGlideScope = 5
|
||||
;
|
||||
xpMarkerLeft = 6
|
||||
;
|
||||
xp_Airport = 7
|
||||
;
|
||||
xpNDB = 8
|
||||
;
|
||||
xpVOR = 9
|
||||
;
|
||||
xpRadioTower = 10
|
||||
;
|
||||
xpAircraftCarrier = 11
|
||||
;
|
||||
xpFire = 12
|
||||
;
|
||||
xpMarkerRight = 13
|
||||
;
|
||||
xpCustomObject = 14
|
||||
;
|
||||
xpCoolingTower = 15
|
||||
;
|
||||
xpSmokeStack = 16
|
||||
;
|
||||
xpBuilding = 17
|
||||
;
|
||||
xpPowerLine = 18
|
||||
;
|
||||
xpVORWithCompassRose = 19
|
||||
;
|
||||
xpOilPlatform = 21
|
||||
;
|
||||
xpOilPlatformSmall = 22
|
||||
;
|
||||
xpWayPoint = 23
|
||||
;
|
||||
|
||||
{
|
||||
General Graphics Properties
|
||||
|
||||
}
|
||||
{ This property controls the type of icon that is drawn. }
|
||||
xpProperty_GeneralGraphicsType = 1700
|
||||
;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* PROGRESS INDICATOR
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
This widget implements a progress indicator as seen when x-plane starts up.
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
xpWidgetClass_Progress = 8;
|
||||
|
||||
{
|
||||
Progress Indicator Properties
|
||||
|
||||
}
|
||||
{ This is the current value of the progress indicator. }
|
||||
xpProperty_ProgressPosition = 1800
|
||||
;
|
||||
{ This is the minimum value, equivalent to 0% filled. }
|
||||
xpProperty_ProgressMin = 1801
|
||||
;
|
||||
{ This is the maximum value, equivalent to 100% filled. }
|
||||
xpProperty_ProgressMax = 1802
|
||||
;
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
380
xpcPlugin/SDK/Delphi/Widgets/XPUIGraphics.pas
Executable file
380
xpcPlugin/SDK/Delphi/Widgets/XPUIGraphics.pas
Executable file
@@ -0,0 +1,380 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPUIGraphics;
|
||||
INTERFACE
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
USES XPWidgetDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* UI GRAPHICS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
XPWindowStyle
|
||||
|
||||
There are a few built-in window styles in X-Plane that you can use.
|
||||
|
||||
Note that X-Plane 6 does not offer real shadow-compositing; you must make
|
||||
sure to put a window on top of another window of the right style to the
|
||||
shadows work, etc. This applies to elements with insets and shadows. The
|
||||
rules are:
|
||||
|
||||
Sub windows must go on top of main windows, and screens and list views on
|
||||
top of subwindows. Only help and main windows can be over the main screen.
|
||||
|
||||
|
||||
With X-Plane 7 any window or element may be placed over any other element.
|
||||
|
||||
Some windows are scaled by stretching, some by repeating. The drawing
|
||||
routines know which scaling method to use. The list view cannot be
|
||||
rescaled in x-plane 6 because it has both a repeating pattern and a
|
||||
gradient in one element. All other elements can be rescaled.
|
||||
}
|
||||
TYPE
|
||||
XPWindowStyle = (
|
||||
{ An LCD screen that shows help. }
|
||||
xpWindow_Help = 0
|
||||
|
||||
{ A dialog box window. }
|
||||
,xpWindow_MainWindow = 1
|
||||
|
||||
{ A panel or frame within a dialog box window. }
|
||||
,xpWindow_SubWindow = 2
|
||||
|
||||
{ An LCD screen within a panel to hold text displays. }
|
||||
,xpWindow_Screen = 4
|
||||
|
||||
{ A list view within a panel for scrolling file names, etc. }
|
||||
,xpWindow_ListView = 5
|
||||
|
||||
);
|
||||
PXPWindowStyle = ^XPWindowStyle;
|
||||
|
||||
{
|
||||
XPDrawWindow
|
||||
|
||||
This routine draws a window of the given dimensions at the given offset on
|
||||
the virtual screen in a given style. The window is automatically scaled as
|
||||
appropriate using a bitmap scaling technique (scaling or repeating) as
|
||||
appropriate to the style.
|
||||
}
|
||||
PROCEDURE XPDrawWindow(
|
||||
inX1 : integer;
|
||||
inY1 : integer;
|
||||
inX2 : integer;
|
||||
inY2 : integer;
|
||||
inStyle : XPWindowStyle);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetWindowDefaultDimensions
|
||||
|
||||
This routine returns the default dimensions for a window. Output is either
|
||||
a minimum or fixed value depending on whether the window is scalable.
|
||||
}
|
||||
PROCEDURE XPGetWindowDefaultDimensions(
|
||||
inStyle : XPWindowStyle;
|
||||
outWidth : Pinteger; { Can be nil }
|
||||
outHeight : Pinteger); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPElementStyle
|
||||
|
||||
Elements are individually drawable UI things like push buttons, etc. The
|
||||
style defines what kind of element you are drawing. Elements can be
|
||||
stretched in one or two dimensions (depending on the element). Some
|
||||
elements can be lit.
|
||||
|
||||
In x-plane 6 some elements must be drawn over metal. Some are scalable and
|
||||
some are not. Any element can be drawn anywhere in x-plane 7.
|
||||
|
||||
Scalable Axis Required Background
|
||||
}
|
||||
TYPE
|
||||
XPElementStyle = (
|
||||
{ x metal }
|
||||
xpElement_TextField = 6
|
||||
|
||||
{ none metal }
|
||||
,xpElement_CheckBox = 9
|
||||
|
||||
{ none metal }
|
||||
,xpElement_CheckBoxLit = 10
|
||||
|
||||
{ none window header }
|
||||
,xpElement_WindowCloseBox = 14
|
||||
|
||||
{ none window header }
|
||||
,xpElement_WindowCloseBoxPressed = 15
|
||||
|
||||
{ x metal }
|
||||
,xpElement_PushButton = 16
|
||||
|
||||
{ x metal }
|
||||
,xpElement_PushButtonLit = 17
|
||||
|
||||
{ none any }
|
||||
,xpElement_OilPlatform = 24
|
||||
|
||||
{ none any }
|
||||
,xpElement_OilPlatformSmall = 25
|
||||
|
||||
{ none any }
|
||||
,xpElement_Ship = 26
|
||||
|
||||
{ none any }
|
||||
,xpElement_ILSGlideScope = 27
|
||||
|
||||
{ none any }
|
||||
,xpElement_MarkerLeft = 28
|
||||
|
||||
{ none any }
|
||||
,xpElement_Airport = 29
|
||||
|
||||
{ none any }
|
||||
,xpElement_Waypoint = 30
|
||||
|
||||
{ none any }
|
||||
,xpElement_NDB = 31
|
||||
|
||||
{ none any }
|
||||
,xpElement_VOR = 32
|
||||
|
||||
{ none any }
|
||||
,xpElement_RadioTower = 33
|
||||
|
||||
{ none any }
|
||||
,xpElement_AircraftCarrier = 34
|
||||
|
||||
{ none any }
|
||||
,xpElement_Fire = 35
|
||||
|
||||
{ none any }
|
||||
,xpElement_MarkerRight = 36
|
||||
|
||||
{ none any }
|
||||
,xpElement_CustomObject = 37
|
||||
|
||||
{ none any }
|
||||
,xpElement_CoolingTower = 38
|
||||
|
||||
{ none any }
|
||||
,xpElement_SmokeStack = 39
|
||||
|
||||
{ none any }
|
||||
,xpElement_Building = 40
|
||||
|
||||
{ none any }
|
||||
,xpElement_PowerLine = 41
|
||||
|
||||
{ none metal }
|
||||
,xpElement_CopyButtons = 45
|
||||
|
||||
{ none metal }
|
||||
,xpElement_CopyButtonsWithEditingGrid = 46
|
||||
|
||||
{ x, y metal }
|
||||
,xpElement_EditingGrid = 47
|
||||
|
||||
{ THIS CAN PROBABLY BE REMOVED }
|
||||
,xpElement_ScrollBar = 48
|
||||
|
||||
{ none any }
|
||||
,xpElement_VORWithCompassRose = 49
|
||||
|
||||
{ none metal }
|
||||
,xpElement_Zoomer = 51
|
||||
|
||||
{ x, y metal }
|
||||
,xpElement_TextFieldMiddle = 52
|
||||
|
||||
{ none metal }
|
||||
,xpElement_LittleDownArrow = 53
|
||||
|
||||
{ none metal }
|
||||
,xpElement_LittleUpArrow = 54
|
||||
|
||||
{ none metal }
|
||||
,xpElement_WindowDragBar = 61
|
||||
|
||||
{ none metal }
|
||||
,xpElement_WindowDragBarSmooth = 62
|
||||
|
||||
);
|
||||
PXPElementStyle = ^XPElementStyle;
|
||||
|
||||
{
|
||||
XPDrawElement
|
||||
|
||||
XPDrawElement draws a given element at an offset on the virtual screen in
|
||||
set dimensions. EVEN if the element is not scalable, it will be scaled if
|
||||
the width and height do not match the preferred dimensions; it'll just look
|
||||
ugly. Pass inLit to see the lit version of the element; if the element
|
||||
cannot be lit this is ignored.
|
||||
}
|
||||
PROCEDURE XPDrawElement(
|
||||
inX1 : integer;
|
||||
inY1 : integer;
|
||||
inX2 : integer;
|
||||
inY2 : integer;
|
||||
inStyle : XPElementStyle;
|
||||
inLit : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetElementDefaultDimensions
|
||||
|
||||
This routine returns the recommended or minimum dimensions of a given UI
|
||||
element. outCanBeLit tells whether the element has both a lit and unlit
|
||||
state. Pass NULL to not receive any of these parameters.
|
||||
}
|
||||
PROCEDURE XPGetElementDefaultDimensions(
|
||||
inStyle : XPElementStyle;
|
||||
outWidth : Pinteger; { Can be nil }
|
||||
outHeight : Pinteger; { Can be nil }
|
||||
outCanBeLit : Pinteger); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPTrackStyle
|
||||
|
||||
A track is a UI element that displays a value vertically or horizontally.
|
||||
X-Plane has three kinds of tracks: scroll bars, sliders, and progress bars.
|
||||
Tracks can be displayed either horizontally or vertically; tracks will
|
||||
choose their own layout based on the larger dimension of their dimensions
|
||||
(e.g. they know if they are tall or wide). Sliders may be lit or unlit
|
||||
(showing the user manipulating them).
|
||||
|
||||
ScrollBar - this is a standard scroll bar with arrows and a thumb to drag.
|
||||
Slider - this is a simple track with a ball in the middle that can be
|
||||
slid. Progress - this is a progress indicator showing how a long task is
|
||||
going.
|
||||
}
|
||||
TYPE
|
||||
XPTrackStyle = (
|
||||
{ not over metal can be lit can be rotated }
|
||||
xpTrack_ScrollBar = 0
|
||||
|
||||
{ over metal can be lit can be rotated }
|
||||
,xpTrack_Slider = 1
|
||||
|
||||
{ over metal cannot be lit cannot be rotated }
|
||||
,xpTrack_Progress = 2
|
||||
|
||||
);
|
||||
PXPTrackStyle = ^XPTrackStyle;
|
||||
|
||||
{
|
||||
XPDrawTrack
|
||||
|
||||
This routine draws a track. You pass in the track dimensions and size; the
|
||||
track picks the optimal orientation for these dimensions. Pass in the
|
||||
track's minimum current and maximum values; the indicator will be
|
||||
positioned appropriately. You can also specify whether the track is lit or
|
||||
not.
|
||||
}
|
||||
PROCEDURE XPDrawTrack(
|
||||
inX1 : integer;
|
||||
inY1 : integer;
|
||||
inX2 : integer;
|
||||
inY2 : integer;
|
||||
inMin : integer;
|
||||
inMax : integer;
|
||||
inValue : integer;
|
||||
inTrackStyle : XPTrackStyle;
|
||||
inLit : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetTrackDefaultDimensions
|
||||
|
||||
This routine returns a track's default smaller dimension; all tracks are
|
||||
scalable in the larger dimension. It also returns whether a track can be
|
||||
lit.
|
||||
}
|
||||
PROCEDURE XPGetTrackDefaultDimensions(
|
||||
inStyle : XPTrackStyle;
|
||||
outWidth : Pinteger;
|
||||
outCanBeLit : Pinteger);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetTrackMetrics
|
||||
|
||||
This routine returns the metrics of a track. If you want to write UI code
|
||||
to manipulate a track, this routine helps you know where the mouse
|
||||
locations are. For most other elements, the rectangle the element is drawn
|
||||
in is enough information. However, the scrollbar drawing routine does some
|
||||
automatic placement; this routine lets you know where things ended up. You
|
||||
pass almost everything you would pass to the draw routine. You get out the
|
||||
orientation, and other useful stuff.
|
||||
|
||||
Besides orientation, you get five dimensions for the five parts of a
|
||||
scrollbar, which are the down button, down area (area before the thumb),
|
||||
the thumb, and the up area and button. For horizontal scrollers, the left
|
||||
button decreases; for vertical scrollers, the top button decreases.
|
||||
}
|
||||
PROCEDURE XPGetTrackMetrics(
|
||||
inX1 : integer;
|
||||
inY1 : integer;
|
||||
inX2 : integer;
|
||||
inY2 : integer;
|
||||
inMin : integer;
|
||||
inMax : integer;
|
||||
inValue : integer;
|
||||
inTrackStyle : XPTrackStyle;
|
||||
outIsVertical : Pinteger;
|
||||
outDownBtnSize : Pinteger;
|
||||
outDownPageSize : Pinteger;
|
||||
outThumbSize : Pinteger;
|
||||
outUpPageSize : Pinteger;
|
||||
outUpBtnSize : Pinteger);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
441
xpcPlugin/SDK/Delphi/Widgets/XPWidgetDefs.pas
Executable file
441
xpcPlugin/SDK/Delphi/Widgets/XPWidgetDefs.pas
Executable file
@@ -0,0 +1,441 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPWidgetDefs;
|
||||
INTERFACE
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* WIDGET DEFINITIONS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
A widget is a call-back driven screen entity like a push-button, window,
|
||||
text entry field, etc.
|
||||
|
||||
Use the widget API to create widgets of various classes. You can nest them
|
||||
into trees of widgets to create complex user interfaces.
|
||||
}
|
||||
|
||||
|
||||
|
||||
TYPE
|
||||
{
|
||||
XPWidgetID
|
||||
|
||||
A Widget ID is an opaque unique non-zero handle identifying your widget.
|
||||
Use 0 to specify "no widget". This type is defined as wide enough to hold
|
||||
a pointer. You receive a widget ID when you create a new widget and then
|
||||
use that widget ID to further refer to the widget.
|
||||
}
|
||||
XPWidgetID = pointer;
|
||||
PXPWidgetID = ^XPWidgetID;
|
||||
|
||||
{
|
||||
XPWidgetPropertyID
|
||||
|
||||
Properties are values attached to instances of your widgets. A property is
|
||||
identified by a 32-bit ID and its value is the width of a pointer.
|
||||
|
||||
Each widget instance may have a property or not have it. When you set a
|
||||
property on a widget for the first time, the property is added to the
|
||||
widget; it then stays there for the life of the widget.
|
||||
|
||||
Some property IDs are predefined by the widget package; you can make up
|
||||
your own property IDs as well.
|
||||
}
|
||||
XPWidgetPropertyID = (
|
||||
{ A window's refcon is an opaque value used by client code to find other data }
|
||||
{ based on it. }
|
||||
xpProperty_Refcon = 0
|
||||
|
||||
{ These properties are used by the utlities to implement dragging. }
|
||||
,xpProperty_Dragging = 1
|
||||
|
||||
,xpProperty_DragXOff = 2
|
||||
|
||||
,xpProperty_DragYOff = 3
|
||||
|
||||
{ Is the widget hilited? (For widgets that support this kind of thing.) }
|
||||
,xpProperty_Hilited = 4
|
||||
|
||||
{ Is there a C++ object attached to this widget? }
|
||||
,xpProperty_Object = 5
|
||||
|
||||
{ If this property is 1, the widget package will use OpenGL to restrict }
|
||||
{ drawing to the Wiget's exposed rectangle. }
|
||||
,xpProperty_Clip = 6
|
||||
|
||||
{ Is this widget enabled (for those that have a disabled state too)? }
|
||||
,xpProperty_Enabled = 7
|
||||
|
||||
{ NOTE: Property IDs 1 - 999 are reserved for the widget's library. }
|
||||
{ }
|
||||
{ NOTE: Property IDs 1000 - 9999 are allocated to the standard widget classes }
|
||||
{ provided with the library Properties 1000 - 1099 are for widget class 0, }
|
||||
{ 1100 - 1199 for widget class 1, etc. }
|
||||
,xpProperty_UserStart = 10000
|
||||
|
||||
);
|
||||
PXPWidgetPropertyID = ^XPWidgetPropertyID;
|
||||
|
||||
{
|
||||
XPMouseState_t
|
||||
|
||||
When the mouse is clicked or dragged, a pointer to this structure is passed
|
||||
to your widget function.
|
||||
}
|
||||
XPMouseState_t = RECORD
|
||||
x : integer;
|
||||
y : integer;
|
||||
{ Mouse Button number, left = 0 (right button not yet supported. }
|
||||
button : integer;
|
||||
{$IFDEF XPLM200}
|
||||
{ Scroll wheel delta (button in this case would be the wheel axis number). }
|
||||
delta : integer;
|
||||
{$ENDIF}
|
||||
END;
|
||||
PXPMouseState_t = ^XPMouseState_t;
|
||||
|
||||
{
|
||||
XPKeyState_t
|
||||
|
||||
When a key is pressed, a pointer to this struct is passed to your widget
|
||||
function.
|
||||
}
|
||||
XPKeyState_t = RECORD
|
||||
{ The ASCII key that was pressed. WARNING: this may be 0 for some non-ASCII }
|
||||
{ key sequences. }
|
||||
key : char;
|
||||
{ The flags. Make sure to check this if you only want key-downs! }
|
||||
flags : XPLMKeyFlags;
|
||||
{ The virtual key code for the key }
|
||||
vkey : char;
|
||||
END;
|
||||
PXPKeyState_t = ^XPKeyState_t;
|
||||
|
||||
{
|
||||
XPWidgetGeometryChange_t
|
||||
|
||||
This structure contains the deltas for your widget's geometry when it
|
||||
changes.
|
||||
}
|
||||
XPWidgetGeometryChange_t = RECORD
|
||||
dx : integer;
|
||||
{ +Y = the widget moved up }
|
||||
dy : integer;
|
||||
dwidth : integer;
|
||||
dheight : integer;
|
||||
END;
|
||||
PXPWidgetGeometryChange_t = ^XPWidgetGeometryChange_t;
|
||||
|
||||
{
|
||||
XPDispatchMode
|
||||
|
||||
The dispatching modes describe how the widgets library sends out messages.
|
||||
Currently there are three modes:
|
||||
}
|
||||
XPDispatchMode = (
|
||||
{ The message will only be sent to the target widget. }
|
||||
xpMode_Direct = 0
|
||||
|
||||
{ The message is sent to the target widget, then up the chain of parents }
|
||||
{ until the message is handled or a parentless widget is reached. }
|
||||
,xpMode_UpChain = 1
|
||||
|
||||
{ The message is sent to the target widget and then all of its children }
|
||||
{ recursively depth-first. }
|
||||
,xpMode_Recursive = 2
|
||||
|
||||
{ The message is snet just to the target, but goes to every callback, even if }
|
||||
{ it is handled. }
|
||||
,xpMode_DirectAllCallbacks = 3
|
||||
|
||||
{ The message is only sent to the very first handler even if it is not }
|
||||
{ accepted. (This is really only useful for some internal Widget Lib }
|
||||
{ functions. }
|
||||
,xpMode_Once = 4
|
||||
|
||||
);
|
||||
PXPDispatchMode = ^XPDispatchMode;
|
||||
|
||||
{
|
||||
XPWidgetClass
|
||||
|
||||
Widget classes define predefined widget types. A widget class basically
|
||||
specifies from a library the widget function to be used for the widget.
|
||||
Most widgets can be made right from classes.
|
||||
}
|
||||
XPWidgetClass = integer;
|
||||
PXPWidgetClass = ^XPWidgetClass;
|
||||
|
||||
CONST
|
||||
{ An unspecified widget class. Other widget classes are in }
|
||||
{ XPStandardWidgets.h }
|
||||
xpWidgetClass_None = 0;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* WIDGET MESSAGES
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
XPWidgetMessage
|
||||
|
||||
Widgets receive 32-bit messages indicating what action is to be taken or
|
||||
notifications of events. The list of messages may be expanded.
|
||||
}
|
||||
TYPE
|
||||
XPWidgetMessage = (
|
||||
{ No message, should not be sent. }
|
||||
xpMsg_None = 0
|
||||
|
||||
{ The create message is sent once per widget that is created with your widget }
|
||||
{ function and once for any widget that has your widget function attached. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
{ }
|
||||
{ Param 1: 1 if you are being added as a subclass, 0 if the widget is first }
|
||||
{ being created. }
|
||||
,xpMsg_Create = 1
|
||||
|
||||
{ The destroy message is sent once for each message that is destroyed that }
|
||||
{ has your widget function. }
|
||||
{ }
|
||||
{ Dispatching: Direct for all }
|
||||
{ }
|
||||
{ Param 1: 1 if being deleted by a recursive delete to the parent, 0 for }
|
||||
{ explicit deletion. }
|
||||
,xpMsg_Destroy = 2
|
||||
|
||||
{ The paint message is sent to your widget to draw itself. The paint message }
|
||||
{ is the bare-bones message; in response you must draw yourself, draw your }
|
||||
{ children, set up clipping and culling, check for visibility, etc. If you }
|
||||
{ don't want to do all of this, ignore the paint message and a draw message }
|
||||
{ (see below) will be sent to you. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
,xpMsg_Paint = 3
|
||||
|
||||
{ The draw message is sent to your widget when it is time to draw yourself. }
|
||||
{ OpenGL will be set up to draw in 2-d global screen coordinates, but you }
|
||||
{ should use the XPLM to set up OpenGL state. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
,xpMsg_Draw = 4
|
||||
|
||||
{ The key press message is sent once per key that is pressed. The first }
|
||||
{ parameter is the type of key code (integer or char) and the second is the }
|
||||
{ code itself. By handling this event, you consume the key stroke. }
|
||||
{ }
|
||||
{ Handling this message 'consumes' the keystroke; not handling it passes it }
|
||||
{ to your parent widget. }
|
||||
{ }
|
||||
{ Dispatching: Up Chain }
|
||||
{ }
|
||||
{ : Param 1: A pointer to an XPKeyState_t structure with the keystroke. }
|
||||
,xpMsg_KeyPress = 5
|
||||
|
||||
{ Keyboard focus is being given to you. By handling this message you accept }
|
||||
{ keyboard focus. The first parameter will be one if a child of yours gave }
|
||||
{ up focus to you, 0 if someone set focus on you explicitly. }
|
||||
{ }
|
||||
{ : Handling this message accepts focus; not handling refuses focus. }
|
||||
{ }
|
||||
{ Dispatching: direct }
|
||||
{ }
|
||||
{ Param 1: 1 if you are gaining focus because your child is giving it up, 0 }
|
||||
{ if someone is explicitly giving you focus. }
|
||||
,xpMsg_KeyTakeFocus = 6
|
||||
|
||||
{ Keyboard focus is being taken away from you. The first parameter will be }
|
||||
{ one if you are losing focus because another widget is taking it, or 0 if }
|
||||
{ someone called the API to make you lose focus explicitly. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
{ }
|
||||
{ Param 1: 1 if focus is being taken by another widget, 0 if code requested }
|
||||
{ to remove focus. }
|
||||
,xpMsg_KeyLoseFocus = 7
|
||||
|
||||
{ You receive one mousedown event per click with a mouse-state structure }
|
||||
{ pointed to by parameter 1, by accepting this you eat the click, otherwise }
|
||||
{ your parent gets it. You will not receive drag and mouse up messages if }
|
||||
{ you do not accept the down message. }
|
||||
{ }
|
||||
{ Handling this message consumes the mouse click, not handling it passes it }
|
||||
{ to the next widget. You can act 'transparent' as a window by never handling }
|
||||
{ moues clicks to certain areas. }
|
||||
{ }
|
||||
{ Dispatching: Up chain NOTE: Technically this is direct dispatched, but the }
|
||||
{ widgets library will shop it to each widget until one consumes the click, }
|
||||
{ making it effectively "up chain". }
|
||||
{ }
|
||||
{ Param 1: A pointer to an XPMouseState_t containing the mouse status. }
|
||||
,xpMsg_MouseDown = 8
|
||||
|
||||
{ You receive a series of mouse drag messages (typically one per frame in the }
|
||||
{ sim) as the mouse is moved once you have accepted a mouse down message. }
|
||||
{ Parameter one points to a mouse-state structure describing the mouse }
|
||||
{ location. You will continue to receive these until the mouse button is }
|
||||
{ released. You may receive multiple mouse state messages with the same mouse }
|
||||
{ position. You will receive mouse drag events even if the mouse is dragged }
|
||||
{ out of your current or original bounds at the time of the mouse down. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
{ }
|
||||
{ Param 1: A pointer to an XPMouseState_t containing the mouse status. }
|
||||
,xpMsg_MouseDrag = 9
|
||||
|
||||
{ The mouseup event is sent once when the mouse button is released after a }
|
||||
{ drag or click. You only receive this message if you accept the mouseDown }
|
||||
{ message. Parameter one points to a mouse state structure. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
{ }
|
||||
{ Param 1: A pointer to an XPMouseState_t containing the mouse status. }
|
||||
,xpMsg_MouseUp = 10
|
||||
|
||||
{ Your geometry or a child's geometry is being changed. }
|
||||
{ }
|
||||
{ Dispatching: Up chain }
|
||||
{ }
|
||||
{ Param 1: The widget ID of the original reshaped target. }
|
||||
{ }
|
||||
{ Param 2: A pointer to a XPWidgetGeometryChange_t struct describing the }
|
||||
{ change. }
|
||||
,xpMsg_Reshape = 11
|
||||
|
||||
{ Your exposed area has changed. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
,xpMsg_ExposedChanged = 12
|
||||
|
||||
{ A child has been added to you. The child's ID is passed in parameter one. }
|
||||
{ }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
{ }
|
||||
{ Param 1: The Widget ID of the child being added. }
|
||||
,xpMsg_AcceptChild = 13
|
||||
|
||||
{ A child has been removed from to you. The child's ID is passed in }
|
||||
{ parameter one. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
{ }
|
||||
{ Param 1: The Widget ID of the child being removed. }
|
||||
,xpMsg_LoseChild = 14
|
||||
|
||||
{ You now have a new parent, or have no parent. The parent's ID is passed }
|
||||
{ in, or 0 for no parent. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
{ }
|
||||
{ Param 1: The Widget ID of your parent }
|
||||
,xpMsg_AcceptParent = 15
|
||||
|
||||
{ You or a child has been shown. Note that this does not include you being }
|
||||
{ shown because your parent was shown, you were put in a new parent, your }
|
||||
{ root was shown, etc. }
|
||||
{ }
|
||||
{ Dispatching: Up chain }
|
||||
{ }
|
||||
{ Param 1: The widget ID of the shown widget. }
|
||||
,xpMsg_Shown = 16
|
||||
|
||||
{ You have been hidden. See limitations above. }
|
||||
{ }
|
||||
{ Dispatching: Up chain }
|
||||
{ }
|
||||
{ Param 1: The widget ID of the hidden widget. }
|
||||
,xpMsg_Hidden = 17
|
||||
|
||||
{ Your descriptor has changed. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
,xpMsg_DescriptorChanged = 18
|
||||
|
||||
{ A property has changed. Param 1 contains the property ID. }
|
||||
{ }
|
||||
{ Dispatching: Direct }
|
||||
{ }
|
||||
{ Param 1: The Property ID being changed. }
|
||||
{ }
|
||||
{ Param 2: The new property value }
|
||||
,xpMsg_PropertyChanged = 19
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{ The mouse wheel has moved. }
|
||||
{ }
|
||||
{ Return 1 to consume the mouse wheel move, or 0 to pass the message to a }
|
||||
{ parent. Dispatching: Up chain }
|
||||
{ }
|
||||
{ Param 1: A pointer to an XPMouseState_t containing the mouse status. }
|
||||
,xpMsg_MouseWheel = 20
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{ The cursor is over your widget. If you consume this message, change the }
|
||||
{ XPLMCursorStatus value to indicate the desired result, with the same rules }
|
||||
{ as in XPLMDisplay.h. }
|
||||
{ }
|
||||
{ Return 1 to consume this message, 0 to pass it on. }
|
||||
{ }
|
||||
{ Dispatching: Up chain Param 1: A pointer to an XPMouseState_t struct }
|
||||
{ containing the mouse status. }
|
||||
{ }
|
||||
{ Param 2: A pointer to a XPLMCursorStatus - set this to the cursor result }
|
||||
{ you desire. }
|
||||
,xpMsg_CursorAdjust = 21
|
||||
{$ENDIF}
|
||||
|
||||
{ NOTE: Message IDs 1000 - 9999 are allocated to the standard widget classes }
|
||||
{ provided with the library with 1000 - 1099 for widget class 0, 1100 - 1199 }
|
||||
{ for widget class 1, etc. Message IDs 10,000 and beyond are for plugin use. }
|
||||
,xpMsg_UserStart = 10000
|
||||
|
||||
);
|
||||
PXPWidgetMessage = ^XPWidgetMessage;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* WIDGET CALLBACK FUNCTION
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
XPWidgetFunc_t
|
||||
|
||||
This function defines your custom widget's behavior. It will be called by
|
||||
the widgets library to send messages to your widget. The message and
|
||||
widget ID are passed in, as well as two ptr-width signed parameters whose
|
||||
meaning varies with the message. Return 1 to indicate that you have
|
||||
processed the message, 0 to indicate that you have not. For any message
|
||||
that is not understood, return 0.
|
||||
}
|
||||
TYPE
|
||||
XPWidgetFunc_t = FUNCTION(
|
||||
inMessage : XPWidgetMessage;
|
||||
inWidget : XPWidgetID;
|
||||
inParam1 : intptr_t;
|
||||
inParam2 : intptr_t) : integer; cdecl;
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
225
xpcPlugin/SDK/Delphi/Widgets/XPWidgetUtils.pas
Executable file
225
xpcPlugin/SDK/Delphi/Widgets/XPWidgetUtils.pas
Executable file
@@ -0,0 +1,225 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPWidgetUtils;
|
||||
INTERFACE
|
||||
{
|
||||
XPWidgetUtils - USAGE NOTES
|
||||
|
||||
The XPWidgetUtils library contains useful functions that make writing and
|
||||
using widgets less of a pain.
|
||||
|
||||
One set of functions are the widget behavior functions. These functions
|
||||
each add specific useful behaviors to widgets. They can be used in two
|
||||
manners:
|
||||
|
||||
1. You can add a widget behavior function to a widget as a callback proc
|
||||
using the XPAddWidgetCallback function. The widget will gain that
|
||||
behavior. Remember that the last function you add has highest priority.
|
||||
You can use this to change or augment the behavior of an existing finished
|
||||
widget.
|
||||
|
||||
2. You can call a widget function from inside your own widget function.
|
||||
This allows you to include useful behaviors in custom-built widgets. A
|
||||
number of the standard widgets get their behavior from this library. To do
|
||||
this, call the behavior function from your function first. If it returns
|
||||
1, that means it handled the event and you don't need to; simply return 1.
|
||||
}
|
||||
|
||||
USES XPWidgetDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* GENERAL UTILITIES
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPWidgetCreate_t
|
||||
|
||||
This structure contains all of the parameters needed to create a wiget. It
|
||||
is used with XPUCreateWidgets to create widgets in bulk from an array. All
|
||||
parameters correspond to those of XPCreateWidget except for the container
|
||||
index. If the container index is equal to the index of a widget in the
|
||||
array, the widget in the array passed to XPUCreateWidgets is used as the
|
||||
parent of this widget. Note that if you pass an index greater than your
|
||||
own position in the array, the parent you are requesting will not exist
|
||||
yet. If the container index is NO_PARENT, the parent widget is specified as
|
||||
NULL. If the container index is PARAM_PARENT, the widget passed into
|
||||
XPUCreateWidgets is used.
|
||||
}
|
||||
TYPE
|
||||
XPWidgetCreate_t = RECORD
|
||||
left : integer;
|
||||
top : integer;
|
||||
right : integer;
|
||||
bottom : integer;
|
||||
visible : integer;
|
||||
descriptor : Pchar;
|
||||
isRoot : integer;
|
||||
containerIndex : integer;
|
||||
widgetClass : XPWidgetClass;
|
||||
END;
|
||||
PXPWidgetCreate_t = ^XPWidgetCreate_t;
|
||||
|
||||
CONST
|
||||
NO_PARENT = -1;
|
||||
|
||||
PARAM_PARENT = -2;
|
||||
|
||||
|
||||
{
|
||||
XPUCreateWidgets
|
||||
|
||||
This function creates a series of widgets from a table...see
|
||||
XPCreateWidget_t above. Pass in an array of widget creation structures and
|
||||
an array of widget IDs that will receive each widget.
|
||||
|
||||
Widget parents are specified by index into the created widget table,
|
||||
allowing you to create nested widget structures. You can create multiple
|
||||
widget trees in one table. Generally you should create widget trees from
|
||||
the top down.
|
||||
|
||||
You can also pass in a widget ID that will be used when the widget's parent
|
||||
is listed as PARAM_PARENT; this allows you to embed widgets created with
|
||||
XPUCreateWidgets in a widget created previously.
|
||||
}
|
||||
PROCEDURE XPUCreateWidgets(
|
||||
inWidgetDefs : PXPWidgetCreate_t;
|
||||
inCount : integer;
|
||||
inParamParent : XPWidgetID;
|
||||
ioWidgets : PXPWidgetID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPUMoveWidgetBy
|
||||
|
||||
Simply moves a widget by an amount, +x = right, +y=up, without resizing the
|
||||
widget.
|
||||
}
|
||||
PROCEDURE XPUMoveWidgetBy(
|
||||
inWidget : XPWidgetID;
|
||||
inDeltaX : integer;
|
||||
inDeltaY : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* LAYOUT MANAGERS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The layout managers are widget behavior functions for handling where
|
||||
widgets move. Layout managers can be called from a widget function or
|
||||
attached to a widget later.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPUFixedLayout
|
||||
|
||||
This function causes the widget to maintain its children in fixed position
|
||||
relative to itself as it is resized. Use this on the top level 'window'
|
||||
widget for your window.
|
||||
}
|
||||
FUNCTION XPUFixedLayout(
|
||||
inMessage : XPWidgetMessage;
|
||||
inWidget : XPWidgetID;
|
||||
inParam1 : intptr_t;
|
||||
inParam2 : intptr_t) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* WIDGET PROC BEHAVIORS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These widget behavior functions add other useful behaviors to widgets.
|
||||
These functions cannot be attached to a widget; they must be called from
|
||||
your widget function.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPUSelectIfNeeded
|
||||
|
||||
This causes the widget to bring its window to the foreground if it is not
|
||||
already. inEatClick specifies whether clicks in the background should be
|
||||
consumed by bringin the window to the foreground.
|
||||
}
|
||||
FUNCTION XPUSelectIfNeeded(
|
||||
inMessage : XPWidgetMessage;
|
||||
inWidget : XPWidgetID;
|
||||
inParam1 : intptr_t;
|
||||
inParam2 : intptr_t;
|
||||
inEatClick : integer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPUDefocusKeyboard
|
||||
|
||||
This causes a click in the widget to send keyboard focus back to X-Plane.
|
||||
This stops editing of any text fields, etc.
|
||||
}
|
||||
FUNCTION XPUDefocusKeyboard(
|
||||
inMessage : XPWidgetMessage;
|
||||
inWidget : XPWidgetID;
|
||||
inParam1 : intptr_t;
|
||||
inParam2 : intptr_t;
|
||||
inEatClick : integer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPUDragWidget
|
||||
|
||||
XPUDragWidget drags the widget in response to mouse clicks. Pass in not
|
||||
only the event, but the global coordinates of the drag region, which might
|
||||
be a sub-region of your widget (for example, a title bar).
|
||||
}
|
||||
FUNCTION XPUDragWidget(
|
||||
inMessage : XPWidgetMessage;
|
||||
inWidget : XPWidgetID;
|
||||
inParam1 : intptr_t;
|
||||
inParam2 : intptr_t;
|
||||
inLeft : integer;
|
||||
inTop : integer;
|
||||
inRight : integer;
|
||||
inBottom : integer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
665
xpcPlugin/SDK/Delphi/Widgets/XPWidgets.pas
Executable file
665
xpcPlugin/SDK/Delphi/Widgets/XPWidgets.pas
Executable file
@@ -0,0 +1,665 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPWidgets;
|
||||
INTERFACE
|
||||
{
|
||||
WIDGETS - THEORY OF OPERATION AND NOTES
|
||||
|
||||
Widgets are persistent view 'objects' for X-Plane. A widget is an object
|
||||
referenced by its opaque handle (widget ID) and the APIs in this file. You
|
||||
cannot access the widget's guts directly. Every Widget has the following
|
||||
intrinsic data:
|
||||
|
||||
- A bounding box defined in global screen coordinates with 0,0 in the
|
||||
bottom left and +y = up, +x = right.
|
||||
|
||||
- A visible box, which is the intersection of the bounding box with the
|
||||
widget's parents visible box.
|
||||
|
||||
- Zero or one parent widgets. (Always zero if the widget is a root widget.
|
||||
|
||||
|
||||
- Zero or more child widgets.
|
||||
|
||||
- Whether the widget is a root. Root widgets are the top level plugin
|
||||
windows.
|
||||
|
||||
- Whether the widget is visible.
|
||||
|
||||
- A text string descriptor, whose meaning varies from widget to widget.
|
||||
|
||||
- An arbitrary set of 32 bit integral properties defined by 32-bit integral
|
||||
keys. This is how specific widgets
|
||||
|
||||
store specific data.
|
||||
|
||||
- A list of widget callbacks proc that implements the widgets behaviors.
|
||||
|
||||
The Widgets library sends messages to widgets to request specific behaviors
|
||||
or notify the widget of things.
|
||||
|
||||
Widgets may have more than one callback function, in which case messages
|
||||
are sent to the most recently added callback function until the message is
|
||||
handled. Messages may also be sent to parents or children; see the
|
||||
XPWidgetDefs.h header file for the different widget message dispatching
|
||||
functions. By adding a callback function to a window you can 'subclass'
|
||||
its behavior.
|
||||
|
||||
A set of standard widgets are provided that serve common UI purposes. You
|
||||
can also customize or implement entirely custom widgets.
|
||||
|
||||
Widgets are different than other view hierarchies (most notably Win32,
|
||||
which they bear a striking resemblance to) in the following ways:
|
||||
|
||||
- Not all behavior can be patched. State that is managed by the XPWidgets
|
||||
DLL and not by individual widgets cannot be customized.
|
||||
|
||||
- All coordinates are in global screen coordinates. Coordinates are not
|
||||
relative to an enclosing widget, nor are they relative to a display window.
|
||||
|
||||
|
||||
- Widget messages are always dispatched synchronously, and there is no
|
||||
concept of scheduling an update or a dirty region. Messages originate from
|
||||
X-Plane as the sim cycle goes by. Since x-plane is constantly redrawing,
|
||||
so are widgets; there is no need to mark a part of a widget as 'needing
|
||||
redrawing' because redrawing happens frequently whether the widget needs it
|
||||
or not.
|
||||
|
||||
- Any widget may be a 'root' widget, causing it to be drawn; there is no
|
||||
relationship between widget class and rootness. Root widgets are
|
||||
imlemented as XPLMDisply windows.
|
||||
}
|
||||
|
||||
USES XPWidgetDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* WIDGET CREATION AND MANAGEMENT
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
XPCreateWidget
|
||||
|
||||
This function creates a new widget and returns the new widget's ID to you.
|
||||
If the widget creation fails for some reason, it returns NULL. Widget
|
||||
creation will fail either if you pass a bad class ID or if there is not
|
||||
adequate memory.
|
||||
|
||||
Input Parameters:
|
||||
|
||||
- Top, left, bottom, and right in global screen coordinates defining the
|
||||
widget's location on the screen.
|
||||
|
||||
- inVisible is 1 if the widget should be drawn, 0 to start the widget as
|
||||
hidden.
|
||||
|
||||
- inDescriptor is a null terminated string that will become the widget's
|
||||
descriptor.
|
||||
|
||||
- inIsRoot is 1 if this is going to be a root widget, 0 if it will not be.
|
||||
|
||||
- inContainer is the ID of this widget's container. It must be 0 for a
|
||||
root widget. for a non-root widget, pass the widget ID of the widget to
|
||||
place this widget within. If this widget is not going to start inside
|
||||
another widget, pass 0; this new widget will then just be floating off in
|
||||
space (and will not be drawn until it is placed in a widget.
|
||||
|
||||
- inClass is the class of the widget to draw. Use one of the predefined
|
||||
class-IDs to create a standard widget.
|
||||
|
||||
A note on widget embedding: a widget is only called (and will be drawn,
|
||||
etc.) if it is placed within a widget that will be called. Root widgets
|
||||
are always called. So it is possible to have whole chains of widgets that
|
||||
are simply not called. You can preconstruct widget trees and then place
|
||||
them into root widgets later to activate them if you wish.
|
||||
}
|
||||
FUNCTION XPCreateWidget(
|
||||
inLeft : integer;
|
||||
inTop : integer;
|
||||
inRight : integer;
|
||||
inBottom : integer;
|
||||
inVisible : integer;
|
||||
inDescriptor : Pchar;
|
||||
inIsRoot : integer;
|
||||
inContainer : XPWidgetID;
|
||||
inClass : XPWidgetClass) : XPWidgetID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPCreateCustomWidget
|
||||
|
||||
This function is the same as XPCreateWidget except that instead of passing
|
||||
a class ID, you pass your widget callback function pointer defining the
|
||||
widget. Use this function to define a custom widget. All parameters are
|
||||
the same as XPCreateWidget, except that the widget class has been replaced
|
||||
with the widget function.
|
||||
}
|
||||
FUNCTION XPCreateCustomWidget(
|
||||
inLeft : integer;
|
||||
inTop : integer;
|
||||
inRight : integer;
|
||||
inBottom : integer;
|
||||
inVisible : integer;
|
||||
inDescriptor : Pchar;
|
||||
inIsRoot : integer;
|
||||
inContainer : XPWidgetID;
|
||||
inCallback : XPWidgetFunc_t) : XPWidgetID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPDestroyWidget
|
||||
|
||||
This class destroys a widget. Pass in the ID of the widget to kill. If
|
||||
you pass 1 for inDestroyChilren, the widget's children will be destroyed
|
||||
first, then this widget will be destroyed. (Furthermore, the widget's
|
||||
children will be destroyed with the inDestroyChildren flag set to 1, so the
|
||||
destruction will recurse down the widget tree.) If you pass 0 for this
|
||||
flag, the child widgets will simply end up with their parent set to 0.
|
||||
}
|
||||
PROCEDURE XPDestroyWidget(
|
||||
inWidget : XPWidgetID;
|
||||
inDestroyChildren : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPSendMessageToWidget
|
||||
|
||||
This sends any message to a widget. You should probably not go around
|
||||
simulating the predefined messages that the widgets library defines for
|
||||
you. You may however define custom messages for your widgets and send them
|
||||
with this method.
|
||||
|
||||
This method supports several dispatching patterns; see XPDispatchMode for
|
||||
more info. The function returns 1 if the message was handled, 0 if it was
|
||||
not.
|
||||
|
||||
For each widget that receives the message (see the dispatching modes), each
|
||||
widget function from the most recently installed to the oldest one
|
||||
receives the message in order until it is handled.
|
||||
}
|
||||
FUNCTION XPSendMessageToWidget(
|
||||
inWidget : XPWidgetID;
|
||||
inMessage : XPWidgetMessage;
|
||||
inMode : XPDispatchMode;
|
||||
inParam1 : intptr_t;
|
||||
inParam2 : intptr_t) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* WIDGET POSITIONING AND VISIBILITY
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
XPPlaceWidgetWithin
|
||||
|
||||
This function changes which container a widget resides in. You may NOT use
|
||||
this function on a root widget! inSubWidget is the widget that will be
|
||||
moved. Pass a widget ID in inContainer to make inSubWidget be a child of
|
||||
inContainer. It will become the last/closest widget in the container.
|
||||
Pass 0 to remove the widget from any container. Any call to this other
|
||||
than passing the widget ID of the old parent of the affected widget will
|
||||
cause the widget to be removed from its old parent. Placing a widget within
|
||||
its own parent simply makes it the last widget.
|
||||
|
||||
NOTE: this routine does not reposition the sub widget in global
|
||||
coordinates. If the container has layout management code, it will
|
||||
reposition the subwidget for you, otherwise you must do it with
|
||||
SetWidgetGeometry.
|
||||
}
|
||||
PROCEDURE XPPlaceWidgetWithin(
|
||||
inSubWidget : XPWidgetID;
|
||||
inContainer : XPWidgetID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPCountChildWidgets
|
||||
|
||||
This routine returns the number of widgets another widget contains.
|
||||
}
|
||||
FUNCTION XPCountChildWidgets(
|
||||
inWidget : XPWidgetID) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetNthChildWidget
|
||||
|
||||
This routine returns the widget ID of a child widget by index. Indexes are
|
||||
0 based, from 0 to one minus the number of widgets in the parent,
|
||||
inclusive. If the index is invalid, 0 is returned.
|
||||
}
|
||||
FUNCTION XPGetNthChildWidget(
|
||||
inWidget : XPWidgetID;
|
||||
inIndex : integer) : XPWidgetID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetParentWidget
|
||||
|
||||
This routine returns the parent of a widget, or 0 if the widget has no
|
||||
parent. Root widgets never have parents and therefore always return 0.
|
||||
}
|
||||
FUNCTION XPGetParentWidget(
|
||||
inWidget : XPWidgetID) : XPWidgetID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPShowWidget
|
||||
|
||||
This routine makes a widget visible if it is not already. Note that if a
|
||||
widget is not in a rooted widget hierarchy or one of its parents is not
|
||||
visible, it will still not be visible to the user.
|
||||
}
|
||||
PROCEDURE XPShowWidget(
|
||||
inWidget : XPWidgetID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPHideWidget
|
||||
|
||||
Makes a widget invisible. See XPShowWidget for considerations of when a
|
||||
widget might not be visible despite its own visibility state.
|
||||
}
|
||||
PROCEDURE XPHideWidget(
|
||||
inWidget : XPWidgetID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPIsWidgetVisible
|
||||
|
||||
This returns 1 if a widget is visible, 0 if it is not. Note that this
|
||||
routine takes into consideration whether a parent is invisible. Use this
|
||||
routine to tell if the user can see the widget.
|
||||
}
|
||||
FUNCTION XPIsWidgetVisible(
|
||||
inWidget : XPWidgetID) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPFindRootWidget
|
||||
|
||||
XPFindRootWidget returns the Widget ID of the root widget that contains the
|
||||
passed in widget or NULL if the passed in widget is not in a rooted
|
||||
hierarchy.
|
||||
}
|
||||
FUNCTION XPFindRootWidget(
|
||||
inWidget : XPWidgetID) : XPWidgetID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPBringRootWidgetToFront
|
||||
|
||||
This routine makes the specified widget be in the front most widget
|
||||
hierarchy. If this widget is a root widget, its widget hierarchy comes to
|
||||
front, otherwise the widget's root is brought to the front. If this widget
|
||||
is not in an active widget hiearchy (e.g. there is no root widget at the
|
||||
top of the tree), this routine does nothing.
|
||||
}
|
||||
PROCEDURE XPBringRootWidgetToFront(
|
||||
inWidget : XPWidgetID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPIsWidgetInFront
|
||||
|
||||
This routine returns true if this widget's hierarchy is the front most
|
||||
hierarchy. It returns false if the widget's hierarchy is not in front, or
|
||||
if the widget is not in a rooted hierarchy.
|
||||
}
|
||||
FUNCTION XPIsWidgetInFront(
|
||||
inWidget : XPWidgetID) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetWidgetGeometry
|
||||
|
||||
This routine returns the bounding box of a widget in global coordinates.
|
||||
Pass NULL for any parameter you are not interested in.
|
||||
}
|
||||
PROCEDURE XPGetWidgetGeometry(
|
||||
inWidget : XPWidgetID;
|
||||
outLeft : Pinteger; { Can be nil }
|
||||
outTop : Pinteger; { Can be nil }
|
||||
outRight : Pinteger; { Can be nil }
|
||||
outBottom : Pinteger); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPSetWidgetGeometry
|
||||
|
||||
This function changes the bounding box of a widget.
|
||||
}
|
||||
PROCEDURE XPSetWidgetGeometry(
|
||||
inWidget : XPWidgetID;
|
||||
inLeft : integer;
|
||||
inTop : integer;
|
||||
inRight : integer;
|
||||
inBottom : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetWidgetForLocation
|
||||
|
||||
Given a widget and a location, this routine returns the widget ID of the
|
||||
child of that widget that owns that location. If inRecursive is true then
|
||||
this will return a child of a child of a widget as it tries to find the
|
||||
deepest widget at that location. If inVisibleOnly is true, then only
|
||||
visible widgets are considered, otherwise all widgets are considered. The
|
||||
widget ID passed for inContainer will be returned if the location is in
|
||||
that widget but not in a child widget. 0 is returned if the location is
|
||||
not in the container.
|
||||
|
||||
NOTE: if a widget's geometry extends outside its parents geometry, it will
|
||||
not be returned by this call for mouse locations outside the parent
|
||||
geometry. The parent geometry limits the child's eligibility for mouse
|
||||
location.
|
||||
}
|
||||
FUNCTION XPGetWidgetForLocation(
|
||||
inContainer : XPWidgetID;
|
||||
inXOffset : integer;
|
||||
inYOffset : integer;
|
||||
inRecursive : integer;
|
||||
inVisibleOnly : integer) : XPWidgetID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetWidgetExposedGeometry
|
||||
|
||||
This routine returns the bounds of the area of a widget that is completely
|
||||
within its parent widgets. Since a widget's bounding box can be outside
|
||||
its parent, part of its area will not be elligible for mouse clicks and
|
||||
should not draw. Use XPGetWidgetGeometry to find out what area defines
|
||||
your widget's shape, but use this routine to find out what area to actually
|
||||
draw into. Note that the widget library does not use OpenGL clipping to
|
||||
keep frame rates up, although you could use it internally.
|
||||
}
|
||||
PROCEDURE XPGetWidgetExposedGeometry(
|
||||
inWidgetID : XPWidgetID;
|
||||
outLeft : Pinteger; { Can be nil }
|
||||
outTop : Pinteger; { Can be nil }
|
||||
outRight : Pinteger; { Can be nil }
|
||||
outBottom : Pinteger); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* ACCESSING WIDGET DATA
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
XPSetWidgetDescriptor
|
||||
|
||||
Every widget has a descriptor, which is a text string. What the text
|
||||
string is used for varies from widget to widget; for example, a push
|
||||
button's text is its descriptor, a caption shows its descriptor, and a text
|
||||
field's descriptor is the text being edited. In other words, the usage for
|
||||
the text varies from widget to widget, but this API provides a universal
|
||||
and convenient way to get at it. While not all UI widgets need their
|
||||
descriptor, many do.
|
||||
}
|
||||
PROCEDURE XPSetWidgetDescriptor(
|
||||
inWidget : XPWidgetID;
|
||||
inDescriptor : Pchar);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetWidgetDescriptor
|
||||
|
||||
This routine returns the widget's descriptor. Pass in the length of the
|
||||
buffer you are going to receive the descriptor in. The descriptor will be
|
||||
null terminated for you. This routine returns the length of the actual
|
||||
descriptor; if you pass NULL for outDescriptor, you can get the
|
||||
descriptor's length without getting its text. If the length of the
|
||||
descriptor exceeds your buffer length, the buffer will not be null
|
||||
terminated (this routine has 'strncpy' semantics).
|
||||
}
|
||||
FUNCTION XPGetWidgetDescriptor(
|
||||
inWidget : XPWidgetID;
|
||||
outDescriptor : Pchar;
|
||||
inMaxDescLength : integer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPSetWidgetProperty
|
||||
|
||||
This function sets a widget's property. Properties are arbitrary values
|
||||
associated by a widget by ID.
|
||||
}
|
||||
PROCEDURE XPSetWidgetProperty(
|
||||
inWidget : XPWidgetID;
|
||||
inProperty : XPWidgetPropertyID;
|
||||
inValue : intptr_t);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetWidgetProperty
|
||||
|
||||
This routine returns the value of a widget's property, or 0 if the property
|
||||
is not defined. If you need to know whether the property is defined, pass
|
||||
a pointer to an int for inExists; the existence of that property will be
|
||||
returned in the int. Pass NULL for inExists if you do not need this
|
||||
information.
|
||||
}
|
||||
FUNCTION XPGetWidgetProperty(
|
||||
inWidget : XPWidgetID;
|
||||
inProperty : XPWidgetPropertyID;
|
||||
inExists : Pinteger) : intptr_t; { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* KEYBOARD MANAGEMENT
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
XPSetKeyboardFocus
|
||||
|
||||
XPSetKeyboardFocus controls which widget will receive keystrokes. Pass the
|
||||
Widget ID of the widget to get the keys. Note that if the widget does not
|
||||
care about keystrokes, they will go to the parent widget, and if no widget
|
||||
cares about them, they go to X-Plane.
|
||||
|
||||
If you set the keyboard focus to Widget ID 0, X-Plane gets keyboard focus.
|
||||
|
||||
This routine returns the widget ID that ended up with keyboard focus, or 0
|
||||
for x-plane.
|
||||
|
||||
Keyboard focus is not changed if the new widget will not accept it. For
|
||||
setting to x-plane, keyboard focus is always accepted.
|
||||
|
||||
}
|
||||
FUNCTION XPSetKeyboardFocus(
|
||||
inWidget : XPWidgetID) : XPWidgetID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLoseKeyboardFocus
|
||||
|
||||
This causes the specified widget to lose focus; focus is passed to its
|
||||
parent, or the next parent that will accept it. This routine does nothing
|
||||
if this widget does not have focus.
|
||||
}
|
||||
PROCEDURE XPLoseKeyboardFocus(
|
||||
inWidget : XPWidgetID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetWidgetWithFocus
|
||||
|
||||
This routine returns the widget that has keyboard focus, or 0 if X-Plane
|
||||
has keyboard focus or some other plugin window that does not have widgets
|
||||
has focus.
|
||||
}
|
||||
FUNCTION XPGetWidgetWithFocus: XPWidgetID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* CREATING CUSTOM WIDGETS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
XPAddWidgetCallback
|
||||
|
||||
This function adds a new widget callback to a widget. This widget callback
|
||||
supercedes any existing ones and will receive messages first; if it does
|
||||
not handle messages they will go on to be handled by pre-existing widgets.
|
||||
|
||||
The widget function will remain on the widget for the life of the widget.
|
||||
The creation message will be sent to the new callback immediately with the
|
||||
widget ID, and the destruction message will be sent before the other widget
|
||||
function receives a destruction message.
|
||||
|
||||
This provides a way to 'subclass' an existing widget. By providing a
|
||||
second hook that only handles certain widget messages, you can customize or
|
||||
extend widget behavior.
|
||||
}
|
||||
PROCEDURE XPAddWidgetCallback(
|
||||
inWidget : XPWidgetID;
|
||||
inNewCallback : XPWidgetFunc_t);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPGetWidgetClassFunc
|
||||
|
||||
Given a widget class, this function returns the callbacks that power that
|
||||
widget class.
|
||||
}
|
||||
FUNCTION XPGetWidgetClassFunc(
|
||||
inWidgetClass : XPWidgetClass) : XPWidgetFunc_t;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPWIDGETS.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
174
xpcPlugin/SDK/Delphi/XPLM/XPLMCamera.pas
Executable file
174
xpcPlugin/SDK/Delphi/XPLM/XPLMCamera.pas
Executable file
@@ -0,0 +1,174 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMCamera;
|
||||
INTERFACE
|
||||
{
|
||||
XPLMCamera - THEORY OF OPERATION The XPLMCamera APIs allow plug-ins to
|
||||
control the camera angle in X-Plane. This has a number of applications,
|
||||
including but not limited to:
|
||||
|
||||
- Creating new views (including dynamic/user-controllable views) for the
|
||||
user.
|
||||
|
||||
- Creating applications that use X-Plane as a renderer of scenery,
|
||||
aircrafts, or both.
|
||||
|
||||
The camera is controlled via six parameters: a location in OpenGL
|
||||
coordinates and pitch, roll and yaw, similar to an airplane's position.
|
||||
OpenGL coordinate info is described in detail in the XPLMGraphics
|
||||
documentation; generally you should use the XPLMGraphics routines to
|
||||
convert from world to local coordinates. The camera's orientation starts
|
||||
facing level with the ground directly up the negative-Z axis
|
||||
(approximately north) with the horizon horizontal. It is then rotated
|
||||
clockwise for yaw, pitched up for positive pitch, and rolled clockwise
|
||||
around the vector it is looking along for roll.
|
||||
|
||||
You control the camera either either until the user selects a new view or
|
||||
permanently (the later being similar to how UDP camera control works). You
|
||||
control the camera by registering a callback per frame from which you
|
||||
calculate the new camera positions. This guarantees smooth camera motion.
|
||||
|
||||
Use the XPLMDataAccess APIs to get information like the position of the
|
||||
aircraft, etc. for complex camera positioning.
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* CAMERA CONTROL
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
XPLMCameraControlDuration
|
||||
|
||||
This enumeration states how long you want to retain control of the camera.
|
||||
You can retain it indefinitely or until the user selects a new view.
|
||||
}
|
||||
TYPE
|
||||
XPLMCameraControlDuration = (
|
||||
{ Control the camera until the user picks a new view. }
|
||||
xplm_ControlCameraUntilViewChanges = 1
|
||||
|
||||
{ Control the camera until your plugin is disabled or another plugin forcably }
|
||||
{ takes control. }
|
||||
,xplm_ControlCameraForever = 2
|
||||
|
||||
);
|
||||
PXPLMCameraControlDuration = ^XPLMCameraControlDuration;
|
||||
|
||||
{
|
||||
XPLMCameraPosition_t
|
||||
|
||||
This structure contains a full specification of the camera. X, Y, and Z
|
||||
are the camera's position in OpenGL coordiantes; pitch, roll, and yaw are
|
||||
rotations from a camera facing flat north in degrees. Positive pitch means
|
||||
nose up, positive roll means roll right, and positive yaw means yaw right,
|
||||
all in degrees. Zoom is a zoom factor, with 1.0 meaning normal zoom and 2.0
|
||||
magnifying by 2x (objects appear larger).
|
||||
}
|
||||
XPLMCameraPosition_t = RECORD
|
||||
x : single;
|
||||
y : single;
|
||||
z : single;
|
||||
pitch : single;
|
||||
heading : single;
|
||||
roll : single;
|
||||
zoom : single;
|
||||
END;
|
||||
PXPLMCameraPosition_t = ^XPLMCameraPosition_t;
|
||||
|
||||
{
|
||||
XPLMCameraControl_f
|
||||
|
||||
You use an XPLMCameraControl function to provide continuous control over
|
||||
the camera. You are passed in a structure in which to put the new camera
|
||||
position; modify it and return 1 to reposition the camera. Return 0 to
|
||||
surrender control of the camera; camera control will be handled by X-Plane
|
||||
on this draw loop. The contents of the structure as you are called are
|
||||
undefined.
|
||||
|
||||
If X-Plane is taking camera control away from you, this function will be
|
||||
called with inIsLosingControl set to 1 and ioCameraPosition NULL.
|
||||
}
|
||||
XPLMCameraControl_f = FUNCTION(
|
||||
outCameraPosition : PXPLMCameraPosition_t; { Can be nil }
|
||||
inIsLosingControl : integer;
|
||||
inRefcon : pointer) : integer; cdecl;
|
||||
|
||||
{
|
||||
XPLMControlCamera
|
||||
|
||||
This function repositions the camera on the next drawing cycle. You must
|
||||
pass a non-null control function. Specify in inHowLong how long you'd like
|
||||
control (indefinitely or until a key is pressed).
|
||||
}
|
||||
PROCEDURE XPLMControlCamera(
|
||||
inHowLong : XPLMCameraControlDuration;
|
||||
inControlFunc : XPLMCameraControl_f;
|
||||
inRefcon : pointer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMDontControlCamera
|
||||
|
||||
This function stops you from controlling the camera. If you have a camera
|
||||
control function, it will not be called with an inIsLosingControl flag.
|
||||
X-Plane will control the camera on the next cycle.
|
||||
|
||||
For maximum compatibility you should not use this routine unless you are in
|
||||
posession of the camera.
|
||||
}
|
||||
PROCEDURE XPLMDontControlCamera;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMIsCameraBeingControlled
|
||||
|
||||
This routine returns 1 if the camera is being controlled, zero if it is
|
||||
not. If it is and you pass in a pointer to a camera control duration, the
|
||||
current control duration will be returned.
|
||||
}
|
||||
FUNCTION XPLMIsCameraBeingControlled(
|
||||
outCameraControlDuration: PXPLMCameraControlDuration) : integer; { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMReadCameraPosition
|
||||
|
||||
This function reads the current camera position.
|
||||
}
|
||||
PROCEDURE XPLMReadCameraPosition(
|
||||
outCameraPosition : PXPLMCameraPosition_t);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
764
xpcPlugin/SDK/Delphi/XPLM/XPLMDataAccess.pas
Executable file
764
xpcPlugin/SDK/Delphi/XPLM/XPLMDataAccess.pas
Executable file
@@ -0,0 +1,764 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMDataAccess;
|
||||
INTERFACE
|
||||
{
|
||||
XPLM Data Access API - Theory of Operation
|
||||
|
||||
The data access API gives you a generic, flexible, high performance way to
|
||||
read and write data to and from X-Plane and other plug-ins. For example,
|
||||
this API allows you to read and set the nav radios, get the plane location,
|
||||
determine the current effective graphics frame rate, etc.
|
||||
|
||||
The data access APIs are the way that you read and write data from the sim
|
||||
as well as other plugins.
|
||||
|
||||
The API works using opaque data references. A data reference is a source
|
||||
of data; you do not know where it comes from, but once you have it you can
|
||||
read the data quickly and possibly write it. To get a data reference, you
|
||||
look it up.
|
||||
|
||||
Data references are identified by verbose string names
|
||||
(sim/cockpit/radios/nav1_freq_hz). The actual numeric value of the data
|
||||
reference is implementation defined and is likely to change each time the
|
||||
simulator is run (or the plugin that provides the datareference is
|
||||
reloaded).
|
||||
|
||||
The task of looking up a data reference is relatively expensive; look up
|
||||
your data references once based on verbose strings, and save the opaque
|
||||
data reference value for the duration of your plugin's operation. Reading
|
||||
and writing data references is relatively fast (the cost is equivalent to
|
||||
two function calls through function pointers).
|
||||
|
||||
This allows data access to be high performance, while leaving in
|
||||
abstraction; since data references are opaque and are searched for, the
|
||||
underlying data access system can be rebuilt.
|
||||
|
||||
A note on typing: you must know the correct data type to read and write.
|
||||
APIs are provided for reading and writing data in a number of ways. You
|
||||
can also double check the data type for a data ref. Note that automatic
|
||||
conversion is not done for you.
|
||||
|
||||
A note for plugins sharing data with other plugins: the load order of
|
||||
plugins is not guaranteed. To make sure that every plugin publishing data
|
||||
has published their data references before other plugins try to subscribe,
|
||||
publish your data references in your start routine but resolve them the
|
||||
first time your 'enable' routine is called, or the first time they are
|
||||
needed in code.
|
||||
|
||||
X-Plane publishes well over 1000 datarefs; a complete list may be found in
|
||||
the reference section of the SDK online documentation (from the SDK home
|
||||
page, choose Documentation).
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* READING AND WRITING DATA
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These routines allow you to access a wide variety of data from within
|
||||
x-plane and modify some of it.
|
||||
}
|
||||
|
||||
|
||||
|
||||
TYPE
|
||||
{
|
||||
XPLMDataRef
|
||||
|
||||
A data ref is an opaque handle to data provided by the simulator or another
|
||||
plugin. It uniquely identifies one variable (or array of variables) over
|
||||
the lifetime of your plugin. You never hard code these values; you always
|
||||
get them from XPLMFindDataRef.
|
||||
}
|
||||
XPLMDataRef = pointer;
|
||||
PXPLMDataRef = ^XPLMDataRef;
|
||||
|
||||
{
|
||||
XPLMDataTypeID
|
||||
|
||||
This is an enumeration that defines the type of the data behind a data
|
||||
reference. This allows you to sanity check that the data type matches what
|
||||
you expect. But for the most part, you will know the type of data you are
|
||||
expecting from the online documentation.
|
||||
|
||||
Data types each take a bit field, so sets of data types may be formed.
|
||||
}
|
||||
XPLMDataTypeID = (
|
||||
{ Data of a type the current XPLM doesn't do. }
|
||||
xplmType_Unknown = 0
|
||||
|
||||
{ A single 4-byte integer, native endian. }
|
||||
,xplmType_Int = 1
|
||||
|
||||
{ A single 4-byte float, native endian. }
|
||||
,xplmType_Float = 2
|
||||
|
||||
{ A single 8-byte double, native endian. }
|
||||
,xplmType_Double = 4
|
||||
|
||||
{ An array of 4-byte floats, native endian. }
|
||||
,xplmType_FloatArray = 8
|
||||
|
||||
{ An array of 4-byte integers, native endian. }
|
||||
,xplmType_IntArray = 16
|
||||
|
||||
{ A variable block of data. }
|
||||
,xplmType_Data = 32
|
||||
|
||||
);
|
||||
PXPLMDataTypeID = ^XPLMDataTypeID;
|
||||
|
||||
{
|
||||
XPLMFindDataRef
|
||||
|
||||
Given a c-style string that names the data ref, this routine looks up the
|
||||
actual opaque XPLMDataRef that you use to read and write the data. The
|
||||
string names for datarefs are published on the x-plane SDK web site.
|
||||
|
||||
This function returns NULL if the data ref cannot be found.
|
||||
|
||||
NOTE: this function is relatively expensive; save the XPLMDataRef this
|
||||
function returns for future use. Do not look up your data ref by string
|
||||
every time you need to read or write it.
|
||||
}
|
||||
FUNCTION XPLMFindDataRef(
|
||||
inDataRefName : Pchar) : XPLMDataRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCanWriteDataRef
|
||||
|
||||
Given a data ref, this routine returns true if you can successfully set
|
||||
the data, false otherwise. Some datarefs are read-only.
|
||||
}
|
||||
FUNCTION XPLMCanWriteDataRef(
|
||||
inDataRef : XPLMDataRef) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMIsDataRefGood
|
||||
|
||||
WARNING: This function is deprecated and should not be used. Datarefs are
|
||||
valid until plugins are reloaded or the sim quits. Plugins sharing
|
||||
datarefs should support these semantics by not unregistering datarefs
|
||||
during operation. (You should however unregister datarefs when your plugin
|
||||
is unloaded, as part of general resource cleanup.)
|
||||
|
||||
This function returns whether a data ref is still valid. If it returns
|
||||
false, you should refind the data ref from its original string. Calling an
|
||||
accessor function on a bad data ref will return a default value, typically
|
||||
0 or 0-length data.
|
||||
}
|
||||
FUNCTION XPLMIsDataRefGood(
|
||||
inDataRef : XPLMDataRef) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetDataRefTypes
|
||||
|
||||
This routine returns the types of the data ref for accessor use. If a data
|
||||
ref is available in multiple data types, they will all be returned.
|
||||
}
|
||||
FUNCTION XPLMGetDataRefTypes(
|
||||
inDataRef : XPLMDataRef) : XPLMDataTypeID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* DATA ACCESSORS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These routines read and write the data references. For each supported data
|
||||
type there is a reader and a writer.
|
||||
|
||||
If the data ref is invalid or the plugin that provides it is disabled or
|
||||
there is a type mismatch, the functions that read data will return 0 as a
|
||||
default value or not modify the passed in memory. The plugins that write
|
||||
data will not write under these circumstances or if the data ref is
|
||||
read-only. NOTE: to keep the overhead of reading datarefs low, these
|
||||
routines do not do full validation of a dataref; passing a junk value for
|
||||
a dataref can result in crashing the sim.
|
||||
|
||||
For array-style datarefs, you specify the number of items to read/write and
|
||||
the offset into the array; the actual number of items read or written is
|
||||
returned. This may be less to prevent an array-out-of-bounds error.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMGetDatai
|
||||
|
||||
Read an integer data ref and return its value. The return value is the
|
||||
dataref value or 0 if the dataref is invalid/NULL or the plugin is
|
||||
disabled.
|
||||
}
|
||||
FUNCTION XPLMGetDatai(
|
||||
inDataRef : XPLMDataRef) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetDatai
|
||||
|
||||
Write a new value to an integer data ref. This routine is a no-op if the
|
||||
plugin publishing the dataref is disabled, the dataref is invalid, or the
|
||||
dataref is not writable.
|
||||
}
|
||||
PROCEDURE XPLMSetDatai(
|
||||
inDataRef : XPLMDataRef;
|
||||
inValue : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetDataf
|
||||
|
||||
Read a single precision floating point dataref and return its value. The
|
||||
return value is the dataref value or 0.0 if the dataref is invalid/NULL or
|
||||
the plugin is disabled.
|
||||
}
|
||||
FUNCTION XPLMGetDataf(
|
||||
inDataRef : XPLMDataRef) : single;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetDataf
|
||||
|
||||
Write a new value to a single precision floating point data ref. This
|
||||
routine is a no-op if the plugin publishing the dataref is disabled, the
|
||||
dataref is invalid, or the dataref is not writable.
|
||||
}
|
||||
PROCEDURE XPLMSetDataf(
|
||||
inDataRef : XPLMDataRef;
|
||||
inValue : single);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetDatad
|
||||
|
||||
Read a double precision floating point dataref and return its value. The
|
||||
return value is the dataref value or 0.0 if the dataref is invalid/NULL or
|
||||
the plugin is disabled.
|
||||
}
|
||||
FUNCTION XPLMGetDatad(
|
||||
inDataRef : XPLMDataRef) : real;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetDatad
|
||||
|
||||
Write a new value to a double precision floating point data ref. This
|
||||
routine is a no-op if the plugin publishing the dataref is disabled, the
|
||||
dataref is invalid, or the dataref is not writable.
|
||||
}
|
||||
PROCEDURE XPLMSetDatad(
|
||||
inDataRef : XPLMDataRef;
|
||||
inValue : real);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetDatavi
|
||||
|
||||
Read a part of an integer array dataref. If you pass NULL for outVaules,
|
||||
the routine will return the size of the array, ignoring inOffset and inMax.
|
||||
|
||||
|
||||
If outValues is not NULL, then up to inMax values are copied from the
|
||||
dataref into outValues, starting at inOffset in the dataref. If inMax +
|
||||
inOffset is larger than the size of the dataref, less than inMax values
|
||||
will be copied. The number of values copied is returned.
|
||||
|
||||
Note: the semantics of array datarefs are entirely implemented by the
|
||||
plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
above description is how these datarefs are intended to work, but a rogue
|
||||
plugin may have different behavior.
|
||||
}
|
||||
FUNCTION XPLMGetDatavi(
|
||||
inDataRef : XPLMDataRef;
|
||||
outValues : Pinteger; { Can be nil }
|
||||
inOffset : integer;
|
||||
inMax : integer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetDatavi
|
||||
|
||||
Write part or all of an integer array dataref. The values passed by
|
||||
inValues are written into the dataref starting at inOffset. Up to inCount
|
||||
values are written; however if the values would write "off the end" of the
|
||||
dataref array, then fewer values are written.
|
||||
|
||||
Note: the semantics of array datarefs are entirely implemented by the
|
||||
plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
above description is how these datarefs are intended to work, but a rogue
|
||||
plugin may have different behavior.
|
||||
}
|
||||
PROCEDURE XPLMSetDatavi(
|
||||
inDataRef : XPLMDataRef;
|
||||
inValues : Pinteger;
|
||||
inoffset : integer;
|
||||
inCount : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetDatavf
|
||||
|
||||
Read a part of a single precision floating point array dataref. If you
|
||||
pass NULL for outVaules, the routine will return the size of the array,
|
||||
ignoring inOffset and inMax.
|
||||
|
||||
If outValues is not NULL, then up to inMax values are copied from the
|
||||
dataref into outValues, starting at inOffset in the dataref. If inMax +
|
||||
inOffset is larger than the size of the dataref, less than inMax values
|
||||
will be copied. The number of values copied is returned.
|
||||
|
||||
Note: the semantics of array datarefs are entirely implemented by the
|
||||
plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
above description is how these datarefs are intended to work, but a rogue
|
||||
plugin may have different behavior.
|
||||
}
|
||||
FUNCTION XPLMGetDatavf(
|
||||
inDataRef : XPLMDataRef;
|
||||
outValues : Psingle; { Can be nil }
|
||||
inOffset : integer;
|
||||
inMax : integer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetDatavf
|
||||
|
||||
Write part or all of a single precision floating point array dataref. The
|
||||
values passed by inValues are written into the dataref starting at
|
||||
inOffset. Up to inCount values are written; however if the values would
|
||||
write "off the end" of the dataref array, then fewer values are written.
|
||||
|
||||
Note: the semantics of array datarefs are entirely implemented by the
|
||||
plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
above description is how these datarefs are intended to work, but a rogue
|
||||
plugin may have different behavior.
|
||||
}
|
||||
PROCEDURE XPLMSetDatavf(
|
||||
inDataRef : XPLMDataRef;
|
||||
inValues : Psingle;
|
||||
inoffset : integer;
|
||||
inCount : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetDatab
|
||||
|
||||
Read a part of a byte array dataref. If you pass NULL for outVaules, the
|
||||
routine will return the size of the array, ignoring inOffset and inMax.
|
||||
|
||||
If outValues is not NULL, then up to inMax values are copied from the
|
||||
dataref into outValues, starting at inOffset in the dataref. If inMax +
|
||||
inOffset is larger than the size of the dataref, less than inMax values
|
||||
will be copied. The number of values copied is returned.
|
||||
|
||||
Note: the semantics of array datarefs are entirely implemented by the
|
||||
plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
above description is how these datarefs are intended to work, but a rogue
|
||||
plugin may have different behavior.
|
||||
}
|
||||
FUNCTION XPLMGetDatab(
|
||||
inDataRef : XPLMDataRef;
|
||||
outValue : pointer; { Can be nil }
|
||||
inOffset : integer;
|
||||
inMaxBytes : integer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetDatab
|
||||
|
||||
Write part or all of a byte array dataref. The values passed by inValues
|
||||
are written into the dataref starting at inOffset. Up to inCount values
|
||||
are written; however if the values would write "off the end" of the dataref
|
||||
array, then fewer values are written.
|
||||
|
||||
Note: the semantics of array datarefs are entirely implemented by the
|
||||
plugin (or X-Plane) that provides the dataref, not the SDK itself; the
|
||||
above description is how these datarefs are intended to work, but a rogue
|
||||
plugin may have different behavior.
|
||||
}
|
||||
PROCEDURE XPLMSetDatab(
|
||||
inDataRef : XPLMDataRef;
|
||||
inValue : pointer;
|
||||
inOffset : integer;
|
||||
inLength : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* PUBLISHING YOUR PLUGINS DATA
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These functions allow you to create data references that other plug-ins can
|
||||
access via the above data access APIs. Data references published by other
|
||||
plugins operate the same as ones published by x-plane in all manners except
|
||||
that your data reference will not be available to other plugins if/when
|
||||
your plugin is disabled.
|
||||
|
||||
You share data by registering data provider callback functions. When a
|
||||
plug-in requests your data, these callbacks are then called. You provide
|
||||
one callback to return the value when a plugin 'reads' it and another to
|
||||
change the value when a plugin 'writes' it.
|
||||
|
||||
Important: you must pick a prefix for your datarefs other than "sim/" -
|
||||
this prefix is reserved for X-Plane. The X-Plane SDK website contains a
|
||||
registry where authors can select a unique first word for dataref names, to
|
||||
prevent dataref collisions between plugins.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMGetDatai_f
|
||||
|
||||
Data provider function pointers.
|
||||
|
||||
These define the function pointers you provide to get or set data. Note
|
||||
that you are passed a generic pointer for each one. This is the same
|
||||
pointer you pass in your register routine; you can use it to find global
|
||||
variables, etc.
|
||||
|
||||
The semantics of your callbacks are the same as the dataref accessor above
|
||||
- basically routines like XPLMGetDatai are just pass-throughs from a caller
|
||||
to your plugin. Be particularly mindful in implementing array dataref
|
||||
read-write accessors; you are responsible for avoiding overruns, supporting
|
||||
offset read/writes, and handling a read with a NULL buffer.
|
||||
}
|
||||
TYPE
|
||||
XPLMGetDatai_f = FUNCTION(
|
||||
inRefcon : pointer) : integer; cdecl;
|
||||
|
||||
{
|
||||
XPLMSetDatai_f
|
||||
|
||||
}
|
||||
XPLMSetDatai_f = PROCEDURE(
|
||||
inRefcon : pointer;
|
||||
inValue : integer); cdecl;
|
||||
|
||||
{
|
||||
XPLMGetDataf_f
|
||||
|
||||
}
|
||||
XPLMGetDataf_f = FUNCTION(
|
||||
inRefcon : pointer) : single; cdecl;
|
||||
|
||||
{
|
||||
XPLMSetDataf_f
|
||||
|
||||
}
|
||||
XPLMSetDataf_f = PROCEDURE(
|
||||
inRefcon : pointer;
|
||||
inValue : single); cdecl;
|
||||
|
||||
{
|
||||
XPLMGetDatad_f
|
||||
|
||||
}
|
||||
XPLMGetDatad_f = FUNCTION(
|
||||
inRefcon : pointer) : real; cdecl;
|
||||
|
||||
{
|
||||
XPLMSetDatad_f
|
||||
|
||||
}
|
||||
XPLMSetDatad_f = PROCEDURE(
|
||||
inRefcon : pointer;
|
||||
inValue : real); cdecl;
|
||||
|
||||
{
|
||||
XPLMGetDatavi_f
|
||||
|
||||
}
|
||||
XPLMGetDatavi_f = FUNCTION(
|
||||
inRefcon : pointer;
|
||||
outValues : Pinteger; { Can be nil }
|
||||
inOffset : integer;
|
||||
inMax : integer) : integer; cdecl;
|
||||
|
||||
{
|
||||
XPLMSetDatavi_f
|
||||
|
||||
}
|
||||
XPLMSetDatavi_f = PROCEDURE(
|
||||
inRefcon : pointer;
|
||||
inValues : Pinteger;
|
||||
inOffset : integer;
|
||||
inCount : integer); cdecl;
|
||||
|
||||
{
|
||||
XPLMGetDatavf_f
|
||||
|
||||
}
|
||||
XPLMGetDatavf_f = FUNCTION(
|
||||
inRefcon : pointer;
|
||||
outValues : Psingle; { Can be nil }
|
||||
inOffset : integer;
|
||||
inMax : integer) : integer; cdecl;
|
||||
|
||||
{
|
||||
XPLMSetDatavf_f
|
||||
|
||||
}
|
||||
XPLMSetDatavf_f = PROCEDURE(
|
||||
inRefcon : pointer;
|
||||
inValues : Psingle;
|
||||
inOffset : integer;
|
||||
inCount : integer); cdecl;
|
||||
|
||||
{
|
||||
XPLMGetDatab_f
|
||||
|
||||
}
|
||||
XPLMGetDatab_f = FUNCTION(
|
||||
inRefcon : pointer;
|
||||
outValue : pointer; { Can be nil }
|
||||
inOffset : integer;
|
||||
inMaxLength : integer) : integer; cdecl;
|
||||
|
||||
{
|
||||
XPLMSetDatab_f
|
||||
|
||||
}
|
||||
XPLMSetDatab_f = PROCEDURE(
|
||||
inRefcon : pointer;
|
||||
inValue : pointer;
|
||||
inOffset : integer;
|
||||
inLength : integer); cdecl;
|
||||
|
||||
{
|
||||
XPLMRegisterDataAccessor
|
||||
|
||||
This routine creates a new item of data that can be read and written. Pass
|
||||
in the data's full name for searching, the type(s) of the data for
|
||||
accessing, and whether the data can be written to. For each data type you
|
||||
support, pass in a read accessor function and a write accessor function if
|
||||
necessary. Pass NULL for data types you do not support or write accessors
|
||||
if you are read-only.
|
||||
|
||||
You are returned a data ref for the new item of data created. You can use
|
||||
this data ref to unregister your data later or read or write from it.
|
||||
}
|
||||
FUNCTION XPLMRegisterDataAccessor(
|
||||
inDataName : Pchar;
|
||||
inDataType : XPLMDataTypeID;
|
||||
inIsWritable : integer;
|
||||
inReadInt : XPLMGetDatai_f;
|
||||
inWriteInt : XPLMSetDatai_f;
|
||||
inReadFloat : XPLMGetDataf_f;
|
||||
inWriteFloat : XPLMSetDataf_f;
|
||||
inReadDouble : XPLMGetDatad_f;
|
||||
inWriteDouble : XPLMSetDatad_f;
|
||||
inReadIntArray : XPLMGetDatavi_f;
|
||||
inWriteIntArray : XPLMSetDatavi_f;
|
||||
inReadFloatArray : XPLMGetDatavf_f;
|
||||
inWriteFloatArray : XPLMSetDatavf_f;
|
||||
inReadData : XPLMGetDatab_f;
|
||||
inWriteData : XPLMSetDatab_f;
|
||||
inReadRefcon : pointer;
|
||||
inWriteRefcon : pointer) : XPLMDataRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMUnregisterDataAccessor
|
||||
|
||||
Use this routine to unregister any data accessors you may have registered.
|
||||
You unregister a data ref by the XPLMDataRef you get back from
|
||||
registration. Once you unregister a data ref, your function pointer will
|
||||
not be called anymore.
|
||||
|
||||
For maximum compatibility, do not unregister your data accessors until
|
||||
final shutdown (when your XPluginStop routine is called). This allows
|
||||
other plugins to find your data reference once and use it for their entire
|
||||
time of operation.
|
||||
}
|
||||
PROCEDURE XPLMUnregisterDataAccessor(
|
||||
inDataRef : XPLMDataRef);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* SHARING DATA BETWEEN MULTIPLE PLUGINS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The data reference registration APIs from the previous section allow a
|
||||
plugin to publish data in a one-owner manner; the plugin that publishes the
|
||||
data reference owns the real memory that the data ref uses. This is
|
||||
satisfactory for most cases, but there are also cases where plugnis need to
|
||||
share actual data.
|
||||
|
||||
With a shared data reference, no one plugin owns the actual memory for the
|
||||
data reference; the plugin SDK allocates that for you. When the first
|
||||
plugin asks to 'share' the data, the memory is allocated. When the data is
|
||||
changed, every plugin that is sharing the data is notified.
|
||||
|
||||
Shared data references differ from the 'owned' data references from the
|
||||
previous section in a few ways:
|
||||
|
||||
- With shared data references, any plugin can create the data reference;
|
||||
with owned plugins one plugin must create the data reference and others
|
||||
subscribe. (This can be a problem if you don't know which set of plugins
|
||||
will be present).
|
||||
|
||||
- With shared data references, every plugin that is sharing the data is
|
||||
notified when the data is changed. With owned data references, only the
|
||||
one owner is notified when the data is changed.
|
||||
|
||||
- With shared data references, you cannot access the physical memory of the
|
||||
data reference; you must use the XPLMGet... and XPLMSet... APIs. With an
|
||||
owned data reference, the one owning data reference can manipulate the
|
||||
data reference's memory in any way it sees fit.
|
||||
|
||||
Shared data references solve two problems: if you need to have a data
|
||||
reference used by several plugins but do not know which plugins will be
|
||||
installed, or if all plugins sharing data need to be notified when that
|
||||
data is changed, use shared data references.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMDataChanged_f
|
||||
|
||||
An XPLMDataChanged_f is a callback that the XPLM calls whenever any other
|
||||
plug-in modifies shared data. A refcon you provide is passed back to help
|
||||
identify which data is being changed. In response, you may want to call one
|
||||
of the XPLMGetDataxxx routines to find the new value of the data.
|
||||
}
|
||||
TYPE
|
||||
XPLMDataChanged_f = PROCEDURE(
|
||||
inRefcon : pointer); cdecl;
|
||||
|
||||
{
|
||||
XPLMShareData
|
||||
|
||||
This routine connects a plug-in to shared data, creating the shared data if
|
||||
necessary. inDataName is a standard path for the data ref, and inDataType
|
||||
specifies the type. This function will create the data if it does not
|
||||
exist. If the data already exists but the type does not match, an error is
|
||||
returned, so it is important that plug-in authors collaborate to establish
|
||||
public standards for shared data.
|
||||
|
||||
If a notificationFunc is passed in and is not NULL, that notification
|
||||
function will be called whenever the data is modified. The notification
|
||||
refcon will be passed to it. This allows your plug-in to know which shared
|
||||
data was changed if multiple shared data are handled by one callback, or if
|
||||
the plug-in does not use global variables.
|
||||
|
||||
A one is returned for successfully creating or finding the shared data; a
|
||||
zero if the data already exists but is of the wrong type.
|
||||
}
|
||||
FUNCTION XPLMShareData(
|
||||
inDataName : Pchar;
|
||||
inDataType : XPLMDataTypeID;
|
||||
inNotificationFunc : XPLMDataChanged_f;
|
||||
inNotificationRefcon: pointer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMUnshareData
|
||||
|
||||
This routine removes your notification function for shared data. Call it
|
||||
when done with the data to stop receiving change notifications. Arguments
|
||||
must match XPLMShareData. The actual memory will not necessarily be freed,
|
||||
since other plug-ins could be using it.
|
||||
}
|
||||
FUNCTION XPLMUnshareData(
|
||||
inDataName : Pchar;
|
||||
inDataType : XPLMDataTypeID;
|
||||
inNotificationFunc : XPLMDataChanged_f;
|
||||
inNotificationRefcon: pointer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
446
xpcPlugin/SDK/Delphi/XPLM/XPLMDefs.pas
Executable file
446
xpcPlugin/SDK/Delphi/XPLM/XPLMDefs.pas
Executable file
@@ -0,0 +1,446 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMDefs;
|
||||
INTERFACE
|
||||
{
|
||||
This file is contains the cross-platform and basic definitions for the
|
||||
X-Plane SDK.
|
||||
|
||||
The preprocessor macros APL and IBM must be defined to specify the
|
||||
compilation target; define APL to 1 and IBM 0 to compile on Macintosh and
|
||||
APL to 0 and IBM to 1 for Windows. You must specify these macro definitions
|
||||
before including XPLMDefs.h or any other XPLM headers. You can do this
|
||||
using the -D command line option or a preprocessor header.
|
||||
}
|
||||
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{$IFDEF LINUX}
|
||||
{$DEFINE KYLIX}
|
||||
{$ENDIF}
|
||||
TYPE
|
||||
{$IFNDEF DELPHI}
|
||||
{$IFNDEF KYLIX}
|
||||
Pchar = ^char;
|
||||
Ppchar = ^Pchar;
|
||||
Psingle = ^single;
|
||||
Pinteger = ^integer;
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
Preal = ^real;
|
||||
Plongint = ^longint;
|
||||
{___________________________________________________________________________
|
||||
* DLL Definitions
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These definitions control the importing and exporting of functions within
|
||||
the DLL.
|
||||
|
||||
You can prefix your five required callbacks with the PLUGIN_API macro to
|
||||
declare them as exported C functions. The XPLM_API macro identifies
|
||||
functions that are provided to you via the plugin SDK. (Link against
|
||||
XPLM.lib to use these functions.)
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
{___________________________________________________________________________
|
||||
* GLOBAL DEFINITIONS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These definitions are used in all parts of the SDK.
|
||||
}
|
||||
|
||||
|
||||
|
||||
TYPE
|
||||
{
|
||||
XPLMPluginID
|
||||
|
||||
Each plug-in is identified by a unique integer ID. This ID can be used to
|
||||
disable or enable a plug-in, or discover what plug-in is 'running' at the
|
||||
time. A plug-in ID is unique within the currently running instance of
|
||||
X-Plane unless plug-ins are reloaded. Plug-ins may receive a different
|
||||
unique ID each time they are loaded.
|
||||
|
||||
For persistent identification of plug-ins, use XPLMFindPluginBySignature in
|
||||
XPLMUtiltiies.h
|
||||
|
||||
-1 indicates no plug-in.
|
||||
}
|
||||
XPLMPluginID = integer;
|
||||
PXPLMPluginID = ^XPLMPluginID;
|
||||
|
||||
CONST
|
||||
{ No plugin. }
|
||||
XPLM_NO_PLUGIN_ID = (-1);
|
||||
|
||||
{ X-Plane itself }
|
||||
XPLM_PLUGIN_XPLANE = (0);
|
||||
|
||||
{ The current XPLM revision is 2.10 (210). }
|
||||
kXPLM_Version = (210);
|
||||
|
||||
{
|
||||
XPLMKeyFlags
|
||||
|
||||
These bitfields define modifier keys in a platform independent way. When a
|
||||
key is pressed, a series of messages are sent to your plugin. The down
|
||||
flag is set in the first of these messages, and the up flag in the last.
|
||||
While the key is held down, messages are sent with neither to indicate that
|
||||
the key is being held down as a repeated character.
|
||||
|
||||
The control flag is mapped to the control flag on Macintosh and PC.
|
||||
Generally X-Plane uses the control key and not the command key on
|
||||
Macintosh, providing a consistent interface across platforms that does not
|
||||
necessarily match the Macintosh user interface guidelines. There is not
|
||||
yet a way for plugins to access the Macintosh control keys without using
|
||||
#ifdefed code.
|
||||
}
|
||||
TYPE
|
||||
XPLMKeyFlags = (
|
||||
{ The shift key is down }
|
||||
xplm_ShiftFlag = 1
|
||||
|
||||
{ The option or alt key is down }
|
||||
,xplm_OptionAltFlag = 2
|
||||
|
||||
{ The control key is down* }
|
||||
,xplm_ControlFlag = 4
|
||||
|
||||
{ The key is being pressed down }
|
||||
,xplm_DownFlag = 8
|
||||
|
||||
{ The key is being released }
|
||||
,xplm_UpFlag = 16
|
||||
|
||||
);
|
||||
PXPLMKeyFlags = ^XPLMKeyFlags;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* ASCII CONTROL KEY CODES
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These definitions define how various control keys are mapped to ASCII key
|
||||
codes. Not all key presses generate an ASCII value, so plugin code should
|
||||
be prepared to see null characters come from the keyboard...this usually
|
||||
represents a key stroke that has no equivalent ASCII, like a page-down
|
||||
press. Use virtual key codes to find these key strokes. ASCII key codes
|
||||
take into account modifier keys; shift keys will affect capitals and
|
||||
punctuation; control key combinations may have no vaild ASCII and produce
|
||||
NULL. To detect control-key combinations, use virtual key codes, not ASCII
|
||||
keys.
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
XPLM_KEY_RETURN = 13;
|
||||
|
||||
XPLM_KEY_ESCAPE = 27;
|
||||
|
||||
XPLM_KEY_TAB = 9;
|
||||
|
||||
XPLM_KEY_DELETE = 8;
|
||||
|
||||
XPLM_KEY_LEFT = 28;
|
||||
|
||||
XPLM_KEY_RIGHT = 29;
|
||||
|
||||
XPLM_KEY_UP = 30;
|
||||
|
||||
XPLM_KEY_DOWN = 31;
|
||||
|
||||
XPLM_KEY_0 = 48;
|
||||
|
||||
XPLM_KEY_1 = 49;
|
||||
|
||||
XPLM_KEY_2 = 50;
|
||||
|
||||
XPLM_KEY_3 = 51;
|
||||
|
||||
XPLM_KEY_4 = 52;
|
||||
|
||||
XPLM_KEY_5 = 53;
|
||||
|
||||
XPLM_KEY_6 = 54;
|
||||
|
||||
XPLM_KEY_7 = 55;
|
||||
|
||||
XPLM_KEY_8 = 56;
|
||||
|
||||
XPLM_KEY_9 = 57;
|
||||
|
||||
XPLM_KEY_DECIMAL = 46;
|
||||
|
||||
{___________________________________________________________________________
|
||||
* VIRTUAL KEY CODES
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These are cross-platform defines for every distinct keyboard press on the
|
||||
computer. Every physical key on the keyboard has a virtual key code. So
|
||||
the "two" key on the top row of the main keyboard has a different code
|
||||
from the "two" key on the numeric key pad. But the 'w' and 'W' character
|
||||
are indistinguishable by virtual key code because they are the same
|
||||
physical key (one with and one without the shift key).
|
||||
|
||||
Use virtual key codes to detect keystrokes that do not have ASCII
|
||||
equivalents, allow the user to map the numeric keypad separately from the
|
||||
main keyboard, and detect control key and other modifier-key combinations
|
||||
that generate ASCII control key sequences (many of which are not available
|
||||
directly via character keys in the SDK).
|
||||
|
||||
To assign virtual key codes we started with the Microsoft set but made some
|
||||
additions and changes. A few differences:
|
||||
|
||||
1. Modifier keys are not available as virtual key codes. You cannot get
|
||||
distinct modifier press and release messages. Please do not try to use
|
||||
modifier keys as regular keys; doing so will almost certainly interfere
|
||||
with users' abilities to use the native x-plane key bindings.
|
||||
|
||||
2. Some keys that do not exist on both Mac and PC keyboards are removed.
|
||||
|
||||
3. Do not assume that the values of these keystrokes are interchangeable
|
||||
with MS v-keys.
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
XPLM_VK_BACK = $08;
|
||||
|
||||
XPLM_VK_TAB = $09;
|
||||
|
||||
XPLM_VK_CLEAR = $0C;
|
||||
|
||||
XPLM_VK_RETURN = $0D;
|
||||
|
||||
XPLM_VK_ESCAPE = $1B;
|
||||
|
||||
XPLM_VK_SPACE = $20;
|
||||
|
||||
XPLM_VK_PRIOR = $21;
|
||||
|
||||
XPLM_VK_NEXT = $22;
|
||||
|
||||
XPLM_VK_END = $23;
|
||||
|
||||
XPLM_VK_HOME = $24;
|
||||
|
||||
XPLM_VK_LEFT = $25;
|
||||
|
||||
XPLM_VK_UP = $26;
|
||||
|
||||
XPLM_VK_RIGHT = $27;
|
||||
|
||||
XPLM_VK_DOWN = $28;
|
||||
|
||||
XPLM_VK_SELECT = $29;
|
||||
|
||||
XPLM_VK_PRINT = $2A;
|
||||
|
||||
XPLM_VK_EXECUTE = $2B;
|
||||
|
||||
XPLM_VK_SNAPSHOT = $2C;
|
||||
|
||||
XPLM_VK_INSERT = $2D;
|
||||
|
||||
XPLM_VK_DELETE = $2E;
|
||||
|
||||
XPLM_VK_HELP = $2F;
|
||||
|
||||
{ XPLM_VK_0 thru XPLM_VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) }
|
||||
XPLM_VK_0 = $30;
|
||||
|
||||
XPLM_VK_1 = $31;
|
||||
|
||||
XPLM_VK_2 = $32;
|
||||
|
||||
XPLM_VK_3 = $33;
|
||||
|
||||
XPLM_VK_4 = $34;
|
||||
|
||||
XPLM_VK_5 = $35;
|
||||
|
||||
XPLM_VK_6 = $36;
|
||||
|
||||
XPLM_VK_7 = $37;
|
||||
|
||||
XPLM_VK_8 = $38;
|
||||
|
||||
XPLM_VK_9 = $39;
|
||||
|
||||
{ XPLM_VK_A thru XPLM_VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) }
|
||||
XPLM_VK_A = $41;
|
||||
|
||||
XPLM_VK_B = $42;
|
||||
|
||||
XPLM_VK_C = $43;
|
||||
|
||||
XPLM_VK_D = $44;
|
||||
|
||||
XPLM_VK_E = $45;
|
||||
|
||||
XPLM_VK_F = $46;
|
||||
|
||||
XPLM_VK_G = $47;
|
||||
|
||||
XPLM_VK_H = $48;
|
||||
|
||||
XPLM_VK_I = $49;
|
||||
|
||||
XPLM_VK_J = $4A;
|
||||
|
||||
XPLM_VK_K = $4B;
|
||||
|
||||
XPLM_VK_L = $4C;
|
||||
|
||||
XPLM_VK_M = $4D;
|
||||
|
||||
XPLM_VK_N = $4E;
|
||||
|
||||
XPLM_VK_O = $4F;
|
||||
|
||||
XPLM_VK_P = $50;
|
||||
|
||||
XPLM_VK_Q = $51;
|
||||
|
||||
XPLM_VK_R = $52;
|
||||
|
||||
XPLM_VK_S = $53;
|
||||
|
||||
XPLM_VK_T = $54;
|
||||
|
||||
XPLM_VK_U = $55;
|
||||
|
||||
XPLM_VK_V = $56;
|
||||
|
||||
XPLM_VK_W = $57;
|
||||
|
||||
XPLM_VK_X = $58;
|
||||
|
||||
XPLM_VK_Y = $59;
|
||||
|
||||
XPLM_VK_Z = $5A;
|
||||
|
||||
XPLM_VK_NUMPAD0 = $60;
|
||||
|
||||
XPLM_VK_NUMPAD1 = $61;
|
||||
|
||||
XPLM_VK_NUMPAD2 = $62;
|
||||
|
||||
XPLM_VK_NUMPAD3 = $63;
|
||||
|
||||
XPLM_VK_NUMPAD4 = $64;
|
||||
|
||||
XPLM_VK_NUMPAD5 = $65;
|
||||
|
||||
XPLM_VK_NUMPAD6 = $66;
|
||||
|
||||
XPLM_VK_NUMPAD7 = $67;
|
||||
|
||||
XPLM_VK_NUMPAD8 = $68;
|
||||
|
||||
XPLM_VK_NUMPAD9 = $69;
|
||||
|
||||
XPLM_VK_MULTIPLY = $6A;
|
||||
|
||||
XPLM_VK_ADD = $6B;
|
||||
|
||||
XPLM_VK_SEPARATOR = $6C;
|
||||
|
||||
XPLM_VK_SUBTRACT = $6D;
|
||||
|
||||
XPLM_VK_DECIMAL = $6E;
|
||||
|
||||
XPLM_VK_DIVIDE = $6F;
|
||||
|
||||
XPLM_VK_F1 = $70;
|
||||
|
||||
XPLM_VK_F2 = $71;
|
||||
|
||||
XPLM_VK_F3 = $72;
|
||||
|
||||
XPLM_VK_F4 = $73;
|
||||
|
||||
XPLM_VK_F5 = $74;
|
||||
|
||||
XPLM_VK_F6 = $75;
|
||||
|
||||
XPLM_VK_F7 = $76;
|
||||
|
||||
XPLM_VK_F8 = $77;
|
||||
|
||||
XPLM_VK_F9 = $78;
|
||||
|
||||
XPLM_VK_F10 = $79;
|
||||
|
||||
XPLM_VK_F11 = $7A;
|
||||
|
||||
XPLM_VK_F12 = $7B;
|
||||
|
||||
XPLM_VK_F13 = $7C;
|
||||
|
||||
XPLM_VK_F14 = $7D;
|
||||
|
||||
XPLM_VK_F15 = $7E;
|
||||
|
||||
XPLM_VK_F16 = $7F;
|
||||
|
||||
XPLM_VK_F17 = $80;
|
||||
|
||||
XPLM_VK_F18 = $81;
|
||||
|
||||
XPLM_VK_F19 = $82;
|
||||
|
||||
XPLM_VK_F20 = $83;
|
||||
|
||||
XPLM_VK_F21 = $84;
|
||||
|
||||
XPLM_VK_F22 = $85;
|
||||
|
||||
XPLM_VK_F23 = $86;
|
||||
|
||||
XPLM_VK_F24 = $87;
|
||||
|
||||
{ The following definitions are extended and are not based on the Microsoft }
|
||||
{ key set. }
|
||||
XPLM_VK_EQUAL = $B0;
|
||||
|
||||
XPLM_VK_MINUS = $B1;
|
||||
|
||||
XPLM_VK_RBRACE = $B2;
|
||||
|
||||
XPLM_VK_LBRACE = $B3;
|
||||
|
||||
XPLM_VK_QUOTE = $B4;
|
||||
|
||||
XPLM_VK_SEMICOLON = $B5;
|
||||
|
||||
XPLM_VK_BACKSLASH = $B6;
|
||||
|
||||
XPLM_VK_COMMA = $B7;
|
||||
|
||||
XPLM_VK_SLASH = $B8;
|
||||
|
||||
XPLM_VK_PERIOD = $B9;
|
||||
|
||||
XPLM_VK_BACKQUOTE = $BA;
|
||||
|
||||
XPLM_VK_ENTER = $BB;
|
||||
|
||||
XPLM_VK_NUMPAD_ENT = $BC;
|
||||
|
||||
XPLM_VK_NUMPAD_EQ = $BD;
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
835
xpcPlugin/SDK/Delphi/XPLM/XPLMDisplay.pas
Executable file
835
xpcPlugin/SDK/Delphi/XPLM/XPLMDisplay.pas
Executable file
@@ -0,0 +1,835 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMDisplay;
|
||||
INTERFACE
|
||||
{
|
||||
XPLM Display APIs - THEORY OF OPERATION
|
||||
|
||||
This API provides the basic hooks to draw in X-Plane and create user
|
||||
interface. All X-Plane drawing is done in OpenGL. The X-Plane plug-in
|
||||
manager takes care of properly setting up the OpenGL context and matrices.
|
||||
You do not decide when in your code's execution to draw; X-Plane tells you
|
||||
when it is ready to have your plugin draw.
|
||||
|
||||
X-Plane's drawing strategy is straightforward: every "frame" the screen is
|
||||
rendered by drawing the 3-d scene (dome, ground, objects, airplanes, etc.)
|
||||
and then drawing the cockpit on top of it. Alpha blending is used to
|
||||
overlay the cockpit over the world (and the gauges over the panel, etc.).
|
||||
|
||||
There are two ways you can draw: directly and in a window.
|
||||
|
||||
Direct drawing involves drawing to the screen before or after X-Plane
|
||||
finishes a phase of drawing. When you draw directly, you can specify
|
||||
whether x-plane is to complete this phase or not. This allows you to do
|
||||
three things: draw before x-plane does (under it), draw after x-plane does
|
||||
(over it), or draw instead of x-plane.
|
||||
|
||||
To draw directly, you register a callback and specify what phase you want
|
||||
to intercept. The plug-in manager will call you over and over to draw that
|
||||
phase.
|
||||
|
||||
Direct drawing allows you to override scenery, panels, or anything. Note
|
||||
that you cannot assume that you are the only plug-in drawing at this
|
||||
phase.
|
||||
|
||||
Window drawing provides slightly higher level functionality. With window
|
||||
drawing you create a window that takes up a portion of the screen. Window
|
||||
drawing is always two dimensional. Window drawing is front-to-back
|
||||
controlled; you can specify that you want your window to be brought on
|
||||
top, and other plug-ins may put their window on top of you. Window drawing
|
||||
also allows you to sign up for key presses and receive mouse clicks.
|
||||
|
||||
There are three ways to get keystrokes:
|
||||
|
||||
If you create a window, the window can take keyboard focus. It will then
|
||||
receive all keystrokes. If no window has focus, X-Plane receives
|
||||
keystrokes. Use this to implement typing in dialog boxes, etc. Only one
|
||||
window may have focus at a time; your window will be notified if it loses
|
||||
focus.
|
||||
|
||||
If you need to associate key strokes with commands/functions in your
|
||||
plug-in, use a hot key. A hoy is a key-specific callback. Hotkeys are
|
||||
sent based on virtual key strokes, so any key may be distinctly mapped with
|
||||
any modifiers. Hot keys can be remapped by other plug-ins. As a plug-in,
|
||||
you don't have to worry about what your hot key ends up mapped to; other
|
||||
plug-ins may provide a UI for remapping keystrokes. So hotkeys allow a
|
||||
user to resolve conflicts and customize keystrokes.
|
||||
|
||||
If you need low level access to the keystroke stream, install a key
|
||||
sniffer. Key sniffers can be installed above everything or right in front
|
||||
of the sim.
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* DRAWING CALLBACKS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
Basic drawing callbacks, for low level intercepting of render loop. The
|
||||
purpose of drawing callbacks is to provide targeted additions or
|
||||
replacements to x-plane's graphics environment (for example, to add extra
|
||||
custom objects, or replace drawing of the AI aircraft). Do not assume that
|
||||
the drawing callbacks will be called in the order implied by the
|
||||
enumerations. Also do not assume that each drawing phase ends before
|
||||
another begins; they may be nested.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMDrawingPhase
|
||||
|
||||
This constant indicates which part of drawing we are in. Drawing is done
|
||||
from the back to the front. We get a callback before or after each item.
|
||||
Metaphases provide access to the beginning and end of the 3d (scene) and 2d
|
||||
(cockpit) drawing in a manner that is independent of new phases added via
|
||||
x-plane implementation.
|
||||
|
||||
WARNING: As X-Plane's scenery evolves, some drawing phases may cease to
|
||||
exist and new ones may be invented. If you need a particularly specific
|
||||
use of these codes, consult Austin and/or be prepared to revise your code
|
||||
as X-Plane evolves.
|
||||
}
|
||||
TYPE
|
||||
XPLMDrawingPhase = (
|
||||
{ This is the earliest point at which you can draw in 3-d. }
|
||||
xplm_Phase_FirstScene = 0
|
||||
|
||||
{ Drawing of land and water. }
|
||||
,xplm_Phase_Terrain = 5
|
||||
|
||||
{ Drawing runways and other airport detail. }
|
||||
,xplm_Phase_Airports = 10
|
||||
|
||||
{ Drawing roads, trails, trains, etc. }
|
||||
,xplm_Phase_Vectors = 15
|
||||
|
||||
{ 3-d objects (houses, smokestacks, etc. }
|
||||
,xplm_Phase_Objects = 20
|
||||
|
||||
{ External views of airplanes, both yours and the AI aircraft. }
|
||||
,xplm_Phase_Airplanes = 25
|
||||
|
||||
{ This is the last point at which you can draw in 3-d. }
|
||||
,xplm_Phase_LastScene = 30
|
||||
|
||||
{ This is the first phase where you can draw in 2-d. }
|
||||
,xplm_Phase_FirstCockpit = 35
|
||||
|
||||
{ The non-moving parts of the aircraft panel. }
|
||||
,xplm_Phase_Panel = 40
|
||||
|
||||
{ The moving parts of the aircraft panel. }
|
||||
,xplm_Phase_Gauges = 45
|
||||
|
||||
{ Floating windows from plugins. }
|
||||
,xplm_Phase_Window = 50
|
||||
|
||||
{ The last change to draw in 2d. }
|
||||
,xplm_Phase_LastCockpit = 55
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{ 3-d Drawing for the local map. Use regular OpenGL coordinates to draw in }
|
||||
{ this phase. }
|
||||
,xplm_Phase_LocalMap3D = 100
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{ 2-d Drawing of text over the local map. }
|
||||
,xplm_Phase_LocalMap2D = 101
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{ Drawing of the side-profile view in the local map screen. }
|
||||
,xplm_Phase_LocalMapProfile = 102
|
||||
{$ENDIF}
|
||||
|
||||
);
|
||||
PXPLMDrawingPhase = ^XPLMDrawingPhase;
|
||||
|
||||
{
|
||||
XPLMDrawCallback_f
|
||||
|
||||
This is the prototype for a low level drawing callback. You are passed in
|
||||
the phase and whether it is before or after. If you are before the phase,
|
||||
return 1 to let x-plane draw or 0 to suppress x-plane drawing. If you are
|
||||
after the phase the return value is ignored.
|
||||
|
||||
Refcon is a unique value that you specify when registering the callback,
|
||||
allowing you to slip a pointer to your own data to the callback.
|
||||
|
||||
Upon entry the OpenGL context will be correctly set up for you and OpenGL
|
||||
will be in 'local' coordinates for 3d drawing and panel coordinates for 2d
|
||||
drawing. The OpenGL state (texturing, etc.) will be unknown.
|
||||
}
|
||||
XPLMDrawCallback_f = FUNCTION(
|
||||
inPhase : XPLMDrawingPhase;
|
||||
inIsBefore : integer;
|
||||
inRefcon : pointer) : integer; cdecl;
|
||||
|
||||
{
|
||||
XPLMKeySniffer_f
|
||||
|
||||
This is the prototype for a low level key-sniffing function. Window-based
|
||||
UI _should not use this_! The windowing system provides high-level
|
||||
mediated keyboard access. By comparison, the key sniffer provides low
|
||||
level keyboard access.
|
||||
|
||||
Key sniffers are provided to allow libraries to provide non-windowed user
|
||||
interaction. For example, the MUI library uses a key sniffer to do pop-up
|
||||
text entry.
|
||||
|
||||
inKey is the character pressed, inRefCon is a value you supply during
|
||||
registration. Return 1 to pass the key on to the next sniffer, the window
|
||||
mgr, x-plane, or whomever is down stream. Return 0 to consume the key.
|
||||
|
||||
Warning: this API declares virtual keys as a signed character; however the
|
||||
VKEY #define macros in XPLMDefs.h define the vkeys using unsigned values
|
||||
(that is 0x80 instead of -0x80). So you may need to cast the incoming vkey
|
||||
to an unsigned char to get correct comparisons in C.
|
||||
}
|
||||
XPLMKeySniffer_f = FUNCTION(
|
||||
inChar : char;
|
||||
inFlags : XPLMKeyFlags;
|
||||
inVirtualKey : char;
|
||||
inRefcon : pointer) : integer; cdecl;
|
||||
|
||||
{
|
||||
XPLMRegisterDrawCallback
|
||||
|
||||
This routine registers a low level drawing callback. Pass in the phase you
|
||||
want to be called for and whether you want to be called before or after.
|
||||
This routine returns 1 if the registration was successful, or 0 if the
|
||||
phase does not exist in this version of x-plane. You may register a
|
||||
callback multiple times for the same or different phases as long as the
|
||||
refcon is unique each time.
|
||||
}
|
||||
FUNCTION XPLMRegisterDrawCallback(
|
||||
inCallback : XPLMDrawCallback_f;
|
||||
inPhase : XPLMDrawingPhase;
|
||||
inWantsBefore : integer;
|
||||
inRefcon : pointer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMUnregisterDrawCallback
|
||||
|
||||
This routine unregisters a draw callback. You must unregister a callback
|
||||
for each time you register a callback if you have registered it multiple
|
||||
times with different refcons. The routine returns 1 if it can find the
|
||||
callback to unregister, 0 otherwise.
|
||||
}
|
||||
FUNCTION XPLMUnregisterDrawCallback(
|
||||
inCallback : XPLMDrawCallback_f;
|
||||
inPhase : XPLMDrawingPhase;
|
||||
inWantsBefore : integer;
|
||||
inRefcon : pointer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMRegisterKeySniffer
|
||||
|
||||
This routine registers a key sniffing callback. You specify whether you
|
||||
want to sniff before the window system, or only sniff keys the window
|
||||
system does not consume. You should ALMOST ALWAYS sniff non-control keys
|
||||
after the window system. When the window system consumes a key, it is
|
||||
because the user has "focused" a window. Consuming the key or taking
|
||||
action based on the key will produce very weird results. Returns 1 if
|
||||
successful.
|
||||
}
|
||||
FUNCTION XPLMRegisterKeySniffer(
|
||||
inCallback : XPLMKeySniffer_f;
|
||||
inBeforeWindows : integer;
|
||||
inRefcon : pointer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMUnregisterKeySniffer
|
||||
|
||||
This routine unregisters a key sniffer. You must unregister a key sniffer
|
||||
for every time you register one with the exact same signature. Returns 1
|
||||
if successful.
|
||||
}
|
||||
FUNCTION XPLMUnregisterKeySniffer(
|
||||
inCallback : XPLMKeySniffer_f;
|
||||
inBeforeWindows : integer;
|
||||
inRefcon : pointer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* WINDOW API
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
Window API, for higher level drawing with UI interaction.
|
||||
|
||||
Note: all 2-d (and thus all window drawing) is done in 'cockpit pixels'.
|
||||
Even when the OpenGL window contains more than 1024x768 pixels, the cockpit
|
||||
drawing is magnified so that only 1024x768 pixels are available.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMMouseStatus
|
||||
|
||||
When the mouse is clicked, your mouse click routine is called repeatedly.
|
||||
It is first called with the mouse down message. It is then called zero or
|
||||
more times with the mouse-drag message, and finally it is called once with
|
||||
the mouse up message. All of these messages will be directed to the same
|
||||
window.
|
||||
}
|
||||
TYPE
|
||||
XPLMMouseStatus = (
|
||||
xplm_MouseDown = 1
|
||||
|
||||
,xplm_MouseDrag = 2
|
||||
|
||||
,xplm_MouseUp = 3
|
||||
|
||||
);
|
||||
PXPLMMouseStatus = ^XPLMMouseStatus;
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMCursorStatus
|
||||
|
||||
XPLMCursorStatus describes how you would like X-Plane to manage the cursor.
|
||||
See XPLMHandleCursor_f for more info.
|
||||
}
|
||||
XPLMCursorStatus = (
|
||||
{ X-Plane manages the cursor normally, plugin does not affect the cusrsor. }
|
||||
xplm_CursorDefault = 0
|
||||
|
||||
{ X-Plane hides the cursor. }
|
||||
,xplm_CursorHidden = 1
|
||||
|
||||
{ X-Plane shows the cursor as the default arrow. }
|
||||
,xplm_CursorArrow = 2
|
||||
|
||||
{ X-Plane shows the cursor but lets you select an OS cursor. }
|
||||
,xplm_CursorCustom = 3
|
||||
|
||||
);
|
||||
PXPLMCursorStatus = ^XPLMCursorStatus;
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMWindowID
|
||||
|
||||
This is an opaque identifier for a window. You use it to control your
|
||||
window. When you create a window, you will specify callbacks to handle
|
||||
drawing and mouse interaction, etc.
|
||||
}
|
||||
XPLMWindowID = pointer;
|
||||
PXPLMWindowID = ^XPLMWindowID;
|
||||
|
||||
{
|
||||
XPLMDrawWindow_f
|
||||
|
||||
This function handles drawing. You are passed in your window and its
|
||||
refcon. Draw the window. You can use XPLM functions to find the current
|
||||
dimensions of your window, etc. When this callback is called, the OpenGL
|
||||
context will be set properly for cockpit drawing. NOTE: Because you are
|
||||
drawing your window over a background, you can make a translucent window
|
||||
easily by simply not filling in your entire window's bounds.
|
||||
}
|
||||
XPLMDrawWindow_f = PROCEDURE(
|
||||
inWindowID : XPLMWindowID;
|
||||
inRefcon : pointer); cdecl;
|
||||
|
||||
{
|
||||
XPLMHandleKey_f
|
||||
|
||||
This function is called when a key is pressed or keyboard focus is taken
|
||||
away from your window. If losingFocus is 1, you are losign the keyboard
|
||||
focus, otherwise a key was pressed and inKey contains its character. You
|
||||
are also passewd your window and a refcon. Warning: this API declares
|
||||
virtual keys as a signed character; however the VKEY #define macros in
|
||||
XPLMDefs.h define the vkeys using unsigned values (that is 0x80 instead of
|
||||
-0x80). So you may need to cast the incoming vkey to an unsigned char to
|
||||
get correct comparisons in C.
|
||||
}
|
||||
XPLMHandleKey_f = PROCEDURE(
|
||||
inWindowID : XPLMWindowID;
|
||||
inKey : char;
|
||||
inFlags : XPLMKeyFlags;
|
||||
inVirtualKey : char;
|
||||
inRefcon : pointer;
|
||||
losingFocus : integer); cdecl;
|
||||
|
||||
{
|
||||
XPLMHandleMouseClick_f
|
||||
|
||||
You receive this call when the mouse button is pressed down or released.
|
||||
Between then these two calls is a drag. You receive the x and y of the
|
||||
click, your window, and a refcon. Return 1 to consume the click, or 0 to
|
||||
pass it through.
|
||||
|
||||
WARNING: passing clicks through windows (as of this writing) causes mouse
|
||||
tracking problems in X-Plane; do not use this feature!
|
||||
}
|
||||
XPLMHandleMouseClick_f = FUNCTION(
|
||||
inWindowID : XPLMWindowID;
|
||||
x : integer;
|
||||
y : integer;
|
||||
inMouse : XPLMMouseStatus;
|
||||
inRefcon : pointer) : integer; cdecl;
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMHandleCursor_f
|
||||
|
||||
The SDK calls your cursor status callback when the mouse is over your
|
||||
plugin window. Return a cursor status code to indicate how you would like
|
||||
X-Plane to manage the cursor. If you return xplm_CursorDefault, the SDK
|
||||
will try lower-Z-order plugin windows, then let the sim manage the cursor.
|
||||
|
||||
Note: you should never show or hide the cursor yourself - these APIs are
|
||||
typically reference-counted and thus cannot safely and predictably be used
|
||||
by the SDK. Instead return one of xplm_CursorHidden to hide the cursor or
|
||||
xplm_CursorArrow/xplm_CursorCustom to show the cursor.
|
||||
|
||||
If you want to implement a custom cursor by drawing a cursor in OpenGL, use
|
||||
xplm_CursorHidden to hide the OS cursor and draw the cursor using a 2-d
|
||||
drawing callback (after xplm_Phase_Window is probably a good choice). If
|
||||
you want to use a custom OS-based cursor, use xplm_CursorCustom to ask
|
||||
X-Plane to show the cursor but not affect its image. You can then use an
|
||||
OS specific call like SetThemeCursor (Mac) or SetCursor/LoadCursor
|
||||
(Windows).
|
||||
}
|
||||
XPLMHandleCursor_f = FUNCTION(
|
||||
inWindowID : XPLMWindowID;
|
||||
x : integer;
|
||||
y : integer;
|
||||
inRefcon : pointer) : XPLMCursorStatus; cdecl;
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMHandleMouseWheel_f
|
||||
|
||||
The SDK calls your mouse wheel callback when one of the mouse wheels is
|
||||
turned within your window. Return 1 to consume the mouse wheel clicks or
|
||||
0 to pass them on to a lower window. (You should consume mouse wheel
|
||||
clicks even if they do nothing if your window appears opaque to the user.)
|
||||
The number of clicks indicates how far the wheel was turned since the last
|
||||
callback. The wheel is 0 for the vertical axis or 1 for the horizontal axis
|
||||
(for OS/mouse combinations that support this).
|
||||
}
|
||||
XPLMHandleMouseWheel_f = FUNCTION(
|
||||
inWindowID : XPLMWindowID;
|
||||
x : integer;
|
||||
y : integer;
|
||||
wheel : integer;
|
||||
clicks : integer;
|
||||
inRefcon : pointer) : integer; cdecl;
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMCreateWindow_t
|
||||
|
||||
The XPMCreateWindow_t structure defines all of the parameters used to
|
||||
create a window using XPLMCreateWindowEx. The structure will be expanded
|
||||
in future SDK APIs to include more features. Always set the structSize
|
||||
member to the size of your struct in bytes!
|
||||
}
|
||||
XPLMCreateWindow_t = RECORD
|
||||
structSize : integer;
|
||||
left : integer;
|
||||
top : integer;
|
||||
right : integer;
|
||||
bottom : integer;
|
||||
visible : integer;
|
||||
drawWindowFunc : XPLMDrawWindow_f;
|
||||
handleMouseClickFunc : XPLMHandleMouseClick_f;
|
||||
handleKeyFunc : XPLMHandleKey_f;
|
||||
handleCursorFunc : XPLMHandleCursor_f;
|
||||
handleMouseWheelFunc : XPLMHandleMouseWheel_f;
|
||||
refcon : pointer;
|
||||
END;
|
||||
PXPLMCreateWindow_t = ^XPLMCreateWindow_t;
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetScreenSize
|
||||
|
||||
This routine returns the size of the size of the X-Plane OpenGL window in
|
||||
pixels. Please note that this is not the size of the screen when doing
|
||||
2-d drawing (the 2-d screen is currently always 1024x768, and graphics are
|
||||
scaled up by OpenGL when doing 2-d drawing for higher-res monitors). This
|
||||
number can be used to get a rough idea of the amount of detail the user
|
||||
will be able to see when drawing in 3-d.
|
||||
}
|
||||
PROCEDURE XPLMGetScreenSize(
|
||||
outWidth : Pinteger; { Can be nil }
|
||||
outHeight : Pinteger); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetMouseLocation
|
||||
|
||||
This routine returns the current mouse location in cockpit pixels. The
|
||||
bottom left corner of the display is 0,0. Pass NULL to not receive info
|
||||
about either parameter.
|
||||
}
|
||||
PROCEDURE XPLMGetMouseLocation(
|
||||
outX : Pinteger; { Can be nil }
|
||||
outY : Pinteger); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCreateWindow
|
||||
|
||||
This routine creates a new window. Pass in the dimensions and offsets to
|
||||
the window's bottom left corner from the bottom left of the screen. You
|
||||
can specify whether the window is initially visible or not. Also, you pass
|
||||
in three callbacks to run the window and a refcon. This function returns a
|
||||
window ID you can use to refer to the new window.
|
||||
|
||||
NOTE: windows do not have "frames"; you are responsible for drawing the
|
||||
background and frame of the window. Higher level libraries have routines
|
||||
which make this easy.
|
||||
}
|
||||
FUNCTION XPLMCreateWindow(
|
||||
inLeft : integer;
|
||||
inTop : integer;
|
||||
inRight : integer;
|
||||
inBottom : integer;
|
||||
inIsVisible : integer;
|
||||
inDrawCallback : XPLMDrawWindow_f;
|
||||
inKeyCallback : XPLMHandleKey_f;
|
||||
inMouseCallback : XPLMHandleMouseClick_f;
|
||||
inRefcon : pointer) : XPLMWindowID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMCreateWindowEx
|
||||
|
||||
This routine creates a new window - you pass in an XPLMCreateWindow_t
|
||||
structure with all of the fields set in. You must set the structSize of
|
||||
the structure to the size of the actual structure you used. Also, you
|
||||
must provide funtions for every callback - you may not leave them null!
|
||||
(If you do not support the cursor or mouse wheel, use functions that return
|
||||
the default values.) The numeric values of the XPMCreateWindow_t structure
|
||||
correspond to the parameters of XPLMCreateWindow.
|
||||
}
|
||||
FUNCTION XPLMCreateWindowEx(
|
||||
inParams : PXPLMCreateWindow_t) : XPLMWindowID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMDestroyWindow
|
||||
|
||||
This routine destroys a window. The callbacks are not called after this
|
||||
call. Keyboard focus is removed from the window before destroying it.
|
||||
}
|
||||
PROCEDURE XPLMDestroyWindow(
|
||||
inWindowID : XPLMWindowID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetWindowGeometry
|
||||
|
||||
This routine returns the position and size of a window in cockpit pixels.
|
||||
Pass NULL to not receive any paramter.
|
||||
}
|
||||
PROCEDURE XPLMGetWindowGeometry(
|
||||
inWindowID : XPLMWindowID;
|
||||
outLeft : Pinteger; { Can be nil }
|
||||
outTop : Pinteger; { Can be nil }
|
||||
outRight : Pinteger; { Can be nil }
|
||||
outBottom : Pinteger); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetWindowGeometry
|
||||
|
||||
This routine allows you to set the position or height aspects of a window.
|
||||
}
|
||||
PROCEDURE XPLMSetWindowGeometry(
|
||||
inWindowID : XPLMWindowID;
|
||||
inLeft : integer;
|
||||
inTop : integer;
|
||||
inRight : integer;
|
||||
inBottom : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetWindowIsVisible
|
||||
|
||||
This routine returns whether a window is visible.
|
||||
}
|
||||
FUNCTION XPLMGetWindowIsVisible(
|
||||
inWindowID : XPLMWindowID) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetWindowIsVisible
|
||||
|
||||
This routine shows or hides a window.
|
||||
}
|
||||
PROCEDURE XPLMSetWindowIsVisible(
|
||||
inWindowID : XPLMWindowID;
|
||||
inIsVisible : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetWindowRefCon
|
||||
|
||||
This routine returns a windows refcon, the unique value you can use for
|
||||
your own purposes.
|
||||
}
|
||||
FUNCTION XPLMGetWindowRefCon(
|
||||
inWindowID : XPLMWindowID) : pointer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetWindowRefCon
|
||||
|
||||
This routine sets a window's reference constant. Use this to pass data to
|
||||
yourself in the callbacks.
|
||||
}
|
||||
PROCEDURE XPLMSetWindowRefCon(
|
||||
inWindowID : XPLMWindowID;
|
||||
inRefcon : pointer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMTakeKeyboardFocus
|
||||
|
||||
This routine gives a specific window keyboard focus. Keystrokes will be
|
||||
sent to that window. Pass a window ID of 0 to pass keyboard strokes
|
||||
directly to X-Plane.
|
||||
}
|
||||
PROCEDURE XPLMTakeKeyboardFocus(
|
||||
inWindow : XPLMWindowID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMBringWindowToFront
|
||||
|
||||
This routine brings the window to the front of the Z-order. Windows are
|
||||
brought to the front when they are created...beyond that you should make
|
||||
sure you are front before handling mouse clicks.
|
||||
}
|
||||
PROCEDURE XPLMBringWindowToFront(
|
||||
inWindow : XPLMWindowID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMIsWindowInFront
|
||||
|
||||
This routine returns true if you pass inthe ID of the frontmost visible
|
||||
window.
|
||||
}
|
||||
FUNCTION XPLMIsWindowInFront(
|
||||
inWindow : XPLMWindowID) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* HOT KEYS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
Hot Keys - keystrokes that can be managed by others.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMHotKey_f
|
||||
|
||||
Your hot key callback simply takes a pointer of your choosing.
|
||||
}
|
||||
TYPE
|
||||
XPLMHotKey_f = PROCEDURE(
|
||||
inRefcon : pointer); cdecl;
|
||||
|
||||
{
|
||||
XPLMHotKeyID
|
||||
|
||||
Hot keys are identified by opaque IDs.
|
||||
}
|
||||
XPLMHotKeyID = pointer;
|
||||
PXPLMHotKeyID = ^XPLMHotKeyID;
|
||||
|
||||
{
|
||||
XPLMRegisterHotKey
|
||||
|
||||
This routine registers a hot key. You specify your preferred key stroke
|
||||
virtual key/flag combination, a description of what your callback does (so
|
||||
other plug-ins can describe the plug-in to the user for remapping) and a
|
||||
callback function and opaque pointer to pass in). A new hot key ID is
|
||||
returned. During execution, the actual key associated with your hot key
|
||||
may change, but you are insulated from this.
|
||||
}
|
||||
FUNCTION XPLMRegisterHotKey(
|
||||
inVirtualKey : char;
|
||||
inFlags : XPLMKeyFlags;
|
||||
inDescription : Pchar;
|
||||
inCallback : XPLMHotKey_f;
|
||||
inRefcon : pointer) : XPLMHotKeyID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMUnregisterHotKey
|
||||
|
||||
This API unregisters a hot key. You can only register your own hot keys.
|
||||
}
|
||||
PROCEDURE XPLMUnregisterHotKey(
|
||||
inHotKey : XPLMHotKeyID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCountHotKeys
|
||||
|
||||
Returns the number of current hot keys.
|
||||
}
|
||||
FUNCTION XPLMCountHotKeys: integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetNthHotKey
|
||||
|
||||
Returns a hot key by index, for iteration on all hot keys.
|
||||
}
|
||||
FUNCTION XPLMGetNthHotKey(
|
||||
inIndex : integer) : XPLMHotKeyID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetHotKeyInfo
|
||||
|
||||
Returns information about the hot key. Return NULL for any parameter you
|
||||
don't want info about. The description should be at least 512 chars long.
|
||||
}
|
||||
PROCEDURE XPLMGetHotKeyInfo(
|
||||
inHotKey : XPLMHotKeyID;
|
||||
outVirtualKey : Pchar; { Can be nil }
|
||||
outFlags : PXPLMKeyFlags; { Can be nil }
|
||||
outDescription : Pchar; { Can be nil }
|
||||
outPlugin : PXPLMPluginID); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetHotKeyCombination
|
||||
|
||||
XPLMSetHotKeyCombination remaps a hot keys keystrokes. You may remap
|
||||
another plugin's keystrokes.
|
||||
}
|
||||
PROCEDURE XPLMSetHotKeyCombination(
|
||||
inHotKey : XPLMHotKeyID;
|
||||
inVirtualKey : char;
|
||||
inFlags : XPLMKeyFlags);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
441
xpcPlugin/SDK/Delphi/XPLM/XPLMGraphics.pas
Executable file
441
xpcPlugin/SDK/Delphi/XPLM/XPLMGraphics.pas
Executable file
@@ -0,0 +1,441 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMGraphics;
|
||||
INTERFACE
|
||||
{
|
||||
Graphics routines for X-Plane and OpenGL.
|
||||
|
||||
A few notes on coordinate systems:
|
||||
|
||||
X-Plane uses three kinds of coordinates. Global coordinates are specified
|
||||
as latitude, longitude and elevation. This coordinate system never changes
|
||||
but is not very precise.
|
||||
|
||||
OpenGL (or 'local') coordinates are cartesian and shift with the plane.
|
||||
They offer more precision and are used for 3-d OpenGL drawing. The X axis
|
||||
is aligned east-west with positive X meaning east. The Y axis is aligned
|
||||
straight up and down at the point 0,0,0 (but since the earth is round it is
|
||||
not truly straight up and down at other points). The Z axis is aligned
|
||||
north-south at 0, 0, 0 with positive Z pointing south (but since the earth
|
||||
is round it isn't exactly north-south as you move east or west of 0, 0, 0).
|
||||
One unit is one meter and the point 0,0,0 is on the surface of the earth
|
||||
at sea level for some latitude and longitude picked by the sim such that
|
||||
the user's aircraft is reasonably nearby.
|
||||
|
||||
Cockpit coordinates are 2d, with the X axis horizontal and the Y axis
|
||||
vertical. The point 0,0 is the bottom left and 1024,768 is the upper right
|
||||
of the screen. This is true no matter what resolution the user's monitor is
|
||||
in; when running in higher resolution, graphics will be scaled.
|
||||
|
||||
Use X-Plane's routines to convert between global and local coordinates. Do
|
||||
not attempt to do this conversion yourself; the precise 'roundness' of
|
||||
X-Plane's physics model may not match your own, and (to make things
|
||||
weirder) the user can potentially customize the physics of the current
|
||||
planet.
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* X-PLANE GRAPHICS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These routines allow you to use OpenGL with X-Plane.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMTextureID
|
||||
|
||||
XPLM Texture IDs name well-known textures in the sim for you to use. This
|
||||
allows you to recycle textures from X-Plane, saving VRAM.
|
||||
}
|
||||
TYPE
|
||||
XPLMTextureID = (
|
||||
{ The bitmap that contains window outlines, button outlines, fonts, etc. }
|
||||
xplm_Tex_GeneralInterface = 0
|
||||
|
||||
{ The exterior paint for the user's aircraft (daytime). }
|
||||
,xplm_Tex_AircraftPaint = 1
|
||||
|
||||
{ The exterior light map for the user's aircraft. }
|
||||
,xplm_Tex_AircraftLiteMap = 2
|
||||
|
||||
);
|
||||
PXPLMTextureID = ^XPLMTextureID;
|
||||
|
||||
{
|
||||
XPLMSetGraphicsState
|
||||
|
||||
XPLMSetGraphicsState changes OpenGL's graphics state in a number of ways:
|
||||
|
||||
inEnableFog - enables or disables fog, equivalent to: glEnable(GL_FOG);
|
||||
|
||||
inNumberTexUnits - enables or disables a number of multitexturing units. If
|
||||
the number is 0, 2d texturing is disabled entirely, as in
|
||||
glDisable(GL_TEXTURE_2D); Otherwise, 2d texturing is enabled, and a
|
||||
number of multitexturing units are enabled sequentially, starting with
|
||||
unit 0, e.g. glActiveTextureARB(GL_TEXTURE0_ARB); glEnable
|
||||
(GL_TEXTURE_2D);
|
||||
|
||||
inEnableLighting - enables or disables OpenGL lighting, e.g.
|
||||
glEnable(GL_LIGHTING); glEnable(GL_LIGHT0);
|
||||
|
||||
inEnableAlphaTesting - enables or disables the alpha test per pixel, e.g.
|
||||
glEnable(GL_ALPHA_TEST);
|
||||
|
||||
inEnableAlphaBlending - enables or disables alpha blending per pixel, e.g.
|
||||
glEnable(GL_BLEND);
|
||||
|
||||
inEnableDepthTesting - enables per pixel depth testing, as in
|
||||
glEnable(GL_DEPTH_TEST);
|
||||
|
||||
inEnableDepthWriting - enables writing back of depth information to the
|
||||
depth bufffer, as in glDepthMask(GL_TRUE);
|
||||
|
||||
The purpose of this function is to change OpenGL state while keeping
|
||||
X-Plane aware of the state changes; this keeps X-Plane from getting
|
||||
surprised by OGL state changes, and prevents X-Plane and plug-ins from
|
||||
having to set all state before all draws; XPLMSetGraphicsState internally
|
||||
skips calls to change state that is already properly enabled.
|
||||
|
||||
X-Plane does not have a 'default' OGL state to plug-ins; plug-ins should
|
||||
totally set OGL state before drawing. Use XPLMSetGraphicsState instead of
|
||||
any of the above OpenGL calls.
|
||||
|
||||
WARNING: Any routine that performs drawing (e.g. XPLMDrawString or widget
|
||||
code) may change X-Plane's state. Always set state before drawing after
|
||||
unknown code has executed.
|
||||
}
|
||||
PROCEDURE XPLMSetGraphicsState(
|
||||
inEnableFog : integer;
|
||||
inNumberTexUnits : integer;
|
||||
inEnableLighting : integer;
|
||||
inEnableAlphaTesting: integer;
|
||||
inEnableAlphaBlending: integer;
|
||||
inEnableDepthTesting: integer;
|
||||
inEnableDepthWriting: integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMBindTexture2d
|
||||
|
||||
XPLMBindTexture2d changes what texture is bound to the 2d texturing target.
|
||||
This routine caches the current 2d texture across all texturing units in
|
||||
the sim and plug-ins, preventing extraneous binding. For example, consider
|
||||
several plug-ins running in series; if they all use the 'general interface'
|
||||
bitmap to do UI, calling this function will skip the rebinding of the
|
||||
general interface texture on all but the first plug-in, which can provide
|
||||
better frame rate son some graphics cards.
|
||||
|
||||
inTextureID is the ID of the texture object to bind; inTextureUnit is a
|
||||
zero-based texture unit (e.g. 0 for the first one), up to a maximum of 4
|
||||
units. (This number may increase in future versions of x-plane.)
|
||||
|
||||
Use this routine instead of glBindTexture(GL_TEXTURE_2D, ....);
|
||||
}
|
||||
PROCEDURE XPLMBindTexture2d(
|
||||
inTextureNum : integer;
|
||||
inTextureUnit : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGenerateTextureNumbers
|
||||
|
||||
This routine generates unused texture numbers that a plug-in can use to
|
||||
safely bind textures. Use this routine instead of glGenTextures;
|
||||
glGenTextures will allocate texture numbers in ranges that X-Plane reserves
|
||||
for its own use but does not always use; for example, it might provide an
|
||||
ID within the range of textures reserved for terrain...loading a new .env
|
||||
file as the plane flies might then cause X-Plane to use this texture ID.
|
||||
X-Plane will then overwrite the plug-ins texture. This routine returns
|
||||
texture IDs that are out of X-Plane's usage range.
|
||||
}
|
||||
PROCEDURE XPLMGenerateTextureNumbers(
|
||||
outTextureIDs : Pinteger;
|
||||
inCount : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetTexture
|
||||
|
||||
XPLMGetTexture returns the OpenGL texture enumeration of an X-Plane texture
|
||||
based on a generic identifying code. For example, you can get the texture
|
||||
for X-Plane's UI bitmaps. This allows you to build new gauges that take
|
||||
advantage of x-plane's textures, for smooth artwork integration and also
|
||||
saving texture memory. Note that the texture might not be loaded yet,
|
||||
depending on what the plane's panel contains.
|
||||
|
||||
OPEN ISSUE: We really need a way to make sure X-Plane loads this texture if
|
||||
it isn't around, or at least a way to find out whether it is loaded or not.
|
||||
}
|
||||
FUNCTION XPLMGetTexture(
|
||||
inTexture : XPLMTextureID) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMWorldToLocal
|
||||
|
||||
This routine translates coordinates from latitude, longitude, and altitude
|
||||
to local scene coordinates. Latitude and longitude are in decimal degrees,
|
||||
and altitude is in meters MSL (mean sea level). The XYZ coordinates are in
|
||||
meters in the local OpenGL coordinate system.
|
||||
}
|
||||
PROCEDURE XPLMWorldToLocal(
|
||||
inLatitude : real;
|
||||
inLongitude : real;
|
||||
inAltitude : real;
|
||||
outX : Preal;
|
||||
outY : Preal;
|
||||
outZ : Preal);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMLocalToWorld
|
||||
|
||||
This routine translates a local coordinate triplet back into latitude,
|
||||
longitude, and altitude. Latitude and longitude are in decimal degrees,
|
||||
and altitude is in meters MSL (mean sea level). The XYZ coordinates are in
|
||||
meters in the local OpenGL coordinate system.
|
||||
|
||||
NOTE: world coordinates are less precise than local coordinates; you should
|
||||
try to avoid round tripping from local to world and back.
|
||||
}
|
||||
PROCEDURE XPLMLocalToWorld(
|
||||
inX : real;
|
||||
inY : real;
|
||||
inZ : real;
|
||||
outLatitude : Preal;
|
||||
outLongitude : Preal;
|
||||
outAltitude : Preal);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMDrawTranslucentDarkBox
|
||||
|
||||
This routine draws a translucent dark box, partially obscuring parts of the
|
||||
screen but making text easy to read. This is the same graphics primitive
|
||||
used by X-Plane to show text files and ATC info.
|
||||
}
|
||||
PROCEDURE XPLMDrawTranslucentDarkBox(
|
||||
inLeft : integer;
|
||||
inTop : integer;
|
||||
inRight : integer;
|
||||
inBottom : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* X-PLANE TEXT
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMFontID
|
||||
|
||||
X-Plane features some fixed-character fonts. Each font may have its own
|
||||
metrics.
|
||||
|
||||
WARNING: Some of these fonts are no longer supported or may have changed
|
||||
geometries. For maximum copmatibility, see the comments below.
|
||||
|
||||
Note: X-Plane 7 supports proportional-spaced fonts. Since no measuring
|
||||
routine is available yet, the SDK will normally draw using a fixed-width
|
||||
font. You can use a dataref to enable proportional font drawing on XP7 if
|
||||
you want to.
|
||||
}
|
||||
TYPE
|
||||
XPLMFontID = (
|
||||
{ Mono-spaced font for user interface. Available in all versions of the SDK. }
|
||||
xplmFont_Basic = 0
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_Menus = 1
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_Metal = 2
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_Led = 3
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_LedWide = 4
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_PanelHUD = 5
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_PanelEFIS = 6
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_PanelGPS = 7
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_RadiosGA = 8
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_RadiosBC = 9
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_RadiosHM = 10
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_RadiosGANarrow = 11
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_RadiosBCNarrow = 12
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_RadiosHMNarrow = 13
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_Timer = 14
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_FullRound = 15
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_SmallRound = 16
|
||||
|
||||
{ Deprecated, do not use. }
|
||||
,xplmFont_Menus_Localized = 17
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{ Proportional UI font. }
|
||||
,xplmFont_Proportional = 18
|
||||
{$ENDIF}
|
||||
|
||||
);
|
||||
PXPLMFontID = ^XPLMFontID;
|
||||
|
||||
{
|
||||
XPLMDrawString
|
||||
|
||||
This routine draws a NULL termianted string in a given font. Pass in the
|
||||
lower left pixel that the character is to be drawn onto. Also pass the
|
||||
character and font ID. This function returns the x offset plus the width of
|
||||
all drawn characters. The color to draw in is specified as a pointer to an
|
||||
array of three floating point colors, representing RGB intensities from 0.0
|
||||
to 1.0.
|
||||
}
|
||||
PROCEDURE XPLMDrawString(
|
||||
inColorRGB : Psingle;
|
||||
inXOffset : integer;
|
||||
inYOffset : integer;
|
||||
inChar : Pchar;
|
||||
inWordWrapWidth : Pinteger; { Can be nil }
|
||||
inFontID : XPLMFontID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMDrawNumber
|
||||
|
||||
This routine draws a number similar to the digit editing fields in
|
||||
PlaneMaker and data output display in X-Plane. Pass in a color, a
|
||||
position, a floating point value, and formatting info. Specify how many
|
||||
integer and how many decimal digits to show and whether to show a sign, as
|
||||
well as a character set. This routine returns the xOffset plus width of the
|
||||
string drawn.
|
||||
}
|
||||
PROCEDURE XPLMDrawNumber(
|
||||
inColorRGB : Psingle;
|
||||
inXOffset : integer;
|
||||
inYOffset : integer;
|
||||
inValue : real;
|
||||
inDigits : integer;
|
||||
inDecimals : integer;
|
||||
inShowSign : integer;
|
||||
inFontID : XPLMFontID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetFontDimensions
|
||||
|
||||
This routine returns the width and height of a character in a given font.
|
||||
It also tells you if the font only supports numeric digits. Pass NULL if
|
||||
you don't need a given field. Note that for a proportional font the width
|
||||
will be an arbitrary, hopefully average width.
|
||||
}
|
||||
PROCEDURE XPLMGetFontDimensions(
|
||||
inFontID : XPLMFontID;
|
||||
outCharWidth : Pinteger; { Can be nil }
|
||||
outCharHeight : Pinteger; { Can be nil }
|
||||
outDigitsOnly : Pinteger); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMMeasureString
|
||||
|
||||
This routine returns the width in pixels of a string using a given font.
|
||||
The string is passed as a pointer plus length (and does not need to be null
|
||||
terminated); this is used to allow for measuring substrings. The return
|
||||
value is floating point; it is possible that future font drawing may allow
|
||||
for fractional pixels.
|
||||
}
|
||||
FUNCTION XPLMMeasureString(
|
||||
inFontID : XPLMFontID;
|
||||
inChar : Pchar;
|
||||
inNumChars : integer) : single;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
259
xpcPlugin/SDK/Delphi/XPLM/XPLMMenus.pas
Executable file
259
xpcPlugin/SDK/Delphi/XPLM/XPLMMenus.pas
Executable file
@@ -0,0 +1,259 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMMenus;
|
||||
INTERFACE
|
||||
{
|
||||
XPLMMenus - Theory of Operation
|
||||
|
||||
Plug-ins can create menus in the menu bar of X-Plane. This is done by
|
||||
creating a menu and then creating items. Menus are referred to by an
|
||||
opaque ID. Items are referred to by index number. For each menu and item
|
||||
you specify a void *. Per menu you specify a handler function that is
|
||||
called with each void * when the menu item is picked. Menu item indices
|
||||
are zero based.
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* XPLM MENUS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMMenuCheck
|
||||
|
||||
These enumerations define the various 'check' states for an X-Plane menu.
|
||||
'checking' in x-plane actually appears as a light which may or may not be
|
||||
lit. So there are three possible states.
|
||||
}
|
||||
TYPE
|
||||
XPLMMenuCheck = (
|
||||
{ there is no symbol to the left of the menu item. }
|
||||
xplm_Menu_NoCheck = 0
|
||||
|
||||
{ the menu has a mark next to it that is unmarked (not lit). }
|
||||
,xplm_Menu_Unchecked = 1
|
||||
|
||||
{ the menu has a mark next to it that is checked (lit). }
|
||||
,xplm_Menu_Checked = 2
|
||||
|
||||
);
|
||||
PXPLMMenuCheck = ^XPLMMenuCheck;
|
||||
|
||||
{
|
||||
XPLMMenuID
|
||||
|
||||
This is a unique ID for each menu you create.
|
||||
}
|
||||
XPLMMenuID = pointer;
|
||||
PXPLMMenuID = ^XPLMMenuID;
|
||||
|
||||
{
|
||||
XPLMMenuHandler_f
|
||||
|
||||
A menu handler function takes two reference pointers, one for the menu
|
||||
(specified when the menu was created) and one for the item (specified when
|
||||
the item was created).
|
||||
}
|
||||
XPLMMenuHandler_f = PROCEDURE(
|
||||
inMenuRef : pointer;
|
||||
inItemRef : pointer); cdecl;
|
||||
|
||||
{
|
||||
XPLMFindPluginsMenu
|
||||
|
||||
This function returns the ID of the plug-ins menu, which is created for you
|
||||
at startup.
|
||||
}
|
||||
FUNCTION XPLMFindPluginsMenu: XPLMMenuID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCreateMenu
|
||||
|
||||
This function creates a new menu and returns its ID. It returns NULL if
|
||||
the menu cannot be created. Pass in a parent menu ID and an item index to
|
||||
create a submenu, or NULL for the parent menu to put the menu in the menu
|
||||
bar. The menu's name is only used if the menu is in the menubar. You also
|
||||
pass a handler function and a menu reference value. Pass NULL for the
|
||||
handler if you do not need callbacks from the menu (for example, if it only
|
||||
contains submenus).
|
||||
|
||||
Important: you must pass a valid, non-empty menu title even if the menu is
|
||||
a submenu where the title is not visible.
|
||||
}
|
||||
FUNCTION XPLMCreateMenu(
|
||||
inName : Pchar;
|
||||
inParentMenu : XPLMMenuID;
|
||||
inParentItem : integer;
|
||||
inHandler : XPLMMenuHandler_f;
|
||||
inMenuRef : pointer) : XPLMMenuID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMDestroyMenu
|
||||
|
||||
This function destroys a menu that you have created. Use this to remove a
|
||||
submenu if necessary. (Normally this function will not be necessary.)
|
||||
}
|
||||
PROCEDURE XPLMDestroyMenu(
|
||||
inMenuID : XPLMMenuID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMClearAllMenuItems
|
||||
|
||||
This function removes all menu items from a menu, allowing you to rebuild
|
||||
it. Use this function if you need to change the number of items on a menu.
|
||||
}
|
||||
PROCEDURE XPLMClearAllMenuItems(
|
||||
inMenuID : XPLMMenuID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMAppendMenuItem
|
||||
|
||||
This routine appends a new menu item to the bottom of a menu and returns
|
||||
its index. Pass in the menu to add the item to, the items name, and a void
|
||||
* ref for this item. If you pass in inForceEnglish, this menu item will be
|
||||
drawn using the english character set no matter what language x-plane is
|
||||
running in. Otherwise the menu item will be drawn localized. (An example
|
||||
of why you'd want to do this is for a proper name.) See XPLMUtilities for
|
||||
determining the current langauge.
|
||||
}
|
||||
FUNCTION XPLMAppendMenuItem(
|
||||
inMenu : XPLMMenuID;
|
||||
inItemName : Pchar;
|
||||
inItemRef : pointer;
|
||||
inForceEnglish : integer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMAppendMenuSeparator
|
||||
|
||||
This routine adds a seperator to the end of a menu.
|
||||
}
|
||||
PROCEDURE XPLMAppendMenuSeparator(
|
||||
inMenu : XPLMMenuID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetMenuItemName
|
||||
|
||||
This routine changes the name of an existing menu item. Pass in the menu
|
||||
ID and the index of the menu item.
|
||||
}
|
||||
PROCEDURE XPLMSetMenuItemName(
|
||||
inMenu : XPLMMenuID;
|
||||
inIndex : integer;
|
||||
inItemName : Pchar;
|
||||
inForceEnglish : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCheckMenuItem
|
||||
|
||||
Set whether a menu item is checked. Pass in the menu ID and item index.
|
||||
}
|
||||
PROCEDURE XPLMCheckMenuItem(
|
||||
inMenu : XPLMMenuID;
|
||||
index : integer;
|
||||
inCheck : XPLMMenuCheck);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCheckMenuItemState
|
||||
|
||||
This routine returns whether a menu item is checked or not. A menu item's
|
||||
check mark may be on or off, or a menu may not have an icon at all.
|
||||
}
|
||||
PROCEDURE XPLMCheckMenuItemState(
|
||||
inMenu : XPLMMenuID;
|
||||
index : integer;
|
||||
outCheck : PXPLMMenuCheck);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMEnableMenuItem
|
||||
|
||||
Sets whether this menu item is enabled. Items start out enabled.
|
||||
}
|
||||
PROCEDURE XPLMEnableMenuItem(
|
||||
inMenu : XPLMMenuID;
|
||||
index : integer;
|
||||
enabled : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{
|
||||
XPLMRemoveMenuItem
|
||||
|
||||
Removes one item from a menu. Note that all menu items below are moved up
|
||||
one; your plugin must track the change in index numbers.
|
||||
}
|
||||
PROCEDURE XPLMRemoveMenuItem(
|
||||
inMenu : XPLMMenuID;
|
||||
inIndex : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
434
xpcPlugin/SDK/Delphi/XPLM/XPLMNavigation.pas
Executable file
434
xpcPlugin/SDK/Delphi/XPLM/XPLMNavigation.pas
Executable file
@@ -0,0 +1,434 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMNavigation;
|
||||
INTERFACE
|
||||
{
|
||||
XPLMNavigation - THEORY OF OPERATION
|
||||
|
||||
The XPLM Navigation APIs give you some access to the navigation databases
|
||||
inside X-Plane. X-Plane stores all navigation information in RAM, so by
|
||||
using these APIs you can gain access to most information without having to
|
||||
go to disk or parse the files yourself.
|
||||
|
||||
You can also use this API to program the FMS. You must use the navigation
|
||||
APIs to find the nav-aids you want to program into the FMS, since the FMS
|
||||
is powered internally by x-plane's navigation database.
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* NAVIGATION DATABASE ACCESS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMNavType
|
||||
|
||||
These enumerations define the different types of navaids. They are each
|
||||
defined with a separate bit so that they may be bit-wise added together to
|
||||
form sets of nav-aid types.
|
||||
|
||||
NOTE: xplm_Nav_LatLon is a specific lat-lon coordinate entered into the
|
||||
FMS. It will not exist in the database, and cannot be programmed into the
|
||||
FMS. Querying the FMS for navaids will return it. Use
|
||||
XPLMSetFMSEntryLatLon to set a lat/lon waypoint.
|
||||
}
|
||||
TYPE
|
||||
XPLMNavType = (
|
||||
xplm_Nav_Unknown = 0
|
||||
|
||||
,xplm_Nav_Airport = 1
|
||||
|
||||
,xplm_Nav_NDB = 2
|
||||
|
||||
,xplm_Nav_VOR = 4
|
||||
|
||||
,xplm_Nav_ILS = 8
|
||||
|
||||
,xplm_Nav_Localizer = 16
|
||||
|
||||
,xplm_Nav_GlideSlope = 32
|
||||
|
||||
,xplm_Nav_OuterMarker = 64
|
||||
|
||||
,xplm_Nav_MiddleMarker = 128
|
||||
|
||||
,xplm_Nav_InnerMarker = 256
|
||||
|
||||
,xplm_Nav_Fix = 512
|
||||
|
||||
,xplm_Nav_DME = 1024
|
||||
|
||||
,xplm_Nav_LatLon = 2048
|
||||
|
||||
);
|
||||
PXPLMNavType = ^XPLMNavType;
|
||||
|
||||
{
|
||||
XPLMNavRef
|
||||
|
||||
XPLMNavRef is an iterator into the navigation database. The navigation
|
||||
database is essentially an array, but it is not necessarily densely
|
||||
populated. The only assumption you can safely make is that like-typed
|
||||
nav-aids are grouped together.
|
||||
|
||||
Use XPLMNavRef to refer to a nav-aid.
|
||||
|
||||
XPLM_NAV_NOT_FOUND is returned by functions that return an XPLMNavRef when
|
||||
the iterator must be invalid.
|
||||
}
|
||||
XPLMNavRef = integer;
|
||||
PXPLMNavRef = ^XPLMNavRef;
|
||||
|
||||
CONST
|
||||
XPLM_NAV_NOT_FOUND = -1;
|
||||
|
||||
{
|
||||
XPLMGetFirstNavAid
|
||||
|
||||
This returns the very first navaid in the database. Use this to traverse
|
||||
the entire database. Returns XPLM_NAV_NOT_FOUND if the nav database is
|
||||
empty.
|
||||
}
|
||||
FUNCTION XPLMGetFirstNavAid: XPLMNavRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetNextNavAid
|
||||
|
||||
Given a nav aid ref, this routine returns the next navaid. It returns
|
||||
XPLM_NAV_NOT_FOUND if the nav aid passed in was invalid or if the navaid
|
||||
passed in was the last one in the database. Use this routine to iterate
|
||||
across all like-typed navaids or the entire database.
|
||||
|
||||
WARNING: due to a bug in the SDK, when fix loading is disabled in the
|
||||
rendering settings screen, calling this routine with the last airport
|
||||
returns a bogus nav aid. Using this nav aid can crash x-plane.
|
||||
}
|
||||
FUNCTION XPLMGetNextNavAid(
|
||||
inNavAidRef : XPLMNavRef) : XPLMNavRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMFindFirstNavAidOfType
|
||||
|
||||
This routine returns the ref of the first navaid of the given type in the
|
||||
database or XPLM_NAV_NOT_FOUND if there are no navaids of that type in the
|
||||
database. You must pass exactly one nav aid type to this routine.
|
||||
|
||||
WARNING: due to a bug in the SDK, when fix loading is disabled in the
|
||||
rendering settings screen, calling this routine with fixes returns a bogus
|
||||
nav aid. Using this nav aid can crash x-plane.
|
||||
}
|
||||
FUNCTION XPLMFindFirstNavAidOfType(
|
||||
inType : XPLMNavType) : XPLMNavRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMFindLastNavAidOfType
|
||||
|
||||
This routine returns the ref of the last navaid of the given type in the
|
||||
database or XPLM_NAV_NOT_FOUND if there are no navaids of that type in the
|
||||
database. You must pass exactly one nav aid type to this routine.
|
||||
|
||||
WARNING: due to a bug in the SDK, when fix loading is disabled in the
|
||||
rendering settings screen, calling this routine with fixes returns a bogus
|
||||
nav aid. Using this nav aid can crash x-plane.
|
||||
}
|
||||
FUNCTION XPLMFindLastNavAidOfType(
|
||||
inType : XPLMNavType) : XPLMNavRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMFindNavAid
|
||||
|
||||
This routine provides a number of searching capabilities for the nav
|
||||
database. XPLMFindNavAid will search through every nav aid whose type is
|
||||
within inType (multiple types may be added together) and return any
|
||||
nav-aids found based on the following rules:
|
||||
|
||||
If inLat and inLon are not NULL, the navaid nearest to that lat/lon will be
|
||||
returned, otherwise the last navaid found will be returned.
|
||||
|
||||
If inFrequency is not NULL, then any navaids considered must match this
|
||||
frequency. Note that this will screen out radio beacons that do not have
|
||||
frequency data published (like inner markers) but not fixes and airports.
|
||||
|
||||
If inNameFragment is not NULL, only navaids that contain the fragment in
|
||||
their name will be returned.
|
||||
|
||||
If inIDFragment is not NULL, only navaids that contain the fragment in
|
||||
their IDs will be returned.
|
||||
|
||||
This routine provides a simple way to do a number of useful searches:
|
||||
|
||||
Find the nearest navaid on this frequency. Find the nearest airport. Find
|
||||
the VOR whose ID is "KBOS". Find the nearest airport whose name contains
|
||||
"Chicago".
|
||||
}
|
||||
FUNCTION XPLMFindNavAid(
|
||||
inNameFragment : Pchar; { Can be nil }
|
||||
inIDFragment : Pchar; { Can be nil }
|
||||
inLat : Psingle; { Can be nil }
|
||||
inLon : Psingle; { Can be nil }
|
||||
inFrequency : Pinteger; { Can be nil }
|
||||
inType : XPLMNavType) : XPLMNavRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetNavAidInfo
|
||||
|
||||
This routine returns information about a navaid. Any non-null field is
|
||||
filled out with information if it is available.
|
||||
|
||||
Frequencies are in the nav.dat convention as described in the X-Plane nav
|
||||
database FAQ: NDB frequencies are exact, all others are multiplied by 100.
|
||||
|
||||
The buffer for IDs should be at least 6 chars and the buffer for names
|
||||
should be at least 41 chars, but since these values are likely to go up, I
|
||||
recommend passing at least 32 chars for IDs and 256 chars for names when
|
||||
possible.
|
||||
|
||||
The outReg parameter tells if the navaid is within the local "region" of
|
||||
loaded DSFs. (This information may not be particularly useful to plugins.)
|
||||
The parameter is a single byte value 1 for true or 0 for false, not a C
|
||||
string.
|
||||
}
|
||||
PROCEDURE XPLMGetNavAidInfo(
|
||||
inRef : XPLMNavRef;
|
||||
outType : PXPLMNavType; { Can be nil }
|
||||
outLatitude : Psingle; { Can be nil }
|
||||
outLongitude : Psingle; { Can be nil }
|
||||
outHeight : Psingle; { Can be nil }
|
||||
outFrequency : Pinteger; { Can be nil }
|
||||
outHeading : Psingle; { Can be nil }
|
||||
outID : Pchar; { Can be nil }
|
||||
outName : Pchar; { Can be nil }
|
||||
outReg : Pchar); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* FLIGHT MANAGEMENT COMPUTER
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
Note: the FMS works based on an array of entries. Indices into the array
|
||||
are zero-based. Each entry is a nav-aid plus an altitude. The FMS tracks
|
||||
the currently displayed entry and the entry that it is flying to.
|
||||
|
||||
The FMS must be programmed with contiguous entries, so clearing an entry at
|
||||
the end shortens the effective flight plan. There is a max of 100
|
||||
waypoints in the flight plan.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMCountFMSEntries
|
||||
|
||||
This routine returns the number of entries in the FMS.
|
||||
}
|
||||
FUNCTION XPLMCountFMSEntries: integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetDisplayedFMSEntry
|
||||
|
||||
This routine returns the index of the entry the pilot is viewing.
|
||||
}
|
||||
FUNCTION XPLMGetDisplayedFMSEntry: integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetDestinationFMSEntry
|
||||
|
||||
This routine returns the index of the entry the FMS is flying to.
|
||||
}
|
||||
FUNCTION XPLMGetDestinationFMSEntry: integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetDisplayedFMSEntry
|
||||
|
||||
This routine changes which entry the FMS is showing to the index specified.
|
||||
}
|
||||
PROCEDURE XPLMSetDisplayedFMSEntry(
|
||||
inIndex : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetDestinationFMSEntry
|
||||
|
||||
This routine changes which entry the FMS is flying the aircraft toward.
|
||||
}
|
||||
PROCEDURE XPLMSetDestinationFMSEntry(
|
||||
inIndex : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetFMSEntryInfo
|
||||
|
||||
This routine returns information about a given FMS entry. A reference to a
|
||||
navaid can be returned allowing you to find additional information (such as
|
||||
a frequency, ILS heading, name, etc.). Some information is available
|
||||
immediately. For a lat/lon entry, the lat/lon is returned by this routine
|
||||
but the navaid cannot be looked up (and the reference will be
|
||||
XPLM_NAV_NOT_FOUND. FMS name entry buffers should be at least 256 chars in
|
||||
length.
|
||||
}
|
||||
PROCEDURE XPLMGetFMSEntryInfo(
|
||||
inIndex : integer;
|
||||
outType : PXPLMNavType; { Can be nil }
|
||||
outID : Pchar; { Can be nil }
|
||||
outRef : PXPLMNavRef; { Can be nil }
|
||||
outAltitude : Pinteger; { Can be nil }
|
||||
outLat : Psingle; { Can be nil }
|
||||
outLon : Psingle); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetFMSEntryInfo
|
||||
|
||||
This routine changes an entry in the FMS to have the destination navaid
|
||||
passed in and the altitude specified. Use this only for airports, fixes,
|
||||
and radio-beacon navaids. Currently of radio beacons, the FMS can only
|
||||
support VORs and NDBs. Use the routines below to clear or fly to a lat/lon.
|
||||
}
|
||||
PROCEDURE XPLMSetFMSEntryInfo(
|
||||
inIndex : integer;
|
||||
inRef : XPLMNavRef;
|
||||
inAltitude : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetFMSEntryLatLon
|
||||
|
||||
This routine changes the entry in the FMS to a lat/lon entry with the given
|
||||
coordinates.
|
||||
}
|
||||
PROCEDURE XPLMSetFMSEntryLatLon(
|
||||
inIndex : integer;
|
||||
inLat : single;
|
||||
inLon : single;
|
||||
inAltitude : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMClearFMSEntry
|
||||
|
||||
This routine clears the given entry, potentially shortening the flight
|
||||
plan.
|
||||
}
|
||||
PROCEDURE XPLMClearFMSEntry(
|
||||
inIndex : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* GPS RECEIVER
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These APIs let you read data from the GPS unit.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMGetGPSDestinationType
|
||||
|
||||
This routine returns the type of the currently selected GPS destination,
|
||||
one of fix, airport, VOR or NDB.
|
||||
}
|
||||
FUNCTION XPLMGetGPSDestinationType: XPLMNavType;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetGPSDestination
|
||||
|
||||
This routine returns the current GPS destination.
|
||||
}
|
||||
FUNCTION XPLMGetGPSDestination: XPLMNavRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
294
xpcPlugin/SDK/Delphi/XPLM/XPLMPlanes.pas
Executable file
294
xpcPlugin/SDK/Delphi/XPLM/XPLMPlanes.pas
Executable file
@@ -0,0 +1,294 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMPlanes;
|
||||
INTERFACE
|
||||
{
|
||||
The XPLMPlanes APIs allow you to control the various aircraft in x-plane,
|
||||
both the user's and the sim's.
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* USER AIRCRAFT ACCESS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
XPLMSetUsersAircraft
|
||||
|
||||
This routine changes the user's aircraft. Note that this will reinitialize
|
||||
the user to be on the nearest airport's first runway. Pass in a full path
|
||||
(hard drive and everything including the .acf extension) to the .acf file.
|
||||
}
|
||||
PROCEDURE XPLMSetUsersAircraft(
|
||||
inAircraftPath : Pchar);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{
|
||||
XPLMPlaceUserAtAirport
|
||||
|
||||
This routine places the user at a given airport. Specify the airport by
|
||||
its ICAO code (e.g. 'KBOS').
|
||||
}
|
||||
PROCEDURE XPLMPlaceUserAtAirport(
|
||||
inAirportCode : Pchar);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* GLOBAL AIRCRAFT ACCESS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
CONST
|
||||
{ The user's aircraft is always index 0. }
|
||||
XPLM_USER_AIRCRAFT = 0;
|
||||
{
|
||||
XPLMPlaneDrawState_t
|
||||
|
||||
This structure contains additional plane parameter info to be passed to
|
||||
draw plane. Make sure to fill in the size of the structure field with
|
||||
sizeof(XPLMDrawPlaneState_t) so that the XPLM can tell how many fields you
|
||||
knew about when compiling your plugin (since more fields may be added
|
||||
later).
|
||||
|
||||
Most of these fields are ratios from 0 to 1 for control input. X-Plane
|
||||
calculates what the actual controls look like based on the .acf file for
|
||||
that airplane. Note for the yoke inputs, this is what the pilot of the
|
||||
plane has commanded (post artificial stability system if there were one)
|
||||
and affects aelerons, rudder, etc. It is not necessarily related to the
|
||||
actual position of the plane!
|
||||
}
|
||||
TYPE
|
||||
XPLMPlaneDrawState_t = RECORD
|
||||
{ The size of the draw state struct. }
|
||||
structSize : integer;
|
||||
{ A ratio from [0..1] describing how far the landing gear is extended. }
|
||||
gearPosition : single;
|
||||
{ Ratio of flap deployment, 0 = up, 1 = full deploy. }
|
||||
flapRatio : single;
|
||||
{ Ratio of spoiler deployment, 0 = none, 1 = full deploy. }
|
||||
spoilerRatio : single;
|
||||
{ Ratio of speed brake deployment, 0 = none, 1 = full deploy. }
|
||||
speedBrakeRatio : single;
|
||||
{ Ratio of slat deployment, 0 = none, 1 = full deploy. }
|
||||
slatRatio : single;
|
||||
{ Wing sweep ratio, 0 = forward, 1 = swept. }
|
||||
wingSweep : single;
|
||||
{ Thrust power, 0 = none, 1 = full fwd, -1 = full reverse. }
|
||||
thrust : single;
|
||||
{ Total pitch input for this plane. }
|
||||
yokePitch : single;
|
||||
{ Total Heading input for this plane. }
|
||||
yokeHeading : single;
|
||||
{ Total Roll input for this plane. }
|
||||
yokeRoll : single;
|
||||
END;
|
||||
PXPLMPlaneDrawState_t = ^XPLMPlaneDrawState_t;
|
||||
{
|
||||
XPLMCountAircraft
|
||||
|
||||
This function returns the number of aircraft X-Plane is capable of having,
|
||||
as well as the number of aircraft that are currently active. These numbers
|
||||
count the user's aircraft. It can also return the plugin that is currently
|
||||
controlling aircraft. In X-Plane 7, this routine reflects the number of
|
||||
aircraft the user has enabled in the rendering options window.
|
||||
}
|
||||
PROCEDURE XPLMCountAircraft(
|
||||
outTotalAircraft : Pinteger;
|
||||
outActiveAircraft : Pinteger;
|
||||
outController : PXPLMPluginID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{
|
||||
XPLMGetNthAircraftModel
|
||||
|
||||
This function returns the aircraft model for the Nth aircraft. Indices are
|
||||
zero based, with zero being the user's aircraft. The file name should be
|
||||
at least 256 chars in length; the path should be at least 512 chars in
|
||||
length.
|
||||
}
|
||||
PROCEDURE XPLMGetNthAircraftModel(
|
||||
inIndex : integer;
|
||||
outFileName : Pchar;
|
||||
outPath : Pchar);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* EXCLUSIVE AIRCRAFT ACCESS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The following routines require exclusive access to the airplane APIs. Only
|
||||
one plugin may have this access at a time.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMPlanesAvailable_f
|
||||
|
||||
Your airplanes available callback is called when another plugin gives up
|
||||
access to the multiplayer planes. Use this to wait for access to
|
||||
multiplayer.
|
||||
}
|
||||
TYPE
|
||||
XPLMPlanesAvailable_f = PROCEDURE(
|
||||
inRefcon : pointer); cdecl;
|
||||
|
||||
{
|
||||
XPLMAcquirePlanes
|
||||
|
||||
XPLMAcquirePlanes grants your plugin exclusive access to the aircraft. It
|
||||
returns 1 if you gain access, 0 if you do not. inAircraft - pass in an
|
||||
array of pointers to strings specifying the planes you want loaded. For
|
||||
any plane index you do not want loaded, pass a 0-length string. Other
|
||||
strings should be full paths with the .acf extension. NULL terminates this
|
||||
array, or pass NULL if there are no planes you want loaded. If you pass in
|
||||
a callback and do not receive access to the planes your callback will be
|
||||
called when the airplanes are available. If you do receive airplane access,
|
||||
your callback will not be called.
|
||||
}
|
||||
FUNCTION XPLMAcquirePlanes(
|
||||
inAircraft : PPchar; { Can be nil }
|
||||
inCallback : XPLMPlanesAvailable_f;
|
||||
inRefcon : pointer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMReleasePlanes
|
||||
|
||||
Call this function to release access to the planes. Note that if you are
|
||||
disabled, access to planes is released for you and you must reacquire it.
|
||||
}
|
||||
PROCEDURE XPLMReleasePlanes;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetActiveAircraftCount
|
||||
|
||||
This routine sets the number of active planes. If you pass in a number
|
||||
higher than the total number of planes availables, only the total number of
|
||||
planes available is actually used.
|
||||
}
|
||||
PROCEDURE XPLMSetActiveAircraftCount(
|
||||
inCount : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetAircraftModel
|
||||
|
||||
This routine loads an aircraft model. It may only be called if you have
|
||||
exclusive access to the airplane APIs. Pass in the path of the model with
|
||||
the .acf extension. The index is zero based, but you may not pass in 0
|
||||
(use XPLMSetUsersAircraft to load the user's aircracft).
|
||||
}
|
||||
PROCEDURE XPLMSetAircraftModel(
|
||||
inIndex : integer;
|
||||
inAircraftPath : Pchar);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMDisableAIForPlane
|
||||
|
||||
This routine turns off X-Plane's AI for a given plane. The plane will
|
||||
continue to draw and be a real plane in X-Plane, but will not move itself.
|
||||
}
|
||||
PROCEDURE XPLMDisableAIForPlane(
|
||||
inPlaneIndex : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMDrawAircraft
|
||||
|
||||
This routine draws an aircraft. It can only be called from a 3-d drawing
|
||||
callback. Pass in the position of the plane in OpenGL local coordinates
|
||||
and the orientation of the plane. A 1 for full drawing indicates that the
|
||||
whole plane must be drawn; a 0 indicates you only need the nav lights
|
||||
drawn. (This saves rendering time when planes are far away.)
|
||||
}
|
||||
PROCEDURE XPLMDrawAircraft(
|
||||
inPlaneIndex : integer;
|
||||
inX : single;
|
||||
inY : single;
|
||||
inZ : single;
|
||||
inPitch : single;
|
||||
inRoll : single;
|
||||
inYaw : single;
|
||||
inFullDraw : integer;
|
||||
inDrawStateInfo : PXPLMPlaneDrawState_t);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMReinitUsersPlane
|
||||
|
||||
This function recomputes the derived flight model data from the aircraft
|
||||
structure in memory. If you have used the data access layer to modify the
|
||||
aircraft structure, use this routine to resynchronize x-plane; since
|
||||
X-plane works at least partly from derived values, the sim will not behave
|
||||
properly until this is called.
|
||||
|
||||
WARNING: this routine does not necessarily place the airplane at the
|
||||
airport; use XPLMSetUsersAircraft to be compatible. This routine is
|
||||
provided to do special experimentation with flight models without resetting
|
||||
flight.
|
||||
}
|
||||
PROCEDURE XPLMReinitUsersPlane;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
381
xpcPlugin/SDK/Delphi/XPLM/XPLMPlugin.pas
Executable file
381
xpcPlugin/SDK/Delphi/XPLM/XPLMPlugin.pas
Executable file
@@ -0,0 +1,381 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMPlugin;
|
||||
INTERFACE
|
||||
{
|
||||
These APIs provide facilities to find and work with other plugins and
|
||||
manage other plugins.
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* FINDING PLUGINS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These APIs allow you to find another plugin or yourself, or iterate across
|
||||
all plugins. For example, if you wrote an FMS plugin that needed to talk
|
||||
to an autopilot plugin, you could use these APIs to locate the autopilot
|
||||
plugin.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMGetMyID
|
||||
|
||||
This routine returns the plugin ID of the calling plug-in. Call this to
|
||||
get your own ID.
|
||||
}
|
||||
FUNCTION XPLMGetMyID: XPLMPluginID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCountPlugins
|
||||
|
||||
This routine returns the total number of plug-ins that are loaded, both
|
||||
disabled and enabled.
|
||||
}
|
||||
FUNCTION XPLMCountPlugins: integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetNthPlugin
|
||||
|
||||
This routine returns the ID of a plug-in by index. Index is 0 based from 0
|
||||
to XPLMCountPlugins-1, inclusive. Plugins may be returned in any arbitrary
|
||||
order.
|
||||
}
|
||||
FUNCTION XPLMGetNthPlugin(
|
||||
inIndex : integer) : XPLMPluginID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMFindPluginByPath
|
||||
|
||||
This routine returns the plug-in ID of the plug-in whose file exists at the
|
||||
passed in absolute file system path. XPLM_NO_PLUGIN_ID is returned if the
|
||||
path does not point to a currently loaded plug-in.
|
||||
}
|
||||
FUNCTION XPLMFindPluginByPath(
|
||||
inPath : Pchar) : XPLMPluginID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMFindPluginBySignature
|
||||
|
||||
This routine returns the plug-in ID of the plug-in whose signature matches
|
||||
what is passed in or XPLM_NO_PLUGIN_ID if no running plug-in has this
|
||||
signature. Signatures are the best way to identify another plug-in as they
|
||||
are independent of the file system path of a plug-in or the human-readable
|
||||
plug-in name, and should be unique for all plug-ins. Use this routine to
|
||||
locate another plugin that your plugin interoperates with
|
||||
}
|
||||
FUNCTION XPLMFindPluginBySignature(
|
||||
inSignature : Pchar) : XPLMPluginID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetPluginInfo
|
||||
|
||||
This routine returns information about a plug-in. Each parameter should be
|
||||
a pointer to a buffer of at least 256 characters, or NULL to not receive
|
||||
the information.
|
||||
|
||||
outName - the human-readable name of the plug-in. outFilePath - the
|
||||
absolute file path to the file that contains this plug-in. outSignature - a
|
||||
unique string that identifies this plug-in. outDescription - a
|
||||
human-readable description of this plug-in.
|
||||
}
|
||||
PROCEDURE XPLMGetPluginInfo(
|
||||
inPlugin : XPLMPluginID;
|
||||
outName : Pchar; { Can be nil }
|
||||
outFilePath : Pchar; { Can be nil }
|
||||
outSignature : Pchar; { Can be nil }
|
||||
outDescription : Pchar); { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* ENABLING/DISABLING PLUG-INS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
These routines are used to work with plug-ins and manage them. Most
|
||||
plugins will not need to use these APIs.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMIsPluginEnabled
|
||||
|
||||
Returns whether the specified plug-in is enabled for running.
|
||||
}
|
||||
FUNCTION XPLMIsPluginEnabled(
|
||||
inPluginID : XPLMPluginID) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMEnablePlugin
|
||||
|
||||
This routine enables a plug-in if it is not already enabled. It returns 1
|
||||
if the plugin was enabled or successfully enables itself, 0 if it does not.
|
||||
Plugins may fail to enable (for example, if resources cannot be acquired)
|
||||
by returning 0 from their XPluginEnable callback.
|
||||
}
|
||||
FUNCTION XPLMEnablePlugin(
|
||||
inPluginID : XPLMPluginID) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMDisablePlugin
|
||||
|
||||
This routine disableds an enabled plug-in.
|
||||
}
|
||||
PROCEDURE XPLMDisablePlugin(
|
||||
inPluginID : XPLMPluginID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMReloadPlugins
|
||||
|
||||
This routine reloads all plug-ins. Once this routine is called and you
|
||||
return from the callback you were within (e.g. a menu select callback) you
|
||||
will receive your XPluginDisable and XPluginStop callbacks and your DLL
|
||||
will be unloaded, then the start process happens as if the sim was starting
|
||||
up.
|
||||
}
|
||||
PROCEDURE XPLMReloadPlugins;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* INTERPLUGIN MESSAGING
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
Plugin messages are defined as 32-bit integers. Messages below 0x00FFFFFF
|
||||
are reserved for X-Plane and the plugin SDK.
|
||||
|
||||
Messages have two conceptual uses: notifications and commands. Commands
|
||||
are sent from one plugin to another to induce behavior; notifications are
|
||||
sent from one plugin to all others for informational purposes. It is
|
||||
important that commands and notifications not have the same values because
|
||||
this could cause a notification sent by one plugin to accidentally induce a
|
||||
command in another.
|
||||
|
||||
By convention, plugin-defined notifications should have the high bit set
|
||||
(e.g. be greater or equal to unsigned 0x8000000) while commands should have
|
||||
this bit be cleared.
|
||||
|
||||
The following messages are sent to your plugin by x-plane.
|
||||
}
|
||||
|
||||
|
||||
|
||||
CONST
|
||||
{ This message is sent to your plugin whenever the user's plane crashes. }
|
||||
XPLM_MSG_PLANE_CRASHED = 101;
|
||||
|
||||
{ This message is sent to your plugin whenever a new plane is loaded. The }
|
||||
{ parameter is the number of the plane being loaded; 0 indicates the user's }
|
||||
{ plane. }
|
||||
XPLM_MSG_PLANE_LOADED = 102;
|
||||
|
||||
{ This messages is called whenever the user's plane is positioned at a new }
|
||||
{ airport. }
|
||||
XPLM_MSG_AIRPORT_LOADED = 103;
|
||||
|
||||
{ This message is sent whenever new scenery is loaded. Use datarefs to }
|
||||
{ determine the new scenery files that were loaded. }
|
||||
XPLM_MSG_SCENERY_LOADED = 104;
|
||||
|
||||
{ This message is sent whenever the user adjusts the number of X-Plane }
|
||||
{ aircraft models. You must use XPLMCountPlanes to find out how many planes }
|
||||
{ are now available. This message will only be sent in XP7 and higher }
|
||||
{ because in XP6 the number of aircraft is not user-adjustable. }
|
||||
XPLM_MSG_AIRPLANE_COUNT_CHANGED = 105;
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{ This message is sent to your plugin whenever a plane is unloaded. The }
|
||||
{ parameter is the number of the plane being unloaded; 0 indicates the user's }
|
||||
{ plane. The parameter is of type int, passed as the value of the pointer. }
|
||||
{ (That is: the parameter is an int, not a pointer to an int.) }
|
||||
XPLM_MSG_PLANE_UNLOADED = 106;
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{ This message is sent to your plugin right before X-Plane writes its }
|
||||
{ preferences file. You can use this for two purposes: to write your own }
|
||||
{ preferences, and to modify any datarefs to influence preferences output. }
|
||||
{ For example, if your plugin temporarily modifies saved preferences, you can }
|
||||
{ put them back to their default values here to avoid having the tweaks be }
|
||||
{ persisted if your plugin is not loaded on the next invocation of X-Plane. }
|
||||
XPLM_MSG_WILL_WRITE_PREFS = 107;
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{ This message is sent to your plugin right after a livery is loaded for an }
|
||||
{ airplane. You can use this to check the new livery (via datarefs) and }
|
||||
{ react accordingly. The parameter is of type int, passed as the value of a }
|
||||
{ pointer and represents the aicraft plane number - 0 is the user's plane. }
|
||||
XPLM_MSG_LIVERY_LOADED = 108;
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSendMessageToPlugin
|
||||
|
||||
This function sends a message to another plug-in or X-Plane. Pass
|
||||
XPLM_NO_PLUGIN_ID to broadcast to all plug-ins. Only enabled plug-ins with
|
||||
a message receive function receive the message.
|
||||
}
|
||||
PROCEDURE XPLMSendMessageToPlugin(
|
||||
inPlugin : XPLMPluginID;
|
||||
inMessage : integer;
|
||||
inParam : pointer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{___________________________________________________________________________
|
||||
* Plugin Features API
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The plugin features API allows your plugin to "sign up" for additional
|
||||
capabilities and plugin system features that are normally disabled for
|
||||
backward compatibility. This allows advanced plugins to "opt-in" to new
|
||||
behavior.
|
||||
|
||||
Each feature is defined by a permanent string name. The feature string
|
||||
names will vary with the particular installation of X-Plane, so plugins
|
||||
should not expect a feature to be guaranteed present.
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMFeatureEnumerator_f
|
||||
|
||||
You pass an XPLMFeatureEnumerator_f to get a list of all features supported
|
||||
by a given version running version of X-Plane. This routine is called once
|
||||
for each feature.
|
||||
}
|
||||
TYPE
|
||||
XPLMFeatureEnumerator_f = PROCEDURE(
|
||||
inFeature : Pchar;
|
||||
inRef : pointer); cdecl;
|
||||
|
||||
{
|
||||
XPLMHasFeature
|
||||
|
||||
This returns 1 if the given installation of X-Plane supports a feature, or
|
||||
0 if it does not.
|
||||
}
|
||||
FUNCTION XPLMHasFeature(
|
||||
inFeature : Pchar) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMIsFeatureEnabled
|
||||
|
||||
This returns 1 if a feature is currently enabled for your plugin, or 0 if
|
||||
it is not enabled. It is an error to call this routine with an unsupported
|
||||
feature.
|
||||
}
|
||||
FUNCTION XPLMIsFeatureEnabled(
|
||||
inFeature : Pchar) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMEnableFeature
|
||||
|
||||
This routine enables or disables a feature for your plugin. This will
|
||||
change the running behavior of X-Plane and your plugin in some way,
|
||||
depending on the feature.
|
||||
}
|
||||
PROCEDURE XPLMEnableFeature(
|
||||
inFeature : Pchar;
|
||||
inEnable : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMEnumerateFeatures
|
||||
|
||||
This routine calls your enumerator callback once for each feature that this
|
||||
running version of X-Plane supports. Use this routine to determine all of
|
||||
the features that X-Plane can support.
|
||||
}
|
||||
PROCEDURE XPLMEnumerateFeatures(
|
||||
inEnumerator : XPLMFeatureEnumerator_f;
|
||||
inRef : pointer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{$ENDIF}
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
276
xpcPlugin/SDK/Delphi/XPLM/XPLMProcessing.pas
Executable file
276
xpcPlugin/SDK/Delphi/XPLM/XPLMProcessing.pas
Executable file
@@ -0,0 +1,276 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMProcessing;
|
||||
INTERFACE
|
||||
{
|
||||
This API allows you to get regular callbacks during the flight loop, the
|
||||
part of X-Plane where the plane's position calculates the physics of
|
||||
flight, etc. Use these APIs to accomplish periodic tasks like logging data
|
||||
and performing I/O.
|
||||
|
||||
WARNING: Do NOT use these callbacks to draw! You cannot draw during flight
|
||||
loop callbacks. Use the drawing callbacks (see XPLMDisplay for more info)
|
||||
for graphics.
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* FLIGHT LOOP CALLBACKS
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{
|
||||
XPLMFlightLoopPhaseType
|
||||
|
||||
You can register a flight loop callback to run either before or after the
|
||||
flight model is integrated by X-Plane.
|
||||
}
|
||||
TYPE
|
||||
XPLMFlightLoopPhaseType = (
|
||||
{ Your callback runs before X-Plane integrates the flight model. }
|
||||
xplm_FlightLoop_Phase_BeforeFlightModel = 0
|
||||
|
||||
{ Your callback runs after X-Plane integrates the flight model. }
|
||||
,xplm_FlightLoop_Phase_AfterFlightModel = 1
|
||||
|
||||
);
|
||||
PXPLMFlightLoopPhaseType = ^XPLMFlightLoopPhaseType;
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{
|
||||
XPLMFlightLoopID
|
||||
|
||||
This is an opaque identifier for a flight loop callback. You can use this
|
||||
identifier to easily track and remove your callbacks, or to use the new
|
||||
flight loop APIs.
|
||||
}
|
||||
XPLMFlightLoopID = pointer;
|
||||
PXPLMFlightLoopID = ^XPLMFlightLoopID;
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMFlightLoop_f
|
||||
|
||||
This is your flight loop callback. Each time the flight loop is iterated
|
||||
through, you receive this call at the end. You receive a time since you
|
||||
were last called and a time since the last loop, as well as a loop counter.
|
||||
The 'phase' parameter is deprecated and should be ignored.
|
||||
|
||||
Your return value controls when you will next be called. Return 0 to stop
|
||||
receiving callbacks. Pass a positive number to specify how many seconds
|
||||
until the next callback. (You will be called at or after this time, not
|
||||
before.) Pass a negative number to specify how many loops must go by until
|
||||
you are called. For example, -1.0 means call me the very next loop. Try
|
||||
to run your flight loop as infrequently as is practical, and suspend it
|
||||
(using return value 0) when you do not need it; lots of flight loop
|
||||
callbacks that do nothing lowers x-plane's frame rate.
|
||||
|
||||
Your callback will NOT be unregistered if you return 0; it will merely be
|
||||
inactive.
|
||||
|
||||
The reference constant you passed to your loop is passed back to you.
|
||||
}
|
||||
XPLMFlightLoop_f = FUNCTION(
|
||||
inElapsedSinceLastCall: single;
|
||||
inElapsedTimeSinceLastFlightLoop: single;
|
||||
inCounter : integer;
|
||||
inRefcon : pointer) : single; cdecl;
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{
|
||||
XPLMCreateFlightLoop_t
|
||||
|
||||
XPLMCreateFlightLoop_t contains the parameters to create a new flight loop
|
||||
callback. The strsucture can be expanded in future SDKs - always set
|
||||
structSize to the size of your structure in bytes.
|
||||
}
|
||||
XPLMCreateFlightLoop_t = RECORD
|
||||
structSize : integer;
|
||||
phase : XPLMFlightLoopPhaseType;
|
||||
callbackFunc : XPLMFlightLoop_f;
|
||||
refcon : pointer;
|
||||
END;
|
||||
PXPLMCreateFlightLoop_t = ^XPLMCreateFlightLoop_t;
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetElapsedTime
|
||||
|
||||
This routine returns the elapsed time since the sim started up in decimal
|
||||
seconds.
|
||||
}
|
||||
FUNCTION XPLMGetElapsedTime: single;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetCycleNumber
|
||||
|
||||
This routine returns a counter starting at zero for each sim cycle
|
||||
computed/video frame rendered.
|
||||
}
|
||||
FUNCTION XPLMGetCycleNumber: integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMRegisterFlightLoopCallback
|
||||
|
||||
This routine registers your flight loop callback. Pass in a pointer to a
|
||||
flight loop function and a refcon. inInterval defines when you will be
|
||||
called. Pass in a positive number to specify seconds from registration
|
||||
time to the next callback. Pass in a negative number to indicate when you
|
||||
will be called (e.g. pass -1 to be called at the next cylcle). Pass 0 to
|
||||
not be called; your callback will be inactive.
|
||||
}
|
||||
PROCEDURE XPLMRegisterFlightLoopCallback(
|
||||
inFlightLoop : XPLMFlightLoop_f;
|
||||
inInterval : single;
|
||||
inRefcon : pointer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMUnregisterFlightLoopCallback
|
||||
|
||||
This routine unregisters your flight loop callback. Do NOT call it from
|
||||
your flight loop callback. Once your flight loop callback is
|
||||
unregistered, it will not be called again.
|
||||
}
|
||||
PROCEDURE XPLMUnregisterFlightLoopCallback(
|
||||
inFlightLoop : XPLMFlightLoop_f;
|
||||
inRefcon : pointer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSetFlightLoopCallbackInterval
|
||||
|
||||
This routine sets when a callback will be called. Do NOT call it from your
|
||||
callback; use the return value of the callback to change your callback
|
||||
interval from inside your callback.
|
||||
|
||||
inInterval is formatted the same way as in XPLMRegisterFlightLoopCallback;
|
||||
positive for seconds, negative for cycles, and 0 for deactivating the
|
||||
callback. If inRelativeToNow is 1, times are from the time of this call;
|
||||
otherwise they are from the time the callback was last called (or the time
|
||||
it was registered if it has never been called.
|
||||
}
|
||||
PROCEDURE XPLMSetFlightLoopCallbackInterval(
|
||||
inFlightLoop : XPLMFlightLoop_f;
|
||||
inInterval : single;
|
||||
inRelativeToNow : integer;
|
||||
inRefcon : pointer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{
|
||||
XPLMCreateFlightLoop
|
||||
|
||||
This routine creates a flight loop callback and returns its ID. The flight
|
||||
loop callback is created using the input param struct, and is inited to be
|
||||
unscheduled.
|
||||
}
|
||||
FUNCTION XPLMCreateFlightLoop(
|
||||
inParams : PXPLMCreateFlightLoop_t) : XPLMFlightLoopID;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{
|
||||
XPLMDestroyFlightLoop
|
||||
|
||||
This routine destroys a flight loop callback by ID.
|
||||
}
|
||||
PROCEDURE XPLMDestroyFlightLoop(
|
||||
inFlightLoopID : XPLMFlightLoopID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{
|
||||
XPLMScheduleFlightLoop
|
||||
|
||||
This routine schedules a flight loop callback for future execution. If
|
||||
inInterval is negative, it is run in a certain number of frames based on
|
||||
the absolute value of the input. If the interval is positive, it is a
|
||||
duration in seconds.
|
||||
|
||||
If inRelativeToNow is true, ties are interpretted relative to the time this
|
||||
routine is called; otherwise they are relative to the last call time or the
|
||||
time the flight loop was registered (if never called).
|
||||
|
||||
THREAD SAFETY: it is legal to call this routine from any thread under the
|
||||
following conditions:
|
||||
|
||||
1. The call must be between the beginning of an XPLMEnable and the end of
|
||||
an XPLMDisable sequence. (That is, you must not call this routine from
|
||||
thread activity when your plugin was supposed to be disabled. Since
|
||||
plugins are only enabled while loaded, this also implies you cannot run
|
||||
this routine outside an XPLMStart/XPLMStop sequence.)
|
||||
|
||||
2. You may not call this routine re-entrantly for a single flight loop ID.
|
||||
(That is, you can't enable from multiple threads at the same time.)
|
||||
|
||||
3. You must call this routine between the time after XPLMCreateFlightLoop
|
||||
returns a value and the time you call XPLMDestroyFlightLoop. (That is, you
|
||||
must ensure that your threaded activity is within the life of the object.
|
||||
The SDK does not check this for you, nor does it synchronize destruction of
|
||||
the object.)
|
||||
|
||||
4. The object must be unscheduled if this routine is to be called from a
|
||||
thread other than the main thread.
|
||||
}
|
||||
PROCEDURE XPLMScheduleFlightLoop(
|
||||
inFlightLoopID : XPLMFlightLoopID;
|
||||
inInterval : single;
|
||||
inRelativeToNow : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
419
xpcPlugin/SDK/Delphi/XPLM/XPLMScenery.pas
Executable file
419
xpcPlugin/SDK/Delphi/XPLM/XPLMScenery.pas
Executable file
@@ -0,0 +1,419 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMScenery;
|
||||
INTERFACE
|
||||
{
|
||||
This package contains APIs to interact with X-Plane's scenery system.
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{$IFDEF XPLM200}
|
||||
{___________________________________________________________________________
|
||||
* Terrain Y-Testing
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The Y-testing API allows you to locate the physical scenery mesh. This
|
||||
would be used to place dynamic graphics on top of the ground in a
|
||||
plausible way or do physics interactions.
|
||||
|
||||
The Y-test API works via probe objects, which are allocated by your plugin
|
||||
and used to query terrain. Probe objects exist both to capture which
|
||||
algorithm you have requested (see probe types) and also to cache query
|
||||
information.
|
||||
|
||||
Performance guidelines: It is generally faster to use the same probe for
|
||||
nearby points and different probes for different points. Try not to
|
||||
allocate more than "hundreds" of probes at most. Share probes if you need
|
||||
more. Generally, probing operations are expensive, and should be avoided
|
||||
via caching when possible.
|
||||
|
||||
Y testing returns a location on the terrain, a normal vectory, and a
|
||||
velocity vector. The normal vector tells you the slope of the terrain at
|
||||
that point. The velocity vector tells you if that terrain is moving (and
|
||||
is in meters/second). For example, if your Y test hits the aircraft carrier
|
||||
deck, this tells you the velocity of that point on the deck.
|
||||
|
||||
Note: the Y-testing API is limited to probing the loaded scenery area,
|
||||
which is approximately 300x300 km in X-Plane 9. Probes outside this area
|
||||
will return the height of a 0 MSL sphere.
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMProbeType
|
||||
|
||||
XPLMProbeType defines the type of terrain probe - each probe has a
|
||||
different algorithm. (Only one type of probe is provided right now, but
|
||||
future APIs will expose more flexible or poewrful or useful probes.
|
||||
}
|
||||
TYPE
|
||||
XPLMProbeType = (
|
||||
{ The Y probe gives you the location of the tallest physical scenery along }
|
||||
{ the Y axis going through the queried point. }
|
||||
xplm_ProbeY = 0
|
||||
|
||||
);
|
||||
PXPLMProbeType = ^XPLMProbeType;
|
||||
|
||||
{
|
||||
XPLMProbeResult
|
||||
|
||||
Probe results - possible results from a probe query.
|
||||
}
|
||||
XPLMProbeResult = (
|
||||
{ The probe hit terrain and returned valid values. }
|
||||
xplm_ProbeHitTerrain = 0
|
||||
|
||||
{ An error in the API call. Either the probe struct size is bad, or the }
|
||||
{ probe is invalid or the type is mismatched for the specific query call. }
|
||||
,xplm_ProbeError = 1
|
||||
|
||||
{ The probe call succeeded but there is no terrain under this point (perhaps }
|
||||
{ it is off the side of the planet?) }
|
||||
,xplm_ProbeMissed = 2
|
||||
|
||||
);
|
||||
PXPLMProbeResult = ^XPLMProbeResult;
|
||||
|
||||
{
|
||||
XPLMProbeRef
|
||||
|
||||
An XPLMProbeRef is an opaque handle to a probe, used for querying the
|
||||
terrain.
|
||||
}
|
||||
XPLMProbeRef = pointer;
|
||||
PXPLMProbeRef = ^XPLMProbeRef;
|
||||
|
||||
{
|
||||
XPLMProbeInfo_t
|
||||
|
||||
XPLMProbeInfo_t contains the results of a probe call. Make sure to set
|
||||
structSize to the size of the struct before using it.
|
||||
}
|
||||
XPLMProbeInfo_t = RECORD
|
||||
{ Size of structure in bytes - always set this before calling the XPLM. }
|
||||
structSize : integer;
|
||||
{ Resulting X location of the terrain point we hit, in local OpenGL }
|
||||
{ coordinates. }
|
||||
locationX : single;
|
||||
{ Resulting Y location of the terrain point we hit, in local OpenGL }
|
||||
{ coordinates. }
|
||||
locationY : single;
|
||||
{ Resulting Z location of the terrain point we hit, in local OpenGL }
|
||||
{ coordinates. }
|
||||
locationZ : single;
|
||||
{ X component of the normal vector to the terrain we found. }
|
||||
normalX : single;
|
||||
{ Y component of the normal vector to the terrain we found. }
|
||||
normalY : single;
|
||||
{ Z component of the normal vector to the terrain we found. }
|
||||
normalZ : single;
|
||||
{ X component of the velocity vector of the terrain we found. }
|
||||
velocityX : single;
|
||||
{ Y component of the velocity vector of the terrain we found. }
|
||||
velocityY : single;
|
||||
{ Z component of the velocity vector of the terrain we found. }
|
||||
velocityZ : single;
|
||||
{ Tells if the surface we hit is water (otherwise it is land). }
|
||||
is_wet : integer;
|
||||
END;
|
||||
PXPLMProbeInfo_t = ^XPLMProbeInfo_t;
|
||||
|
||||
{
|
||||
XPLMCreateProbe
|
||||
|
||||
Creates a new probe object of a given type and returns.
|
||||
}
|
||||
FUNCTION XPLMCreateProbe(
|
||||
inProbeType : XPLMProbeType) : XPLMProbeRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMDestroyProbe
|
||||
|
||||
Deallocates an existing probe object.
|
||||
}
|
||||
PROCEDURE XPLMDestroyProbe(
|
||||
inProbe : XPLMProbeRef);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMProbeTerrainXYZ
|
||||
|
||||
Probes the terrain. Pass in the XYZ coordinate of the probe point, a probe
|
||||
object, and an XPLMProbeInfo_t struct that has its structSize member set
|
||||
properly. Other fields are filled in if we hit terrain, and a probe result
|
||||
is returned.
|
||||
}
|
||||
FUNCTION XPLMProbeTerrainXYZ(
|
||||
inProbe : XPLMProbeRef;
|
||||
inX : single;
|
||||
inY : single;
|
||||
inZ : single;
|
||||
outInfo : PXPLMProbeInfo_t) : XPLMProbeResult;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* Object Drawing
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The object drawing routines let you load and draw X-Plane OBJ files.
|
||||
Objects are loaded by file path and managed via an opaque handle. X-Plane
|
||||
naturally reference counts objects, so it is important that you balance
|
||||
every successful call to XPLMLoadObject with a call to XPLMUnloadObject!
|
||||
}
|
||||
|
||||
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
TYPE
|
||||
{
|
||||
XPLMObjectRef
|
||||
|
||||
An XPLMObjectRef is a opaque handle to an .obj file that has been loaded
|
||||
into memory.
|
||||
}
|
||||
XPLMObjectRef = pointer;
|
||||
PXPLMObjectRef = ^XPLMObjectRef;
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMDrawInfo_t
|
||||
|
||||
The XPLMDrawInfo_t structure contains positioning info for one object that
|
||||
is to be drawn. Be sure to set structSize to the size of the structure for
|
||||
future expansion.
|
||||
}
|
||||
XPLMDrawInfo_t = RECORD
|
||||
{ Set this to the size of this structure! }
|
||||
structSize : integer;
|
||||
{ X location of the object in local coordinates. }
|
||||
x : single;
|
||||
{ Y location of the object in local coordinates. }
|
||||
y : single;
|
||||
{ Z location of the object in local coordinates. }
|
||||
z : single;
|
||||
{ Pitch in degres to rotate the object, positive is up. }
|
||||
pitch : single;
|
||||
{ Heading in local coordinates to rotate the object, clockwise. }
|
||||
heading : single;
|
||||
{ Roll to rotate the object. }
|
||||
roll : single;
|
||||
END;
|
||||
PXPLMDrawInfo_t = ^XPLMDrawInfo_t;
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{
|
||||
XPLMObjectLoaded_f
|
||||
|
||||
You provide this callback when loading an object asynchronously; it will be
|
||||
called once the object is loaded. Your refcon is passed back. The object
|
||||
ref passed in is the newly loaded object (ready for use) or NULL if an
|
||||
error occured.
|
||||
|
||||
If your plugin is disabled, this callback will be delivered as soon as the
|
||||
plugin is re-enabled. If your plugin is unloaded before this callback is
|
||||
ever called, the SDK will release the object handle for you.
|
||||
}
|
||||
XPLMObjectLoaded_f = PROCEDURE(
|
||||
inObject : XPLMObjectRef;
|
||||
inRefcon : pointer); cdecl;
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMLoadObject
|
||||
|
||||
This routine loads an OBJ file and returns a handle to it. If X-plane has
|
||||
already loaded the object, the handle to the existing object is returned.
|
||||
Do not assume you will get the same handle back twice, but do make sure to
|
||||
call unload once for every load to avoid "leaking" objects. The object
|
||||
will be purged from memory when no plugins and no scenery are using it.
|
||||
|
||||
The path for the object must be relative to the X-System base folder. If
|
||||
the path is in the root of the X-System folder you may need to prepend ./
|
||||
to it; loading objects in the root of the X-System folder is STRONGLY
|
||||
discouraged - your plugin should not dump art resources in the root folder!
|
||||
|
||||
|
||||
XPLMLoadObject will return NULL if the object cannot be loaded (either
|
||||
because it is not found or the file is misformatted). This routine will
|
||||
load any object that can be used in the X-Plane scenery system.
|
||||
|
||||
It is important that the datarefs an object uses for animation already be
|
||||
loaded before you load the object. For this reason it may be necessary to
|
||||
defer object loading until the sim has fully started.
|
||||
}
|
||||
FUNCTION XPLMLoadObject(
|
||||
inPath : Pchar) : XPLMObjectRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM210}
|
||||
{
|
||||
XPLMLoadObjectAsync
|
||||
|
||||
This routine loads an object asynchronously; control is returned to you
|
||||
immediately while X-Plane loads the object. The sim will not stop flying
|
||||
while the object loads. For large objects, it may be several seconds
|
||||
before the load finishes.
|
||||
|
||||
You provide a callback function that is called once the load has completed.
|
||||
Note that if the object cannot be loaded, you will not find out until the
|
||||
callback function is called with a NULL object handle.
|
||||
|
||||
There is no way to cancel an asynchronous object load; you must wait for
|
||||
the load to complete and then release the object if it is no longer
|
||||
desired.
|
||||
}
|
||||
PROCEDURE XPLMLoadObjectAsync(
|
||||
inPath : Pchar;
|
||||
inCallback : XPLMObjectLoaded_f;
|
||||
inRefcon : pointer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMDrawObjects
|
||||
|
||||
XPLMDrawObjects draws an object from an OBJ file one or more times. You
|
||||
pass in the object and an array of XPLMDrawInfo_t structs, one for each
|
||||
place you would like the object to be drawn.
|
||||
|
||||
X-Plane will attempt to cull the objects based on LOD and visibility, and
|
||||
will pick the appropriate LOD.
|
||||
|
||||
Lighting is a boolean; pass 1 to show the night version of object with
|
||||
night-only lights lit up. Pass 0 to show the daytime version of the
|
||||
object.
|
||||
|
||||
earth_relative controls the coordinate system. If this is 1, the rotations
|
||||
you specify are applied to the object after its coordinate system is
|
||||
transformed from local to earth-relative coordinates -- that is, an object
|
||||
with no rotations will point toward true north and the Y axis will be up
|
||||
against gravity. If this is 0, the object is drawn with your rotations
|
||||
from local coordanates -- that is, an object with no rotations is drawn
|
||||
pointing down the -Z axis and the Y axis of the object matches the local
|
||||
coordinate Y axis.
|
||||
}
|
||||
PROCEDURE XPLMDrawObjects(
|
||||
inObject : XPLMObjectRef;
|
||||
inCount : integer;
|
||||
inLocations : PXPLMDrawInfo_t;
|
||||
lighting : integer;
|
||||
earth_relative : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMUnloadObject
|
||||
|
||||
This routine marks an object as no longer being used by your plugin.
|
||||
Objects are reference counted: once no plugins are using an object, it is
|
||||
purged from memory. Make sure to call XPLMUnloadObject once for each
|
||||
successful call to XPLMLoadObject.
|
||||
}
|
||||
PROCEDURE XPLMUnloadObject(
|
||||
inObject : XPLMObjectRef);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{___________________________________________________________________________
|
||||
* Library Access
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The library access routines allow you to locate scenery objects via the
|
||||
X-Plane library system. Right now library access is only provided for
|
||||
objects, allowing plugin-drawn objects to be extended using the library
|
||||
system.
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMLibraryEnumerator_f
|
||||
|
||||
An XPLMLibraryEnumerator_f is a callback you provide that is called once
|
||||
for each library element that is located. The returned paths will be
|
||||
relative to the X-System folder.
|
||||
}
|
||||
TYPE
|
||||
XPLMLibraryEnumerator_f = PROCEDURE(
|
||||
inFilePath : Pchar;
|
||||
inRef : pointer); cdecl;
|
||||
|
||||
{
|
||||
XPLMLookupObjects
|
||||
|
||||
This routine looks up a virtual path in the library system and returns all
|
||||
matching elements. You provide a callback - one virtual path may match
|
||||
many objects in the library. XPLMLookupObjects returns the number of
|
||||
objects found.
|
||||
|
||||
The latitude and longitude parameters specify the location the object will
|
||||
be used. The library system allows for scenery packages to only provide
|
||||
objects to certain local locations. Only objects that are allowed at the
|
||||
latitude/longitude you provide will be returned.
|
||||
}
|
||||
FUNCTION XPLMLookupObjects(
|
||||
inPath : Pchar;
|
||||
inLatitude : single;
|
||||
inLongitude : single;
|
||||
enumerator : XPLMLibraryEnumerator_f;
|
||||
ref : pointer) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{$ENDIF}
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
927
xpcPlugin/SDK/Delphi/XPLM/XPLMUtilities.pas
Executable file
927
xpcPlugin/SDK/Delphi/XPLM/XPLMUtilities.pas
Executable file
@@ -0,0 +1,927 @@
|
||||
{
|
||||
Copyright 2005-2012 Sandy Barbour and Ben Supnik
|
||||
|
||||
All rights reserved. See license.txt for usage.
|
||||
|
||||
X-Plane SDK Version: 2.1.1
|
||||
}
|
||||
|
||||
UNIT XPLMUtilities;
|
||||
INTERFACE
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
USES XPLMDefs;
|
||||
{$A4}
|
||||
{$IFDEF MSWINDOWS}
|
||||
{$DEFINE DELPHI}
|
||||
{$ENDIF}
|
||||
{___________________________________________________________________________
|
||||
* X-PLANE USER INTERACTION
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The user interaction APIs let you simulate commands the user can do with a
|
||||
joystick, keyboard etc. Note that it is generally safer for future
|
||||
compatibility to use one of these commands than to manipulate the
|
||||
underlying sim data.
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMCommandKeyID
|
||||
|
||||
These enums represent all the keystrokes available within x-plane. They
|
||||
can be sent to x-plane directly. For example, you can reverse thrust using
|
||||
these enumerations.
|
||||
}
|
||||
TYPE
|
||||
XPLMCommandKeyID = (
|
||||
xplm_key_pause=0,
|
||||
xplm_key_revthrust,
|
||||
xplm_key_jettison,
|
||||
xplm_key_brakesreg,
|
||||
xplm_key_brakesmax,
|
||||
xplm_key_gear,
|
||||
xplm_key_timedn,
|
||||
xplm_key_timeup,
|
||||
xplm_key_fadec,
|
||||
xplm_key_otto_dis,
|
||||
xplm_key_otto_atr,
|
||||
xplm_key_otto_asi,
|
||||
xplm_key_otto_hdg,
|
||||
xplm_key_otto_gps,
|
||||
xplm_key_otto_lev,
|
||||
xplm_key_otto_hnav,
|
||||
xplm_key_otto_alt,
|
||||
xplm_key_otto_vvi,
|
||||
xplm_key_otto_vnav,
|
||||
xplm_key_otto_nav1,
|
||||
xplm_key_otto_nav2,
|
||||
xplm_key_targ_dn,
|
||||
xplm_key_targ_up,
|
||||
xplm_key_hdgdn,
|
||||
xplm_key_hdgup,
|
||||
xplm_key_barodn,
|
||||
xplm_key_baroup,
|
||||
xplm_key_obs1dn,
|
||||
xplm_key_obs1up,
|
||||
xplm_key_obs2dn,
|
||||
xplm_key_obs2up,
|
||||
xplm_key_com1_1,
|
||||
xplm_key_com1_2,
|
||||
xplm_key_com1_3,
|
||||
xplm_key_com1_4,
|
||||
xplm_key_nav1_1,
|
||||
xplm_key_nav1_2,
|
||||
xplm_key_nav1_3,
|
||||
xplm_key_nav1_4,
|
||||
xplm_key_com2_1,
|
||||
xplm_key_com2_2,
|
||||
xplm_key_com2_3,
|
||||
xplm_key_com2_4,
|
||||
xplm_key_nav2_1,
|
||||
xplm_key_nav2_2,
|
||||
xplm_key_nav2_3,
|
||||
xplm_key_nav2_4,
|
||||
xplm_key_adf_1,
|
||||
xplm_key_adf_2,
|
||||
xplm_key_adf_3,
|
||||
xplm_key_adf_4,
|
||||
xplm_key_adf_5,
|
||||
xplm_key_adf_6,
|
||||
xplm_key_transpon_1,
|
||||
xplm_key_transpon_2,
|
||||
xplm_key_transpon_3,
|
||||
xplm_key_transpon_4,
|
||||
xplm_key_transpon_5,
|
||||
xplm_key_transpon_6,
|
||||
xplm_key_transpon_7,
|
||||
xplm_key_transpon_8,
|
||||
xplm_key_flapsup,
|
||||
xplm_key_flapsdn,
|
||||
xplm_key_cheatoff,
|
||||
xplm_key_cheaton,
|
||||
xplm_key_sbrkoff,
|
||||
xplm_key_sbrkon,
|
||||
xplm_key_ailtrimL,
|
||||
xplm_key_ailtrimR,
|
||||
xplm_key_rudtrimL,
|
||||
xplm_key_rudtrimR,
|
||||
xplm_key_elvtrimD,
|
||||
xplm_key_elvtrimU,
|
||||
xplm_key_forward,
|
||||
xplm_key_down,
|
||||
xplm_key_left,
|
||||
xplm_key_right,
|
||||
xplm_key_back,
|
||||
xplm_key_tower,
|
||||
xplm_key_runway,
|
||||
xplm_key_chase,
|
||||
xplm_key_free1,
|
||||
xplm_key_free2,
|
||||
xplm_key_spot,
|
||||
xplm_key_fullscrn1,
|
||||
xplm_key_fullscrn2,
|
||||
xplm_key_tanspan,
|
||||
xplm_key_smoke,
|
||||
xplm_key_map,
|
||||
xplm_key_zoomin,
|
||||
xplm_key_zoomout,
|
||||
xplm_key_cycledump,
|
||||
xplm_key_replay,
|
||||
xplm_key_tranID,
|
||||
xplm_key_max
|
||||
);
|
||||
PXPLMCommandKeyID = ^XPLMCommandKeyID;
|
||||
|
||||
{
|
||||
XPLMCommandButtonID
|
||||
|
||||
These are enumerations for all of the things you can do with a joystick
|
||||
button in X-Plane. They currently match the buttons menu in the equipment
|
||||
setup dialog, but these enums will be stable even if they change in
|
||||
X-Plane.
|
||||
}
|
||||
XPLMCommandButtonID = (
|
||||
xplm_joy_nothing=0,
|
||||
xplm_joy_start_all,
|
||||
xplm_joy_start_0,
|
||||
xplm_joy_start_1,
|
||||
xplm_joy_start_2,
|
||||
xplm_joy_start_3,
|
||||
xplm_joy_start_4,
|
||||
xplm_joy_start_5,
|
||||
xplm_joy_start_6,
|
||||
xplm_joy_start_7,
|
||||
xplm_joy_throt_up,
|
||||
xplm_joy_throt_dn,
|
||||
xplm_joy_prop_up,
|
||||
xplm_joy_prop_dn,
|
||||
xplm_joy_mixt_up,
|
||||
xplm_joy_mixt_dn,
|
||||
xplm_joy_carb_tog,
|
||||
xplm_joy_carb_on,
|
||||
xplm_joy_carb_off,
|
||||
xplm_joy_trev,
|
||||
xplm_joy_trm_up,
|
||||
xplm_joy_trm_dn,
|
||||
xplm_joy_rot_trm_up,
|
||||
xplm_joy_rot_trm_dn,
|
||||
xplm_joy_rud_lft,
|
||||
xplm_joy_rud_cntr,
|
||||
xplm_joy_rud_rgt,
|
||||
xplm_joy_ail_lft,
|
||||
xplm_joy_ail_cntr,
|
||||
xplm_joy_ail_rgt,
|
||||
xplm_joy_B_rud_lft,
|
||||
xplm_joy_B_rud_rgt,
|
||||
xplm_joy_look_up,
|
||||
xplm_joy_look_dn,
|
||||
xplm_joy_look_lft,
|
||||
xplm_joy_look_rgt,
|
||||
xplm_joy_glance_l,
|
||||
xplm_joy_glance_r,
|
||||
xplm_joy_v_fnh,
|
||||
xplm_joy_v_fwh,
|
||||
xplm_joy_v_tra,
|
||||
xplm_joy_v_twr,
|
||||
xplm_joy_v_run,
|
||||
xplm_joy_v_cha,
|
||||
xplm_joy_v_fr1,
|
||||
xplm_joy_v_fr2,
|
||||
xplm_joy_v_spo,
|
||||
xplm_joy_flapsup,
|
||||
xplm_joy_flapsdn,
|
||||
xplm_joy_vctswpfwd,
|
||||
xplm_joy_vctswpaft,
|
||||
xplm_joy_gear_tog,
|
||||
xplm_joy_gear_up,
|
||||
xplm_joy_gear_down,
|
||||
xplm_joy_lft_brake,
|
||||
xplm_joy_rgt_brake,
|
||||
xplm_joy_brakesREG,
|
||||
xplm_joy_brakesMAX,
|
||||
xplm_joy_speedbrake,
|
||||
xplm_joy_ott_dis,
|
||||
xplm_joy_ott_atr,
|
||||
xplm_joy_ott_asi,
|
||||
xplm_joy_ott_hdg,
|
||||
xplm_joy_ott_alt,
|
||||
xplm_joy_ott_vvi,
|
||||
xplm_joy_tim_start,
|
||||
xplm_joy_tim_reset,
|
||||
xplm_joy_ecam_up,
|
||||
xplm_joy_ecam_dn,
|
||||
xplm_joy_fadec,
|
||||
xplm_joy_yaw_damp,
|
||||
xplm_joy_art_stab,
|
||||
xplm_joy_chute,
|
||||
xplm_joy_JATO,
|
||||
xplm_joy_arrest,
|
||||
xplm_joy_jettison,
|
||||
xplm_joy_fuel_dump,
|
||||
xplm_joy_puffsmoke,
|
||||
xplm_joy_prerotate,
|
||||
xplm_joy_UL_prerot,
|
||||
xplm_joy_UL_collec,
|
||||
xplm_joy_TOGA,
|
||||
xplm_joy_shutdown,
|
||||
xplm_joy_con_atc,
|
||||
xplm_joy_fail_now,
|
||||
xplm_joy_pause,
|
||||
xplm_joy_rock_up,
|
||||
xplm_joy_rock_dn,
|
||||
xplm_joy_rock_lft,
|
||||
xplm_joy_rock_rgt,
|
||||
xplm_joy_rock_for,
|
||||
xplm_joy_rock_aft,
|
||||
xplm_joy_idle_hilo,
|
||||
xplm_joy_lanlights,
|
||||
xplm_joy_max
|
||||
);
|
||||
PXPLMCommandButtonID = ^XPLMCommandButtonID;
|
||||
|
||||
{
|
||||
XPLMHostApplicationID
|
||||
|
||||
The plug-in system is based on Austin's cross-platform OpenGL framework and
|
||||
could theoretically be adapted to run in other apps like WorldMaker. The
|
||||
plug-in system also runs against a test harness for internal development
|
||||
and could be adapted to another flight sim (in theory at least). So an ID
|
||||
is providing allowing plug-ins to indentify what app they are running
|
||||
under.
|
||||
}
|
||||
XPLMHostApplicationID = (
|
||||
xplm_Host_Unknown = 0
|
||||
|
||||
,xplm_Host_XPlane = 1
|
||||
|
||||
,xplm_Host_PlaneMaker = 2
|
||||
|
||||
,xplm_Host_WorldMaker = 3
|
||||
|
||||
,xplm_Host_Briefer = 4
|
||||
|
||||
,xplm_Host_PartMaker = 5
|
||||
|
||||
,xplm_Host_YoungsMod = 6
|
||||
|
||||
,xplm_Host_XAuto = 7
|
||||
|
||||
);
|
||||
PXPLMHostApplicationID = ^XPLMHostApplicationID;
|
||||
|
||||
{
|
||||
XPLMLanguageCode
|
||||
|
||||
These enums define what language the sim is running in. These enumerations
|
||||
do not imply that the sim can or does run in all of these languages; they
|
||||
simply provide a known encoding in the event that a given sim version is
|
||||
localized to a certain language.
|
||||
}
|
||||
XPLMLanguageCode = (
|
||||
xplm_Language_Unknown = 0
|
||||
|
||||
,xplm_Language_English = 1
|
||||
|
||||
,xplm_Language_French = 2
|
||||
|
||||
,xplm_Language_German = 3
|
||||
|
||||
,xplm_Language_Italian = 4
|
||||
|
||||
,xplm_Language_Spanish = 5
|
||||
|
||||
,xplm_Language_Korean = 6
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
,xplm_Language_Russian = 7
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
,xplm_Language_Greek = 8
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
,xplm_Language_Japanese = 9
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
,xplm_Language_Chinese = 10
|
||||
{$ENDIF}
|
||||
|
||||
);
|
||||
PXPLMLanguageCode = ^XPLMLanguageCode;
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMDataFileType
|
||||
|
||||
These enums define types of data files you can load or unload using the
|
||||
SDK.
|
||||
}
|
||||
XPLMDataFileType = (
|
||||
{ A situation (.sit) file, which starts off a flight in a given }
|
||||
{ configuration. }
|
||||
xplm_DataFile_Situation = 1
|
||||
|
||||
{ A situation movie (.smo) file, which replays a past flight. }
|
||||
,xplm_DataFile_ReplayMovie = 2
|
||||
|
||||
);
|
||||
PXPLMDataFileType = ^XPLMDataFileType;
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMError_f
|
||||
|
||||
An XPLM error callback is a function that you provide to receive debugging
|
||||
information from the plugin SDK. See XPLMSetErrorCallback for more
|
||||
information. NOTE: for the sake of debugging, your error callback will be
|
||||
called even if your plugin is not enabled, allowing you to receive debug
|
||||
info in your XPluginStart and XPluginStop callbacks. To avoid causing
|
||||
logic errors in the management code, do not call any other plugin routines
|
||||
from your error callback - it is only meant for logging!
|
||||
}
|
||||
XPLMError_f = PROCEDURE(
|
||||
inMessage : Pchar); cdecl;
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSimulateKeyPress
|
||||
|
||||
This function simulates a key being pressed for x-plane. The keystroke
|
||||
goes directly to x-plane; it is never sent to any plug-ins. However, since
|
||||
this is a raw key stroke it may be mapped by the keys file or enter text
|
||||
into a field.
|
||||
|
||||
WARNING: This function will be deprecated; do not use it. Instead use
|
||||
XPLMCommandKeyStroke.
|
||||
}
|
||||
PROCEDURE XPLMSimulateKeyPress(
|
||||
inKeyType : integer;
|
||||
inKey : integer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMSpeakString
|
||||
|
||||
This function displays the string in a translucent overlay over the current
|
||||
display and also speaks the string if text-to-speech is enabled. The
|
||||
string is spoken asynchronously, this function returns immediately.
|
||||
}
|
||||
PROCEDURE XPLMSpeakString(
|
||||
inString : Pchar);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCommandKeyStroke
|
||||
|
||||
This routine simulates a command-key stroke. However, the keys are done by
|
||||
function, not by actual letter, so this function works even if the user has
|
||||
remapped their keyboard. Examples of things you might do with this include
|
||||
pausing the simulator.
|
||||
}
|
||||
PROCEDURE XPLMCommandKeyStroke(
|
||||
inKey : XPLMCommandKeyID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCommandButtonPress
|
||||
|
||||
This function simulates any of the actions that might be taken by pressing
|
||||
a joystick button. However, this lets you call the command directly rather
|
||||
than have to know which button is mapped where. Important: you must
|
||||
release each button you press. The APIs are separate so that you can 'hold
|
||||
down' a button for a fixed amount of time.
|
||||
}
|
||||
PROCEDURE XPLMCommandButtonPress(
|
||||
inButton : XPLMCommandButtonID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCommandButtonRelease
|
||||
|
||||
This function simulates any of the actions that might be taken by pressing
|
||||
a joystick button. See XPLMCommandButtonPress
|
||||
}
|
||||
PROCEDURE XPLMCommandButtonRelease(
|
||||
inButton : XPLMCommandButtonID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetVirtualKeyDescription
|
||||
|
||||
Given a virtual key code (as defined in XPLMDefs.h) this routine returns a
|
||||
human-readable string describing the character. This routine is provided
|
||||
for showing users what keyboard mappings they have set up. The string may
|
||||
read 'unknown' or be a blank or NULL string if the virtual key is unknown.
|
||||
}
|
||||
FUNCTION XPLMGetVirtualKeyDescription(
|
||||
inVirtualKey : char) : Pchar;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{___________________________________________________________________________
|
||||
* X-PLANE MISC
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMReloadScenery
|
||||
|
||||
XPLMReloadScenery reloads the current set of scenery. You can use this
|
||||
function in two typical ways: simply call it to reload the scenery, picking
|
||||
up any new installed scenery, .env files, etc. from disk. Or, change the
|
||||
lat/ref and lon/ref data refs and then call this function to shift the
|
||||
scenery environment.
|
||||
}
|
||||
PROCEDURE XPLMReloadScenery;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetSystemPath
|
||||
|
||||
This function returns the full path to the X-System folder. Note that this
|
||||
is a directory path, so it ends in a trailing : or /. The buffer you pass
|
||||
should be at least 512 characters long.
|
||||
}
|
||||
PROCEDURE XPLMGetSystemPath(
|
||||
outSystemPath : Pchar);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetPrefsPath
|
||||
|
||||
This routine returns a full path to the proper directory to store
|
||||
preferences in. It ends in a : or /. The buffer you pass should be at
|
||||
least 512 characters long.
|
||||
}
|
||||
PROCEDURE XPLMGetPrefsPath(
|
||||
outPrefsPath : Pchar);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetDirectorySeparator
|
||||
|
||||
This routine returns a string with one char and a null terminator that is
|
||||
the directory separator for the current platform. This allows you to write
|
||||
code that concatinates directory paths without having to #ifdef for
|
||||
platform.
|
||||
}
|
||||
FUNCTION XPLMGetDirectorySeparator: Pchar;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMExtractFileAndPath
|
||||
|
||||
Given a full path to a file, this routine separates the path from the file.
|
||||
If the path is a partial directory (e.g. ends in : or \) the trailing
|
||||
directory separator is removed. This routine works in-place; a pointer to
|
||||
the file part of the buffer is returned; the original buffer still starts
|
||||
with the path.
|
||||
}
|
||||
FUNCTION XPLMExtractFileAndPath(
|
||||
inFullPath : Pchar) : Pchar;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetDirectoryContents
|
||||
|
||||
This routine returns a list of files in a directory (specified by a full
|
||||
path, no trailing : or \). The output is returned as a list of NULL
|
||||
terminated strings. An index array (if specified) is filled with pointers
|
||||
into the strings. This routine The last file is indicated by a zero-length
|
||||
string (and NULL in the indices). This routine will return 1 if you had
|
||||
capacity for all files or 0 if you did not. You can also skip a given
|
||||
number of files.
|
||||
|
||||
inDirectoryPath - a null terminated C string containing the full path to
|
||||
the directory with no trailing directory char.
|
||||
|
||||
inFirstReturn - the zero-based index of the first file in the directory to
|
||||
return. (Usually zero to fetch all in one pass.)
|
||||
|
||||
outFileNames - a buffer to receive a series of sequential null terminated
|
||||
C-string file names. A zero-length C string will be appended to the very
|
||||
end.
|
||||
|
||||
inFileNameBufSize - the size of the file name buffer in bytes.
|
||||
|
||||
outIndices - a pointer to an array of character pointers that will become
|
||||
an index into the directory. The last file will be followed by a NULL
|
||||
value. Pass NULL if you do not want indexing information.
|
||||
|
||||
inIndexCount - the max size of the index in entries.
|
||||
|
||||
outTotalFiles - if not NULL, this is filled in with the number of files in
|
||||
the directory.
|
||||
|
||||
outReturnedFiles - if not NULL, the number of files returned by this
|
||||
iteration.
|
||||
|
||||
Return value - 1 if all info could be returned, 0 if there was a buffer
|
||||
overrun.
|
||||
|
||||
WARNING: Before X-Plane 7 this routine did not properly iterate through
|
||||
directories. If X-Plane 6 compatibility is needed, use your own code to
|
||||
iterate directories.
|
||||
}
|
||||
FUNCTION XPLMGetDirectoryContents(
|
||||
inDirectoryPath : Pchar;
|
||||
inFirstReturn : integer;
|
||||
outFileNames : Pchar;
|
||||
inFileNameBufSize : integer;
|
||||
outIndices : PPchar; { Can be nil }
|
||||
inIndexCount : integer;
|
||||
outTotalFiles : Pinteger; { Can be nil }
|
||||
outReturnedFiles : Pinteger) : integer; { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMInitialized
|
||||
|
||||
This function returns 1 if X-Plane has properly initialized the plug-in
|
||||
system. If this routine returns 0, many XPLM functions will not work.
|
||||
|
||||
NOTE: Under normal circumstances a plug-in should never be running while
|
||||
the plug-in manager is not initialized.
|
||||
|
||||
WARNING: This function is generally not needed and may be deprecated in the
|
||||
future.
|
||||
}
|
||||
FUNCTION XPLMInitialized: integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetVersions
|
||||
|
||||
This routine returns the revision of both X-Plane and the XPLM DLL. All
|
||||
versions are three-digit decimal numbers (e.g. 606 for version 6.06 of
|
||||
X-Plane); the current revision of the XPLM is 200 (2.00). This routine
|
||||
also returns the host ID of the app running us.
|
||||
|
||||
The most common use of this routine is to special-case around x-plane
|
||||
version-specific behavior.
|
||||
}
|
||||
PROCEDURE XPLMGetVersions(
|
||||
outXPlaneVersion : Pinteger;
|
||||
outXPLMVersion : Pinteger;
|
||||
outHostID : PXPLMHostApplicationID);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMGetLanguage
|
||||
|
||||
This routine returns the langauge the sim is running in.
|
||||
}
|
||||
FUNCTION XPLMGetLanguage: XPLMLanguageCode;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMDebugString
|
||||
|
||||
This routine outputs a C-style string to the Log.txt file. The file is
|
||||
immediately flushed so you will not lose data. (This does cause a
|
||||
performance penalty.)
|
||||
}
|
||||
PROCEDURE XPLMDebugString(
|
||||
inString : Pchar);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMSetErrorCallback
|
||||
|
||||
XPLMSetErrorCallback installs an error-reporting callback for your plugin.
|
||||
Normally the plugin system performs minimum diagnostics to maximize
|
||||
performance. When you install an error callback, you will receive calls
|
||||
due to certain plugin errors, such as passing bad parameters or incorrect
|
||||
data.
|
||||
|
||||
The intention is for you to install the error callback during debug
|
||||
sections and put a break-point inside your callback. This will cause you
|
||||
to break into the debugger from within the SDK at the point in your plugin
|
||||
where you made an illegal call.
|
||||
|
||||
Installing an error callback may activate error checking code that would
|
||||
not normally run, and this may adversely affect performance, so do not
|
||||
leave error callbacks installed in shipping plugins.
|
||||
}
|
||||
PROCEDURE XPLMSetErrorCallback(
|
||||
inCallback : XPLMError_f);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMFindSymbol
|
||||
|
||||
This routine will attempt to find the symbol passed in the inString
|
||||
parameter. If the symbol is found a pointer the function is returned,
|
||||
othewise the function will return NULL.
|
||||
}
|
||||
FUNCTION XPLMFindSymbol(
|
||||
inString : Pchar) : pointer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMLoadDataFile
|
||||
|
||||
Loads a data file of a given type. Paths must be relative to the X-System
|
||||
folder. To clear the replay, pass a NULL file name (this is only valid with
|
||||
replay movies, not sit files).
|
||||
}
|
||||
FUNCTION XPLMLoadDataFile(
|
||||
inFileType : XPLMDataFileType;
|
||||
inFilePath : Pchar) : integer; { Can be nil }
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{
|
||||
XPLMSaveDataFile
|
||||
|
||||
Saves the current situation or replay; paths are relative to the X-System
|
||||
folder.
|
||||
}
|
||||
FUNCTION XPLMSaveDataFile(
|
||||
inFileType : XPLMDataFileType;
|
||||
inFilePath : Pchar) : integer;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
{$ENDIF}
|
||||
|
||||
{$IFDEF XPLM200}
|
||||
{___________________________________________________________________________
|
||||
* X-PLANE COMMAND MANAGEMENT
|
||||
___________________________________________________________________________}
|
||||
{
|
||||
The command management APIs let plugins interact with the command-system in
|
||||
X-Plane, the abstraction behind keyboard presses and joystick buttons.
|
||||
This API lets you create new commands and modify the behavior (or get
|
||||
notification) of existing ones.
|
||||
|
||||
An X-Plane command consists of three phases: a beginning, continuous
|
||||
repetition, and an ending. The command may be repeated zero times in the
|
||||
event that the user presses a button only momentarily.
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
{
|
||||
XPLMCommandPhase
|
||||
|
||||
The phases of a command.
|
||||
}
|
||||
TYPE
|
||||
XPLMCommandPhase = (
|
||||
{ The command is being started. }
|
||||
xplm_CommandBegin = 0
|
||||
|
||||
{ The command is continuing to execute. }
|
||||
,xplm_CommandContinue = 1
|
||||
|
||||
{ The command has ended. }
|
||||
,xplm_CommandEnd = 2
|
||||
|
||||
);
|
||||
PXPLMCommandPhase = ^XPLMCommandPhase;
|
||||
|
||||
{
|
||||
XPLMCommandRef
|
||||
|
||||
A command ref is an opaque identifier for an X-Plane command. Command
|
||||
references stay the same for the life of your plugin but not between
|
||||
executions of X-Plane. Command refs are used to execute commands, create
|
||||
commands, and create callbacks for particular commands.
|
||||
|
||||
Note that a command is not "owned" by a particular plugin. Since many
|
||||
plugins may participate in a command's execution, the command does not go
|
||||
away if the plugin that created it is unloaded.
|
||||
}
|
||||
XPLMCommandRef = pointer;
|
||||
PXPLMCommandRef = ^XPLMCommandRef;
|
||||
|
||||
{
|
||||
XPLMCommandCallback_f
|
||||
|
||||
A command callback is a function in your plugin that is called when a
|
||||
command is pressed. Your callback receives the commadn reference for the
|
||||
particular command, the phase of the command that is executing, and a
|
||||
reference pointer that you specify when registering the callback.
|
||||
|
||||
Your command handler should return 1 to let processing of the command
|
||||
continue to other plugins and X-Plane, or 0 to halt processing,
|
||||
potentially bypassing X-Plane code.
|
||||
}
|
||||
XPLMCommandCallback_f = FUNCTION(
|
||||
inCommand : XPLMCommandRef;
|
||||
inPhase : XPLMCommandPhase;
|
||||
inRefcon : pointer) : integer; cdecl;
|
||||
|
||||
{
|
||||
XPLMFindCommand
|
||||
|
||||
XPLMFindCommand looks up a command by name, and returns its command
|
||||
reference or NULL if the command does not exist.
|
||||
}
|
||||
FUNCTION XPLMFindCommand(
|
||||
inName : Pchar) : XPLMCommandRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCommandBegin
|
||||
|
||||
XPLMCommandBegin starts the execution of a command, specified by its
|
||||
command reference. The command is "held down" until XPLMCommandEnd is
|
||||
called.
|
||||
}
|
||||
PROCEDURE XPLMCommandBegin(
|
||||
inCommand : XPLMCommandRef);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCommandEnd
|
||||
|
||||
XPLMCommandEnd ends the execution of a given command that was started with
|
||||
XPLMCommandBegin.
|
||||
}
|
||||
PROCEDURE XPLMCommandEnd(
|
||||
inCommand : XPLMCommandRef);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCommandOnce
|
||||
|
||||
This executes a given command momentarily, that is, the command begins and
|
||||
ends immediately.
|
||||
}
|
||||
PROCEDURE XPLMCommandOnce(
|
||||
inCommand : XPLMCommandRef);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMCreateCommand
|
||||
|
||||
XPLMCreateCommand creates a new command for a given string. If the command
|
||||
already exists, the existing command reference is returned. The
|
||||
description may appear in user interface contexts, such as the joystick
|
||||
configuration screen.
|
||||
}
|
||||
FUNCTION XPLMCreateCommand(
|
||||
inName : Pchar;
|
||||
inDescription : Pchar) : XPLMCommandRef;
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMRegisterCommandHandler
|
||||
|
||||
XPLMRegisterCommandHandler registers a callback to be called when a command
|
||||
is executed. You provide a callback with a reference pointer.
|
||||
|
||||
If inBefore is true, your command handler callback will be executed before
|
||||
X-Plane executes the command, and returning 0 from your callback will
|
||||
disable X-Plane's processing of the command. If inBefore is false, your
|
||||
callback will run after X-Plane. (You can register a single callback both
|
||||
before and after a command.)
|
||||
}
|
||||
PROCEDURE XPLMRegisterCommandHandler(
|
||||
inComand : XPLMCommandRef;
|
||||
inHandler : XPLMCommandCallback_f;
|
||||
inBefore : integer;
|
||||
inRefcon : pointer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{
|
||||
XPLMUnregisterCommandHandler
|
||||
|
||||
XPLMUnregisterCommandHandler removes a command callback registered with
|
||||
XPLMRegisterCommandHandler.
|
||||
}
|
||||
PROCEDURE XPLMUnregisterCommandHandler(
|
||||
inComand : XPLMCommandRef;
|
||||
inHandler : XPLMCommandCallback_f;
|
||||
inBefore : integer;
|
||||
inRefcon : pointer);
|
||||
{$IFDEF DELPHI}
|
||||
cdecl; external 'XPLM.DLL';
|
||||
{$ELSE}
|
||||
cdecl; external '';
|
||||
{$ENDIF}
|
||||
|
||||
{$ENDIF}
|
||||
IMPLEMENTATION
|
||||
END.
|
||||
BIN
xpcPlugin/SDK/Libraries/Mac/XPLM.framework/XPLM
Executable file
BIN
xpcPlugin/SDK/Libraries/Mac/XPLM.framework/XPLM
Executable file
Binary file not shown.
BIN
xpcPlugin/SDK/Libraries/Mac/XPWidgets.framework/XPWidgets
Executable file
BIN
xpcPlugin/SDK/Libraries/Mac/XPWidgets.framework/XPWidgets
Executable file
Binary file not shown.
BIN
xpcPlugin/SDK/Libraries/Win/XPLM.lib
Executable file
BIN
xpcPlugin/SDK/Libraries/Win/XPLM.lib
Executable file
Binary file not shown.
BIN
xpcPlugin/SDK/Libraries/Win/XPLM_64.lib
Executable file
BIN
xpcPlugin/SDK/Libraries/Win/XPLM_64.lib
Executable file
Binary file not shown.
BIN
xpcPlugin/SDK/Libraries/Win/XPWidgets.lib
Executable file
BIN
xpcPlugin/SDK/Libraries/Win/XPWidgets.lib
Executable file
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user