topic Re: Info of selected items in Archicad C++ API

Info of selected items

TomWaltz — Mon, 07 Aug 2023 09:33:55 GMT

A lot of the API examples show how to get/assign parameters of clicked elements.

Does anyone have any tips on getting the API_ElemTypeID typeID, and changing parameters on SELECTED elements?

I'm struggling with which myriad of "change/get/set" functions does what I want!

Re: Info of selected items

Anonymous — Thu, 13 Oct 2005 01:18:49 GMT

Use the ACAPI_Goodies function with APIAny_NeigIDToElemTypeID to convert a neig type to a element type.

Then you can then change parameters as you would in a notification handler

Re: Info of selected items

TomWaltz — Fri, 14 Oct 2005 17:05:47 GMT

Adam

Thanks!

does that apply to parameters inside door & window objects as well?

Re: Info of selected items

Anonymous — Wed, 19 Oct 2005 01:23:51 GMT

You can use the ACAPI_Goodies function with APIAny_NeigIDToElemTypeID to convert any neig type to an element type. Windows, doors, dimensions. See the docs.

To set the parameters do like the example in the docs under APIAny_OpenParametersID, but use ACAPI_Element_ChangeParameters instead of changeDefauts. You can use ACAPI_Element_ChangeParameters straight up without the goodie functions, but the parameter script in gdl won't run so don't.

This is to change parameters (like those in gdl). It is different to changing 'members' of an element, ie. everything you see under API_Element in the docs. To do this use ACAPI_Element_Change. This is things like door position in a wall.

Re: Info of selected items

TomWaltz — Thu, 20 Oct 2005 12:18:31 GMT

Thanks, Adam. I really appreciate your help so far.

It seems I was on the right path, but must have some other problem. I copied in that bit of code, compiled it, and while no errors are generated, nor can I make the parameter actually change.

I was experimenting with two different ideas: changing the "A" value of the object and changing the "width" and "height" of the window. Neither approach seemed to work. I actually want to change the "gs_detlevel_3D" parameter, but used these as test cases.

I added a ton of debugging "WriteReport" statements, and not one displays an error. All my message statements show the "successful" path was taken and no err statements were generated.


		API_ParamOwnerType 		paramOwner;
		API_ChangeParamType 		chgParam;
		API_GetParamsType 		getParams;
		API_Element 				element, mask;
		API_ElementMemo 			memo;
		GSErrCode 				err, err2;

		BNZeroMemory (&paramOwner, sizeof (API_ParamOwnerType)); 
		paramOwner.libInd = 0; 					// no library part
		paramOwner.typeID = API_WindowID;	 	// window element
		paramOwner.index = 0; 					// element default 
	

		BNZeroMemory (&getParams, sizeof (APIAny_GetActParametersID));

		err = ACAPI_Goodies (APIAny_OpenParametersID, &paramOwner, NULL);
		if (!err) {
			BNZeroMemory (&chgParam, sizeof (API_ChangeParamType));

			err = ACAPI_Goodies (APIAny_GetActParametersID, &getParams, NULL);
			if (!err) {
				chgParam.index = 0;
				// junk parameter for testing
				CHCopyC ("A", chgParam.name);
				chgParam.realValue = 2.1;
				// what I actually want to change
				//CHCopyC ("gs_detlevel_3D", chgParam.name);
				// chgParam.strValue = "Off";
				err2 = ACAPI_Goodies (APIAny_ChangeAParameterID, &chgParam, NULL);
				if (!err2){
					err = ACAPI_Goodies (APIAny_GetActParametersID, &getParams, NULL);
					if (!err){
						WriteReport_Err("APIAny_GetActParametersID successful: ", err);
					}else{
						WriteReport_Err("APIAny_GetActParametersID error: ", err);
					}
					WriteReport_Err("ACAPI_Goodies (APIAny_ChangeAParameterID) successful: ", err2);
				}else{
					WriteReport_Err("ACAPI_Goodies (APIAny_ChangeAParameterID) error: ", err2);
				}
			}else {
				WriteReport_Err("ACAPI_Goodies (APIAny_OpenParametersID) error: ", err);
			}
			ACAPI_Goodies (APIAny_CloseParametersID, NULL, NULL);
			WriteReport_Err("APIAny_OpenParametersID successful: ", err);
		}else {
			WriteReport_Err("APIAny_OpenParametersID error: ", err);
		}

		if (!err) { 			// If typeID = Window
			BNZeroMemory (&element, sizeof (API_Element));
			BNZeroMemory (&memo, sizeof (API_ElementMemo));
			element.header.typeID = API_WindowID;
			element.window.width = 1.2;
			element.window.height = 2.1;
			ACAPI_ELEMENT_MASK_CLEAR (mask);
			ACAPI_ELEMENT_MASK_SET (mask, API_WindowType, width);
			ACAPI_ELEMENT_MASK_SET (mask, API_WindowType, height);
			memo.params = getParams.params;
			err2 = ACAPI_Element_ChangeParameters (elemHead, elemCount, &element, &memo, &mask);
			if (!err2){
				WriteReport_Err("ACAPI_Element_ChangeParameters successful: ", err2);
			}else{ 
				WriteReport_Err("ACAPI_Element_ChangeParameters error: ", err2);
			}
			WriteReport_Err("ACAPI_Goodies (APIAny_ChangeAParameterID) successful: ", err);
		}else{
			WriteReport_Err("ACAPI_Goodies (APIAny_ChangeAParameterID) error:: ", err);
		}

