topic Compile and create my own API in C++ in Archicad C++ API

Compile and create my own API in C++

Anonymous — Thu, 03 Aug 2023 07:42:16 GMT

Hi,

i'm Alex, from Spain. I need help about how to program API's for archiCAD, specifically how to compile C++ programs alredy finished with Qt GUI in Visual Studio and transform this project in an archiCAD API. I guess is something difficult but probably is not impossible. Please if somebody can help me or suggest me something different, please just contact with me here.

Thank you!

Re: Compile and create my own API in C++

Ralph Wessel — Fri, 05 Aug 2011 12:35:09 GMT

frankito5 wrote:
I need help about how to program API's for archiCAD, specifically how to compile C++ programs alredy finished with Qt GUI in Visual Studio and transform this project in an archiCAD API.

I haven't tried to do this, so I can only provide general advice. I suspect that you will have to rewrite the UI to use the ArchiCAD API rather than the Qt GUI. It will otherwise be very difficult - perhaps impossible - to integrate with ArchiCAD.

Also, be very careful with how resources (e.g. memory) are allocated by the Qt framework - a plugin cannot allocate resources with the same freedom as a standalone application.

And finally, be aware that the add-on only runs when ArchiCAD activates it, i.e. it cannot be running constantly on a separate thread.

Re: Compile and create my own API in C++

Anonymous — Fri, 05 Aug 2011 13:35:11 GMT

First of all, thank you for a quickly reply. I imagined something like that, but i thougt it was possible. I'm trying including the Qt files in a VS project and the oppossite, including into Qt project all the files remaining to the API. Unfortunately there are always mistakes about librarys or missing files.

Even i will continue trying i would like to know what is your expert suggestion. I'm working in an API that make some calculations but it must show a good appareance(e.g. EcoDesigner). I've compiled and i've taken a look to the examples from the API Developement kit and i runned them in archiCAD. But this appareance is not enough.

What can i do? Could you give me some references, tutorial about how to do it? Thank you again, your help will be really useful for me .

Re: Compile and create my own API in C++

Ralph Wessel — Sat, 06 Aug 2011 18:53:06 GMT

frankito5 wrote:
Even i will continue trying i would like to know what is your expert suggestion. I'm working in an API that make some calculations but it must show a good appareance(e.g. EcoDesigner). I've compiled and i've taken a look to the examples from the API Developement kit and i runned them in archiCAD. But this appareance is not enough. What can i do? Could you give me some references, tutorial about how to do it?

Information about the ArchiCAD API is very scarce, so there isn't really anywhere to look outside of the examples bundled with the developer kit.

Re: Compile and create my own API in C++

Anonymous — Mon, 08 Aug 2011 06:32:09 GMT

And what about give good appearance to the APIs? Thanks.

Re: Compile and create my own API in C++

Ralph Wessel — Mon, 08 Aug 2011 07:32:19 GMT

frankito5 wrote:
And what about give good appearance to the APIs? Thanks.

Your question is too broad - can you post some screenshots to illustrate the kind of UI features/tools you are aspiring to?

Re: Compile and create my own API in C++

Anonymous — Mon, 08 Aug 2011 07:48:28 GMT

Ok. I would like to start with little tasks. For example, imagine i want to get two numbers from the user and make a calculation(addition). I woud like to create a window where the user can introduce those numbers, press a button (calculate) and get another window with the addition result.

Re: Compile and create my own API in C++

Ralph Wessel — Mon, 08 Aug 2011 09:10:21 GMT

frankito5 wrote:
Ok. I would like to start with little tasks. For example, imagine i want to get two numbers from the user and make a calculation(addition). I woud like to create a window where the user can introduce those numbers, press a button (calculate) and get another window with the addition result.

This is very easy to accomplish using the ArchiCAD API - read the documentation for the Dialog Manager (in the DevKit) and look at the example called DG_Test. The API Dialog Manager can handle a wide variety of UI control types, including Check Box, Date & Time Control, Edit Control, Group Box, Icon, List Box, List View, Picture, Pop-up Control, Progress Bar, Push Button, Push Menu Control, Radio Button, Rich Edit Control, Scroll Bar, Separator Item, Slider Bar, Spin Control, Splitter Control, Static Text, Tab Control, Tree View, User Control, User Item. You can also create modal dialogs, modeless palettes, custom menus, and new panels within existing settings dialogs.

