topic Re: Wall Tool from favorite in Archicad C++ API

Wall Tool from favorite

dushyant — Tue, 04 Oct 2022 14:23:19 GMT

Hello,
Is there a way to activate the wall tool for drawing the wall, with a particular favorite wall’s settings? I can place a favorite wall with begC and endC. But I need the wall tool to get activated with the favorite’s settings applied & ready to draw.

Basically from the menu: Design > Design Tools > Wall , should get activated and instead of Default Settings, it should be ready with the settings of a particular favorite wall.

Thanks,
Dushyant

Re: Wall Tool from favorite

Ralph Wessel — Tue, 04 Feb 2020 10:41:35 GMT

How about using ACAPI_Element_ChangeDefaults to apply the favorite setings to the tool defaults? And APIEnv_SetToolBoxModeID can be used to make the tool active.

Re: Wall Tool from favorite

dushyant — Tue, 04 Feb 2020 11:13:11 GMT

Thanks Ralph, I will try and work with those.

Re: Wall Tool from favorite

dushyant — Tue, 04 Feb 2020 12:29:22 GMT

I am now able to set the current tool to Wall tool. However, I don’t know what to set for the ‘mask’ part of:
GSErrCode ACAPI_Element_ChangeDefaults (
API_Element* element,
API_ElementMemo* memo,
const API_Element* mask
);

Code snippet:

API_Favorite    favorite (favName);
favorite.memo.New ();
API_Element& favElement = favorite.element;
API_ElementMemo& favMemo = favorite.memo.Get();
ACAPI_Element_ChangeDefaults(&favElement, &favMemo, <MASK?>);

Thanks,
Dushyant

Re: Wall Tool from favorite

Ralph Wessel — Tue, 04 Feb 2020 12:55:04 GMT

Try using this:

	API_Element mask;
	ACAPI_ELEMENT_MASK_SETFULL(mask);

…and use mask in your call to ACAPI_Element_ChangeDefaults. That will cause everything in the favorite to be applied to the default settings.

Re: Wall Tool from favorite

dushyant — Tue, 04 Feb 2020 12:59:35 GMT

Hi Ralph,
Thanks. Just wondering, how would an API_Element mask set the properties of my favorite element when it is not linked to the favorite? Or how does it fetch the properties of the favorite?

Dushyant

Re: Wall Tool from favorite

dushyant — Tue, 04 Feb 2020 13:07:20 GMT

Ralph,
I tried:

API_Element mask;
ACAPI_ELEMENT_MASK_SETFULL(mask);

It does change the default settings as per the Favorite set in code, except for the Classification..

Does something else need to be done to change the classification as per the Favorite?

Dushyant

Re: Wall Tool from favorite

Ralph Wessel — Tue, 04 Feb 2020 13:10:17 GMT

The mask is just a filter that allows you to define which values you want to change. In this case I assume you want to apply all the settings from the favorite, which is achieved with the macro ACAPI_ELEMENT_MASK_SETFULL

A description of this macro and the application of masks is available in the API document if you need more detail.

Re: Wall Tool from favorite

dushyant — Tue, 04 Feb 2020 13:12:49 GMT

Okay, thanks a lot!

Re: Wall Tool from favorite

dushyant — Tue, 04 Feb 2020 13:20:29 GMT