Is there anything you (or anyone else) see that is wrong?

Thanks for any ideas!

Re: Info of selected items

TomWaltz — Thu, 20 Oct 2005 12:20:57 GMT

.... and the output in my Report window:

Demo layer is on
Existing layer is on
Window #14
Selected element is a Window
Element is set to existing
APIAny_GetActParametersID successful: : 0
ACAPI_Goodies (APIAny_ChangeAParameterID) successful: : 0
APIAny_OpenParametersID successful: : 0
ACAPI_Element_ChangeParameters successful: : 0
ACAPI_Goodies (APIAny_ChangeAParameterID) successful: : 0

Re: Info of selected items

Anonymous — Fri, 21 Oct 2005 03:02:25 GMT

has a quick look and you don't appear to be setting the element index anywhere. eg. chgParam.index, (*elemhead)[0].index

how does it know what element your changing?
you should try with a regular parameter as a and b are kindof special

Re: Info of selected items

Ralph Wessel — Thu, 27 Oct 2005 17:17:13 GMT

TomWaltz wrote:
I was experimenting with two different ideas: changing the "A" value of the object and changing the "width" and "height" of the window. Neither approach seemed to work.
		API_ParamOwnerType 		paramOwner;
		BNZeroMemory (&paramOwner, sizeof (API_ParamOwnerType)); 
		paramOwner.libInd = 0; 					// no library part
		paramOwner.typeID = API_WindowID;	 	// window element
		paramOwner.index = 0; 					// element default 