Re: Compile and create my own API in C++

Anonymous — Mon, 08 Aug 2011 12:00:07 GMT

I was reading the Dialog Manager just to make a new modal dialog in the DG_Test example. I've modified the GRF file just for make a new one with two buttons.

'GDLG' 32580 Modal 0 0 306 158 "Dialogo Prueba" {
/* [ 1] */ Button 10 128 70 20 LargePlain "Aceptar"
/* [ 2] */ Button 216 128 70 20 LargePlain "Cancelar"
}

'DLGH' 32580 DLG_32580_Profile_Controls {
1 "" Button_0
2 "" Button_1
}

Now its supossed i have to create the dialog, but i dont know how to do it. Its supossed i have to create a new window when i click in the name of my API and i have to give tasks to these bottons inside. I've read the manual and i've seen i have to use a "call function" and a DGModalDialog, right?
In this examples is not programmed like that. It has to be inside my new function in DG_Test.cpp? Could u give me an example for this two buttons?

I'm sorry, but i'm starting and when i learn how to do one, it will be easier to develop more and more. Thank you!

Re: Compile and create my own API in C++

Anonymous — Mon, 08 Aug 2011 12:13:37 GMT

Good news!! I have my new dialog with two buttons in my API menu. So, dont text me and wait for my new answer. I hope it will be in few days . Thank you a lot!

Re: Compile and create my own API in C++

Anonymous — Tue, 09 Aug 2011 09:24:16 GMT

Hi again,

i am "playing" with the GUI and i've found a problem. I have created a Modal dialog with 4 edit text and two buttons. But, i dont know when i try to change the size(208px) in the GRC file, it does not change in the API and i do not know why! Here, the code regarding to the GRC.

'GDLG' 32590 Modal 0 0 306 208 "Caracteristicas del Captador" {
Button 50 148 70 20 LargePlain "Aceptar"
Button 200 148 70 20 LargePlain "Cancelar"
LeftText 20 25 80 16 LargePlain "Caract. 1:"
TextEdit 105 20 100 20 LargePlain 50
LeftText 20 55 80 16 LargePlain "Caract. 2:"
TextEdit 105 50 100 20 LargePlain 50
LeftText 20 85 80 16 LargePlain "Caract. 3:"
TextEdit 105 80 100 20 LargePlain 50
LeftText 20 115 80 16 LargePlain "Caract. 4:"
TextEdit 105 110 100 20 LargePlain 50
}

'DLGH' 32590 DLG_32590_Dialogo_prueba {
1 "" Button_0
2 "" Button_1
3 "" LeftText_0
4 "" TextEdit_0
5 "" LeftText_1
6 "" TextEdit_1
7 "" LeftText_2
8 "" TextEdit_2
9 "" LeftText_3
10 "" TextEdit_3
}

Could it be something related with the handler? Even i don't think so...Thanks!

Re: Compile and create my own API in C++

Ralph Wessel — Tue, 09 Aug 2011 09:50:54 GMT

frankito5 wrote:
i am "playing" with the GUI and i've found a problem. I have created a Modal dialog with 4 edit text and two buttons. But, i dont know when i try to change the size(208px) in the GRC file, it does not change in the API and i do not know why!

ArchiCAD automatically stores the previous size and position of dialogs, and retrieves them the next time the dialog is displayed. To override this, you can obtain and apply the correct dialog size during the initialisation phase of the dialog. Refer to DGGetDialogSize for the means to get the correct dialog size.

Re: Compile and create my own API in C++

Anonymous — Tue, 09 Aug 2011 10:33:13 GMT

1. Where i have to include this call function?
2. Should i have to modify the size from the GRC file?
3. Is this call correct?

void DGGetDialogSize (short dialId,short rectType,short* hSize,short* vSize);

DGGetDialogSize (Dialogo_prueba_GDLGID, DG_CLIENT, (short*)306, (short*)408);

