topic Re: Add-On Template in Archicad C++ API

Add-On Template

poco2013 — Thu, 06 Oct 2022 11:05:00 GMT

The Xcode Add On Template is great to get started but lacks the menu 'hook-up' necessary to start a project. This kind of defeats the propose of a quick start template.

Would like to see a template that includes a simple test menu with say one item/function and the standard 'Hello World' WriteReport message.

Are there any instruction available as how to create my own template in xcode to do this?

Re: Add-On Template

Anonymous — Wed, 03 Oct 2018 14:08:13 GMT

It would be good to have one for Visual Studio as well. So you can start project instantly on custom path.

Re: Add-On Template

Anonymous — Thu, 04 Oct 2018 01:59:39 GMT

kzaremba wrote:
It would be good to have one for Visual Studio as well. So you can start project instantly on custom path.

I'm using VS 2017 but I don't know how to start with Hello World Blog. How can I use that code and necessary resource to get Hello World in AC. Could you show me how to do it step by step? Thanks for your kind.

Re: Add-On Template

Ralph Wessel — Thu, 04 Oct 2018 08:34:29 GMT

I suggest copying one of the example projects with a single menu item, e.g. AddOnObject_Manager and replace the code in the menu handler:

// -----------------------------------------------------------------------------
// DoCommand
//		called to perform the user-asked command
// -----------------------------------------------------------------------------

GSErrCode	__ACENV_CALL	MenuCommandHandler (const API_MenuParams *params)
{
	if (params->menuItemRef.itemIndex == 1) {
		//Your code here
	}

	return NoError;
}		// MenuCommandHandler

Re: Add-On Template

Anonymous — Thu, 04 Oct 2018 14:49:55 GMT

Hi Ralph,
Thank you so much but I'm a beginner and sorry I don't understand where menu handler is.

Re: Add-On Template

Ralph Wessel — Thu, 04 Oct 2018 16:17:36 GMT

Hai wrote:
Thank you so much but I'm a beginner and sorry I don't understand where menu handler is.

Search the project for MenuCommandHandler. For that particular project, it's in the file AddOnObject_Manager.cpp

Re: Add-On Template

Akos Somorjai — Fri, 05 Oct 2018 11:23:21 GMT

Hai wrote:
Hi Ralph,
Thank you so much but I'm a beginner and sorry I don't understand where menu handler is.

So, in your RegisterInterface() function:


GSErrCode	__ACENV_CALL	RegisterInterface (void)
{
	ACAPI_Register_Menu (32500, 0, MenuCode_UserDef, MenuFlag_Default);

	return NoError;
}		// RegisterInterface

Here 32500 is the ID of the string resource that appears in the menu; add this to the .grc file:


'STR#' 32500 "Strings for the Menu" {
/* [  1] */  "Hello world"
}

Then in your Initialize() function add the following:


GSErrCode __ACENV_CALL	Initialize (void)
{
    GSErrCode err = ACAPI_Install_MenuHandler (32500, MenuCommandHandler);
    // other stuff
}

Last, in your MenuCommandHandler function call Do_CreateHelloWord():


GSErrCode	__ACENV_CALL	MenuCommandHandler (const API_MenuParams *params)
{
    if (params->menuItemRef.itemIndex == 1) {
        Do_CreateHelloWord ();
    }
}

Re: Add-On Template

Anonymous — Fri, 05 Oct 2018 17:27:11 GMT

Ralph wrote:
Search the project for MenuCommandHandler. For that particular project, it's in the file AddOnObject_Manager.cpp

Thank you very much. I will learn it and reply for result as soon.

Re: Add-On Template

Anonymous — Fri, 05 Oct 2018 17:32:01 GMT

Hi Akos,
Thank you very much for the detailed guide for me. It's very helpful for the beginner like me.

P/S: Thanks for Ralph, I can build more example without any errors and maybe I knew how API work and folder structure. Thank so much for supporting. I will do something by myself ^.^