Can you clarify what you are trying to do here? Your opening question suggests you are trying to modify a selected element, but this code would modify the default settings for placing a new Window element (you only specify the typeID and not the index of a specific element. Is that what you want? Take a look at the API documentation on the type API_ParamOwnerType for more information on this.

TomWaltz wrote:


		API_GetParamsType       getParams;
		BNZeroMemory (&getParams, sizeof(APIAny_GetActParametersID));

There is a type mismatch here - getParams is the type API_GetParamsType, but you zero it using the size of APIAny_GetActParametersID. You could also write:

BNZeroMemory (&getParams, sizeof(getParams));

Re: Info of selected items

TomWaltz — Thu, 27 Oct 2005 17:22:31 GMT

Can you clarify what you are trying to do here?

Ralph,

my intention is to change one of the parameters of the selected door or window.

The change is being done based on user information being entered into a custom panel on the settings menu.

Re: Info of selected items

Ralph Wessel — Thu, 27 Oct 2005 17:38:07 GMT

TomWaltz wrote:
my intention is to change one of the parameters of the selected door or window.

In that case, you need to specify the index for each selected window to be changed:

paramOwner.index = <index of a selected window>;

Re: Info of selected items

TomWaltz — Thu, 27 Oct 2005 18:23:30 GMT

Ralph,
I used the API_ParamOwnerType documentation as a starting point, and it never mentioned the index. It makes sense, though.

Is something more like this what you were describing?:

	API_Elem_Head		**elemHead;
	API_ElemTypeID		typeID = API_ZombieElemID;
	API_ParamOwnerType 		paramOwner;
	API_ChangeParamType 		chgParam;
	API_GetParamsType 		getParams;
	API_Element 				element, mask;
	API_ElementMemo 			memo;
	GSErrCode 				err, err2;
	API_AddParType			** addPars;

        elemHead = (API_Elem_Head **) BMAllocateHandle (sizeof (API_Elem_Head), ALLOCATE_CLEAR, 0);
	BNZeroMemory (&paramOwner, sizeof (API_ParamOwnerType)); 
	paramOwner.libInd = 0; 					// no library part
	paramOwner.typeID = API_DoorID;	 	// Door element
	paramOwner.index = 0; 					// element default 

	BNZeroMemory (&getParams, sizeof (APIAny_GetParamValuesID));

	err = ACAPI_Goodies (APIAny_OpenParametersID, &paramOwner, NULL);
	if (!err) {
		BNZeroMemory (&chgParam, sizeof (API_ChangeParamType)); 

		err = ACAPI_Goodies (APIAny_GetActParametersID, &getParams, NULL);
		if (!err) {
			chgParam.index = 0;
			CHCopyC ("gs_detlevel_3D", chgParam.name);
			chgParam.strValue = "Off";

			addPars = getParams.params;

			char 		parName[32];
			double 	val = 0;
			long 		ii;
			long  	addParNum = BMGetHandleSize (reinterpret_cast (*addPars)) / sizeof (API_AddParType);
			char		buffer [256];
			
			for (ii = 0; ii < addParNum; ii++) {
				CHCopyC ((*addPars)[ii].name, buffer);
				ACAPI_WriteReport (buffer, false); // print name for debugging
				
				if (strncmp (parName,(*addPars)[ii].name, 8)==0) {
					WriteReport("Parameter Matched",  parName); 
					paramOwner.index = ii;  
					chgParam.index = ii;
				}
				if (CHCompareCStrings ((*addPars)[ii].name, parName, CS_CaseInsensitive) == 0) { 
					chgParam.index = ii;
					CHCopyC ((*addPars)[ii].name , chgParam.name);
					CHCopyC ("Off", chgParam.strValue);
					WriteReport("Parameter variables set ", buffer); 
			         	break;
				}
			}
			err2 = ACAPI_Goodies (APIAny_ChangeAParameterID, &chgParam, NULL);

Re: Info of selected items

Ralph Wessel — Fri, 28 Oct 2005 08:24:45 GMT

TomWaltz wrote:
Ralph,
I used the API_ParamOwnerType documentation as a starting point, and it never mentioned the index. It makes sense, though.
Is something more like this what you were describing?:
	BNZeroMemory (&paramOwner, sizeof (API_ParamOwnerType)); 
	paramOwner.libInd = 0; 					// no library part
	paramOwner.typeID = API_DoorID;	 	// Door element
	paramOwner.index = 0; 					// element default 
	err = ACAPI_Goodies (APIAny_OpenParametersID, &paramOwner, NULL);

No, you haven't specified the index of the element to be modified in paramOwner.index. The documentation on API_ParamOwnerType states:

"This structure is used to specify the target of which the parameter list should be opened to edit. Possible targets are:

- parameters of a placed element (Library Part instance)
- default parameters of an element (default tool settings)
- default parameters of a Library Part itself"

The values required by API_ParamOwnerType are different for each case. Your code would be suitable for the 2nd case (library part default), but you want to do the first (placed element). You should specify the index of a selected element in paramOwner.index in order to modify it. Do you know how to get the index of a selected element?

BTW, I notice the following error in your code comes from an example in the API documentation:

BNZeroMemory (&getParams, sizeof (APIAny_GetActParametersID));

It should be:

BNZeroMemory (&getParams, sizeof (API_GetParamsType));

Re: Info of selected items

TomWaltz — Fri, 28 Oct 2005 18:28:09 GMT

Ralph wrote:
Do you know how to get the index of a selected element?

BTW, I notice the following error in your code comes from an example in the API documentation:

I believe I do. That would be:

{
	API_SelectionInfo 	selectionInfo;
	API_Neig			**selNeigs = NULL;
	API_ElemTypeID 	typeID;
	char				buffer[256];
	char 				msgStr[256];
	GSErrCode		err;

	// ------- Check selection -------
	err = ACAPI_Selection_Get (&selectionInfo, &selNeigs, false);
	if (err != NoError) {
		WriteReport_Err ("ACAPI_Selection_Get", err);
		return API_ZombieElemID;
	}
	index = elemHead.index;

	// ------- Enumerate the selection -------
	for (long i = 0; i < selectionInfo.sel_nElem; i++) {
		typeID = Neig_To_ElemID ((*selNeigs).neigID);
		if (typeID != API_ZombieElemID) {
			sprintf (buffer, "%s #%d", ElemID_To_Name (typeID), (*selNeigs).index);
			WriteReport (buffer);
		}
	}
	return;

I guess my question is whether I return the elemHead.index or the selNeigs.index?

Re: Info of selected items

Oleg — Sat, 29 Oct 2005 21:12:27 GMT

There is some rough way, snippets. So I hope you can find a way to solve your task. I didnt tested it, just tried once, so there may be number of bugs, check the source closely.


// helper function
template<class T> inline void ApiClearIt(T & obj)
{
	BNZeroMemory(&obj,sizeof(T));
}

GSErrCode StartElementParamsEditing( API_ElemTypeID elem_type, long elem_index )
{
	API_ParamOwnerType param_owner;
	ApiClearIt( param_owner );
	param_owner.typeID = elem_type;
	param_owner.index = elem_index;
	return ACAPI_Goodies (APIAny_OpenParametersID, &param_owner, NULL); 
}

GSErrCode EndParamsEditing()
{
	return ACAPI_Goodies ( APIAny_CloseParametersID, NULL, NULL );
}

GSErrCode EditParameter( const char* name, const char* value )
{
	API_ChangeParamType param;
	ApiClearIt( param );
	CHCopyC( name, param.name );
	param.strValue = const_cast<char*>(value);
	return ACAPI_Goodies ( APIAny_ChangeAParameterID, &param, NULL );
}

GSErrCode GetParamsEdited( API_GetParamsType& params )
{
	return ACAPI_Goodies ( APIAny_GetActParametersID, &params, NULL );
}

GSErrCode UpdateElementParameters(	API_ElemTypeID elem_type,
									long elem_index,
									API_AddParType** params )
{
	API_Element elem, mask;
	API_ElementMemo memo;
	ApiClearIt( elem );
	ApiClearIt( mask );
	ApiClearIt( memo );
	elem.header.typeID = elem_type;
	elem.header.index = elem_index;
	memo.params = params;
	return ACAPI_Element_Change ( &elem, &mask, &memo, APIMemoMask_AddPars, true );
}

GSErrCode ChangeElementParameter(	API_ElemTypeID elem_type,
									long elem_index,
									const char* name,
									const char* value )
{
	GSErrCode err = StartElementParamsEditing( elem_type, elem_index );
	if ( !err )
	{
		err = EditParameter( name, value );
		// more parameters to edit
		if ( !err )
		{
			API_GetParamsType params;
			params.params = 0;
			err = GetParamsEdited( params );
			if ( !err )
				err = UpdateElementParameters( elem_type, elem_index, params.params );
			ACAPI_DisposeAddParHdl( &params.params );
		}
		EndParamsEditing();
	}	
	return err;
}

GSErrCode ChangeParameterOfSelectedWinDoors( const char* pname, const char* value )
{
	API_SelectionInfo sel; 
	API_Neig** neigs = 0;
	ApiClearIt( sel );
	GSErrCode err = ACAPI_Selection_Get (&sel, &neigs, true);
    BMKillHandle ((GSHandle *) &sel.marquee.coords);
	if ( !err && neigs && sel.typeID == API_SelElems )
	{
		GSSize count = BMGetHandleSize ((GSHandle) neigs) / sizeof (API_Neig);
		for ( GSSize i = 0; i<count; ++i )
		{
			API_ElemTypeID elem_type = API_ZombieElemID;
			ACAPI_Goodies (APIAny_NeigIDToElemTypeID, &(*neigs).neigID, &elem_type );
			if ( elem_type == API_WindowID || elem_type == API_DoorID )
			{
				long elem_index = (*neigs).index;
				GSErrCode edit_err = ChangeElementParameter(elem_type,elem_index,pname,value);
				if ( edit_err )
					err = edit_err;
			}
		}
	}
    BMKillHandle ((GSHandle *) &neigs);
	return err;
}

GSErrCode ChangeDetLevelOfSelectedWinDoors()
{
	ACAPI_OpenUndoableSession ( "Test" );
	GSErrCode err = ChangeParameterOfSelectedWinDoors( "gs_detlevel_3D", "Off" );
	ACAPI_CloseUndoableSession();
	return err;
}

Re: Info of selected items

TomWaltz — Mon, 31 Oct 2005 16:10:01 GMT

Thanks, Oleg. I will probably not be able to really work on this tomorrow, but it looks like you have all the elements I was struggling with.

I owe you big time for this!

Re: Info of selected items

Ralph Wessel — Tue, 01 Nov 2005 21:33:03 GMT

TomWaltz wrote:
I guess my question is whether I return the elemHead.index or the selNeigs.index?

They are both the same thing - an index to a particular element in the Element database. The main difference between the handling of API_Elem_Head and API_Neig in this context is that the type specified in API_Neig describes not only the element type, but some specific part of that type, e.g. a point on a wall, or a reference line on a wall. That's why the type specified in the API_Neig has to be converted to an API_ElemTypeID before you can use it to find the target element.