where Dialogo_prueba_GDLGID is 32590, as the resId Modal dialog.

Re: Compile and create my own API in C++

Ralph Wessel — Tue, 09 Aug 2011 12:31:33 GMT

frankito5 wrote:
1. Where i have to include this call function?

You could add it to the dialog callback, when it is called for the dialog initialisation (DG_MSG_INIT).

frankito5 wrote:
2. Should i have to modify the size from the GRC file?

DGGetDialogSize can retrieve the size specified in the GRC file (with DG_ORIGFRAME).

frankito5 wrote:
3. Is this call correct?
void DGGetDialogSize (short dialId,short rectType,short* hSize,short* vSize);
DGGetDialogSize (Dialogo_prueba_GDLGID, DG_CLIENT, (short*)306, (short*)408);

That's the right call, but you shouldn't cast an integer value as a pointer. You want to retrieve the size of the dialog, so you should pass the addresses of integer variables to the function, e.g.:

short dialogWide = 0;
short dialogDeep = 0;
DGGetDialogSize (Dialogo_prueba_GDLGID, DG_ORIGFRAME, &dialogWide, &dialogDeep);

Then set the dialog size with those values using DGSetDialogSize.

Re: Compile and create my own API in C++

Anonymous — Wed, 10 Aug 2011 10:33:32 GMT

Unfortunately it does not work. I have alredy included it in the DGCALLBACK, inicializating 'ancho' and 'alto' inside and it is supossed it has to achieve the value of wide and hight of the GRC.

static void CaractCaptador(void)
{
GSResModule filNum;
bool isOK;

// Get the dialog from our resource file
filNum = ACAPI_UseOwnResModule ();
isOK=(DGModalDialog(CaractCapt_GDLGID,CaractCaptador_Handler, 0) == DG_OK);
ACAPI_ResetResModule (filNum);

return;
}

static short DGCALLBACK CaractCaptador_Handler (short message, short dialogID, short item, DGUserData /*userData*/, DGMessageData){

// Declaramos las variables que van a recibir el valor del GRC
short ancho = 0;
short alto = 0;

switch (message) {
case DG_MSG_INIT:
API_UCCallbackType ucb;
// initialize user controls
BNZeroMemory (&ucb, sizeof (ucb));
DGGetDialogSize (CaractCapt_GDLGID, DG_ORIGFRAME, &ancho, &alto);
ucb.dialogID = dialogID;
ucb.type = APIUserControlType_WallProfile;
ucb.itemID = WallProfileItm;
ACAPI_Interface (APIIo_SetUserControlCallbackID, &ucb, NULL);
ucb.type = APIUserControlType_BeamProfile;
ucb.itemID = BeamProfileItm;
ACAPI_Interface (APIIo_SetUserControlCallbackID, &ucb, NULL);
ucb.type = APIUserControlType_ColumnProfile;
ucb.itemID = ColumnProfileItm;
ACAPI_Interface (APIIo_SetUserControlCallbackID, &ucb, NULL);
ucb.type = APIUserControlType_AllProfile;
ucb.itemID = AllProfileItm;
ACAPI_Interface (APIIo_SetUserControlCallbackID, &ucb, NULL);
break;

case DG_MSG_CLICK:
result = item;
break;

case DG_MSG_CLOSE:
result = item;
break;
}

return (result);
}

CaractCapt_GDLGID is 32590, and u can see the GRC code regarding to this CALLBACK:

'GDLG' 32590 Modal 0 0 800 800 "Caracteristicas del Captador" {
Button 50 148 70 20 LargePlain "Aceptar"
Button 200 148 70 20 LargePlain "Cancelar"
LeftText 20 25 80 16 LargePlain "Caract. 1:"
TextEdit 105 20 100 20 LargePlain 50
LeftText 20 55 80 16 LargePlain "Caract. 2:"
TextEdit 105 50 100 20 LargePlain 50
LeftText 20 85 80 16 LargePlain "Caract. 3:"
TextEdit 105 80 100 20 LargePlain 50
LeftText 20 115 80 16 LargePlain "Caract. 4:"
TextEdit 105 110 100 20 LargePlain 50
}

