topic Re: Run a script when file is loaded? (C++) in Archicad C++ API

Run a script when file is loaded? (C++)

Anonymous — Wed, 15 Sep 2021 07:54:58 GMT

Hello,

My goal is to open a pln file, and to run a script from my addon after my file is loded.

What I want to do is to open bunch of files by an external program, automatically process each on them with my addon.

Thanks a lot!

Re: Run a script when file is loaded? (C++)

Ralph Wessel — Tue, 04 Aug 2020 14:27:48 GMT

GS has introduced Python and JSON development features that are primarily supporting external apps driving Archicad. Do you think they might support the actions you intend to perform on the open project?

Re: Run a script when file is loaded? (C++)

Anonymous — Tue, 04 Aug 2020 14:41:53 GMT

Ralph wrote:
GS has introduced Python and JSON development features that are primarily supporting external apps driving Archicad. Do you think they might support the actions you intend to perform on the open project?

I didn’t check the python api because I know it doesn’t have all the feature that the c++ api provide.
I practically really Prefer to only use the c++ api for everything, including what I’m asking here. I have a large and complicated addon with more than 20 classes..
Isn’t it possible to do it with the c++ api?

Re: Run a script when file is loaded? (C++)

Ralph Wessel — Tue, 04 Aug 2020 15:02:48 GMT

Tomer1 wrote:
I didn’t check the python api because I know it doesn’t have all the feature that the c++ api provide.
I practically really Prefer to only use the c++ api for everything, including what I’m asking here. I have a large and complicated addon with more than 20 classes..
Isn’t it possible to do it with the c++ api?

Yes, it's certainly possible with the C++ API - and has the potential to be lot better too. I just wanted to be certain the alternatives had been considered.

First, what is the intended activation point for your process, i.e. does it need to be triggered by an external application or can it be started within Archicad and then query an external application for the intended process parameters?

Re: Run a script when file is loaded? (C++)

Anonymous — Tue, 04 Aug 2020 15:20:54 GMT

Ralph wrote:

Tomer1 wrote:
I didn’t check the python api because I know it doesn’t have all the feature that the c++ api provide.
I practically really Prefer to only use the c++ api for everything, including what I’m asking here. I have a large and complicated addon with more than 20 classes..
Isn’t it possible to do it with the c++ api?
Yes, it's certainly possible with the C++ API - and has the potential to be lot better too. I just wanted to be certain the alternatives had been considered.

First, what is the intended activation point for your process, i.e. does it need to be triggered by an external application or can it be started within Archicad and then query an external application for the intended process parameters?

The activation point is after the file is loaded.
Example of the wanted process:
1. File.pln is opened on a computer with my addon
2. After the file done loading, the addon executes some scripts
3. Done

Re: Run a script when file is loaded? (C++)

Ralph Wessel — Tue, 04 Aug 2020 16:52:15 GMT

Tomer1 wrote:
The activation point is after the file is loaded.
Example of the wanted process:
1. File.pln is opened on a computer with my addon
2. After the file done loading, the addon executes some scripts

Assuming that when you say, "File.pln is opened", that means even if the user opens the project:
1) When the add-on Initialise function is called (when it's loaded), call ACAPI_Notify_CatchProjectEvent so Archicad notifies you when project events occur, e.g. opening/saving/closing etc.

2) When Archicad invokes the callback with a project event, check the event type is APINotify_Open

3) You could immediately run whatever process is required on receiving APINotify_Open, but it's safer to ask Archicad to notify your add-on as soon as it's safe for all kinds of activity (some actions can otherwise cause a crash or be ignored). We do this if we want to display some UI component to the user (e.g. show a palette), validate project content or ensure add-on preferences are loaded/valid.

4) To delay processing until an appropriate moment, you can request a callback from Archicad using ACAPI_Command_CallFromEventLoop. The documentation for this function has a code example you can use. Your callback handler can implement whatever process you need to action on the project. If you intend to modify the project, don't forget to fold your process into ACAPI_CallUndoableCommand

Re: Run a script when file is loaded? (C++)

Anonymous — Wed, 05 Aug 2020 06:23:38 GMT

Ralph wrote:

Tomer1 wrote:
The activation point is after the file is loaded.
Example of the wanted process:
1. File.pln is opened on a computer with my addon
2. After the file done loading, the addon executes some scripts
Assuming that when you say, "File.pln is opened", that means even if the user opens the project:
1) When the add-on Initialise function is called (when it's loaded), call ACAPI_Notify_CatchProjectEvent so Archicad notifies you when project events occur, e.g. opening/saving/closing etc.

2) When Archicad invokes the callback with a project event, check the event type is APINotify_Open

3) You could immediately run whatever process is required on receiving APINotify_Open, but it's safer to ask Archicad to notify your add-on as soon as it's safe for all kinds of activity (some actions can otherwise cause a crash or be ignored). We do this if we want to display some UI component to the user (e.g. show a palette), validate project content or ensure add-on preferences are loaded/valid.

4) To delay processing until an appropriate moment, you can request a callback from Archicad using ACAPI_Command_CallFromEventLoop. The documentation for this function has a code example you can use. Your callback handler can implement whatever process you need to action on the project. If you intend to modify the project, don't forget to fold your process into ACAPI_CallUndoableCommand

File.pln is opened means that I opened AC file (Archicad was closed and I double clicked a pln file). Will it work?

Edit:
Worked after setting the addon to preload
Thanks!!

Re: Run a script when file is loaded? (C++)

Ralph Wessel — Wed, 05 Aug 2020 07:31:26 GMT

Tomer1 wrote:
File.pln is opened means that I opened AC file (Archicad was closed and I double clicked a pln file). Will it work?

Yes, the notification works for any action that opens a project.