Any idea why the Classification is not getting set to that of the Favorite? (It's not changing at all)

Re: Wall Tool from favorite

Ralph Wessel — Tue, 04 Feb 2020 13:28:13 GMT

dushyant wrote:
Any idea why the Classification is not getting set to that of the Favorite? (It's not changing at all)

Classifications and Properties have to be set separately. Use ACAPI_Element_RemoveClassificationItemDefault, ACAPI_Element_AddClassificationItemDefault and ACAPI_Element_SetPropertiesOfDefaultElem as required.

Re: Wall Tool from favorite

dushyant — Wed, 05 Feb 2020 12:37:17 GMT

Hi Ralph,
Thanks. I am trying to first get the existing classification of the element default:

API_Element& favElement = favorite.element;
    API_ElementMemo& favMemo = favorite.memo.Get();
    
    API_ElemTypeID typeID = tboxInfo.typeID;
    API_ElemVariationID variationID = APIVarId_LabelWall2;
    GS::Array<GS::Pair<API_Guid, API_Guid>>  systemItemPairs;
    
    ACAPI_Element_GetClassificationItemsDefault(typeID, variationID, systemItemPairs);

I am not able to figure out how to print/output the contents of systemItemPairs

Dushyant

Re: Wall Tool from favorite

Ralph Wessel — Wed, 05 Feb 2020 12:48:58 GMT

You could do something like:

	for (auto i = systemItemPairs.Begin(); i != systemItemPairs.End(); ++i) {
		//guid of system is i->first
		//guid of item is i->second
	}

Re: Wall Tool from favorite

dushyant — Wed, 05 Feb 2020 13:15:11 GMT

Thanks Ralph.
Is there a way to translate these guids into names?

Re: Wall Tool from favorite

Ralph Wessel — Wed, 05 Feb 2020 13:41:11 GMT

dushyant wrote:
Is there a way to translate these guids into names?

Use ACAPI_Classification_GetClassificationSystem and ACAPI_Classification_GetClassificationItem.

Re: Wall Tool from favorite

dushyant — Wed, 05 Feb 2020 15:21:54 GMT

Thanks Ralph. Got it!

Re: Wall Tool from favorite

dushyant — Wed, 05 Feb 2020 17:16:35 GMT

Got the default item id from:

GS::Array<GS::Pair<API_Guid, API_Guid>>  systemItemPairs;
ACAPI_Element_GetClassificationItemsDefault(typeID, variationID, systemItemPairs);
    for (auto i = systemItemPairs.Begin(); i != systemItemPairs.End(); ++i) {
        system.guid = i->first;
        item.guid = i->second;
        ACAPI_WriteReport("\nsystem guid: %d\n item guid: %d\n", false, system.guid, item.guid);
    }

Not able to get the guid of a favorite like this:

API_Favorite    favorite (favName);
API_Element& favElement = favorite.element;
ACAPI_WriteReport("favElement.header.guid: %d", false, favElement.header.guid);

Tried to get the systemItemPair of the favorite like this:

ACAPI_Element_GetClassificationItems(favElement.header.guid, favorite.classifications.Get());

and fed it into the for-loop like for default, it gave out a huge list of pairs instead of just one for the favorite in question.

I am able to clear the default Classification:

ACAPI_Element_RemoveClassificationItemDefault(typeID, variationID, item.guid);

But the default Classification is not getting set by:

ACAPI_Element_AddClassificationItemDefault(typeID, variationID, favElement.header.guid);

Please help!

Thanks.

Re: Wall Tool from favorite

Ralph Wessel — Fri, 07 Feb 2020 10:07:50 GMT

dushyant wrote:
Not able to get the guid of a favorite like this:
API_Favorite    favorite (favName);

That's the default constructor for API_Favorite - so all that code does is construct a new instance with the name you specified. The other data will all be empty.

I think you want to call a function to look up a favorite by name, e.g. ACAPI_Favorite_Get.

Re: Wall Tool from favorite

dushyant — Fri, 07 Feb 2020 10:14:27 GMT

Yes, I did use ACAPI_Favorite_Get() after that. So,

favName = "myFav"; // name of an existing favorite
API_Favorite favorite (favName);

ACAPI_Favorite_Get (&favorite); // returns NoError

API_Element& favElement = favorite.element;

ACAPI_Element_GetClassificationItems(favElement.header.guid, favorite.classifications.Get()); // this is not working

Dushyant

Re: Wall Tool from favorite

Ralph Wessel — Fri, 07 Feb 2020 10:38:34 GMT

dushyant wrote:
ACAPI_Element_GetClassificationItems(favElement.header.guid, favorite.classifications.Get()); // this is not working

The function ACAPI_Element_GetClassificationItems retrieves the classifications of an element in the model. The element data in a favorite is a template for an element (not a placed element in the model) so the guid will be null.

What are you trying to do with that call? Don't you already have the Favorite classifications after calling ACAPI_Favorite_Get?