'DLGH' 32590 DLG_32590_CaractEner {
1 "" Button_0
2 "" Button_1
3 "" LeftText_0
4 "" TextEdit_0
5 "" LeftText_1
6 "" TextEdit_1
7 "" LeftText_2
8 "" TextEdit_2
9 "" LeftText_3
10 "" TextEdit_3
}

Now i have the same size (no 800 x 800 as i want) i refered in last post. Could you tell me if i have made any error or if i have forgotten something? Thank you again.

Re: Compile and create my own API in C++

Ralph Wessel — Wed, 10 Aug 2011 14:55:55 GMT

frankito5 wrote:
Could you tell me if i have made any error or if i have forgotten something?

I can't see where you use DGSetDialogSize to set the dialog to the size obtained with DGGetDialogSize.

Re: Compile and create my own API in C++

Anonymous — Thu, 11 Aug 2011 08:36:25 GMT

Ok, now i know how it works, getting and the setting the size, perfect!

1. Next task is fill a list box without set each field one by one and repeat DGListSetItemText" X times. I want to read from a .TXT file 52 fields. The problem is when i try to open the file, because it does not open. Where i have to include this .TXT file? Or what i have to do?

static short DGCALLBACK TreeViewDlgCallBack (short message, short dialId, short itemId,
DGUserData /*userData*/, DGMessageData /*msgData*/)
{
#define FOLDER_CONTENT 3
#define CHANGE_ICON 4
#define TREEVIEW 5

Int32 treeItem;

ifstream prov("provincias.txt", ifstream::in);

if(!prov){
cout << "Error de apertura del fichero." << endl;
return -1;
}

short indprov = 1;
char * cadprov = new char [15];
static TreeViewData tvd = { 0 };

switch (message) {
case DG_MSG_INIT:
LoadTreeViewDialogIcons (&tvd);
DGListSetHeaderItemText(SelecProv_GDLGID,3,1,"Provincia");
for(int i=0;i<52;i++)
//DGListInsertItem (short dialId,short item,short listItem);
DGListInsertItem(SelecProv_GDLGID,3,DG_LIST_BOTTOM);
//DGListSetItemText (short dialId, short item, short listItem, const char* text)
DGListSetItemText(SelecProv_GDLGID,3,indprov,"Alicante");
//DGListSetItemText(SelecProv_GDLGID,3,2,"Castellón");
//DGListSetItemText(SelecProv_GDLGID,3,3,"Valencia");
while(prov >> cadprov)
DGListSetItemText(SelecProv_GDLGID,3,indprov++,cadprov);
break;

2. Another point, i would like to see errors by the output screen, but i cant generate this output messages because there is not .EXE file. How to debug the API in VS2005 to check errors? And

3. There is one way to update the archiCAD without open&close each time i want to see the changes in the API?

Thank you,

Alex

Re: Compile and create my own API in C++

Ralph Wessel — Thu, 11 Aug 2011 09:19:16 GMT

frankito5 wrote:
1. I want to read from a .TXT file 52 fields. The problem is when i try to open the file, because it does not open. Where i have to include this .TXT file?

I get the impression you haven't done much C/C++ development to date. If you write the following:

ifstream prov("provincias.txt", ifstream::in);

...you haven't stated where the file should be found, so it will assume a default directory for your file, probably C:\provincias.txt. I suggest reading the Input/Output section of the API documentation. Also, look up the functionality provided by APIEnv_GetSpecFolderID to obtain the location of key directories.

frankito5 wrote:
2. How to debug the API in VS2005 to check errors?

Set the ArchiCAD application as the target for debugging.

frankito5 wrote:
3. There is one way to update the archiCAD without open&close each time i want to see the changes in the API?

Unfortunately not.

Re: Compile and create my own API in C++

Anonymous — Thu, 11 Aug 2011 09:39:50 GMT

Set the ArchiCAD application as the target for debugging.

How to do it?

Re: Compile and create my own API in C++

Ralph Wessel — Thu, 11 Aug 2011 12:22:02 GMT

frankito5 wrote:
Set the ArchiCAD application as the target for debugging.
How to do it?

In the Debugging section of the project properties (see attached image).