Add Z coordinate parameter to CreateColumns command

Author: tlorantfy

README.md

@@ -198,7 +198,7 @@ acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'MoveElem
 Creates columns. The given coordinates will be origos of the columns.
 ### Parameters
 * coordinates (required)
-  * Type: array of x,y values
+  * Type: array of 3D coordinates with x,y,z values
 ### Response
 * errorMessage
   * Type: string
@@ -212,7 +212,7 @@ conn = ACConnection.connect ()
 acc = conn.commands
 act = conn.types
 
-origosOfNewColumns = [{'x': 1.0, 'y': 1.0}, {'x': 5.0, 'y': 5.0}]
+origosOfNewColumns = [{'x': 1.0, 'y': 1.0, 'z': 0.0}, {'x': 5.0, 'y': 5.0, 'z': 3.0}]
 
 acc.ExecuteAddOnCommand (act.AddOnCommandId ('AdditionalJSONCommands', 'CreateColumns'), {'coordinates': origosOfNewColumns})
 ```

Src/AdditionalJSONCommand.cpp

@@ -71,4 +71,47 @@ API_Guid AdditionalJSONCommand::GetGuidFromElementIdField (const GS::ObjectState
 	GS::String guid;
 	os.Get (GuidField, guid);
 	return APIGuidFromString (guid.ToCStr ());
+}
+
+
+namespace Utilities {
+
+
+GS::Array<GS::Pair<short, double>> GetStoryLevels ()
+{
+	GS::Array<GS::Pair<short, double>> storyLevels;
+	API_StoryInfo storyInfo = {};
+
+	GSErrCode err = ACAPI_Environment (APIEnv_GetStorySettingsID, &storyInfo);
+	if (err == NoError) {
+		const short numberOfStories = storyInfo.lastStory - storyInfo.firstStory + 1;
+		for (short i = 0; i < numberOfStories; ++i) {
+			storyLevels.PushNew ((*storyInfo.data)[i].index, (*storyInfo.data)[i].level);
+		}
+		BMKillHandle ((GSHandle*) &storyInfo.data);
+	}
+	return storyLevels;
+}
+
+
+short GetFloorIndexAndOffset (double zPos, const GS::Array<GS::Pair<short, double>>& storyLevels, double& zOffset)
+{
+	if (storyLevels.IsEmpty ()) {
+		zOffset = zPos;
+		return 0;
+	}
+
+	auto* lastStoryIndexAndLevel = &storyLevels[0];
+	for (const auto& storyIndexAndLevel : storyLevels) {
+		if (storyIndexAndLevel.second > zPos) {
+			break;
+		}
+		lastStoryIndexAndLevel = &storyIndexAndLevel;
+	}
+
+	zOffset = zPos - lastStoryIndexAndLevel->second;
+	return lastStoryIndexAndLevel->first;
+}
+
+
 }

Src/AdditionalJSONCommand.hpp

@@ -25,4 +25,9 @@ class AdditionalJSONCommand : public API_AddOnCommand {
 
 constexpr const char* ElementIdField = "elementId";
 
+namespace Utilities {
+	GS::Array<GS::Pair<short, double>> GetStoryLevels ();
+	short GetFloorIndexAndOffset (double zPos, const GS::Array<GS::Pair<short, double>>& storyLevels, double& zOffset);
+}
+
 #endif

Src/CreateColumnsCommand.cpp

@@ -19,24 +19,29 @@ GS::Optional<GS::UniString> CreateColumnsCommand::GetInputParametersSchema () co
 	"properties": {
 		"%s": {
 			"type": "array",
-			"description": "The 2D coordinates of the new columns.",
+			"description": "The 3D coordinates of the new columns' origos.",
 			"items": {
 				"type": "object",
-				"description" : "Position of a 2D point.",
+				"description" : "3D coordinate.",
 				"properties" : {
 					"x": {
 						"type": "number",
-						"description" : "X value of the point."
+						"description" : "X value of the coordinate."
 					},
 					"y" : {
 						"type": "number",
-						"description" : "Y value of the point."
+						"description" : "Y value of the coordinate."
+					},
+					"z" : {
+						"type": "number",
+						"description" : "Z value of the coordinate."
 					}
 				},
 				"additionalProperties": false,
 				"required" : [
 					"x",
-					"y"
+					"y",
+					"z"
 				]
 			}
 		}
@@ -51,11 +56,12 @@ CoordinatesParameterField);
 }
 
 
-static API_Coord GetCoordinateFromObjectState (const GS::ObjectState& objectState)
+static API_Coord3D GetCoordinateFromObjectState (const GS::ObjectState& objectState)
 {
-	API_Coord coordinate = {};
+	API_Coord3D coordinate = {};
 	objectState.Get ("x", coordinate.x);
 	objectState.Get ("y", coordinate.y);
+	objectState.Get ("z", coordinate.z);
 	return coordinate;
 }
 
@@ -65,23 +71,27 @@ GS::ObjectState	CreateColumnsCommand::Execute (const GS::ObjectState& parameters
 	GS::Array<GS::ObjectState> coordinates;
 	parameters.Get (CoordinatesParameterField, coordinates);
 
-	API_Coord apiCoordinate = {};
+	API_Coord3D apiCoordinate = {};
 	const APIErrCodes err = (APIErrCodes) ACAPI_CallUndoableCommand ("Create Columns", [&] () -> GSErrCode {
 		API_Element element = {};
 		API_ElementMemo memo = {};
 		const GS::OnExit guard ([&memo] () { ACAPI_DisposeElemMemoHdls (&memo); });
 
-		#ifdef ServerMainVers_2600
-		element.header.type = API_ElemType(API_ColumnID); // AC26
-		#else
-		element.header.typeID = API_ColumnID; // AC25
-		#endif
+#ifdef ServerMainVers_2600
+		element.header.type   = API_ColumnID;
+#else
+		element.header.typeID = API_ColumnID;
+#endif
 		APIErrCodes err = (APIErrCodes) ACAPI_Element_GetDefaults (&element, &memo);
 
+		const GS::Array<GS::Pair<short, double>> storyLevels = Utilities::GetStoryLevels ();
+
 		for (const GS::ObjectState& coordinate : coordinates) {
 			apiCoordinate = GetCoordinateFromObjectState (coordinate);
 
-			element.column.origoPos = apiCoordinate;
+			element.header.floorInd = Utilities::GetFloorIndexAndOffset (apiCoordinate.z, storyLevels, element.column.bottomOffset);
+			element.column.origoPos.x = apiCoordinate.x;
+			element.column.origoPos.y = apiCoordinate.y;
 			err = (APIErrCodes) ACAPI_Element_Create (&element, &memo);
 
 			if (err != NoError) {
@@ -93,7 +103,7 @@ GS::ObjectState	CreateColumnsCommand::Execute (const GS::ObjectState& parameters
 	});
 
 	if (err != NoError) {
-		const GS::UniString errorMsg = GS::UniString::Printf ("Failed to create column to coordinate: {%.2f, %.2f}!", apiCoordinate.x, apiCoordinate.y);
+		const GS::UniString errorMsg = GS::UniString::Printf ("Failed to create column to coordinate: {%.2f, %.2f, %.2f}!", apiCoordinate.x, apiCoordinate.y, apiCoordinate.z);
 		return CreateErrorResponse (err, errorMsg);
 	}