Survey Points

Functions related to the Survey Point. More...

Functions
GSErrCode	ACAPI_SurveyPoint_GetSurveyPointTransformation (API_Tranmat *apiSPTransformation)
	Returns the transformation matrix that transforms points given in the Project Origin's coordinate system into the Survey Point's coordinate system.
GSErrCode	ACAPI_SurveyPoint_IsSurveyPointVisible (bool *spVisibility)
	Checks if the survey point is visible.
GSErrCode	ACAPI_SurveyPoint_SetSurveyPointVisibility (bool *spVisibility)
	Sets the visibility of the survey point.
GSErrCode	ACAPI_SurveyPoint_IsSurveyPointLocked (bool *isSurveyPointLocked)
	Returns the lock state of the Survey Point.
GSErrCode	ACAPI_SurveyPoint_SetSurveyPointLocked (bool *lockedState)
	Locks or Unlocks the Survey Point.

Detailed Description

Functions related to the Survey Point.

Function Documentation

ACAPI_SurveyPoint_GetSurveyPointTransformation()

GSErrCode ACAPI_SurveyPoint_GetSurveyPointTransformation

(

API_Tranmat *

apiSPTransformation

)

Returns the transformation matrix that transforms points given in the Project Origin's coordinate system into the Survey Point's coordinate system.

Since

Archicad 25

Parameters

apiSPTransformation

[out] The calculated transformation matrix.

Returns

• NoError - The function has completed with success.
• APIERR_BADPARS - apiSPTransformation is nullptr

Remarks

Computes a transformation matrix that converts coordinates from the Project Origin's coordinate system to the Survey Point's coordinate system.

Example

API_Tranmat tm;
if (ACAPI_SurveyPoint_GetSurveyPointTransformation (&tm) == NoError) {
    API_Coord3D pointInProject = { 1.0, 1.0, 0.0 };
    API_Coord3D coordInSPSystem;
    coordInSPSystem.x = tm.tmx[0]*pointInProject.x + tm.tmx[1]*pointInProject.y + tm.tmx[2]*pointInProject.z + tm.tmx[3];
    coordInSPSystem.y = tm.tmx[4]*pointInProject.x + tm.tmx[5]*pointInProject.y + tm.tmx[6]*pointInProject.z + tm.tmx[7];
    coordInSPSystem.z = tm.tmx[8]*pointInProject.x + tm.tmx[9]*pointInProject.y + tm.tmx[10]*pointInProject.z + tm.tmx[11];
    ACAPI_WriteReport ("Point coordinates in the Survey Point's coordinate system: x=%lf, y=%lf, z=%lf",
                       false, coordInSPSystem.x, coordInSPSystem.y, coordInSPSystem.z);
}

ACAPI_SurveyPoint_IsSurveyPointLocked()

GSErrCode ACAPI_SurveyPoint_IsSurveyPointLocked

(

bool *

isSurveyPointLocked

)

Returns the lock state of the Survey Point.

Since

Archicad 25

Parameters

isSurveyPointLocked

[out] Lock state of the Survey Point.

Returns

• NoError - The function has completed with success.
• APIERR_BADPARS - The passed parameter is nullptr

Remarks

The Survey Point can be locked to prevent changes to its floor plan position coordinates and the project north angle.

Example

bool isSurveyPointLocked = false;
ACAPI_SurveyPoint_IsSurveyPointLocked (&isSurveyPointLocked);

ACAPI_SurveyPoint_IsSurveyPointVisible()

GSErrCode ACAPI_SurveyPoint_IsSurveyPointVisible

(

bool *

spVisibility

)

Checks if the survey point is visible.

Since

Archicad 25

Parameters

spVisibility

[out] Survey point visibility.

Returns

• NoError - The function has completed with success.
• APIERR_BADPARS - spVisibility is nullptr

Remarks

Checks the visibility of the survey point.

Example

bool spVisibility = true;
ACAPI_SurveyPoint_IsSurveyPointVisible (&spVisibility);

ACAPI_SurveyPoint_SetSurveyPointLocked()

GSErrCode ACAPI_SurveyPoint_SetSurveyPointLocked

(

bool *

lockedState

)

Locks or Unlocks the Survey Point.

Since

Archicad 25

Parameters

lockedState

[in] Lock state of the Survey Point.

Returns

• NoError - The function has completed with success.
• APIERR_BADPARS - The passed parameter is nullptr

Remarks

Locks or unlocks the Survey Point. This lock affects only the North Angle and the floor plan position of the Survey Point. All other parameters of the API_GeoLocation data can be changed even if the Survey Point is locked.

Example

bool lockedState = true;
ACAPI_SurveyPoint_SetSurveyPointLocked (&lockedState);

ACAPI_SurveyPoint_SetSurveyPointVisibility()

GSErrCode ACAPI_SurveyPoint_SetSurveyPointVisibility

(

bool *

spVisibility

)

Sets the visibility of the survey point.

Since

Archicad 25

Parameters

spVisibility

[in] New survey point visibility.

Returns

• NoError - The function has completed with success.
• APIERR_BADPARS - spVisibility is nullptr

Remarks

Sets the visibility of the survey point.

Example

bool spVisibility = true;
ACAPI_SurveyPoint_SetSurveyPointVisibility (&spVisibility);